<!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::MessageDecoder::ArtifactResolver 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('a00004.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="a00136.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">opensaml::MessageDecoder::ArtifactResolver Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Interface to caller-supplied artifact resolution mechanism.
<a href="a00004.html#details">More...</a></p>
<p><code>#include <saml/binding/MessageDecoder.h></code></p>
<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:addd14a47e5b2bf8ba08b7e09a558b9e3"><td class="memItemLeft" align="right" valign="top">virtual saml1p::Response * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00004.html#addd14a47e5b2bf8ba08b7e09a558b9e3">resolve</a> (const std::vector< <a class="el" href="a00056.html">SAMLArtifact</a> * > &artifacts, const saml2md::IDPSSODescriptor &idpDescriptor, <a class="el" href="a00060.html">SecurityPolicy</a> &policy) const =0</td></tr>
<tr class="memdesc:addd14a47e5b2bf8ba08b7e09a558b9e3"><td class="mdescLeft"> </td><td class="mdescRight">Resolves one or more SAML 1.x artifacts into a response containing a set of resolved Assertions. <a href="#addd14a47e5b2bf8ba08b7e09a558b9e3">More...</a><br/></td></tr>
<tr class="separator:addd14a47e5b2bf8ba08b7e09a558b9e3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:addf3f9b76472162df919303c98b0675a"><td class="memItemLeft" align="right" valign="top">virtual saml2p::ArtifactResponse * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00004.html#addf3f9b76472162df919303c98b0675a">resolve</a> (const <a class="el" href="a00051.html">saml2p::SAML2Artifact</a> &artifact, const saml2md::SSODescriptorType &ssoDescriptor, <a class="el" href="a00060.html">SecurityPolicy</a> &policy) const =0</td></tr>
<tr class="memdesc:addf3f9b76472162df919303c98b0675a"><td class="mdescLeft"> </td><td class="mdescRight">Resolves a SAML 2.0 artifact into the corresponding SAML protocol message. <a href="#addf3f9b76472162df919303c98b0675a">More...</a><br/></td></tr>
<tr class="separator:addf3f9b76472162df919303c98b0675a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aed0fc1d5246fd16c36a836ea79d775bd"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00004.html#aed0fc1d5246fd16c36a836ea79d775bd">isSupported</a> (const saml2md::SSODescriptorType &ssoDescriptor) const </td></tr>
<tr class="memdesc:aed0fc1d5246fd16c36a836ea79d775bd"><td class="mdescLeft"> </td><td class="mdescRight">Returns true iff the metadata provided includes a supported artifact resolution service. <a href="#aed0fc1d5246fd16c36a836ea79d775bd">More...</a><br/></td></tr>
<tr class="separator:aed0fc1d5246fd16c36a836ea79d775bd"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Interface to caller-supplied artifact resolution mechanism. </p>
<p>Resolving artifacts requires internally performing a SOAP-based call to the artifact source, usually in a mutually authenticated fashion. The potential options vary widely, so the work is encapsulated by this interface, though of course other library facilities may be used.</p>
<p>A <a class="el" href="a00034.html" title="Interface to SAML protocol binding message decoders. ">MessageDecoder</a> implementation will invoke the supplied interface when it requires an artifact be resolved. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aed0fc1d5246fd16c36a836ea79d775bd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool opensaml::MessageDecoder::ArtifactResolver::isSupported </td>
<td>(</td>
<td class="paramtype">const saml2md::SSODescriptorType & </td>
<td class="paramname"><em>ssoDescriptor</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>Returns true iff the metadata provided includes a supported artifact resolution service. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ssoDescriptor</td><td>reference to SSO role of artifact issuer (may be SP or IdP) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true iff the artifact issuer offers endpoints supported by this resolver </dd></dl>
</div>
</div>
<a class="anchor" id="addd14a47e5b2bf8ba08b7e09a558b9e3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual saml1p::Response* opensaml::MessageDecoder::ArtifactResolver::resolve </td>
<td>(</td>
<td class="paramtype">const std::vector< <a class="el" href="a00056.html">SAMLArtifact</a> * > & </td>
<td class="paramname"><em>artifacts</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const saml2md::IDPSSODescriptor & </td>
<td class="paramname"><em>idpDescriptor</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Resolves one or more SAML 1.x artifacts into a response containing a set of resolved Assertions. </p>
<p>The caller is responsible for the resulting Response. The supplied <a class="el" href="a00060.html" title="A policy used to verify the security of an incoming message. ">SecurityPolicy</a> is used to access caller-supplied infrastructure and to pass back the result of authenticating the resolution process.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">artifacts</td><td>one or more SAML 1.x artifacts </td></tr>
<tr><td class="paramname">idpDescriptor</td><td>reference to IdP role of artifact issuer </td></tr>
<tr><td class="paramname">policy</td><td>reference to policy containing rules, MetadataProvider, TrustEngine, etc. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the corresponding SAML Assertions wrapped in a Response. </dd></dl>
</div>
</div>
<a class="anchor" id="addf3f9b76472162df919303c98b0675a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual saml2p::ArtifactResponse* opensaml::MessageDecoder::ArtifactResolver::resolve </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00051.html">saml2p::SAML2Artifact</a> & </td>
<td class="paramname"><em>artifact</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const saml2md::SSODescriptorType & </td>
<td class="paramname"><em>ssoDescriptor</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Resolves a SAML 2.0 artifact into the corresponding SAML protocol message. </p>
<p>The caller is responsible for the resulting ArtifactResponse message. The supplied <a class="el" href="a00060.html" title="A policy used to verify the security of an incoming message. ">SecurityPolicy</a> is used to access caller-supplied infrastructure and to pass back the result of authenticating the resolution process.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">artifact</td><td>reference to a SAML 2.0 artifact </td></tr>
<tr><td class="paramname">ssoDescriptor</td><td>reference to SSO role of artifact issuer (may be SP or IdP) </td></tr>
<tr><td class="paramname">policy</td><td>reference to policy containing rules, MetadataProvider, TrustEngine, etc. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the corresponding SAML protocol message or nullptr </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>saml/binding/<a class="el" href="a00072.html">MessageDecoder.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="a00034.html">MessageDecoder</a></li><li class="navelem"><a class="el" href="a00004.html">ArtifactResolver</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>
