<!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>opensaml-2.5.2: opensaml Namespace 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">opensaml-2.5.2
</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 class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><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="namespaces.html"><span>Namespace List</span></a></li>
<li><a href="namespacemembers.html"><span>Namespace 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('a00119.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> |
<a href="#nested-classes">Classes</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">opensaml Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Common classes for OpenSAML library.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:a00120"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00120.html">saml1</a></td></tr>
<tr class="memdesc:a00120"><td class="mdescLeft"> </td><td class="mdescRight">SAML 1.x assertion namespace. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00121"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00121.html">saml1p</a></td></tr>
<tr class="memdesc:a00121"><td class="mdescLeft"> </td><td class="mdescRight">SAML 1.x protocol namespace. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00122"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html">saml2</a></td></tr>
<tr class="memdesc:a00122"><td class="mdescLeft"> </td><td class="mdescRight">SAML 2.0 assertion namespace. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00123"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00123.html">saml2md</a></td></tr>
<tr class="memdesc:a00123"><td class="mdescLeft"> </td><td class="mdescRight">SAML 2.0 metadata namespace. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00124"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00124.html">saml2p</a></td></tr>
<tr class="memdesc:a00124"><td class="mdescLeft"> </td><td class="mdescRight">SAML 2.0 protocol namespace. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html">ArtifactMap</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Helper class for <a class="el" href="a00056.html" title="Base class for SAML 1.x and 2.0 artifacts. ">SAMLArtifact</a> mapping and retrieval. <a href="a00003.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00034.html">MessageDecoder</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Interface to SAML protocol binding message decoders. <a href="a00034.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html">MessageEncoder</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Interface to SAML protocol binding message encoders. <a href="a00035.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00056.html">SAMLArtifact</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Base class for SAML 1.x and 2.0 artifacts. <a href="a00056.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html">SecurityPolicy</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A policy used to verify the security of an incoming message. <a href="a00060.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00061.html">SecurityPolicyRule</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A rule that a protocol request and message must meet in order to be valid and secure. <a href="a00061.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00064.html">SOAPClient</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Specialized <a class="el" href="a00064.html" title="Specialized SOAPClient for SAML SOAP bindings. ">SOAPClient</a> for SAML SOAP bindings. <a href="a00064.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html">EncryptedKeyResolver</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">SAML-specific encrypted key resolver. <a href="a00023.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html">RootObject</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Base class for SAML objects at the root of core schemas. <a href="a00048.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00005.html">Assertion</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Base class for SAML assertions. <a href="a00005.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00067.html">Status</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Base class for SAML status codes. <a href="a00067.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00059.html">SAMLConfig</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Singleton object that manages library startup/shutdown.configuration. <a href="a00059.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00017.html">ContentReference</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">SAML-specific signature reference profile. <a href="a00017.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00062.html">SignableObject</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Base class for SAML objects that can be signed. <a href="a00062.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00063.html">SignatureProfileValidator</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">SAML-specific signature profile validator. <a href="a00063.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html">CommonDomainCookie</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Helper class for maintaining discovery cookie. <a href="a00014.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a9488637c8c0c068f811f022eed27acc7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9488637c8c0c068f811f022eed27acc7"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00119.html#a9488637c8c0c068f811f022eed27acc7">registerMessageDecoders</a> ()</td></tr>
<tr class="memdesc:a9488637c8c0c068f811f022eed27acc7"><td class="mdescLeft"> </td><td class="mdescRight">Registers <a class="el" href="a00034.html" title="Interface to SAML protocol binding message decoders. ">MessageDecoder</a> plugins into the runtime. <br/></td></tr>
<tr class="separator:a9488637c8c0c068f811f022eed27acc7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab15d1da2f9876b27ad9cb26fb718a5f2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab15d1da2f9876b27ad9cb26fb718a5f2"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00119.html#ab15d1da2f9876b27ad9cb26fb718a5f2">registerMessageEncoders</a> ()</td></tr>
<tr class="memdesc:ab15d1da2f9876b27ad9cb26fb718a5f2"><td class="mdescLeft"> </td><td class="mdescRight">Registers <a class="el" href="a00035.html" title="Interface to SAML protocol binding message encoders. ">MessageEncoder</a> plugins into the runtime. <br/></td></tr>
<tr class="separator:ab15d1da2f9876b27ad9cb26fb718a5f2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae006ef28260b9738aa4f6fe8b6394dea"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae006ef28260b9738aa4f6fe8b6394dea"></a>
 </td><td class="memItemRight" valign="bottom"><b>DECL_XMLTOOLING_EXCEPTION</b> (ArtifactException,, opensaml, xmltooling::XMLToolingException, Exceptions related to artifact parsing)</td></tr>
<tr class="separator:ae006ef28260b9738aa4f6fe8b6394dea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a77e32a7f1e6905e6a905d7ec6e431c9e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a77e32a7f1e6905e6a905d7ec6e431c9e"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00119.html#a77e32a7f1e6905e6a905d7ec6e431c9e">registerSAMLArtifacts</a> ()</td></tr>
<tr class="memdesc:a77e32a7f1e6905e6a905d7ec6e431c9e"><td class="mdescLeft"> </td><td class="mdescRight">Registers <a class="el" href="a00056.html" title="Base class for SAML 1.x and 2.0 artifacts. ">SAMLArtifact</a> subclasses into the runtime. <br/></td></tr>
<tr class="separator:a77e32a7f1e6905e6a905d7ec6e431c9e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0cae3fcb284f9a7a4c5b666e4b015a2e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0cae3fcb284f9a7a4c5b666e4b015a2e"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00119.html#a0cae3fcb284f9a7a4c5b666e4b015a2e">registerSecurityPolicyRules</a> ()</td></tr>
<tr class="memdesc:a0cae3fcb284f9a7a4c5b666e4b015a2e"><td class="mdescLeft"> </td><td class="mdescRight">Registers <a class="el" href="a00061.html" title="A rule that a protocol request and message must meet in order to be valid and secure. ">SecurityPolicyRule</a> plugins into the runtime. <br/></td></tr>
<tr class="separator:a0cae3fcb284f9a7a4c5b666e4b015a2e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5095d81221d7e47a10bb0e8a3f1dc91c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5095d81221d7e47a10bb0e8a3f1dc91c"></a>
 </td><td class="memItemRight" valign="bottom"><b>DECL_XMLTOOLING_EXCEPTION</b> (SecurityPolicyException,, opensaml, xmltooling::XMLToolingException, Exceptions in security policy processing)</td></tr>
<tr class="separator:a5095d81221d7e47a10bb0e8a3f1dc91c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a149a1cebe5f1cc6dc8eb8b9a71da3969"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a149a1cebe5f1cc6dc8eb8b9a71da3969"></a>
 </td><td class="memItemRight" valign="bottom"><b>DECL_XMLTOOLING_EXCEPTION</b> (BindingException,, opensaml, xmltooling::XMLToolingException, Exceptions in SAML binding processing)</td></tr>
<tr class="separator:a149a1cebe5f1cc6dc8eb8b9a71da3969"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1dae5bc36c778fc59ff5cddb729e7a2a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1dae5bc36c778fc59ff5cddb729e7a2a"></a>
 </td><td class="memItemRight" valign="bottom"><b>DECL_XMLTOOLING_EXCEPTION</b> (ProfileException,, opensaml, xmltooling::ValidationException, Exceptions in SAML profile processing)</td></tr>
<tr class="separator:a1dae5bc36c778fc59ff5cddb729e7a2a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a47acc85309d3de880c51984d99138648"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a47acc85309d3de880c51984d99138648"></a>
 </td><td class="memItemRight" valign="bottom"><b>DECL_XMLTOOLING_EXCEPTION</b> (FatalProfileException,, opensaml, ProfileException, Fatal exceptions in SAML profile processing)</td></tr>
<tr class="separator:a47acc85309d3de880c51984d99138648"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a916de43ce22069db17a4576b8834cee2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a916de43ce22069db17a4576b8834cee2"></a>
 </td><td class="memItemRight" valign="bottom"><b>DECL_XMLTOOLING_EXCEPTION</b> (RetryableProfileException,, opensaml, ProfileException, Non-fatal exceptions in SAML profile processing)</td></tr>
<tr class="separator:a916de43ce22069db17a4576b8834cee2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a485ac568ebc0615faaa21d19d357de52"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00119.html#a485ac568ebc0615faaa21d19d357de52">annotateException</a> (xmltooling::XMLToolingException *e, const saml2md::EntityDescriptor *entity, const <a class="el" href="a00067.html">Status</a> *status=nullptr, bool rethrow=true)</td></tr>
<tr class="memdesc:a485ac568ebc0615faaa21d19d357de52"><td class="mdescLeft"> </td><td class="mdescRight">Attaches metadata-derived information as exception properties and optionally rethrows the object. <a href="#a485ac568ebc0615faaa21d19d357de52">More...</a><br/></td></tr>
<tr class="separator:a485ac568ebc0615faaa21d19d357de52"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af1c73a6589019e36a50f668b4265b2a0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00119.html#af1c73a6589019e36a50f668b4265b2a0">annotateException</a> (xmltooling::XMLToolingException *e, const saml2md::RoleDescriptor *role, const <a class="el" href="a00067.html">Status</a> *status=nullptr, bool rethrow=true)</td></tr>
<tr class="memdesc:af1c73a6589019e36a50f668b4265b2a0"><td class="mdescLeft"> </td><td class="mdescRight">Attaches metadata-derived information as exception properties and optionally rethrows the object. <a href="#af1c73a6589019e36a50f668b4265b2a0">More...</a><br/></td></tr>
<tr class="separator:af1c73a6589019e36a50f668b4265b2a0"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Common classes for OpenSAML library. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a485ac568ebc0615faaa21d19d357de52"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void opensaml::annotateException </td>
<td>(</td>
<td class="paramtype">xmltooling::XMLToolingException * </td>
<td class="paramname"><em>e</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const saml2md::EntityDescriptor * </td>
<td class="paramname"><em>entity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Status * </td>
<td class="paramname"><em>status</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>rethrow</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Attaches metadata-derived information as exception properties and optionally rethrows the object. </p>
<p>The following named properties are attached, when possible:</p>
<dl>
<dt>entityID </dt>
<dd>The unique ID of the entity </dd>
<dt>errorURL </dt>
<dd>The error support URL of a random role </dd>
<dt>contactName </dt>
<dd>A formatted support or technical contact name </dd>
<dt>contactEmail </dt>
<dd>A contact email address </dd>
<dt>statusCode </dt>
<dd>Top-level status code from <a class="el" href="a00067.html" title="Base class for SAML status codes. ">Status</a> object </dd>
<dt>statusCode2 </dt>
<dd>Second-level status code from <a class="el" href="a00067.html" title="Base class for SAML status codes. ">Status</a> object </dd>
<dt>statusMessage </dt>
<dd>StatusMessage from <a class="el" href="a00067.html" title="Base class for SAML status codes. ">Status</a> object </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">e</td><td>pointer to exception object </td></tr>
<tr><td class="paramname">entity</td><td>pointer to entity </td></tr>
<tr><td class="paramname">status</td><td>pointer to <a class="el" href="a00067.html" title="Base class for SAML status codes. ">Status</a> from message </td></tr>
<tr><td class="paramname">rethrow</td><td>true iff the exception should be rethrown </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af1c73a6589019e36a50f668b4265b2a0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void opensaml::annotateException </td>
<td>(</td>
<td class="paramtype">xmltooling::XMLToolingException * </td>
<td class="paramname"><em>e</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const saml2md::RoleDescriptor * </td>
<td class="paramname"><em>role</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Status * </td>
<td class="paramname"><em>status</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>rethrow</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Attaches metadata-derived information as exception properties and optionally rethrows the object. </p>
<p>The following named properties are attached, when possible:</p>
<dl>
<dt>entityID </dt>
<dd>The unique ID of the entity </dd>
<dt>errorURL </dt>
<dd>The error support URL of the role </dd>
<dt>contactName </dt>
<dd>A formatted support or technical contact name </dd>
<dt>contactEmail </dt>
<dd>A contact email address </dd>
<dt>statusCode </dt>
<dd>Top-level status code from <a class="el" href="a00067.html" title="Base class for SAML status codes. ">Status</a> object </dd>
<dt>statusCode2 </dt>
<dd>Second-level status code from <a class="el" href="a00067.html" title="Base class for SAML status codes. ">Status</a> object </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">e</td><td>pointer to exception object </td></tr>
<tr><td class="paramname">entity</td><td>pointer to role </td></tr>
<tr><td class="paramname">status</td><td>pointer to <a class="el" href="a00067.html" title="Base class for SAML status codes. ">Status</a> from message </td></tr>
<tr><td class="paramname">rethrow</td><td>true iff the exception should be rethrown </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</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="a00119.html">opensaml</a></li>
<li class="footer">Generated on Sat Oct 19 2013 08:32:21 for opensaml-2.5.2 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>
