Google Git
Sign in
apache / qpid-site / 2a732cdefd1763908e5fef45e6fc60b5973cb84a / . / input / releases / qpid-proton-j-0.24.0 / api / org / apache / qpid / proton / engine / impl / ssl / SslImpl.html
blob: d7cd6b5cb944d38ab60e307f7dc9df8c31929090 [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>SslImpl (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="SslImpl (Qpid Proton-J API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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/SslHandshakeSniffingTransportWrapper.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/SslPeerDetailsImpl.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/SslImpl.html" target="_top">Frames</a></li>
<li><a href="SslImpl.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 SslImpl" class="title">Class SslImpl</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.SslImpl</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/TransportLayer.html" title="interface in org.apache.qpid.proton.engine.impl">TransportLayer</a>, <a href="../../../../../../../org/apache/qpid/proton/engine/Ssl.html" title="interface in org.apache.qpid.proton.engine">Ssl</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">SslImpl</span>
extends java.lang.Object
implements <a href="../../../../../../../org/apache/qpid/proton/engine/Ssl.html" title="interface in org.apache.qpid.proton.engine">Ssl</a>, <a href="../../../../../../../org/apache/qpid/proton/engine/impl/TransportLayer.html" title="interface in org.apache.qpid.proton.engine.impl">TransportLayer</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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/SslImpl.html#SslImpl-org.apache.qpid.proton.engine.SslDomain-org.apache.qpid.proton.engine.SslPeerDetails-">SslImpl</a></span>(<a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html" title="interface in org.apache.qpid.proton.engine">SslDomain</a>&nbsp;domain,
<a href="../../../../../../../org/apache/qpid/proton/engine/SslPeerDetails.html" title="interface in org.apache.qpid.proton.engine">SslPeerDetails</a>&nbsp;peerDetails)</code>&nbsp;</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>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/SslImpl.html#getCipherName--">getCipherName</a></span>()</code>
<div class="block">Get the name of the Cipher that is currently in use.</div>
</td>
</tr>
<tr id="i1" 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/SslImpl.html#getPeerHostname--">getPeerHostname</a></span>()</code></td>
</tr>
<tr id="i2" 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/SslImpl.html#getProtocolName--">getProtocolName</a></span>()</code>
<div class="block">Get the name of the SSL protocol that is currently in use.</div>
</td>
</tr>
<tr id="i3" 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/SslImpl.html#setPeerHostname-java.lang.String-">setPeerHostname</a></span>(java.lang.String&nbsp;hostname)</code></td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/qpid/proton/engine/impl/TransportWrapper.html" title="interface in org.apache.qpid.proton.engine.impl">TransportWrapper</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/SslImpl.html#wrap-org.apache.qpid.proton.engine.impl.TransportInput-org.apache.qpid.proton.engine.impl.TransportOutput-">wrap</a></span>(<a href="../../../../../../../org/apache/qpid/proton/engine/impl/TransportInput.html" title="interface in org.apache.qpid.proton.engine.impl">TransportInput</a>&nbsp;inputProcessor,
<a href="../../../../../../../org/apache/qpid/proton/engine/impl/TransportOutput.html" title="interface in org.apache.qpid.proton.engine.impl">TransportOutput</a>&nbsp;outputProcessor)</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, toString, 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="SslImpl-org.apache.qpid.proton.engine.SslDomain-org.apache.qpid.proton.engine.SslPeerDetails-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SslImpl</h4>
<pre>public&nbsp;SslImpl(<a href="../../../../../../../org/apache/qpid/proton/engine/SslDomain.html" title="interface in org.apache.qpid.proton.engine">SslDomain</a>&nbsp;domain,
<a href="../../../../../../../org/apache/qpid/proton/engine/SslPeerDetails.html" title="interface in org.apache.qpid.proton.engine">SslPeerDetails</a>&nbsp;peerDetails)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>domain</code> - must implement <a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/ProtonSslEngineProvider.html" title="interface in org.apache.qpid.proton.engine.impl.ssl"><code>ProtonSslEngineProvider</code></a>. This is not possible
enforce at the API level because <a href="../../../../../../../org/apache/qpid/proton/engine/impl/ssl/ProtonSslEngineProvider.html" title="interface in org.apache.qpid.proton.engine.impl.ssl"><code>ProtonSslEngineProvider</code></a> is not part of the
public Proton API.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="wrap-org.apache.qpid.proton.engine.impl.TransportInput-org.apache.qpid.proton.engine.impl.TransportOutput-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>wrap</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/qpid/proton/engine/impl/TransportWrapper.html" title="interface in org.apache.qpid.proton.engine.impl">TransportWrapper</a>&nbsp;wrap(<a href="../../../../../../../org/apache/qpid/proton/engine/impl/TransportInput.html" title="interface in org.apache.qpid.proton.engine.impl">TransportInput</a>&nbsp;inputProcessor,
<a href="../../../../../../../org/apache/qpid/proton/engine/impl/TransportOutput.html" title="interface in org.apache.qpid.proton.engine.impl">TransportOutput</a>&nbsp;outputProcessor)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/qpid/proton/engine/impl/TransportLayer.html#wrap-org.apache.qpid.proton.engine.impl.TransportInput-org.apache.qpid.proton.engine.impl.TransportOutput-">wrap</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/impl/TransportLayer.html" title="interface in org.apache.qpid.proton.engine.impl">TransportLayer</a></code></dd>
</dl>
</li>
</ul>
<a name="getCipherName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCipherName</h4>
<pre>public&nbsp;java.lang.String&nbsp;getCipherName()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/Ssl.html#getCipherName--">Ssl</a></code></span></div>
<div class="block">Get the name of the Cipher that is currently in use.
Gets a text description of the cipher that is currently active, or returns null if SSL
is not active (no cipher). Note that the cipher in use may change over time due to
renegotiation or other changes to the SSL state.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/qpid/proton/engine/Ssl.html#getCipherName--">getCipherName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/Ssl.html" title="interface in org.apache.qpid.proton.engine">Ssl</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the cipher in use, or null if none</dd>
</dl>
</li>
</ul>
<a name="getProtocolName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProtocolName</h4>
<pre>public&nbsp;java.lang.String&nbsp;getProtocolName()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/Ssl.html#getProtocolName--">Ssl</a></code></span></div>
<div class="block">Get the name of the SSL protocol that is currently in use.
Gets a text description of the SSL protocol that is currently active, or null if SSL
is not active. Note that the protocol may change over time due to renegotiation.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/qpid/proton/engine/Ssl.html#getProtocolName--">getProtocolName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/Ssl.html" title="interface in org.apache.qpid.proton.engine">Ssl</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the protocol in use, or null if none</dd>
</dl>
</li>
</ul>
<a name="setPeerHostname-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPeerHostname</h4>
<pre>public&nbsp;void&nbsp;setPeerHostname(java.lang.String&nbsp;hostname)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/qpid/proton/engine/Ssl.html#setPeerHostname-java.lang.String-">setPeerHostname</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/Ssl.html" title="interface in org.apache.qpid.proton.engine">Ssl</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/qpid/proton/ProtonUnsupportedOperationException.html" title="class in org.apache.qpid.proton">ProtonUnsupportedOperationException</a></code></dd>
</dl>
</li>
</ul>
<a name="getPeerHostname--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getPeerHostname</h4>
<pre>public&nbsp;java.lang.String&nbsp;getPeerHostname()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/qpid/proton/engine/Ssl.html#getPeerHostname--">getPeerHostname</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/qpid/proton/engine/Ssl.html" title="interface in org.apache.qpid.proton.engine">Ssl</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/qpid/proton/ProtonUnsupportedOperationException.html" title="class in org.apache.qpid.proton">ProtonUnsupportedOperationException</a></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/SslHandshakeSniffingTransportWrapper.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/SslPeerDetailsImpl.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/SslImpl.html" target="_top">Frames</a></li>
<li><a href="SslImpl.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>