Google Git
Sign in
apache / qpid-site / 5404ff5f26d72c4c418dd95f4ef04e1fba050c29 / . / input / releases / qpid-proton-j-0.30.0 / api / org / apache / qpid / proton / engine / impl / ssl / SslDomainImpl.html
blob: 4b1fb8e620d96f24f0960644547199c0e5c3e214 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>SslDomainImpl (Qpid Proton-J API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SslDomainImpl (Qpid Proton-J API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/SimpleSslTransportWrapper.html" title="class in org.apache.qpid.proton.engine.impl.ssl"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/SslEngineFacadeFactory.html" title="class in org.apache.qpid.proton.engine.impl.ssl"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/qpid/proton/engine/impl/ssl/SslDomainImpl.html" target="_top">Frames</a></li>
<li><a href="SslDomainImpl.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.qpid.proton.engine.impl.ssl</div>
<h2 title="Class SslDomainImpl" class="title">Class SslDomainImpl</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.qpid.proton.engine.impl.ssl.SslDomainImpl</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/ProtonSslEngineProvider.html" title="interface in org.apache.qpid.proton.engine.impl.ssl">ProtonSslEngineProvider</a>, <a href="../../../../../../../org/apache/qpid/proton/engine/ProtonJSslDomain.html" title="interface in org.apache.qpid.proton.engine">ProtonJSslDomain</a>, <a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html" title="interface in org.apache.qpid.proton.engine">SslDomain</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">SslDomainImpl</span>
extends java.lang.Object
implements <a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html" title="interface in org.apache.qpid.proton.engine">SslDomain</a>, <a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/ProtonSslEngineProvider.html" title="interface in org.apache.qpid.proton.engine.impl.ssl">ProtonSslEngineProvider</a>, <a href="../../../../../../../org/apache/qpid/proton/engine/ProtonJSslDomain.html" title="interface in org.apache.qpid.proton.engine">ProtonJSslDomain</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.qpid.proton.engine.SslDomain">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.qpid.proton.engine.<a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html" title="interface in org.apache.qpid.proton.engine">SslDomain</a></h3>
<code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.Factory.html" title="class in org.apache.qpid.proton.engine">SslDomain.Factory</a>, <a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.Mode.html" title="enum in org.apache.qpid.proton.engine">SslDomain.Mode</a>, <a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.VerifyMode.html" title="enum in org.apache.qpid.proton.engine">SslDomain.VerifyMode</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/SslDomainImpl.html#SslDomainImpl--">SslDomainImpl</a></span>()</code>
<div class="block">Application code should use <a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.Factory.html#create--"><code>SslDomain.Factory.create()</code></a> instead.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/SslDomainImpl.html#allowUnsecuredClient--">allowUnsecuredClient</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/SslDomainImpl.html#allowUnsecuredClient-boolean-">allowUnsecuredClient</a></span>(boolean&nbsp;allowUnsecured)</code>
<div class="block">Permit a server to accept connection requests from non-SSL clients.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/ProtonSslEngine.html" title="interface in org.apache.qpid.proton.engine.impl.ssl">ProtonSslEngine</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/SslDomainImpl.html#createSslEngine-org.apache.qpid.proton.engine.SslPeerDetails-">createSslEngine</a></span>(<a href="../../../../../../../org/apache/qpid/proton/engine/SslPeerDetails.html" title="interface in org.apache.qpid.proton.engine">SslPeerDetails</a>&nbsp;peerDetails)</code>
<div class="block">Returns an SSL engine.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/SslDomainImpl.html#getCertificateFile--">getCertificateFile</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.Mode.html" title="enum in org.apache.qpid.proton.engine">SslDomain.Mode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/SslDomainImpl.html#getMode--">getMode</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.VerifyMode.html" title="enum in org.apache.qpid.proton.engine">SslDomain.VerifyMode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/SslDomainImpl.html#getPeerAuthentication--">getPeerAuthentication</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/SslDomainImpl.html#getPrivateKeyFile--">getPrivateKeyFile</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/SslDomainImpl.html#getPrivateKeyPassword--">getPrivateKeyPassword</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>javax.net.ssl.SSLContext</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/SslDomainImpl.html#getSslContext--">getSslContext</a></span>()</code>
<div class="block">Returns the SSLContext set by <a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html#setSslContext-javax.net.ssl.SSLContext-"><code>SslDomain.setSslContext(SSLContext)</code></a>.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/SslDomainImpl.html#getTrustedCaDb--">getTrustedCaDb</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/SslDomainImpl.html#init-org.apache.qpid.proton.engine.SslDomain.Mode-">init</a></span>(<a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.Mode.html" title="enum in org.apache.qpid.proton.engine">SslDomain.Mode</a>&nbsp;mode)</code>
<div class="block">Initialize the ssl domain object.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/SslDomainImpl.html#setCredentials-java.lang.String-java.lang.String-java.lang.String-">setCredentials</a></span>(java.lang.String&nbsp;certificateFile,
java.lang.String&nbsp;privateKeyFile,
java.lang.String&nbsp;privateKeyPassword)</code>
<div class="block">Set the certificate that identifies the local node to the remote.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/SslDomainImpl.html#setPeerAuthentication-org.apache.qpid.proton.engine.SslDomain.VerifyMode-">setPeerAuthentication</a></span>(<a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.VerifyMode.html" title="enum in org.apache.qpid.proton.engine">SslDomain.VerifyMode</a>&nbsp;verifyMode)</code>
<div class="block">Configure the level of verification used on the peer certificate.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/SslDomainImpl.html#setSslContext-javax.net.ssl.SSLContext-">setSslContext</a></span>(javax.net.ssl.SSLContext&nbsp;sslContext)</code>
<div class="block">Sets an SSLContext for use when establishing SSL transport.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/SslDomainImpl.html#setTrustedCaDb-java.lang.String-">setTrustedCaDb</a></span>(java.lang.String&nbsp;certificateDb)</code>
<div class="block">Configure the set of trusted CA certificates used by this node to verify peers.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/SslDomainImpl.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SslDomainImpl--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SslDomainImpl</h4>
<pre>public&nbsp;SslDomainImpl()</pre>
<div class="block">Application code should use <a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.Factory.html#create--"><code>SslDomain.Factory.create()</code></a> instead.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="init-org.apache.qpid.proton.engine.SslDomain.Mode-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>public&nbsp;void&nbsp;init(<a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.Mode.html" title="enum in org.apache.qpid.proton.engine">SslDomain.Mode</a>&nbsp;mode)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html#init-org.apache.qpid.proton.engine.SslDomain.Mode-">SslDomain</a></code></span></div>
<div class="block">Initialize the ssl domain object.
An SSL object be either an SSL server or an SSL client. It cannot be both. Those
transports that will be used to accept incoming connection requests must be configured
as an SSL server. Those transports that will be used to initiate outbound connections
must be configured as an SSL client.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html#init-org.apache.qpid.proton.engine.SslDomain.Mode-">init</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html" title="interface in org.apache.qpid.proton.engine">SslDomain</a></code></dd>
</dl>
</li>
</ul>
<a name="getMode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMode</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.Mode.html" title="enum in org.apache.qpid.proton.engine">SslDomain.Mode</a>&nbsp;getMode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html#getMode--">getMode</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html" title="interface in org.apache.qpid.proton.engine">SslDomain</a></code></dd>
</dl>
</li>
</ul>
<a name="setCredentials-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCredentials</h4>
<pre>public&nbsp;void&nbsp;setCredentials(java.lang.String&nbsp;certificateFile,
java.lang.String&nbsp;privateKeyFile,
java.lang.String&nbsp;privateKeyPassword)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html#setCredentials-java.lang.String-java.lang.String-java.lang.String-">SslDomain</a></code></span></div>
<div class="block">Set the certificate that identifies the local node to the remote.
This certificate establishes the identity for the local node. It will be sent to the
remote if the remote needs to verify the identity of this node. This may be used for
both SSL servers and SSL clients (if client authentication is required by the server).</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html#setCredentials-java.lang.String-java.lang.String-java.lang.String-">setCredentials</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html" title="interface in org.apache.qpid.proton.engine">SslDomain</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>certificateFile</code> - path to file/database containing the identifying
certificate.</dd>
<dd><code>privateKeyFile</code> - path to file/database containing the private key used to
sign the certificate</dd>
<dd><code>privateKeyPassword</code> - the password used to sign the key, else null if key is not
protected.</dd>
</dl>
</li>
</ul>
<a name="setTrustedCaDb-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTrustedCaDb</h4>
<pre>public&nbsp;void&nbsp;setTrustedCaDb(java.lang.String&nbsp;certificateDb)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html#setTrustedCaDb-java.lang.String-">SslDomain</a></code></span></div>
<div class="block">Configure the set of trusted CA certificates used by this node to verify peers.
If the local SSL client/server needs to verify the identity of the remote, it must
validate the signature of the remote's certificate. This function sets the database of
trusted CAs that will be used to verify the signature of the remote's certificate.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html#setTrustedCaDb-java.lang.String-">setTrustedCaDb</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html" title="interface in org.apache.qpid.proton.engine">SslDomain</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>certificateDb</code> - database of trusted CAs, used to authenticate the peer.</dd>
</dl>
</li>
</ul>
<a name="getTrustedCaDb--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTrustedCaDb</h4>
<pre>public&nbsp;java.lang.String&nbsp;getTrustedCaDb()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html#getTrustedCaDb--">getTrustedCaDb</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html" title="interface in org.apache.qpid.proton.engine">SslDomain</a></code></dd>
</dl>
</li>
</ul>
<a name="setSslContext-javax.net.ssl.SSLContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSslContext</h4>
<pre>public&nbsp;void&nbsp;setSslContext(javax.net.ssl.SSLContext&nbsp;sslContext)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html#setSslContext-javax.net.ssl.SSLContext-">SslDomain</a></code></span></div>
<div class="block">Sets an SSLContext for use when establishing SSL transport. Setting a context this way overrides alternate
configuration that might otherwise have been used to create a context, such as key and trust store paths.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html#setSslContext-javax.net.ssl.SSLContext-">setSslContext</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html" title="interface in org.apache.qpid.proton.engine">SslDomain</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sslContext</code> - the context to use</dd>
</dl>
</li>
</ul>
<a name="getSslContext--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSslContext</h4>
<pre>public&nbsp;javax.net.ssl.SSLContext&nbsp;getSslContext()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html#getSslContext--">SslDomain</a></code></span></div>
<div class="block">Returns the SSLContext set by <a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html#setSslContext-javax.net.ssl.SSLContext-"><code>SslDomain.setSslContext(SSLContext)</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html#getSslContext--">getSslContext</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html" title="interface in org.apache.qpid.proton.engine">SslDomain</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the SSLContext, or null if none was set.</dd>
</dl>
</li>
</ul>
<a name="setPeerAuthentication-org.apache.qpid.proton.engine.SslDomain.VerifyMode-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPeerAuthentication</h4>
<pre>public&nbsp;void&nbsp;setPeerAuthentication(<a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.VerifyMode.html" title="enum in org.apache.qpid.proton.engine">SslDomain.VerifyMode</a>&nbsp;verifyMode)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html#setPeerAuthentication-org.apache.qpid.proton.engine.SslDomain.VerifyMode-">SslDomain</a></code></span></div>
<div class="block">Configure the level of verification used on the peer certificate.
This method controls how the peer's certificate is validated, if at all. By default,
neither servers nor clients attempt to verify their peers (<a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.VerifyMode.html#ANONYMOUS_PEER"><code>SslDomain.VerifyMode.ANONYMOUS_PEER</code></a>).
Once certificates and trusted CAs are configured, peer verification can be enabled.
In order to verify a peer, a trusted CA must be configured. See
<a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html#setTrustedCaDb-java.lang.String-"><code>SslDomain.setTrustedCaDb(String)</code></a>.
NOTE: Servers must provide their own certificate when verifying a peer. See
<a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html#setCredentials-java.lang.String-java.lang.String-java.lang.String-"><code>SslDomain.setCredentials(String, String, String)</code></a>).</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html#setPeerAuthentication-org.apache.qpid.proton.engine.SslDomain.VerifyMode-">setPeerAuthentication</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html" title="interface in org.apache.qpid.proton.engine">SslDomain</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>verifyMode</code> - the level of validation to apply to the peer</dd>
</dl>
</li>
</ul>
<a name="getPeerAuthentication--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPeerAuthentication</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.VerifyMode.html" title="enum in org.apache.qpid.proton.engine">SslDomain.VerifyMode</a>&nbsp;getPeerAuthentication()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html#getPeerAuthentication--">getPeerAuthentication</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html" title="interface in org.apache.qpid.proton.engine">SslDomain</a></code></dd>
</dl>
</li>
</ul>
<a name="getPrivateKeyFile--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPrivateKeyFile</h4>
<pre>public&nbsp;java.lang.String&nbsp;getPrivateKeyFile()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html#getPrivateKeyFile--">getPrivateKeyFile</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html" title="interface in org.apache.qpid.proton.engine">SslDomain</a></code></dd>
</dl>
</li>
</ul>
<a name="getPrivateKeyPassword--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPrivateKeyPassword</h4>
<pre>public&nbsp;java.lang.String&nbsp;getPrivateKeyPassword()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html#getPrivateKeyPassword--">getPrivateKeyPassword</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html" title="interface in org.apache.qpid.proton.engine">SslDomain</a></code></dd>
</dl>
</li>
</ul>
<a name="getCertificateFile--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCertificateFile</h4>
<pre>public&nbsp;java.lang.String&nbsp;getCertificateFile()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html#getCertificateFile--">getCertificateFile</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html" title="interface in org.apache.qpid.proton.engine">SslDomain</a></code></dd>
</dl>
</li>
</ul>
<a name="allowUnsecuredClient-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allowUnsecuredClient</h4>
<pre>public&nbsp;void&nbsp;allowUnsecuredClient(boolean&nbsp;allowUnsecured)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html#allowUnsecuredClient-boolean-">SslDomain</a></code></span></div>
<div class="block">Permit a server to accept connection requests from non-SSL clients.
This configures the server to "sniff" the incoming client data stream, and dynamically
determine whether SSL/TLS is being used. This option is disabled by default: only
clients using SSL/TLS are accepted.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html#allowUnsecuredClient-boolean-">allowUnsecuredClient</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html" title="interface in org.apache.qpid.proton.engine">SslDomain</a></code></dd>
</dl>
</li>
</ul>
<a name="allowUnsecuredClient--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allowUnsecuredClient</h4>
<pre>public&nbsp;boolean&nbsp;allowUnsecuredClient()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html#allowUnsecuredClient--">allowUnsecuredClient</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html" title="interface in org.apache.qpid.proton.engine">SslDomain</a></code></dd>
</dl>
</li>
</ul>
<a name="createSslEngine-org.apache.qpid.proton.engine.SslPeerDetails-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSslEngine</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/ProtonSslEngine.html" title="interface in org.apache.qpid.proton.engine.impl.ssl">ProtonSslEngine</a>&nbsp;createSslEngine(<a href="../../../../../../../org/apache/qpid/proton/engine/SslPeerDetails.html" title="interface in org.apache.qpid.proton.engine">SslPeerDetails</a>&nbsp;peerDetails)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/ProtonSslEngineProvider.html#createSslEngine-org.apache.qpid.proton.engine.SslPeerDetails-">ProtonSslEngineProvider</a></code></span></div>
<div class="block">Returns an SSL engine.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/ProtonSslEngineProvider.html#createSslEngine-org.apache.qpid.proton.engine.SslPeerDetails-">createSslEngine</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/ProtonSslEngineProvider.html" title="interface in org.apache.qpid.proton.engine.impl.ssl">ProtonSslEngineProvider</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>peerDetails</code> - the details of the remote peer. If non-null, may be used to assist SSL session resumption.</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/SimpleSslTransportWrapper.html" title="class in org.apache.qpid.proton.engine.impl.ssl"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/SslEngineFacadeFactory.html" title="class in org.apache.qpid.proton.engine.impl.ssl"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/qpid/proton/engine/impl/ssl/SslDomainImpl.html" target="_top">Frames</a></li>
<li><a href="SslDomainImpl.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>