<!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::saml1p::SAML1SOAPClient 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('a00050.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="a00158.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">opensaml::saml1p::SAML1SOAPClient Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Client class for SAML 1.x SOAP binding.
<a href="a00050.html#details">More...</a></p>
<p><code>#include <saml/saml1/binding/SAML1SOAPClient.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:a7d7dd057a12193013af7162b8a466225"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#a7d7dd057a12193013af7162b8a466225">SAML1SOAPClient</a> (<a class="el" href="a00064.html">SOAPClient</a> &soaper, bool fatalSAMLErrors=true)</td></tr>
<tr class="memdesc:a7d7dd057a12193013af7162b8a466225"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a7d7dd057a12193013af7162b8a466225">More...</a><br/></td></tr>
<tr class="separator:a7d7dd057a12193013af7162b8a466225"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aceb1e4bf41bf2993de13e49da46978fc"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#aceb1e4bf41bf2993de13e49da46978fc">sendSAML</a> (Request *request, const char *from, <a class="el" href="a00037.html">saml2md::MetadataCredentialCriteria</a> &to, const char *endpoint)</td></tr>
<tr class="memdesc:aceb1e4bf41bf2993de13e49da46978fc"><td class="mdescLeft"> </td><td class="mdescRight">Specialized method for sending SAML 1.x requests. <a href="#aceb1e4bf41bf2993de13e49da46978fc">More...</a><br/></td></tr>
<tr class="separator:aceb1e4bf41bf2993de13e49da46978fc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae6373e0be58babb26ad4a6298669d603"><td class="memItemLeft" align="right" valign="top">virtual Response * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#ae6373e0be58babb26ad4a6298669d603">receiveSAML</a> ()</td></tr>
<tr class="memdesc:ae6373e0be58babb26ad4a6298669d603"><td class="mdescLeft"> </td><td class="mdescRight">Specialized method for receiving SAML 1.x responses. <a href="#ae6373e0be58babb26ad4a6298669d603">More...</a><br/></td></tr>
<tr class="separator:ae6373e0be58babb26ad4a6298669d603"><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:acc90d3f7bed71a379c8cd0119ae7a46e"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#acc90d3f7bed71a379c8cd0119ae7a46e">handleError</a> (const <a class="el" href="a00067.html">Status</a> &status)</td></tr>
<tr class="memdesc:acc90d3f7bed71a379c8cd0119ae7a46e"><td class="mdescLeft"> </td><td class="mdescRight">Handling of SAML errors. <a href="#acc90d3f7bed71a379c8cd0119ae7a46e">More...</a><br/></td></tr>
<tr class="separator:acc90d3f7bed71a379c8cd0119ae7a46e"><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:aa1d5769ba9ea695338d0d019f1e2f683"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00064.html">SOAPClient</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#aa1d5769ba9ea695338d0d019f1e2f683">m_soaper</a></td></tr>
<tr class="memdesc:aa1d5769ba9ea695338d0d019f1e2f683"><td class="mdescLeft"> </td><td class="mdescRight">SOAP client object. <a href="#aa1d5769ba9ea695338d0d019f1e2f683">More...</a><br/></td></tr>
<tr class="separator:aa1d5769ba9ea695338d0d019f1e2f683"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8bdefafc5b4f2274a3dfc6bc349178b2"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#a8bdefafc5b4f2274a3dfc6bc349178b2">m_fatal</a></td></tr>
<tr class="memdesc:a8bdefafc5b4f2274a3dfc6bc349178b2"><td class="mdescLeft"> </td><td class="mdescRight">Flag controlling default error handler. <a href="#a8bdefafc5b4f2274a3dfc6bc349178b2">More...</a><br/></td></tr>
<tr class="separator:a8bdefafc5b4f2274a3dfc6bc349178b2"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Client class for SAML 1.x SOAP binding. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a7d7dd057a12193013af7162b8a466225"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">opensaml::saml1p::SAML1SOAPClient::SAML1SOAPClient </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00064.html">SOAPClient</a> & </td>
<td class="paramname"><em>soaper</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>fatalSAMLErrors</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">soaper</td><td>reference to <a class="el" href="a00064.html" title="Specialized SOAPClient for SAML SOAP bindings. ">SOAPClient</a> object to use for call </td></tr>
<tr><td class="paramname">fatalSAMLErrors</td><td>true iff a non-successful SAML <a class="el" href="a00067.html" title="Base class for SAML status codes. ">Status</a> code should be fatal </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="acc90d3f7bed71a379c8cd0119ae7a46e"></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::saml1p::SAML1SOAPClient::handleError </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00067.html">Status</a> & </td>
<td class="paramname"><em>status</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Handling of SAML errors. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>SAML <a class="el" href="a00067.html" title="Base class for SAML status codes. ">Status</a> received by client </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true iff the error should be treated as a fatal error </dd></dl>
</div>
</div>
<a class="anchor" id="ae6373e0be58babb26ad4a6298669d603"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual Response* opensaml::saml1p::SAML1SOAPClient::receiveSAML </td>
<td>(</td>
<td class="paramname"></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>Specialized method for receiving SAML 1.x responses. </p>
<p>The SOAP layer will be evaluated automatically, and the attached policy will be applied to the Response.</p>
<p>The caller is responsible for freeing the Response.</p>
<dl class="section return"><dt>Returns</dt><dd>SAML 1.x Response, 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="aceb1e4bf41bf2993de13e49da46978fc"></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::saml1p::SAML1SOAPClient::sendSAML </td>
<td>(</td>
<td class="paramtype">Request * </td>
<td class="paramname"><em>request</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>Specialized method for sending SAML 1.x requests. </p>
<p>The SOAP layer will be constructed automatically.</p>
<p>The request will be freed by the client object regardless of the outcome.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">request</td><td>SAML request 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="a8bdefafc5b4f2274a3dfc6bc349178b2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool opensaml::saml1p::SAML1SOAPClient::m_fatal</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 default error handler. </p>
</div>
</div>
<a class="anchor" id="aa1d5769ba9ea695338d0d019f1e2f683"></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="a00064.html">SOAPClient</a>& opensaml::saml1p::SAML1SOAPClient::m_soaper</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>SOAP client object. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>saml/saml1/binding/<a class="el" href="a00084.html">SAML1SOAPClient.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="a00121.html">saml1p</a></li><li class="navelem"><a class="el" href="a00050.html">SAML1SOAPClient</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>
