<!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::SOAPClient 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('a00064.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="a00143.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">opensaml::SOAPClient Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>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></p>
<p><code>#include <saml/binding/SOAPClient.h></code></p>
<div class="dynheader">
Inheritance diagram for opensaml::SOAPClient:</div>
<div class="dyncontent">
<div class="center">
<img src="a00064.png" usemap="#opensaml::SOAPClient_map" alt=""/>
<map id="opensaml::SOAPClient_map" name="opensaml::SOAPClient_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:a4c31709f0fbd09124d9f0400761b7e30"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00064.html#a4c31709f0fbd09124d9f0400761b7e30">SOAPClient</a> (<a class="el" href="a00060.html">SecurityPolicy</a> &policy)</td></tr>
<tr class="memdesc:a4c31709f0fbd09124d9f0400761b7e30"><td class="mdescLeft"> </td><td class="mdescRight">Creates a SOAP client instance with a particular <a class="el" href="a00060.html" title="A policy used to verify the security of an incoming message. ">SecurityPolicy</a>. <a href="#a4c31709f0fbd09124d9f0400761b7e30">More...</a><br/></td></tr>
<tr class="separator:a4c31709f0fbd09124d9f0400761b7e30"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae72e29cd020509bdea467ddc3af4318a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00064.html#ae72e29cd020509bdea467ddc3af4318a">forceTransportAuthentication</a> (bool force=true)</td></tr>
<tr class="memdesc:ae72e29cd020509bdea467ddc3af4318a"><td class="mdescLeft"> </td><td class="mdescRight">Controls whether to force transport/peer authentication via an X509TrustEngine. <a href="#ae72e29cd020509bdea467ddc3af4318a">More...</a><br/></td></tr>
<tr class="separator:ae72e29cd020509bdea467ddc3af4318a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a40499a3d0bfed471c52f912a6feed3e1"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00064.html#a40499a3d0bfed471c52f912a6feed3e1">send</a> (const soap11::Envelope &env, const char *from, <a class="el" href="a00037.html">saml2md::MetadataCredentialCriteria</a> &to, const char *endpoint)</td></tr>
<tr class="memdesc:a40499a3d0bfed471c52f912a6feed3e1"><td class="mdescLeft"> </td><td class="mdescRight">SAML-specific method uses metadata to determine the peer name and prepare the transport layer with peer credential information. <a href="#a40499a3d0bfed471c52f912a6feed3e1">More...</a><br/></td></tr>
<tr class="separator:a40499a3d0bfed471c52f912a6feed3e1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a05126984c94b7bb8510942895ff1da26"><td class="memItemLeft" align="right" valign="top">soap11::Envelope * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00064.html#a05126984c94b7bb8510942895ff1da26">receive</a> ()</td></tr>
<tr class="memdesc:a05126984c94b7bb8510942895ff1da26"><td class="mdescLeft"> </td><td class="mdescRight">Override applies <a class="el" href="a00060.html" title="A policy used to verify the security of an incoming message. ">SecurityPolicy</a> to envelope before returning it. <a href="#a05126984c94b7bb8510942895ff1da26">More...</a><br/></td></tr>
<tr class="separator:a05126984c94b7bb8510942895ff1da26"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a4518de4d26b93d5cc3a6119c0de4bc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0a4518de4d26b93d5cc3a6119c0de4bc"></a>
void </td><td class="memItemRight" valign="bottom"><b>reset</b> ()</td></tr>
<tr class="separator:a0a4518de4d26b93d5cc3a6119c0de4bc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a433d4ff5af3c0ecc2d49f9d2474575c7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00060.html">SecurityPolicy</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00064.html#a433d4ff5af3c0ecc2d49f9d2474575c7">getPolicy</a> () const </td></tr>
<tr class="memdesc:a433d4ff5af3c0ecc2d49f9d2474575c7"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <a class="el" href="a00060.html" title="A policy used to verify the security of an incoming message. ">SecurityPolicy</a> supplied to the client. <a href="#a433d4ff5af3c0ecc2d49f9d2474575c7">More...</a><br/></td></tr>
<tr class="separator:a433d4ff5af3c0ecc2d49f9d2474575c7"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a70e867769247cc9805278009d003c29d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00064.html#a70e867769247cc9805278009d003c29d">prepareTransport</a> (xmltooling::SOAPTransport &transport)</td></tr>
<tr class="memdesc:a70e867769247cc9805278009d003c29d"><td class="mdescLeft"> </td><td class="mdescRight">Override prepares transport by assigning an X509TrustEngine to it, if one is attached to the policy. <a href="#a70e867769247cc9805278009d003c29d">More...</a><br/></td></tr>
<tr class="separator:a70e867769247cc9805278009d003c29d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ae487a9fa12af76c677afad32a5942bb8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00060.html">SecurityPolicy</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00064.html#ae487a9fa12af76c677afad32a5942bb8">m_policy</a></td></tr>
<tr class="memdesc:ae487a9fa12af76c677afad32a5942bb8"><td class="mdescLeft"> </td><td class="mdescRight">Reference to security policy to apply. <a href="#ae487a9fa12af76c677afad32a5942bb8">More...</a><br/></td></tr>
<tr class="separator:ae487a9fa12af76c677afad32a5942bb8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a69fbed9fbe371c7e586739e64715cbab"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00064.html#a69fbed9fbe371c7e586739e64715cbab">m_force</a></td></tr>
<tr class="memdesc:a69fbed9fbe371c7e586739e64715cbab"><td class="mdescLeft"> </td><td class="mdescRight">Flag controlling whether transport/peer authn is mandatory. <a href="#a69fbed9fbe371c7e586739e64715cbab">More...</a><br/></td></tr>
<tr class="separator:a69fbed9fbe371c7e586739e64715cbab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0f49661b76b2b0c2ea538bad3d11ad0b"><td class="memItemLeft" align="right" valign="top">const saml2md::RoleDescriptor * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00064.html#a0f49661b76b2b0c2ea538bad3d11ad0b">m_peer</a></td></tr>
<tr class="memdesc:a0f49661b76b2b0c2ea538bad3d11ad0b"><td class="mdescLeft"> </td><td class="mdescRight">Metadata-based peer identity. <a href="#a0f49661b76b2b0c2ea538bad3d11ad0b">More...</a><br/></td></tr>
<tr class="separator:a0f49661b76b2b0c2ea538bad3d11ad0b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af8e2f5f90f8306b60dcc64892fb27a89"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00037.html">saml2md::MetadataCredentialCriteria</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00064.html#af8e2f5f90f8306b60dcc64892fb27a89">m_criteria</a></td></tr>
<tr class="memdesc:af8e2f5f90f8306b60dcc64892fb27a89"><td class="mdescLeft"> </td><td class="mdescRight">Metadata-based CredentialCriteria for supplying credentials to TrustEngine. <a href="#af8e2f5f90f8306b60dcc64892fb27a89">More...</a><br/></td></tr>
<tr class="separator:af8e2f5f90f8306b60dcc64892fb27a89"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Specialized <a class="el" href="a00064.html" title="Specialized SOAPClient for SAML SOAP bindings. ">SOAPClient</a> for SAML SOAP bindings. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a4c31709f0fbd09124d9f0400761b7e30"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">opensaml::SOAPClient::SOAPClient </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00060.html">SecurityPolicy</a> & </td>
<td class="paramname"><em>policy</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a SOAP client instance with a particular <a class="el" href="a00060.html" title="A policy used to verify the security of an incoming message. ">SecurityPolicy</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">policy</td><td>reference to <a class="el" href="a00060.html" title="A policy used to verify the security of an incoming message. ">SecurityPolicy</a> to apply </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ae72e29cd020509bdea467ddc3af4318a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void opensaml::SOAPClient::forceTransportAuthentication </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>force</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Controls whether to force transport/peer authentication via an X509TrustEngine. </p>
<p>Only makes sense if an X509TrustEngine is supplied by the <a class="el" href="a00060.html" title="A policy used to verify the security of an incoming message. ">SecurityPolicy</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">force</td><td>true iff the client should refuse to communicate without this protection </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a433d4ff5af3c0ecc2d49f9d2474575c7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00060.html">SecurityPolicy</a>& opensaml::SOAPClient::getPolicy </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the <a class="el" href="a00060.html" title="A policy used to verify the security of an incoming message. ">SecurityPolicy</a> supplied to the client. </p>
<dl class="section return"><dt>Returns</dt><dd>the associated <a class="el" href="a00060.html" title="A policy used to verify the security of an incoming message. ">SecurityPolicy</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a70e867769247cc9805278009d003c29d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void opensaml::SOAPClient::prepareTransport </td>
<td>(</td>
<td class="paramtype">xmltooling::SOAPTransport & </td>
<td class="paramname"><em>transport</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Override prepares transport by assigning an X509TrustEngine to it, if one is attached to the policy. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">transport</td><td>reference to transport layer </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a05126984c94b7bb8510942895ff1da26"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">soap11::Envelope* opensaml::SOAPClient::receive </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Override applies <a class="el" href="a00060.html" title="A policy used to verify the security of an incoming message. ">SecurityPolicy</a> to envelope before returning it. </p>
<dl class="section return"><dt>Returns</dt><dd>response envelope after <a class="el" href="a00060.html" title="A policy used to verify the security of an incoming message. ">SecurityPolicy</a> has been applied </dd></dl>
</div>
</div>
<a class="anchor" id="a40499a3d0bfed471c52f912a6feed3e1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void opensaml::SOAPClient::send </td>
<td>(</td>
<td class="paramtype">const soap11::Envelope & </td>
<td class="paramname"><em>env</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>from</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00037.html">saml2md::MetadataCredentialCriteria</a> & </td>
<td class="paramname"><em>to</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>endpoint</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></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>SAML-specific method uses metadata to determine the peer name and prepare the transport layer with peer credential information. </p>
<p>The <a class="el" href="a00060.html" title="A policy used to verify the security of an incoming message. ">SecurityPolicy</a> is also reset, in case the policy is reused.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">env</td><td>SOAP envelope to send </td></tr>
<tr><td class="paramname">from</td><td>identity of sending application </td></tr>
<tr><td class="paramname">to</td><td>peer to send message to, expressed in metadata criteria terms </td></tr>
<tr><td class="paramname">endpoint</td><td>URL of endpoint to recieve message </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="af8e2f5f90f8306b60dcc64892fb27a89"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00037.html">saml2md::MetadataCredentialCriteria</a>* opensaml::SOAPClient::m_criteria</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Metadata-based CredentialCriteria for supplying credentials to TrustEngine. </p>
</div>
</div>
<a class="anchor" id="a69fbed9fbe371c7e586739e64715cbab"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool opensaml::SOAPClient::m_force</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Flag controlling whether transport/peer authn is mandatory. </p>
</div>
</div>
<a class="anchor" id="a0f49661b76b2b0c2ea538bad3d11ad0b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const saml2md::RoleDescriptor* opensaml::SOAPClient::m_peer</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Metadata-based peer identity. </p>
</div>
</div>
<a class="anchor" id="ae487a9fa12af76c677afad32a5942bb8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00060.html">SecurityPolicy</a>& opensaml::SOAPClient::m_policy</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reference to security policy to apply. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>saml/binding/<a class="el" href="a00077.html">SOAPClient.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="a00064.html">SOAPClient</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>
