<!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.8"/> <title>xmltooling: xmltooling::OpenSSLSOAPTransport 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">xmltooling  <span id="projectnumber">1.5.3</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.8 --> <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('a00059.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-types">Public Types</a> | <a href="#pub-methods">Public Member Functions</a> | <a href="a00272.html">List of all members</a> </div> <div class="headertitle"> <div class="title">xmltooling::OpenSSLSOAPTransport Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> </div><!--header--> <div class="contents"> <p>Encapsulates OpenSSL-capable SOAP transport layer. <a href="a00059.html#details">More...</a></p> <p><code>#include <xmltooling/soap/OpenSSLSOAPTransport.h></code></p> <div class="dynheader"> Inheritance diagram for xmltooling::OpenSSLSOAPTransport:</div> <div class="dyncontent"> <div class="center"> <img src="a00059.png" usemap="#xmltooling::OpenSSLSOAPTransport_map" alt=""/> <map id="xmltooling::OpenSSLSOAPTransport_map" name="xmltooling::OpenSSLSOAPTransport_map"> <area href="a00081.html" title="Encapsulates a transport layer protocol for sending/receiving messages. " alt="xmltooling::SOAPTransport" shape="rect" coords="0,0,216,24"/> </map> </div></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> Public Types</h2></td></tr> <tr class="memitem:ae8e8084305f694fc18d0f9669f064f5f"><td class="memItemLeft" align="right" valign="top">typedef bool(* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00059.html#ae8e8084305f694fc18d0f9669f064f5f">ssl_ctx_callback_fn</a> )(<a class="el" href="a00059.html">OpenSSLSOAPTransport</a> *transport, SSL_CTX *ssl_ctx, void *userptr)</td></tr> <tr class="memdesc:ae8e8084305f694fc18d0f9669f064f5f"><td class="mdescLeft"> </td><td class="mdescRight">OpenSSL context callback for manipulating credentials and validation behavior. <a href="#ae8e8084305f694fc18d0f9669f064f5f">More...</a><br /></td></tr> <tr class="separator:ae8e8084305f694fc18d0f9669f064f5f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_types_a00081"><td colspan="2" onclick="javascript:toggleInherit('pub_types_a00081')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="a00081.html">xmltooling::SOAPTransport</a></td></tr> <tr class="memitem:aafd763f15fbe6818acd53b256e698b7a inherit pub_types_a00081"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aafd763f15fbe6818acd53b256e698b7a"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00081.html#aafd763f15fbe6818acd53b256e698b7a">transport_auth_t</a> { <br />   <b>transport_auth_none</b> = 0, <b>transport_auth_basic</b> = 1, <b>transport_auth_digest</b> = 2, <b>transport_auth_ntlm</b> = 3, <br />   <b>transport_auth_gss</b> = 4 <br /> }</td></tr> <tr class="memdesc:aafd763f15fbe6818acd53b256e698b7a"><td class="mdescLeft"> </td><td class="mdescRight">Common types of transport authentication that may be supported. <br /></td></tr> <tr class="separator:aafd763f15fbe6818acd53b256e698b7a inherit pub_types_a00081"><td class="memSeparator" colspan="2"> </td></tr> </table><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:a6846474a9e05915896be66e2bb2b575b"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00059.html#a6846474a9e05915896be66e2bb2b575b">setSSLCallback</a> (<a class="el" href="a00059.html#ae8e8084305f694fc18d0f9669f064f5f">ssl_ctx_callback_fn</a> fn, void *userptr=0)=0</td></tr> <tr class="memdesc:a6846474a9e05915896be66e2bb2b575b"><td class="mdescLeft"> </td><td class="mdescRight">Sets a callback function to invoke against the SSL_CTX before the handshake. <a href="#a6846474a9e05915896be66e2bb2b575b">More...</a><br /></td></tr> <tr class="separator:a6846474a9e05915896be66e2bb2b575b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a11d6e8f3749886c21e715922de37d0a0"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00059.html#a11d6e8f3749886c21e715922de37d0a0">setAuthenticated</a> (bool auth)=0</td></tr> <tr class="memdesc:a11d6e8f3749886c21e715922de37d0a0"><td class="mdescLeft"> </td><td class="mdescRight">Sets indicator that the transport peer has been authenticated. <a href="#a11d6e8f3749886c21e715922de37d0a0">More...</a><br /></td></tr> <tr class="separator:a11d6e8f3749886c21e715922de37d0a0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_a00081"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_a00081')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="a00081.html">xmltooling::SOAPTransport</a></td></tr> <tr class="memitem:a50364245d734a5e9f70124796381063b inherit pub_methods_a00081"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00081.html#a50364245d734a5e9f70124796381063b">isConfidential</a> () const =0</td></tr> <tr class="memdesc:a50364245d734a5e9f70124796381063b inherit pub_methods_a00081"><td class="mdescLeft"> </td><td class="mdescRight">Indicates whether transport provides confidentiality. <a href="#a50364245d734a5e9f70124796381063b">More...</a><br /></td></tr> <tr class="separator:a50364245d734a5e9f70124796381063b inherit pub_methods_a00081"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0628479a98a0dff4e24814ae4a9e7510 inherit pub_methods_a00081"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00081.html#a0628479a98a0dff4e24814ae4a9e7510">setConnectTimeout</a> (long timeout)=0</td></tr> <tr class="memdesc:a0628479a98a0dff4e24814ae4a9e7510 inherit pub_methods_a00081"><td class="mdescLeft"> </td><td class="mdescRight">Sets the connection timeout. <a href="#a0628479a98a0dff4e24814ae4a9e7510">More...</a><br /></td></tr> <tr class="separator:a0628479a98a0dff4e24814ae4a9e7510 inherit pub_methods_a00081"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5d549b64adea079d4fa7680659911c26 inherit pub_methods_a00081"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00081.html#a5d549b64adea079d4fa7680659911c26">setTimeout</a> (long timeout)=0</td></tr> <tr class="memdesc:a5d549b64adea079d4fa7680659911c26 inherit pub_methods_a00081"><td class="mdescLeft"> </td><td class="mdescRight">Sets the request timeout. <a href="#a5d549b64adea079d4fa7680659911c26">More...</a><br /></td></tr> <tr class="separator:a5d549b64adea079d4fa7680659911c26 inherit pub_methods_a00081"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab26a0df9cfc08aea87859e9bc0f74ea6 inherit pub_methods_a00081"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00081.html#ab26a0df9cfc08aea87859e9bc0f74ea6">setAuth</a> (<a class="el" href="a00081.html#aafd763f15fbe6818acd53b256e698b7a">transport_auth_t</a> authType, const char *username=0, const char *password=0)=0</td></tr> <tr class="memdesc:ab26a0df9cfc08aea87859e9bc0f74ea6 inherit pub_methods_a00081"><td class="mdescLeft"> </td><td class="mdescRight">Sets a particular form of transport authentication and credentials. <a href="#ab26a0df9cfc08aea87859e9bc0f74ea6">More...</a><br /></td></tr> <tr class="separator:ab26a0df9cfc08aea87859e9bc0f74ea6 inherit pub_methods_a00081"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a542f4f60eb15290abbadbd690d92f811 inherit pub_methods_a00081"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00081.html#a542f4f60eb15290abbadbd690d92f811">setVerifyHost</a> (bool verify)=0</td></tr> <tr class="memdesc:a542f4f60eb15290abbadbd690d92f811 inherit pub_methods_a00081"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether TLS/SSL connections include a check of the server's certificate against the expected hostname or address. <a href="#a542f4f60eb15290abbadbd690d92f811">More...</a><br /></td></tr> <tr class="separator:a542f4f60eb15290abbadbd690d92f811 inherit pub_methods_a00081"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a68711ad923de6b963d774fbf5fb4371a inherit pub_methods_a00081"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00081.html#a68711ad923de6b963d774fbf5fb4371a">setCredential</a> (const <a class="el" href="a00023.html">Credential</a> *credential=0)=0</td></tr> <tr class="memdesc:a68711ad923de6b963d774fbf5fb4371a inherit pub_methods_a00081"><td class="mdescLeft"> </td><td class="mdescRight">Supplies transport credentials. <a href="#a68711ad923de6b963d774fbf5fb4371a">More...</a><br /></td></tr> <tr class="separator:a68711ad923de6b963d774fbf5fb4371a inherit pub_methods_a00081"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae70e40ca16f01cb1dcdf7b7c7a93365f inherit pub_methods_a00081"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00081.html#ae70e40ca16f01cb1dcdf7b7c7a93365f">setTrustEngine</a> (const <a class="el" href="a00102.html">X509TrustEngine</a> *trustEngine=0, const <a class="el" href="a00026.html">CredentialResolver</a> *credResolver=0, <a class="el" href="a00025.html">CredentialCriteria</a> *criteria=0, bool mandatory=true)=0</td></tr> <tr class="memdesc:ae70e40ca16f01cb1dcdf7b7c7a93365f inherit pub_methods_a00081"><td class="mdescLeft"> </td><td class="mdescRight">Provides an <a class="el" href="a00102.html" title="TrustEngine interface that adds validation of X.509 credentials. ">X509TrustEngine</a> to the transport to authenticate the transport peer. <a href="#ae70e40ca16f01cb1dcdf7b7c7a93365f">More...</a><br /></td></tr> <tr class="separator:ae70e40ca16f01cb1dcdf7b7c7a93365f inherit pub_methods_a00081"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a880488488723268757d4cfe7a4d76268 inherit pub_methods_a00081"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00081.html#a880488488723268757d4cfe7a4d76268">setCacheTag</a> (std::string *cacheTag=0)</td></tr> <tr class="memdesc:a880488488723268757d4cfe7a4d76268 inherit pub_methods_a00081"><td class="mdescLeft"> </td><td class="mdescRight">Installs (or clears) a pointer to an object used for cache management of the content being accessed. <a href="#a880488488723268757d4cfe7a4d76268">More...</a><br /></td></tr> <tr class="separator:a880488488723268757d4cfe7a4d76268 inherit pub_methods_a00081"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad0217ed0f74bf739584b1223b51133ed inherit pub_methods_a00081"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00081.html#ad0217ed0f74bf739584b1223b51133ed">setProviderOption</a> (const char *provider, const char *option, const char *value)</td></tr> <tr class="memdesc:ad0217ed0f74bf739584b1223b51133ed inherit pub_methods_a00081"><td class="mdescLeft"> </td><td class="mdescRight">Sets an implementation-specific transport provider option. <a href="#ad0217ed0f74bf739584b1223b51133ed">More...</a><br /></td></tr> <tr class="separator:ad0217ed0f74bf739584b1223b51133ed inherit pub_methods_a00081"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a36adf241ea8040a6b834b8010acc27ea inherit pub_methods_a00081"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00081.html#a36adf241ea8040a6b834b8010acc27ea">send</a> (std::istream &in)=0</td></tr> <tr class="memdesc:a36adf241ea8040a6b834b8010acc27ea inherit pub_methods_a00081"><td class="mdescLeft"> </td><td class="mdescRight">Sends a stream of data over the transport. <a href="#a36adf241ea8040a6b834b8010acc27ea">More...</a><br /></td></tr> <tr class="separator:a36adf241ea8040a6b834b8010acc27ea inherit pub_methods_a00081"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1f4b613cce2a00172efa1c7324a46c16 inherit pub_methods_a00081"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00081.html#a1f4b613cce2a00172efa1c7324a46c16">send</a> (std::istream *in=0)</td></tr> <tr class="memdesc:a1f4b613cce2a00172efa1c7324a46c16 inherit pub_methods_a00081"><td class="mdescLeft"> </td><td class="mdescRight">Sends an optional stream of data over the transport. <a href="#a1f4b613cce2a00172efa1c7324a46c16">More...</a><br /></td></tr> <tr class="separator:a1f4b613cce2a00172efa1c7324a46c16 inherit pub_methods_a00081"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af735cce6c57f3b9bdb8374501d5a2cba inherit pub_methods_a00081"><td class="memItemLeft" align="right" valign="top">virtual std::istream & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00081.html#af735cce6c57f3b9bdb8374501d5a2cba">receive</a> ()=0</td></tr> <tr class="memdesc:af735cce6c57f3b9bdb8374501d5a2cba inherit pub_methods_a00081"><td class="mdescLeft"> </td><td class="mdescRight">Returns reference to response stream. <a href="#af735cce6c57f3b9bdb8374501d5a2cba">More...</a><br /></td></tr> <tr class="separator:af735cce6c57f3b9bdb8374501d5a2cba inherit pub_methods_a00081"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a80b9f0de753cf8c321156aa46addd81b inherit pub_methods_a00081"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00081.html#a80b9f0de753cf8c321156aa46addd81b">isAuthenticated</a> () const =0</td></tr> <tr class="memdesc:a80b9f0de753cf8c321156aa46addd81b inherit pub_methods_a00081"><td class="mdescLeft"> </td><td class="mdescRight">Returns result of authenticating transport peer. <a href="#a80b9f0de753cf8c321156aa46addd81b">More...</a><br /></td></tr> <tr class="separator:a80b9f0de753cf8c321156aa46addd81b inherit pub_methods_a00081"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a14ee8fbe6422039b538caabc3c1f9659 inherit pub_methods_a00081"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00081.html#a14ee8fbe6422039b538caabc3c1f9659">getContentType</a> () const =0</td></tr> <tr class="memdesc:a14ee8fbe6422039b538caabc3c1f9659 inherit pub_methods_a00081"><td class="mdescLeft"> </td><td class="mdescRight">Returns the MIME type of the response, if any. <a href="#a14ee8fbe6422039b538caabc3c1f9659">More...</a><br /></td></tr> <tr class="separator:a14ee8fbe6422039b538caabc3c1f9659 inherit pub_methods_a00081"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a85cedb62cc353124415d28437b5ec498 inherit pub_methods_a00081"><td class="memItemLeft" align="right" valign="top">virtual long </td><td class="memItemRight" valign="bottom"><a class="el" href="a00081.html#a85cedb62cc353124415d28437b5ec498">getStatusCode</a> () const </td></tr> <tr class="memdesc:a85cedb62cc353124415d28437b5ec498 inherit pub_methods_a00081"><td class="mdescLeft"> </td><td class="mdescRight">Returns the status code of the response. <a href="#a85cedb62cc353124415d28437b5ec498">More...</a><br /></td></tr> <tr class="separator:a85cedb62cc353124415d28437b5ec498 inherit pub_methods_a00081"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Encapsulates OpenSSL-capable SOAP transport layer. </p> </div><h2 class="groupheader">Member Typedef Documentation</h2> <a class="anchor" id="ae8e8084305f694fc18d0f9669f064f5f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef bool(* xmltooling::OpenSSLSOAPTransport::ssl_ctx_callback_fn)(<a class="el" href="a00059.html">OpenSSLSOAPTransport</a> *transport, SSL_CTX *ssl_ctx, void *userptr)</td> </tr> </table> </div><div class="memdoc"> <p>OpenSSL context callback for manipulating credentials and validation behavior. </p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a11d6e8f3749886c21e715922de37d0a0"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void xmltooling::OpenSSLSOAPTransport::setAuthenticated </td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"><em>auth</em></td><td>)</td> <td></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>Sets indicator that the transport peer has been authenticated. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">auth</td><td>flag to set </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a6846474a9e05915896be66e2bb2b575b"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual bool xmltooling::OpenSSLSOAPTransport::setSSLCallback </td> <td>(</td> <td class="paramtype"><a class="el" href="a00059.html#ae8e8084305f694fc18d0f9669f064f5f">ssl_ctx_callback_fn</a> </td> <td class="paramname"><em>fn</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">void * </td> <td class="paramname"><em>userptr</em> = <code>0</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></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>Sets a callback function to invoke against the SSL_CTX before the handshake. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">fn</td><td>callback function </td></tr> <tr><td class="paramname">userptr</td><td>a caller-supplied value to pass to the callback function </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>true iff the callback was set </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>xmltooling/soap/<a class="el" href="a00175.html">OpenSSLSOAPTransport.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="a00206.html">xmltooling</a></li><li class="navelem"><a class="el" href="a00059.html">OpenSSLSOAPTransport</a></li> <li class="footer">Generated on Fri Oct 17 2014 12:44:58 for xmltooling by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.8 </li> </ul> </div> </body> </html>