<!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::BasicFilteringContext 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('a00013.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="a00146.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shibsp::BasicFilteringContext Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A trivial <a class="el" href="a00022.html" title="Context for attribute filtering operations. ">FilteringContext</a> implementation.
<a href="a00013.html#details">More...</a></p>
<p><code>#include <shibsp/attribute/filtering/BasicFilteringContext.h></code></p>
<div class="dynheader">
Inheritance diagram for shibsp::BasicFilteringContext:</div>
<div class="dyncontent">
<div class="center">
<img src="a00013.png" usemap="#shibsp::BasicFilteringContext_map" alt=""/>
<map id="shibsp::BasicFilteringContext_map" name="shibsp::BasicFilteringContext_map">
<area href="a00022.html" title="Context for attribute filtering operations. " alt="shibsp::FilteringContext" shape="rect" coords="0,0,173,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:a81bc18f393cfb574d0b5aa3fd11ce821"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00013.html#a81bc18f393cfb574d0b5aa3fd11ce821">BasicFilteringContext</a> (const <a class="el" href="a00004.html">Application</a> &app, const std::vector< <a class="el" href="a00007.html">Attribute</a> * > &attributes, const opensaml::saml2md::RoleDescriptor *role=nullptr, const XMLCh *authncontext_class=nullptr, const XMLCh *authncontext_decl=nullptr)</td></tr>
<tr class="memdesc:a81bc18f393cfb574d0b5aa3fd11ce821"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a81bc18f393cfb574d0b5aa3fd11ce821">More...</a><br/></td></tr>
<tr class="separator:a81bc18f393cfb574d0b5aa3fd11ce821"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6579d5bf4829f209b3a1a01f39629f8f"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="a00004.html">Application</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00013.html#a6579d5bf4829f209b3a1a01f39629f8f">getApplication</a> () const </td></tr>
<tr class="memdesc:a6579d5bf4829f209b3a1a01f39629f8f"><td class="mdescLeft"> </td><td class="mdescRight">Gets the <a class="el" href="a00004.html" title="Interface to a Shibboleth Application instance. ">Application</a> doing the filtering. <a href="#a6579d5bf4829f209b3a1a01f39629f8f">More...</a><br/></td></tr>
<tr class="separator:a6579d5bf4829f209b3a1a01f39629f8f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4d5e211a39adc03510a278a338336b48"><td class="memItemLeft" align="right" valign="top">const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00013.html#a4d5e211a39adc03510a278a338336b48">getAuthnContextClassRef</a> () const </td></tr>
<tr class="memdesc:a4d5e211a39adc03510a278a338336b48"><td class="mdescLeft"> </td><td class="mdescRight">Returns a URI containing an AuthnContextClassRef associated with the subject. <a href="#a4d5e211a39adc03510a278a338336b48">More...</a><br/></td></tr>
<tr class="separator:a4d5e211a39adc03510a278a338336b48"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a35f45360c803247de749dd4f9e3884af"><td class="memItemLeft" align="right" valign="top">const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00013.html#a35f45360c803247de749dd4f9e3884af">getAuthnContextDeclRef</a> () const </td></tr>
<tr class="memdesc:a35f45360c803247de749dd4f9e3884af"><td class="mdescLeft"> </td><td class="mdescRight">Returns a URI containing an AuthnContextDeclRef associated with the subject. <a href="#a35f45360c803247de749dd4f9e3884af">More...</a><br/></td></tr>
<tr class="separator:a35f45360c803247de749dd4f9e3884af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acd4da510f4b2a1ff5fe9d83f3fa70af4"><td class="memItemLeft" align="right" valign="top">const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00013.html#acd4da510f4b2a1ff5fe9d83f3fa70af4">getAttributeRequester</a> () const </td></tr>
<tr class="memdesc:acd4da510f4b2a1ff5fe9d83f3fa70af4"><td class="mdescLeft"> </td><td class="mdescRight">Gets the ID of the requester of the attributes, if known. <a href="#acd4da510f4b2a1ff5fe9d83f3fa70af4">More...</a><br/></td></tr>
<tr class="separator:acd4da510f4b2a1ff5fe9d83f3fa70af4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a54a6b5e6e86b950f3a1972277dac2ec3"><td class="memItemLeft" align="right" valign="top">const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00013.html#a54a6b5e6e86b950f3a1972277dac2ec3">getAttributeIssuer</a> () const </td></tr>
<tr class="memdesc:a54a6b5e6e86b950f3a1972277dac2ec3"><td class="mdescLeft"> </td><td class="mdescRight">Gets the ID of the issuer of the attributes, if known. <a href="#a54a6b5e6e86b950f3a1972277dac2ec3">More...</a><br/></td></tr>
<tr class="separator:a54a6b5e6e86b950f3a1972277dac2ec3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af1a6e6176c0d39ad31754b5a2e0a5e7d"><td class="memItemLeft" align="right" valign="top">const <br class="typebreak"/>
opensaml::saml2md::RoleDescriptor * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00013.html#af1a6e6176c0d39ad31754b5a2e0a5e7d">getAttributeRequesterMetadata</a> () const </td></tr>
<tr class="memdesc:af1a6e6176c0d39ad31754b5a2e0a5e7d"><td class="mdescLeft"> </td><td class="mdescRight">Gets the SAML metadata for the attribute requesting role, if available. <a href="#af1a6e6176c0d39ad31754b5a2e0a5e7d">More...</a><br/></td></tr>
<tr class="separator:af1a6e6176c0d39ad31754b5a2e0a5e7d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac1df7d96eed31f0620492cb4eb559629"><td class="memItemLeft" align="right" valign="top">const <br class="typebreak"/>
opensaml::saml2md::RoleDescriptor * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00013.html#ac1df7d96eed31f0620492cb4eb559629">getAttributeIssuerMetadata</a> () const </td></tr>
<tr class="memdesc:ac1df7d96eed31f0620492cb4eb559629"><td class="mdescLeft"> </td><td class="mdescRight">Gets the SAML metadata for the attribute issuing role, if available. <a href="#ac1df7d96eed31f0620492cb4eb559629">More...</a><br/></td></tr>
<tr class="separator:ac1df7d96eed31f0620492cb4eb559629"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeb11f2623565067c12bc8b31922e557c"><td class="memItemLeft" align="right" valign="top">const std::multimap<br class="typebreak"/>
< std::string, <a class="el" href="a00007.html">Attribute</a> * > & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00013.html#aeb11f2623565067c12bc8b31922e557c">getAttributes</a> () const </td></tr>
<tr class="memdesc:aeb11f2623565067c12bc8b31922e557c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the set of Attributes being filtered. <a href="#aeb11f2623565067c12bc8b31922e557c">More...</a><br/></td></tr>
<tr class="separator:aeb11f2623565067c12bc8b31922e557c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A trivial <a class="el" href="a00022.html" title="Context for attribute filtering operations. ">FilteringContext</a> implementation. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a81bc18f393cfb574d0b5aa3fd11ce821"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">shibsp::BasicFilteringContext::BasicFilteringContext </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00004.html">Application</a> & </td>
<td class="paramname"><em>app</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< <a class="el" href="a00007.html">Attribute</a> * > & </td>
<td class="paramname"><em>attributes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const opensaml::saml2md::RoleDescriptor * </td>
<td class="paramname"><em>role</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh * </td>
<td class="paramname"><em>authncontext_class</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh * </td>
<td class="paramname"><em>authncontext_decl</em> = <code>nullptr</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">app</td><td>reference to <a class="el" href="a00004.html" title="Interface to a Shibboleth Application instance. ">Application</a> </td></tr>
<tr><td class="paramname">attributes</td><td>attributes being filtered </td></tr>
<tr><td class="paramname">role</td><td>metadata role of <a class="el" href="a00007.html" title="A resolved attribute. ">Attribute</a> issuer, if any </td></tr>
<tr><td class="paramname">authncontext_class</td><td>method/category of authentication event, if known </td></tr>
<tr><td class="paramname">authncontext_decl</td><td>specifics of authentication event, if known </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a6579d5bf4829f209b3a1a01f39629f8f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="a00004.html">Application</a>& shibsp::BasicFilteringContext::getApplication </td>
<td>(</td>
<td class="paramname"></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>Gets the <a class="el" href="a00004.html" title="Interface to a Shibboleth Application instance. ">Application</a> doing the filtering. </p>
<dl class="section return"><dt>Returns</dt><dd>reference to an <a class="el" href="a00004.html" title="Interface to a Shibboleth Application instance. ">Application</a> </dd></dl>
<p>Implements <a class="el" href="a00022.html#a014e0c2202b6dcc44841ce4a561df4ce">shibsp::FilteringContext</a>.</p>
</div>
</div>
<a class="anchor" id="a54a6b5e6e86b950f3a1972277dac2ec3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const XMLCh* shibsp::BasicFilteringContext::getAttributeIssuer </td>
<td>(</td>
<td class="paramname"></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>Gets the ID of the issuer of the attributes, if known. </p>
<dl class="section return"><dt>Returns</dt><dd>ID of the issuer of the attributes, or nullptr </dd></dl>
<p>Implements <a class="el" href="a00022.html#a0887141084fe28343bcd94b5105fa681">shibsp::FilteringContext</a>.</p>
</div>
</div>
<a class="anchor" id="ac1df7d96eed31f0620492cb4eb559629"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const opensaml::saml2md::RoleDescriptor* shibsp::BasicFilteringContext::getAttributeIssuerMetadata </td>
<td>(</td>
<td class="paramname"></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>Gets the SAML metadata for the attribute issuing role, if available. </p>
<dl class="section return"><dt>Returns</dt><dd>SAML metadata for the attribute issuing role, or nullptr </dd></dl>
<p>Implements <a class="el" href="a00022.html#a3bfc1e2510ca26468aa2f92592ea8a60">shibsp::FilteringContext</a>.</p>
</div>
</div>
<a class="anchor" id="acd4da510f4b2a1ff5fe9d83f3fa70af4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const XMLCh* shibsp::BasicFilteringContext::getAttributeRequester </td>
<td>(</td>
<td class="paramname"></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>Gets the ID of the requester of the attributes, if known. </p>
<dl class="section return"><dt>Returns</dt><dd>requester of the attributes, or nullptr </dd></dl>
<p>Implements <a class="el" href="a00022.html#a078b20251c49240f8596c6b8620a93bb">shibsp::FilteringContext</a>.</p>
</div>
</div>
<a class="anchor" id="af1a6e6176c0d39ad31754b5a2e0a5e7d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const opensaml::saml2md::RoleDescriptor* shibsp::BasicFilteringContext::getAttributeRequesterMetadata </td>
<td>(</td>
<td class="paramname"></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>Gets the SAML metadata for the attribute requesting role, if available. </p>
<dl class="section return"><dt>Returns</dt><dd>SAML metadata for the attribute requesting role, or nullptr </dd></dl>
<p>Implements <a class="el" href="a00022.html#af4aa001c7145e6894cb9973b107c67f2">shibsp::FilteringContext</a>.</p>
</div>
</div>
<a class="anchor" id="aeb11f2623565067c12bc8b31922e557c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::multimap<std::string,<a class="el" href="a00007.html">Attribute</a>*>& shibsp::BasicFilteringContext::getAttributes </td>
<td>(</td>
<td class="paramname"></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>Returns the set of Attributes being filtered. </p>
<p>No modifications should be performed, access is provided only for use by MatchFunctors based on the presence of <a class="el" href="a00007.html" title="A resolved attribute. ">Attribute</a> data.</p>
<dl class="section return"><dt>Returns</dt><dd>an immutable map of Attributes. </dd></dl>
<p>Implements <a class="el" href="a00022.html#af3c3e2bde25fb5f8aa646166c0fbcb8e">shibsp::FilteringContext</a>.</p>
</div>
</div>
<a class="anchor" id="a4d5e211a39adc03510a278a338336b48"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const XMLCh* shibsp::BasicFilteringContext::getAuthnContextClassRef </td>
<td>(</td>
<td class="paramname"></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>Returns a URI containing an AuthnContextClassRef associated with the subject. </p>
<p>SAML 1.x AuthenticationMethods will be returned as class references.</p>
<dl class="section return"><dt>Returns</dt><dd>a URI identifying the authentication context class </dd></dl>
<p>Implements <a class="el" href="a00022.html#a7dd28d9ff303b0d238430a9a4580d5d4">shibsp::FilteringContext</a>.</p>
</div>
</div>
<a class="anchor" id="a35f45360c803247de749dd4f9e3884af"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const XMLCh* shibsp::BasicFilteringContext::getAuthnContextDeclRef </td>
<td>(</td>
<td class="paramname"></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>Returns a URI containing an AuthnContextDeclRef associated with the subject. </p>
<dl class="section return"><dt>Returns</dt><dd>a URI identifying the authentication context declaration </dd></dl>
<p>Implements <a class="el" href="a00022.html#a5c567979284798b890e800c399910257">shibsp::FilteringContext</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>shibsp/attribute/filtering/<a class="el" href="a00066.html">BasicFilteringContext.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="a00013.html">BasicFilteringContext</a></li>
<li class="footer">Generated on Thu Dec 5 2013 22:10:43 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>
