blob: e217980fa8466fbfeb46dbaeb41f2cf7f228a2a1 [file] [log] [blame]
<!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"/>
<title>activemq-cpp-3.4.0: decaf::internal::net::ssl::openssl::OpenSSLContextSpi Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">activemq-cpp-3.4.0</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data&#160;Structures</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>Data&#160;Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_context_spi.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<h1>decaf::internal::net::ssl::openssl::OpenSSLContextSpi Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="decaf::internal::net::ssl::openssl::OpenSSLContextSpi" --><!-- doxytag: inherits="decaf::net::ssl::SSLContextSpi" -->
<p>Provides an SSLContext that wraps the OpenSSL API.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_open_s_s_l_context_spi_8h_source.html">src/main/decaf/internal/net/ssl/openssl/OpenSSLContextSpi.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for decaf::internal::net::ssl::openssl::OpenSSLContextSpi:</div>
<div class="dyncontent">
<div class="center"><img src="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_context_spi__inherit__graph.png" border="0" usemap="#decaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_context_spi_inherit__map" alt="Inheritance graph"/></div>
<map name="decaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_context_spi_inherit__map" id="decaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_context_spi_inherit__map">
<area shape="rect" id="node2" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_context_spi.html" title="Defines the interface that should be provided by an SSLContext provider." alt="" coords="84,5,313,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_context_spi.html#a1abe1b1b7469f4a53cbafa2cf55be39c">OpenSSLContextSpi</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_context_spi.html#a3e5397dfee56d1ec84662da31d9116d7">~OpenSSLContextSpi</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_context_spi.html#a36311478722a184f6c379e6e67fd3747">providerInit</a> (<a class="el" href="classdecaf_1_1security_1_1_secure_random.html">security::SecureRandom</a> *random)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Perform the initialization of this Context.<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">random</td><td>Pointer to an instance of a secure random number generator.</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">NullPointerException</td><td>if the SecureRandom instance is NULL. </td></tr>
<tr><td class="paramname">KeyManagementException</td><td>if an error occurs while initializing the context.</td></tr>
</table>
</dd>
</dl>
<a href="#a36311478722a184f6c379e6e67fd3747"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classdecaf_1_1net_1_1_socket_factory.html">decaf::net::SocketFactory</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_context_spi.html#a43863cedc2fc1acedb06a66fd361ff92">providerGetSocketFactory</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a <a class="el" href="classdecaf_1_1net_1_1_socket_factory.html" title="The SocketFactory is used to create Socket objects and can be sub-classed to provide other types of S...">SocketFactory</a> instance that can be used to create new <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_socket.html">SSLSocket</a> objects.The <a class="el" href="classdecaf_1_1net_1_1_socket_factory.html" title="The SocketFactory is used to create Socket objects and can be sub-classed to provide other types of S...">SocketFactory</a> is owned by the Service Provider and should not be destroyed by the caller.<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classdecaf_1_1net_1_1_socket_factory.html" title="The SocketFactory is used to create Socket objects and can be sub-classed to provide other types of S...">SocketFactory</a> instance that can be used to create new SSLSockets.</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">IllegalStateException</td><td>if the <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_context_spi.html" title="Defines the interface that should be provided by an SSLContext provider.">SSLContextSpi</a> object requires initialization but has not been initialized yet.</td></tr>
</table>
</dd>
</dl>
<a href="#a43863cedc2fc1acedb06a66fd361ff92"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <br class="typebreak"/>
<a class="el" href="classdecaf_1_1net_1_1_server_socket_factory.html">decaf::net::ServerSocketFactory</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_context_spi.html#a494a1d886e40677e26f59c0e57ec7f8a">providerGetServerSocketFactory</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a <a class="el" href="classdecaf_1_1net_1_1_server_socket_factory.html" title="Class used to create Server Sockets, subclasses can be created that create certain types of server so...">ServerSocketFactory</a> instance that can be used to create new <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_server_socket.html" title="Represents a server socket that is used to accept connections from clients using the Secure Sockets p...">SSLServerSocket</a> objects.The <a class="el" href="classdecaf_1_1net_1_1_server_socket_factory.html" title="Class used to create Server Sockets, subclasses can be created that create certain types of server so...">ServerSocketFactory</a> is owned by the Service Provider and should not be destroyed by the caller.<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classdecaf_1_1net_1_1_socket_factory.html" title="The SocketFactory is used to create Socket objects and can be sub-classed to provide other types of S...">SocketFactory</a> instance that can be used to create new SSLServerSockets.</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">IllegalStateException</td><td>if the <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_context_spi.html" title="Defines the interface that should be provided by an SSLContext provider.">SSLContextSpi</a> object requires initialization but has not been initialized yet.</td></tr>
</table>
</dd>
</dl>
<a href="#a494a1d886e40677e26f59c0e57ec7f8a"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_context_spi.html#abcb5a56a52d18c03429c699f30cd42de">OpenSSLSocket</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_context_spi.html#a9e936a35f57f8fbb4df9387883af30d3">OpenSSLSocketFactory</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Provides an SSLContext that wraps the OpenSSL API. </p>
<dl class="since"><dt><b>Since:</b></dt><dd>1.0 </dd></dl>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a1abe1b1b7469f4a53cbafa2cf55be39c"></a><!-- doxytag: member="decaf::internal::net::ssl::openssl::OpenSSLContextSpi::OpenSSLContextSpi" ref="a1abe1b1b7469f4a53cbafa2cf55be39c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">decaf::internal::net::ssl::openssl::OpenSSLContextSpi::OpenSSLContextSpi </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a3e5397dfee56d1ec84662da31d9116d7"></a><!-- doxytag: member="decaf::internal::net::ssl::openssl::OpenSSLContextSpi::~OpenSSLContextSpi" ref="a3e5397dfee56d1ec84662da31d9116d7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual decaf::internal::net::ssl::openssl::OpenSSLContextSpi::~OpenSSLContextSpi </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a494a1d886e40677e26f59c0e57ec7f8a"></a><!-- doxytag: member="decaf::internal::net::ssl::openssl::OpenSSLContextSpi::providerGetServerSocketFactory" ref="a494a1d886e40677e26f59c0e57ec7f8a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classdecaf_1_1net_1_1_server_socket_factory.html">decaf::net::ServerSocketFactory</a>* decaf::internal::net::ssl::openssl::OpenSSLContextSpi::providerGetServerSocketFactory </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a <a class="el" href="classdecaf_1_1net_1_1_server_socket_factory.html" title="Class used to create Server Sockets, subclasses can be created that create certain types of server so...">ServerSocketFactory</a> instance that can be used to create new <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_server_socket.html" title="Represents a server socket that is used to accept connections from clients using the Secure Sockets p...">SSLServerSocket</a> objects.The <a class="el" href="classdecaf_1_1net_1_1_server_socket_factory.html" title="Class used to create Server Sockets, subclasses can be created that create certain types of server so...">ServerSocketFactory</a> is owned by the Service Provider and should not be destroyed by the caller.<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classdecaf_1_1net_1_1_socket_factory.html" title="The SocketFactory is used to create Socket objects and can be sub-classed to provide other types of S...">SocketFactory</a> instance that can be used to create new SSLServerSockets.</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">IllegalStateException</td><td>if the <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_context_spi.html" title="Defines the interface that should be provided by an SSLContext provider.">SSLContextSpi</a> object requires initialization but has not been initialized yet.</td></tr>
</table>
</dd>
</dl>
</p>
<p>Implements <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_context_spi.html#a66b7cd2de60fc0cd2e547f01ba06006d">decaf::net::ssl::SSLContextSpi</a>.</p>
</div>
</div>
<a class="anchor" id="a43863cedc2fc1acedb06a66fd361ff92"></a><!-- doxytag: member="decaf::internal::net::ssl::openssl::OpenSSLContextSpi::providerGetSocketFactory" ref="a43863cedc2fc1acedb06a66fd361ff92" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classdecaf_1_1net_1_1_socket_factory.html">decaf::net::SocketFactory</a>* decaf::internal::net::ssl::openssl::OpenSSLContextSpi::providerGetSocketFactory </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a <a class="el" href="classdecaf_1_1net_1_1_socket_factory.html" title="The SocketFactory is used to create Socket objects and can be sub-classed to provide other types of S...">SocketFactory</a> instance that can be used to create new <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_socket.html">SSLSocket</a> objects.The <a class="el" href="classdecaf_1_1net_1_1_socket_factory.html" title="The SocketFactory is used to create Socket objects and can be sub-classed to provide other types of S...">SocketFactory</a> is owned by the Service Provider and should not be destroyed by the caller.<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classdecaf_1_1net_1_1_socket_factory.html" title="The SocketFactory is used to create Socket objects and can be sub-classed to provide other types of S...">SocketFactory</a> instance that can be used to create new SSLSockets.</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">IllegalStateException</td><td>if the <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_context_spi.html" title="Defines the interface that should be provided by an SSLContext provider.">SSLContextSpi</a> object requires initialization but has not been initialized yet.</td></tr>
</table>
</dd>
</dl>
</p>
<p>Implements <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_context_spi.html#a3fb660180c3e7ab5845033f074676ba7">decaf::net::ssl::SSLContextSpi</a>.</p>
</div>
</div>
<a class="anchor" id="a36311478722a184f6c379e6e67fd3747"></a><!-- doxytag: member="decaf::internal::net::ssl::openssl::OpenSSLContextSpi::providerInit" ref="a36311478722a184f6c379e6e67fd3747" args="(security::SecureRandom *random)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void decaf::internal::net::ssl::openssl::OpenSSLContextSpi::providerInit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classdecaf_1_1security_1_1_secure_random.html">security::SecureRandom</a> *&#160;</td>
<td class="paramname"><em>random</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Perform the initialization of this Context.<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">random</td><td>Pointer to an instance of a secure random number generator.</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">NullPointerException</td><td>if the SecureRandom instance is NULL. </td></tr>
<tr><td class="paramname">KeyManagementException</td><td>if an error occurs while initializing the context.</td></tr>
</table>
</dd>
</dl>
</p>
<p>Implements <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_context_spi.html#aaafe97bffaf441792f326e98d97a008a">decaf::net::ssl::SSLContextSpi</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="abcb5a56a52d18c03429c699f30cd42de"></a><!-- doxytag: member="decaf::internal::net::ssl::openssl::OpenSSLContextSpi::OpenSSLSocket" ref="abcb5a56a52d18c03429c699f30cd42de" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_socket.html">OpenSSLSocket</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a9e936a35f57f8fbb4df9387883af30d3"></a><!-- doxytag: member="decaf::internal::net::ssl::openssl::OpenSSLContextSpi::OpenSSLSocketFactory" ref="a9e936a35f57f8fbb4df9387883af30d3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_socket_factory.html">OpenSSLSocketFactory</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/main/decaf/internal/net/ssl/openssl/<a class="el" href="_open_s_s_l_context_spi_8h_source.html">OpenSSLContextSpi.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacedecaf.html">decaf</a> </li>
<li class="navelem"><a class="el" href="namespacedecaf_1_1internal.html">internal</a> </li>
<li class="navelem"><a class="el" href="namespacedecaf_1_1internal_1_1net.html">net</a> </li>
<li class="navelem"><a class="el" href="namespacedecaf_1_1internal_1_1net_1_1ssl.html">ssl</a> </li>
<li class="navelem"><a class="el" href="namespacedecaf_1_1internal_1_1net_1_1ssl_1_1openssl.html">openssl</a> </li>
<li class="navelem"><a class="el" href="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_context_spi.html">OpenSSLContextSpi</a> </li>
<li class="footer">Generated on Mon Apr 25 2011 for activemq-cpp-3.4.0 by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>