<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>shibboleth-2.5.3: shibsp::SecuredHandler Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">shibboleth-2.5.3
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('a00041.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="a00167.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shibsp::SecuredHandler Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Pluggable runtime functionality that is protected by simple access control.
<a href="a00041.html#details">More...</a></p>
<p><code>#include <shibsp/handler/SecuredHandler.h></code></p>
<div class="dynheader">
Inheritance diagram for shibsp::SecuredHandler:</div>
<div class="dyncontent">
<div class="center">
<img src="a00041.png" usemap="#shibsp::SecuredHandler_map" alt=""/>
<map id="shibsp::SecuredHandler_map" name="shibsp::SecuredHandler_map">
<area href="a00001.html" title="Base class for handlers based on a DOMPropertySet. " alt="shibsp::AbstractHandler" shape="rect" coords="80,112,231,136"/>
<area href="a00024.html" title="Pluggable runtime functionality that implement protocols and services. " alt="shibsp::Handler" shape="rect" coords="0,56,151,80"/>
<area href="a00019.html" title="DOM-based property set implementation. " alt="shibsp::DOMPropertySet" shape="rect" coords="161,56,312,80"/>
<area href="a00034.html" title="Interface to a generic set of typed properties or a DOM container of additional data. " alt="shibsp::PropertySet" shape="rect" coords="0,0,151,24"/>
<area href="a00034.html" title="Interface to a generic set of typed properties or a DOM container of additional data. " alt="shibsp::PropertySet" shape="rect" coords="161,0,312,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a86352d77c9997a07ea851243a86bd67a"><td class="memItemLeft" align="right" valign="top">std::pair< bool, long > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00041.html#a86352d77c9997a07ea851243a86bd67a">run</a> (<a class="el" href="a00053.html">SPRequest</a> &request, bool isHandler=true) const </td></tr>
<tr class="memdesc:a86352d77c9997a07ea851243a86bd67a"><td class="mdescLeft"> </td><td class="mdescRight">Executes handler functionality as an incoming request. <a href="#a86352d77c9997a07ea851243a86bd67a">More...</a><br/></td></tr>
<tr class="separator:a86352d77c9997a07ea851243a86bd67a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_a00024"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_a00024')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="a00024.html">shibsp::Handler</a></td></tr>
<tr class="memitem:ae4ee079fa0ddab026383ff95ae521390 inherit pub_methods_a00024"><td class="memItemLeft" align="right" valign="top">virtual const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00024.html#ae4ee079fa0ddab026383ff95ae521390">getProtocolFamily</a> () const </td></tr>
<tr class="memdesc:ae4ee079fa0ddab026383ff95ae521390 inherit pub_methods_a00024"><td class="mdescLeft"> </td><td class="mdescRight">Returns an identifier for the protocol family associated with the handler, if any. <a href="#ae4ee079fa0ddab026383ff95ae521390">More...</a><br/></td></tr>
<tr class="separator:ae4ee079fa0ddab026383ff95ae521390 inherit pub_methods_a00024"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5cab4d84f3b4ba8a7c5d2c645bf236bc inherit pub_methods_a00024"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00024.html#a5cab4d84f3b4ba8a7c5d2c645bf236bc">generateMetadata</a> (opensaml::saml2md::SPSSODescriptor &role, const char *handlerURL) const </td></tr>
<tr class="memdesc:a5cab4d84f3b4ba8a7c5d2c645bf236bc inherit pub_methods_a00024"><td class="mdescLeft"> </td><td class="mdescRight">Generates and/or modifies metadata reflecting the <a class="el" href="a00024.html" title="Pluggable runtime functionality that implement protocols and services. ">Handler</a>. <a href="#a5cab4d84f3b4ba8a7c5d2c645bf236bc">More...</a><br/></td></tr>
<tr class="separator:a5cab4d84f3b4ba8a7c5d2c645bf236bc inherit pub_methods_a00024"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a758202b21a519e66f26d0b786dda89c3 inherit pub_methods_a00024"><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00024.html#a758202b21a519e66f26d0b786dda89c3">getType</a> () const </td></tr>
<tr class="memdesc:a758202b21a519e66f26d0b786dda89c3 inherit pub_methods_a00024"><td class="mdescLeft"> </td><td class="mdescRight">Returns the "type" of the <a class="el" href="a00024.html" title="Pluggable runtime functionality that implement protocols and services. ">Handler</a> plugin. <a href="#a758202b21a519e66f26d0b786dda89c3">More...</a><br/></td></tr>
<tr class="separator:a758202b21a519e66f26d0b786dda89c3 inherit pub_methods_a00024"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_a00019"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_a00019')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="a00019.html">shibsp::DOMPropertySet</a></td></tr>
<tr class="memitem:aae28fecd0bf90bb64e7b09278bd03530 inherit pub_methods_a00019"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="a00034.html">PropertySet</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00019.html#aae28fecd0bf90bb64e7b09278bd03530">getParent</a> () const </td></tr>
<tr class="memdesc:aae28fecd0bf90bb64e7b09278bd03530 inherit pub_methods_a00019"><td class="mdescLeft"> </td><td class="mdescRight">Returns parent of this <a class="el" href="a00034.html" title="Interface to a generic set of typed properties or a DOM container of additional data. ">PropertySet</a>, if any. <a href="#aae28fecd0bf90bb64e7b09278bd03530">More...</a><br/></td></tr>
<tr class="separator:aae28fecd0bf90bb64e7b09278bd03530 inherit pub_methods_a00019"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac063c2a9bc5b5881fd87c4bf09f46f08 inherit pub_methods_a00019"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00019.html#ac063c2a9bc5b5881fd87c4bf09f46f08">setParent</a> (const <a class="el" href="a00034.html">PropertySet</a> *parent)</td></tr>
<tr class="memdesc:ac063c2a9bc5b5881fd87c4bf09f46f08 inherit pub_methods_a00019"><td class="mdescLeft"> </td><td class="mdescRight">Establishes a "parent" <a class="el" href="a00034.html" title="Interface to a generic set of typed properties or a DOM container of additional data. ">PropertySet</a> to supply inherited settings. <a href="#ac063c2a9bc5b5881fd87c4bf09f46f08">More...</a><br/></td></tr>
<tr class="separator:ac063c2a9bc5b5881fd87c4bf09f46f08 inherit pub_methods_a00019"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac30b948087b77030bdba76389516c6f2 inherit pub_methods_a00019"><td class="memItemLeft" align="right" valign="top">std::pair< bool, bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00019.html#ac30b948087b77030bdba76389516c6f2">getBool</a> (const char *name, const char *ns=nullptr) const </td></tr>
<tr class="memdesc:ac30b948087b77030bdba76389516c6f2 inherit pub_methods_a00019"><td class="mdescLeft"> </td><td class="mdescRight">Returns a boolean-valued property. <a href="#ac30b948087b77030bdba76389516c6f2">More...</a><br/></td></tr>
<tr class="separator:ac30b948087b77030bdba76389516c6f2 inherit pub_methods_a00019"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab017fc985e21496e2781823c98167f7b inherit pub_methods_a00019"><td class="memItemLeft" align="right" valign="top">std::pair< bool, const char * > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00019.html#ab017fc985e21496e2781823c98167f7b">getString</a> (const char *name, const char *ns=nullptr) const </td></tr>
<tr class="memdesc:ab017fc985e21496e2781823c98167f7b inherit pub_methods_a00019"><td class="mdescLeft"> </td><td class="mdescRight">Returns a string-valued property. <a href="#ab017fc985e21496e2781823c98167f7b">More...</a><br/></td></tr>
<tr class="separator:ab017fc985e21496e2781823c98167f7b inherit pub_methods_a00019"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab8cd5d48936c7fee3014c93deabede79 inherit pub_methods_a00019"><td class="memItemLeft" align="right" valign="top">std::pair< bool, const XMLCh * > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00019.html#ab8cd5d48936c7fee3014c93deabede79">getXMLString</a> (const char *name, const char *ns=nullptr) const </td></tr>
<tr class="memdesc:ab8cd5d48936c7fee3014c93deabede79 inherit pub_methods_a00019"><td class="mdescLeft"> </td><td class="mdescRight">Returns a Unicode string-valued property. <a href="#ab8cd5d48936c7fee3014c93deabede79">More...</a><br/></td></tr>
<tr class="separator:ab8cd5d48936c7fee3014c93deabede79 inherit pub_methods_a00019"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a27399d5e63b0b268de1dee6ff7e0dd74 inherit pub_methods_a00019"><td class="memItemLeft" align="right" valign="top">std::pair< bool, unsigned int > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00019.html#a27399d5e63b0b268de1dee6ff7e0dd74">getUnsignedInt</a> (const char *name, const char *ns=nullptr) const </td></tr>
<tr class="memdesc:a27399d5e63b0b268de1dee6ff7e0dd74 inherit pub_methods_a00019"><td class="mdescLeft"> </td><td class="mdescRight">Returns an unsigned integer-valued property. <a href="#a27399d5e63b0b268de1dee6ff7e0dd74">More...</a><br/></td></tr>
<tr class="separator:a27399d5e63b0b268de1dee6ff7e0dd74 inherit pub_methods_a00019"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a567b00639c7053f271ae814485f9066a inherit pub_methods_a00019"><td class="memItemLeft" align="right" valign="top">std::pair< bool, int > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00019.html#a567b00639c7053f271ae814485f9066a">getInt</a> (const char *name, const char *ns=nullptr) const </td></tr>
<tr class="memdesc:a567b00639c7053f271ae814485f9066a inherit pub_methods_a00019"><td class="mdescLeft"> </td><td class="mdescRight">Returns an integer-valued property. <a href="#a567b00639c7053f271ae814485f9066a">More...</a><br/></td></tr>
<tr class="separator:a567b00639c7053f271ae814485f9066a inherit pub_methods_a00019"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a06c3d7aa85892b6535133ed67154522c inherit pub_methods_a00019"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00019.html#a06c3d7aa85892b6535133ed67154522c">getAll</a> (std::map< std::string, const char * > &properties) const </td></tr>
<tr class="memdesc:a06c3d7aa85892b6535133ed67154522c inherit pub_methods_a00019"><td class="mdescLeft"> </td><td class="mdescRight">Returns a map of all known properties in string form. <a href="#a06c3d7aa85892b6535133ed67154522c">More...</a><br/></td></tr>
<tr class="separator:a06c3d7aa85892b6535133ed67154522c inherit pub_methods_a00019"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad28dddc643f538829f0ebdcbdc81d4e1 inherit pub_methods_a00019"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="a00034.html">PropertySet</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00019.html#ad28dddc643f538829f0ebdcbdc81d4e1">getPropertySet</a> (const char *name, const char *ns=<a class="el" href="a00128.html#a7c430d9a2b402fafe37a49e23b941d27">shibspconstants::ASCII_SHIB2SPCONFIG_NS</a>) const </td></tr>
<tr class="memdesc:ad28dddc643f538829f0ebdcbdc81d4e1 inherit pub_methods_a00019"><td class="mdescLeft"> </td><td class="mdescRight">Returns a nested property set. <a href="#ad28dddc643f538829f0ebdcbdc81d4e1">More...</a><br/></td></tr>
<tr class="separator:ad28dddc643f538829f0ebdcbdc81d4e1 inherit pub_methods_a00019"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2b6c11add2a74af7e20c4fa05f07a075 inherit pub_methods_a00019"><td class="memItemLeft" align="right" valign="top">const xercesc::DOMElement * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00019.html#a2b6c11add2a74af7e20c4fa05f07a075">getElement</a> () const </td></tr>
<tr class="memdesc:a2b6c11add2a74af7e20c4fa05f07a075 inherit pub_methods_a00019"><td class="mdescLeft"> </td><td class="mdescRight">Returns a DOM element representing the property container, if any. <a href="#a2b6c11add2a74af7e20c4fa05f07a075">More...</a><br/></td></tr>
<tr class="separator:a2b6c11add2a74af7e20c4fa05f07a075 inherit pub_methods_a00019"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a53b982f9480a15786eecdf6b3ed4a527 inherit pub_methods_a00019"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00019.html#a53b982f9480a15786eecdf6b3ed4a527">load</a> (const xercesc::DOMElement *e, xmltooling::logging::Category *log=nullptr, xercesc::DOMNodeFilter *filter=nullptr, const std::map< std::string, std::string > *remapper=nullptr)</td></tr>
<tr class="memdesc:a53b982f9480a15786eecdf6b3ed4a527 inherit pub_methods_a00019"><td class="mdescLeft"> </td><td class="mdescRight">Loads the property set from a DOM element. <a href="#a53b982f9480a15786eecdf6b3ed4a527">More...</a><br/></td></tr>
<tr class="separator:a53b982f9480a15786eecdf6b3ed4a527 inherit pub_methods_a00019"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a9c44fa89ea0e10e3480335ced438c297"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00041.html#a9c44fa89ea0e10e3480335ced438c297">SecuredHandler</a> (const xercesc::DOMElement *e, xmltooling::logging::Category &<a class="el" href="a00001.html#ad64993bb2bb67b2de7eea4ba06b38b93">log</a>, const char *aclProperty="acl", const char *defaultACL=nullptr, xercesc::DOMNodeFilter *filter=nullptr, const std::map< std::string, std::string > *remapper=nullptr)</td></tr>
<tr class="memdesc:a9c44fa89ea0e10e3480335ced438c297"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a9c44fa89ea0e10e3480335ced438c297">More...</a><br/></td></tr>
<tr class="separator:a9c44fa89ea0e10e3480335ced438c297"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_methods_a00001"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_a00001')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="a00001.html">shibsp::AbstractHandler</a></td></tr>
<tr class="memitem:aab31c75b778d4e5c27722f04f2cd80b9 inherit pro_methods_a00001"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#aab31c75b778d4e5c27722f04f2cd80b9">AbstractHandler</a> (const xercesc::DOMElement *e, xmltooling::logging::Category &<a class="el" href="a00001.html#ad64993bb2bb67b2de7eea4ba06b38b93">log</a>, xercesc::DOMNodeFilter *filter=nullptr, const std::map< std::string, std::string > *remapper=nullptr)</td></tr>
<tr class="memdesc:aab31c75b778d4e5c27722f04f2cd80b9 inherit pro_methods_a00001"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#aab31c75b778d4e5c27722f04f2cd80b9">More...</a><br/></td></tr>
<tr class="separator:aab31c75b778d4e5c27722f04f2cd80b9 inherit pro_methods_a00001"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad64993bb2bb67b2de7eea4ba06b38b93 inherit pro_methods_a00001"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#ad64993bb2bb67b2de7eea4ba06b38b93">log</a> (<a class="el" href="a00053.html#a20701bedd21eab2b73de90cb364535a1">SPRequest::SPLogLevel</a> level, const std::string &msg) const </td></tr>
<tr class="memdesc:ad64993bb2bb67b2de7eea4ba06b38b93 inherit pro_methods_a00001"><td class="mdescLeft"> </td><td class="mdescRight">Log using handler's specific logging object. <a href="#ad64993bb2bb67b2de7eea4ba06b38b93">More...</a><br/></td></tr>
<tr class="separator:ad64993bb2bb67b2de7eea4ba06b38b93 inherit pro_methods_a00001"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a74a7ad8808a8c8a243095ce6a32a5261 inherit pro_methods_a00001"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#a74a7ad8808a8c8a243095ce6a32a5261">checkError</a> (const xmltooling::XMLObject *response, const opensaml::saml2md::RoleDescriptor *role=nullptr) const </td></tr>
<tr class="memdesc:a74a7ad8808a8c8a243095ce6a32a5261 inherit pro_methods_a00001"><td class="mdescLeft"> </td><td class="mdescRight">Examines a protocol response message for errors and raises an annotated exception if an error is found. <a href="#a74a7ad8808a8c8a243095ce6a32a5261">More...</a><br/></td></tr>
<tr class="separator:a74a7ad8808a8c8a243095ce6a32a5261 inherit pro_methods_a00001"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4ec6e65e81b1dc7bb699fb06d0dc9dc7 inherit pro_methods_a00001"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#a4ec6e65e81b1dc7bb699fb06d0dc9dc7">fillStatus</a> (opensaml::saml2p::StatusResponseType &response, const XMLCh *code, const XMLCh *subcode=nullptr, const char *msg=nullptr) const </td></tr>
<tr class="memdesc:a4ec6e65e81b1dc7bb699fb06d0dc9dc7 inherit pro_methods_a00001"><td class="mdescLeft"> </td><td class="mdescRight">Prepares Status information in a SAML 2.0 response. <a href="#a4ec6e65e81b1dc7bb699fb06d0dc9dc7">More...</a><br/></td></tr>
<tr class="separator:a4ec6e65e81b1dc7bb699fb06d0dc9dc7 inherit pro_methods_a00001"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a150c03330cab705b8341604bdbe793d9 inherit pro_methods_a00001"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#a150c03330cab705b8341604bdbe793d9">sendMessage</a> (const opensaml::MessageEncoder &encoder, xmltooling::XMLObject *msg, const char *relayState, const char *destination, const opensaml::saml2md::RoleDescriptor *role, const <a class="el" href="a00004.html">Application</a> &application, xmltooling::HTTPResponse &httpResponse, bool signIfPossible=false) const </td></tr>
<tr class="memdesc:a150c03330cab705b8341604bdbe793d9 inherit pro_methods_a00001"><td class="mdescLeft"> </td><td class="mdescRight">Encodes and sends SAML 2.0 message, optionally signing it in the process. <a href="#a150c03330cab705b8341604bdbe793d9">More...</a><br/></td></tr>
<tr class="separator:a150c03330cab705b8341604bdbe793d9 inherit pro_methods_a00001"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad968dbd36b077e16629b413982151a61 inherit pro_methods_a00001"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#ad968dbd36b077e16629b413982151a61">preservePostData</a> (const <a class="el" href="a00004.html">Application</a> &application, const xmltooling::HTTPRequest &request, xmltooling::HTTPResponse &response, const char *relayState) const </td></tr>
<tr class="memdesc:ad968dbd36b077e16629b413982151a61 inherit pro_methods_a00001"><td class="mdescLeft"> </td><td class="mdescRight">Implements a mechanism to preserve form post data. <a href="#ad968dbd36b077e16629b413982151a61">More...</a><br/></td></tr>
<tr class="separator:ad968dbd36b077e16629b413982151a61 inherit pro_methods_a00001"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a563bed07af889392a84b70131a8ea5f3 inherit pro_methods_a00001"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="a00017.html">DDF</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#a563bed07af889392a84b70131a8ea5f3">recoverPostData</a> (const <a class="el" href="a00004.html">Application</a> &application, const xmltooling::HTTPRequest &request, xmltooling::HTTPResponse &response, const char *relayState) const </td></tr>
<tr class="memdesc:a563bed07af889392a84b70131a8ea5f3 inherit pro_methods_a00001"><td class="mdescLeft"> </td><td class="mdescRight">Implements storage service and cookie mechanism to recover PostData. <a href="#a563bed07af889392a84b70131a8ea5f3">More...</a><br/></td></tr>
<tr class="separator:a563bed07af889392a84b70131a8ea5f3 inherit pro_methods_a00001"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5dca134627fa489a4c618a4211ce5aa2 inherit pro_methods_a00001"><td class="memItemLeft" align="right" valign="top">virtual long </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#a5dca134627fa489a4c618a4211ce5aa2">sendPostResponse</a> (const <a class="el" href="a00004.html">Application</a> &application, xmltooling::HTTPResponse &response, const char *url, <a class="el" href="a00017.html">DDF</a> &postData) const </td></tr>
<tr class="memdesc:a5dca134627fa489a4c618a4211ce5aa2 inherit pro_methods_a00001"><td class="mdescLeft"> </td><td class="mdescRight">Post a redirect response with post data. <a href="#a5dca134627fa489a4c618a4211ce5aa2">More...</a><br/></td></tr>
<tr class="separator:a5dca134627fa489a4c618a4211ce5aa2 inherit pro_methods_a00001"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab9507a1aa802abef1a52749a46a47cbd inherit pro_methods_a00001"><td class="memItemLeft" align="right" valign="top">std::pair< bool, bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#ab9507a1aa802abef1a52749a46a47cbd">getBool</a> (const char *name, const <a class="el" href="a00053.html">SPRequest</a> &request, unsigned int type=HANDLER_PROPERTY_ALL) const </td></tr>
<tr class="memdesc:ab9507a1aa802abef1a52749a46a47cbd inherit pro_methods_a00001"><td class="mdescLeft"> </td><td class="mdescRight">Returns a boolean-valued property. <a href="#ab9507a1aa802abef1a52749a46a47cbd">More...</a><br/></td></tr>
<tr class="separator:ab9507a1aa802abef1a52749a46a47cbd inherit pro_methods_a00001"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3cba8182d40b16f1456db757bbb531fb inherit pro_methods_a00001"><td class="memItemLeft" align="right" valign="top">std::pair< bool, const char * > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#a3cba8182d40b16f1456db757bbb531fb">getString</a> (const char *name, const <a class="el" href="a00053.html">SPRequest</a> &request, unsigned int type=HANDLER_PROPERTY_ALL) const </td></tr>
<tr class="memdesc:a3cba8182d40b16f1456db757bbb531fb inherit pro_methods_a00001"><td class="mdescLeft"> </td><td class="mdescRight">Returns a string-valued property. <a href="#a3cba8182d40b16f1456db757bbb531fb">More...</a><br/></td></tr>
<tr class="separator:a3cba8182d40b16f1456db757bbb531fb inherit pro_methods_a00001"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5db86c3d80eab2403b98e026f2d863b4 inherit pro_methods_a00001"><td class="memItemLeft" align="right" valign="top">std::pair< bool, unsigned int > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#a5db86c3d80eab2403b98e026f2d863b4">getUnsignedInt</a> (const char *name, const <a class="el" href="a00053.html">SPRequest</a> &request, unsigned int type=HANDLER_PROPERTY_ALL) const </td></tr>
<tr class="memdesc:a5db86c3d80eab2403b98e026f2d863b4 inherit pro_methods_a00001"><td class="mdescLeft"> </td><td class="mdescRight">Returns an unsigned integer-valued property. <a href="#a5db86c3d80eab2403b98e026f2d863b4">More...</a><br/></td></tr>
<tr class="separator:a5db86c3d80eab2403b98e026f2d863b4 inherit pro_methods_a00001"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abb01ea8c24ec1968ca38fc0b3fcea6fa inherit pro_methods_a00001"><td class="memItemLeft" align="right" valign="top">std::pair< bool, int > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#abb01ea8c24ec1968ca38fc0b3fcea6fa">getInt</a> (const char *name, const <a class="el" href="a00053.html">SPRequest</a> &request, unsigned int type=HANDLER_PROPERTY_ALL) const </td></tr>
<tr class="memdesc:abb01ea8c24ec1968ca38fc0b3fcea6fa inherit pro_methods_a00001"><td class="mdescLeft"> </td><td class="mdescRight">Returns an integer-valued property. <a href="#abb01ea8c24ec1968ca38fc0b3fcea6fa">More...</a><br/></td></tr>
<tr class="separator:abb01ea8c24ec1968ca38fc0b3fcea6fa inherit pro_methods_a00001"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_methods_a00024"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_a00024')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="a00024.html">shibsp::Handler</a></td></tr>
<tr class="memitem:a8c78dee1e5d3f4e8e6b3669dbaadf90c inherit pro_methods_a00024"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00024.html#a8c78dee1e5d3f4e8e6b3669dbaadf90c">cleanRelayState</a> (const <a class="el" href="a00004.html">Application</a> &application, const xmltooling::HTTPRequest &request, xmltooling::HTTPResponse &response) const </td></tr>
<tr class="memdesc:a8c78dee1e5d3f4e8e6b3669dbaadf90c inherit pro_methods_a00024"><td class="mdescLeft"> </td><td class="mdescRight">Prevents unused relay state from building up by cleaning old state from the client. <a href="#a8c78dee1e5d3f4e8e6b3669dbaadf90c">More...</a><br/></td></tr>
<tr class="separator:a8c78dee1e5d3f4e8e6b3669dbaadf90c inherit pro_methods_a00024"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a706aab1f40db95dbb72aa3e6910c905c inherit pro_methods_a00024"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00024.html#a706aab1f40db95dbb72aa3e6910c905c">preserveRelayState</a> (const <a class="el" href="a00004.html">Application</a> &application, xmltooling::HTTPResponse &response, std::string &relayState) const </td></tr>
<tr class="memdesc:a706aab1f40db95dbb72aa3e6910c905c inherit pro_methods_a00024"><td class="mdescLeft"> </td><td class="mdescRight">Implements various mechanisms to preserve RelayState, such as cookies or StorageService-backed keys. <a href="#a706aab1f40db95dbb72aa3e6910c905c">More...</a><br/></td></tr>
<tr class="separator:a706aab1f40db95dbb72aa3e6910c905c inherit pro_methods_a00024"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a93c03331411ecd033f6f9d118e8eea3c inherit pro_methods_a00024"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00024.html#a93c03331411ecd033f6f9d118e8eea3c">recoverRelayState</a> (const <a class="el" href="a00004.html">Application</a> &application, const xmltooling::HTTPRequest &request, xmltooling::HTTPResponse &response, std::string &relayState, bool clear=true) const </td></tr>
<tr class="memdesc:a93c03331411ecd033f6f9d118e8eea3c inherit pro_methods_a00024"><td class="mdescLeft"> </td><td class="mdescRight">Implements various mechanisms to recover RelayState, such as cookies or StorageService-backed keys. <a href="#a93c03331411ecd033f6f9d118e8eea3c">More...</a><br/></td></tr>
<tr class="separator:a93c03331411ecd033f6f9d118e8eea3c inherit pro_methods_a00024"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_methods_a00019"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_a00019')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="a00019.html">shibsp::DOMPropertySet</a></td></tr>
<tr class="memitem:adba99745c1aeaa1adda4d9db78eaca6e inherit pro_methods_a00019"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00019.html#adba99745c1aeaa1adda4d9db78eaca6e">setProperty</a> (const char *name, const char *val, const char *ns=nullptr)</td></tr>
<tr class="memdesc:adba99745c1aeaa1adda4d9db78eaca6e inherit pro_methods_a00019"><td class="mdescLeft"> </td><td class="mdescRight">Post-load injection of a property, for use by subclasses. <a href="#adba99745c1aeaa1adda4d9db78eaca6e">More...</a><br/></td></tr>
<tr class="separator:adba99745c1aeaa1adda4d9db78eaca6e inherit pro_methods_a00019"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_types_a00001"><td colspan="2" onclick="javascript:toggleInherit('pro_types_a00001')"><img src="closed.png" alt="-"/> Protected Types inherited from <a class="el" href="a00001.html">shibsp::AbstractHandler</a></td></tr>
<tr class="memitem:a6a1613af215416514575475060dcb728 inherit pro_types_a00001"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#a6a1613af215416514575475060dcb728">PropertySourceTypes</a> { <b>HANDLER_PROPERTY_REQUEST</b> = 1,
<b>HANDLER_PROPERTY_MAP</b> = 2,
<b>HANDLER_PROPERTY_FIXED</b> = 4,
<b>HANDLER_PROPERTY_ALL</b> = 255
}</td></tr>
<tr class="memdesc:a6a1613af215416514575475060dcb728"><td class="mdescLeft"> </td><td class="mdescRight">Bitmask of property sources to read from (request query parameter, request mapper, fixed handler property). <br/></td></tr>
<tr class="separator:a6a1613af215416514575475060dcb728 inherit pro_types_a00001"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_attribs_a00001"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_a00001')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="a00001.html">shibsp::AbstractHandler</a></td></tr>
<tr class="memitem:a62494104137a133e288e74a5291c5945 inherit pro_attribs_a00001"><td class="memItemLeft" align="right" valign="top">xmltooling::logging::Category & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#a62494104137a133e288e74a5291c5945">m_log</a></td></tr>
<tr class="memdesc:a62494104137a133e288e74a5291c5945 inherit pro_attribs_a00001"><td class="mdescLeft"> </td><td class="mdescRight">Logging object. <a href="#a62494104137a133e288e74a5291c5945">More...</a><br/></td></tr>
<tr class="separator:a62494104137a133e288e74a5291c5945 inherit pro_attribs_a00001"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1798016142689feb354214ae0e061fbb inherit pro_attribs_a00001"><td class="memItemLeft" align="right" valign="top">xmltooling::auto_ptr_char </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#a1798016142689feb354214ae0e061fbb">m_configNS</a></td></tr>
<tr class="memdesc:a1798016142689feb354214ae0e061fbb inherit pro_attribs_a00001"><td class="mdescLeft"> </td><td class="mdescRight">Configuration namespace for custom properties. <a href="#a1798016142689feb354214ae0e061fbb">More...</a><br/></td></tr>
<tr class="separator:a1798016142689feb354214ae0e061fbb inherit pro_attribs_a00001"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Pluggable runtime functionality that is protected by simple access control. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a9c44fa89ea0e10e3480335ced438c297"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">shibsp::SecuredHandler::SecuredHandler </td>
<td>(</td>
<td class="paramtype">const xercesc::DOMElement * </td>
<td class="paramname"><em>e</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">xmltooling::logging::Category & </td>
<td class="paramname"><em>log</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>aclProperty</em> = <code>"acl"</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>defaultACL</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">xercesc::DOMNodeFilter * </td>
<td class="paramname"><em>filter</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::map< std::string, std::string > * </td>
<td class="paramname"><em>remapper</em> = <code>nullptr</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">e</td><td>DOM element to load as property set </td></tr>
<tr><td class="paramname">log</td><td>logging category to use </td></tr>
<tr><td class="paramname">aclProperty</td><td>name of IP/CIDR ACL property </td></tr>
<tr><td class="paramname">defaultACL</td><td>IP/CIDR ACL to apply if no acl property is set </td></tr>
<tr><td class="paramname">filter</td><td>optional filter controls what child elements to include as nested PropertySets </td></tr>
<tr><td class="paramname">remapper</td><td>optional map of property rename rules for legacy property support </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a86352d77c9997a07ea851243a86bd67a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::pair<bool,long> shibsp::SecuredHandler::run </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00053.html">SPRequest</a> & </td>
<td class="paramname"><em>request</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isHandler</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Executes handler functionality as an incoming request. </p>
<p>Handlers can be run either directly by incoming web requests or indirectly/implicitly during other SP processing.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">request</td><td>SP request context </td></tr>
<tr><td class="paramname">isHandler</td><td>true iff executing in the context of a direct handler invocation </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pair containing a "request completed" indicator and a server-specific response code </dd></dl>
<p>Implements <a class="el" href="a00024.html#a8c31d112d1dceeb50cab16aa7d6b3294">shibsp::Handler</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>shibsp/handler/<a class="el" href="a00091.html">SecuredHandler.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="a00127.html">shibsp</a></li><li class="navelem"><a class="el" href="a00041.html">SecuredHandler</a></li>
<li class="footer">Generated on Thu Dec 5 2013 22:10:44 for shibboleth-2.5.3 by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
</ul>
</div>
</body>
</html>
