<!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::saml2p::SAML2MessageDecoder 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">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><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('a00054.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="a00200.html">List of all members</a> </div> <div class="headertitle"> <div class="title">opensaml::saml2p::SAML2MessageDecoder Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>Base class for SAML 2.0 MessageDecoders. <a href="a00054.html#details">More...</a></p> <p><code>#include <saml/saml2/binding/SAML2MessageDecoder.h></code></p> <div class="dynheader"> Inheritance diagram for opensaml::saml2p::SAML2MessageDecoder:</div> <div class="dyncontent"> <div class="center"> <img src="a00054.png" usemap="#opensaml::saml2p::SAML2MessageDecoder_map" alt=""/> <map id="opensaml::saml2p::SAML2MessageDecoder_map" name="opensaml::saml2p::SAML2MessageDecoder_map"> <area href="a00034.html" title="Interface to SAML protocol binding message decoders. " alt="opensaml::MessageDecoder" shape="rect" coords="0,0,258,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:a619447b196f19bc8f9c875c5da820010"><td class="memItemLeft" align="right" valign="top">const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#a619447b196f19bc8f9c875c5da820010">getProtocolFamily</a> () const </td></tr> <tr class="memdesc:a619447b196f19bc8f9c875c5da820010"><td class="mdescLeft"> </td><td class="mdescRight">Returns identifier for the protocol family associated with the decoder. <a href="#a619447b196f19bc8f9c875c5da820010">More...</a><br/></td></tr> <tr class="separator:a619447b196f19bc8f9c875c5da820010"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a23b54e2bbbf87eee1821c33270becf9c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#a23b54e2bbbf87eee1821c33270becf9c">extractMessageDetails</a> (const xmltooling::XMLObject &message, const xmltooling::GenericRequest &genericRequest, const XMLCh *protocol, <a class="el" href="a00060.html">SecurityPolicy</a> &policy) const </td></tr> <tr class="memdesc:a23b54e2bbbf87eee1821c33270becf9c"><td class="mdescLeft"> </td><td class="mdescRight">Extracts policy-relevant message details. <a href="#a23b54e2bbbf87eee1821c33270becf9c">More...</a><br/></td></tr> <tr class="separator:a23b54e2bbbf87eee1821c33270becf9c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_a00034"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_a00034')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="a00034.html">opensaml::MessageDecoder</a></td></tr> <tr class="memitem:aa75e9d68c932b63000141bc32bdef933 inherit pub_methods_a00034"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00034.html#aa75e9d68c932b63000141bc32bdef933">isUserAgentPresent</a> () const </td></tr> <tr class="memdesc:aa75e9d68c932b63000141bc32bdef933 inherit pub_methods_a00034"><td class="mdescLeft"> </td><td class="mdescRight">Indicates whether a web browser or similar user agent delivered the message. <a href="#aa75e9d68c932b63000141bc32bdef933">More...</a><br/></td></tr> <tr class="separator:aa75e9d68c932b63000141bc32bdef933 inherit pub_methods_a00034"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad19f38c369a5136353f1e6bfc7d871b2 inherit pub_methods_a00034"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00034.html#ad19f38c369a5136353f1e6bfc7d871b2">setArtifactResolver</a> (const <a class="el" href="a00004.html">ArtifactResolver</a> *artifactResolver)</td></tr> <tr class="memdesc:ad19f38c369a5136353f1e6bfc7d871b2 inherit pub_methods_a00034"><td class="mdescLeft"> </td><td class="mdescRight">Provides an <a class="el" href="a00004.html" title="Interface to caller-supplied artifact resolution mechanism. ">ArtifactResolver</a> implementation for the <a class="el" href="a00034.html" title="Interface to SAML protocol binding message decoders. ">MessageDecoder</a> to use. <a href="#ad19f38c369a5136353f1e6bfc7d871b2">More...</a><br/></td></tr> <tr class="separator:ad19f38c369a5136353f1e6bfc7d871b2 inherit pub_methods_a00034"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad5b79ebdfe4cb53795d873309b75cfd5 inherit pub_methods_a00034"><td class="memItemLeft" align="right" valign="top">virtual xmltooling::XMLObject * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00034.html#ad5b79ebdfe4cb53795d873309b75cfd5">decode</a> (std::string &relayState, const xmltooling::GenericRequest &genericRequest, <a class="el" href="a00060.html">SecurityPolicy</a> &policy) const =0</td></tr> <tr class="memdesc:ad5b79ebdfe4cb53795d873309b75cfd5 inherit pub_methods_a00034"><td class="mdescLeft"> </td><td class="mdescRight">Decodes a transport request into a SAML protocol message, and evaluates it against a supplied <a class="el" href="a00060.html" title="A policy used to verify the security of an incoming message. ">SecurityPolicy</a>. <a href="#ad5b79ebdfe4cb53795d873309b75cfd5">More...</a><br/></td></tr> <tr class="separator:ad5b79ebdfe4cb53795d873309b75cfd5 inherit pub_methods_a00034"><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_attribs_a00034"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_a00034')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="a00034.html">opensaml::MessageDecoder</a></td></tr> <tr class="memitem:a5a18221e5861a5eba1d6f24d49cd7e08 inherit pro_attribs_a00034"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="a00004.html">ArtifactResolver</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00034.html#a5a18221e5861a5eba1d6f24d49cd7e08">m_artifactResolver</a></td></tr> <tr class="memdesc:a5a18221e5861a5eba1d6f24d49cd7e08 inherit pro_attribs_a00034"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to an <a class="el" href="a00004.html" title="Interface to caller-supplied artifact resolution mechanism. ">ArtifactResolver</a> implementation. <a href="#a5a18221e5861a5eba1d6f24d49cd7e08">More...</a><br/></td></tr> <tr class="separator:a5a18221e5861a5eba1d6f24d49cd7e08 inherit pro_attribs_a00034"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Base class for SAML 2.0 MessageDecoders. </p> </div><h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a23b54e2bbbf87eee1821c33270becf9c"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void opensaml::saml2p::SAML2MessageDecoder::extractMessageDetails </td> <td>(</td> <td class="paramtype">const xmltooling::XMLObject & </td> <td class="paramname"><em>message</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 XMLCh * </td> <td class="paramname"><em>protocol</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="a00060.html">SecurityPolicy</a> & </td> <td class="paramname"><em>policy</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 policy-relevant message details. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">message</td><td>the incoming message </td></tr> <tr><td class="paramname">request</td><td>the protocol request </td></tr> <tr><td class="paramname">protocol</td><td>the protocol family in use </td></tr> <tr><td class="paramname">policy</td><td><a class="el" href="a00060.html" title="A policy used to verify the security of an incoming message. ">SecurityPolicy</a> to provide various components and track message data </td></tr> </table> </dd> </dl> <p>Implements <a class="el" href="a00034.html#a18fcf45467ec0ea2f104c6a12d3f4c2b">opensaml::MessageDecoder</a>.</p> </div> </div> <a class="anchor" id="a619447b196f19bc8f9c875c5da820010"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const XMLCh* opensaml::saml2p::SAML2MessageDecoder::getProtocolFamily </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 identifier for the protocol family associated with the decoder. </p> <dl class="section return"><dt>Returns</dt><dd>a protocol family identifier, or nullptr </dd></dl> <p>Reimplemented from <a class="el" href="a00034.html#ada340797dbd23c09ad7b667a79df2bf9">opensaml::MessageDecoder</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>saml/saml2/binding/<a class="el" href="a00097.html">SAML2MessageDecoder.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="a00119.html">opensaml</a></li><li class="navelem"><a class="el" href="a00124.html">saml2p</a></li><li class="navelem"><a class="el" href="a00054.html">SAML2MessageDecoder</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>