<!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::AttributeExtractor 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('a00009.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="a00152.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shibsp::AttributeExtractor Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>A service that extracts and decodes attributes from XML objects.
<a href="a00009.html#details">More...</a></p>
<p><code>#include <shibsp/attribute/resolver/AttributeExtractor.h></code></p>
<div class="dynheader">
Inheritance diagram for shibsp::AttributeExtractor:</div>
<div class="dyncontent">
<div class="center">
<img src="a00009.png" usemap="#shibsp::AttributeExtractor_map" alt=""/>
<map id="shibsp::AttributeExtractor_map" name="shibsp::AttributeExtractor_map">
</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:a4792052f965228ef8a64e776b194b1ee"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00009.html#a4792052f965228ef8a64e776b194b1ee">extractAttributes</a> (const <a class="el" href="a00004.html">Application</a> &application, const opensaml::saml2md::RoleDescriptor *issuer, const xmltooling::XMLObject &xmlObject, std::vector< <a class="el" href="a00007.html">Attribute</a> * > &attributes) const </td></tr>
<tr class="separator:a4792052f965228ef8a64e776b194b1ee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3af7e4dd5d35a7829f0668d2f112f6c7"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00009.html#a3af7e4dd5d35a7829f0668d2f112f6c7">extractAttributes</a> (const <a class="el" href="a00004.html">Application</a> &application, const xmltooling::GenericRequest *request, const opensaml::saml2md::RoleDescriptor *issuer, const xmltooling::XMLObject &xmlObject, std::vector< <a class="el" href="a00007.html">Attribute</a> * > &attributes) const </td></tr>
<tr class="memdesc:a3af7e4dd5d35a7829f0668d2f112f6c7"><td class="mdescLeft"> </td><td class="mdescRight">Extracts the attributes found in an XMLObject. <a href="#a3af7e4dd5d35a7829f0668d2f112f6c7">More...</a><br/></td></tr>
<tr class="separator:a3af7e4dd5d35a7829f0668d2f112f6c7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a131bedf2cbd08a200689ecc66d76c9b3"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00009.html#a131bedf2cbd08a200689ecc66d76c9b3">getAttributeIds</a> (std::vector< std::string > &attributes) const =0</td></tr>
<tr class="memdesc:a131bedf2cbd08a200689ecc66d76c9b3"><td class="mdescLeft"> </td><td class="mdescRight">Populates an array with the set of <a class="el" href="a00007.html" title="A resolved attribute. ">Attribute</a> IDs that might be generated. <a href="#a131bedf2cbd08a200689ecc66d76c9b3">More...</a><br/></td></tr>
<tr class="separator:a131bedf2cbd08a200689ecc66d76c9b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa9528f119b4fb793b55d2b590fa98efc"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00009.html#aa9528f119b4fb793b55d2b590fa98efc">generateMetadata</a> (opensaml::saml2md::SPSSODescriptor &role) const </td></tr>
<tr class="memdesc:aa9528f119b4fb793b55d2b590fa98efc"><td class="mdescLeft"> </td><td class="mdescRight">Generates and/or modifies metadata reflecting the extractor, typically attribute-related requirements. <a href="#aa9528f119b4fb793b55d2b590fa98efc">More...</a><br/></td></tr>
<tr class="separator:aa9528f119b4fb793b55d2b590fa98efc"><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 service that extracts and decodes attributes from XML objects. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a4792052f965228ef8a64e776b194b1ee"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void shibsp::AttributeExtractor::extractAttributes </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00004.html">Application</a> & </td>
<td class="paramname"><em>application</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const opensaml::saml2md::RoleDescriptor * </td>
<td class="paramname"><em>issuer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const xmltooling::XMLObject & </td>
<td class="paramname"><em>xmlObject</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector< <a class="el" href="a00007.html">Attribute</a> * > & </td>
<td class="paramname"><em>attributes</em> </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">
<dl class="deprecated"><dt><b><a class="el" href="a00134.html#_deprecated000004">Deprecated:</a></b></dt><dd>Extracts the attributes found in an XMLObject.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">application</td><td><a class="el" href="a00004.html" title="Interface to a Shibboleth Application instance. ">Application</a> performing the extraction </td></tr>
<tr><td class="paramname">issuer</td><td>source of object, if known </td></tr>
<tr><td class="paramname">xmlObject</td><td>object to extract </td></tr>
<tr><td class="paramname">attributes</td><td>an array to populate with the extracted attributes</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">AttributeExtractionException</td><td>thrown if there is a problem extracting attributes </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3af7e4dd5d35a7829f0668d2f112f6c7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void shibsp::AttributeExtractor::extractAttributes </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00004.html">Application</a> & </td>
<td class="paramname"><em>application</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const xmltooling::GenericRequest * </td>
<td class="paramname"><em>request</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const opensaml::saml2md::RoleDescriptor * </td>
<td class="paramname"><em>issuer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const xmltooling::XMLObject & </td>
<td class="paramname"><em>xmlObject</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector< <a class="el" href="a00007.html">Attribute</a> * > & </td>
<td class="paramname"><em>attributes</em> </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>Extracts the attributes found in an XMLObject. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">application</td><td><a class="el" href="a00004.html" title="Interface to a Shibboleth Application instance. ">Application</a> performing the extraction </td></tr>
<tr><td class="paramname">request</td><td>request triggering the extraction, if any </td></tr>
<tr><td class="paramname">issuer</td><td>source of object, if known </td></tr>
<tr><td class="paramname">xmlObject</td><td>object to extract </td></tr>
<tr><td class="paramname">attributes</td><td>an array to populate with the extracted attributes</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">AttributeExtractionException</td><td>thrown if there is a problem extracting attributes </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa9528f119b4fb793b55d2b590fa98efc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void shibsp::AttributeExtractor::generateMetadata </td>
<td>(</td>
<td class="paramtype">opensaml::saml2md::SPSSODescriptor & </td>
<td class="paramname"><em>role</em></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>Generates and/or modifies metadata reflecting the extractor, typically attribute-related requirements. </p>
<p>The default implementation does nothing.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">role</td><td>metadata role to decorate </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a131bedf2cbd08a200689ecc66d76c9b3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void shibsp::AttributeExtractor::getAttributeIds </td>
<td>(</td>
<td class="paramtype">std::vector< std::string > & </td>
<td class="paramname"><em>attributes</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Populates an array with the set of <a class="el" href="a00007.html" title="A resolved attribute. ">Attribute</a> IDs that might be generated. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">attributes</td><td>array to populate </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>shibsp/attribute/resolver/<a class="el" href="a00071.html">AttributeExtractor.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="a00009.html">AttributeExtractor</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>
