| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>SslSupport (Qpid ProtonJ2 Parent 1.0.0-M9 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <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="SslSupport (Qpid ProtonJ2 Parent 1.0.0-M9 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/SslSupport.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses.html">All 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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.qpid.protonj2.client.transport</a></div> |
| <h2 title="Class SslSupport" class="title">Class SslSupport</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.qpid.protonj2.client.transport.SslSupport</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>public class <span class="typeNameLabel">SslSupport</span> |
| extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></pre> |
| <div class="block">Static class that provides various utility methods used by Transport implementations.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">SslSupport</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/javax/net/ssl/SSLContext.html?is-external=true" title="class or interface in javax.net.ssl" class="externalLink">SSLContext</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createJdkSslContext(org.apache.qpid.protonj2.client.SslOptions)">createJdkSslContext</a></span>​(<a href="../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> options)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new SSLContext using the options specific in the given TransportOptions |
| instance.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/javax/net/ssl/SSLEngine.html?is-external=true" title="class or interface in javax.net.ssl" class="externalLink">SSLEngine</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createJdkSslEngine(java.lang.String,int,javax.net.ssl.SSLContext,org.apache.qpid.protonj2.client.SslOptions)">createJdkSslEngine</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> host, |
| int port, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/javax/net/ssl/SSLContext.html?is-external=true" title="class or interface in javax.net.ssl" class="externalLink">SSLContext</a> context, |
| <a href="../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> options)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new JDK SSLEngine instance in client mode from the given SSLContext and |
| TransportOptions instances.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static io.netty.handler.ssl.SslContext</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createOpenSslContext(org.apache.qpid.protonj2.client.SslOptions)">createOpenSslContext</a></span>​(<a href="../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> options)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new Netty SslContext using the options specific in the given TransportOptions |
| instance.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/javax/net/ssl/SSLEngine.html?is-external=true" title="class or interface in javax.net.ssl" class="externalLink">SSLEngine</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createOpenSslEngine(io.netty.buffer.ByteBufAllocator,java.lang.String,int,io.netty.handler.ssl.SslContext,org.apache.qpid.protonj2.client.SslOptions)">createOpenSslEngine</a></span>​(io.netty.buffer.ByteBufAllocator allocator, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> host, |
| int port, |
| io.netty.handler.ssl.SslContext context, |
| <a href="../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> options)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new OpenSSL SSLEngine instance in client mode from the given SSLContext and |
| TransportOptions instances.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static io.netty.handler.ssl.SslHandler</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createSslHandler(io.netty.buffer.ByteBufAllocator,java.lang.String,int,org.apache.qpid.protonj2.client.SslOptions)">createSslHandler</a></span>​(io.netty.buffer.ByteBufAllocator allocator, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> host, |
| int port, |
| <a href="../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> options)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a Netty SslHandler instance for use in Transports that require |
| an SSL encoder / decoder.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isOpenSSLPossible(org.apache.qpid.protonj2.client.SslOptions)">isOpenSSLPossible</a></span>​(<a href="../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> options)</code></th> |
| <td class="colLast"> |
| <div class="block">Determines if Netty OpenSSL support is available and applicable based on the configuration |
| in the given TransportOptions instance.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SslSupport</h4> |
| <pre>public SslSupport()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="isOpenSSLPossible(org.apache.qpid.protonj2.client.SslOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOpenSSLPossible</h4> |
| <pre class="methodSignature">public static boolean isOpenSSLPossible​(<a href="../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> options)</pre> |
| <div class="block">Determines if Netty OpenSSL support is available and applicable based on the configuration |
| in the given TransportOptions instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>options</code> - The configuration of the Transport being created.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if OpenSSL support is available and usable given the requested configuration.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createSslHandler(io.netty.buffer.ByteBufAllocator,java.lang.String,int,org.apache.qpid.protonj2.client.SslOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSslHandler</h4> |
| <pre class="methodSignature">public static io.netty.handler.ssl.SslHandler createSslHandler​(io.netty.buffer.ByteBufAllocator allocator, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> host, |
| int port, |
| <a href="../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> options) |
| throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre> |
| <div class="block">Creates a Netty SslHandler instance for use in Transports that require |
| an SSL encoder / decoder. |
| |
| If the given options contain an SSLContext override, this will be used directly |
| when creating the handler. If they do not, an SSLContext will first be created |
| using the other option values.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>allocator</code> - The Netty Buffer Allocator to use when Netty resources need to be created.</dd> |
| <dd><code>host</code> - the host name or IP address that this transport connects to.</dd> |
| <dd><code>port</code> - the port on the given host that this transport connects to.</dd> |
| <dd><code>options</code> - The SSL options object to build the SslHandler instance from.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new SslHandler that is configured from the given options.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code> - if an error occurs while creating the SslHandler instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createJdkSslContext(org.apache.qpid.protonj2.client.SslOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createJdkSslContext</h4> |
| <pre class="methodSignature">public static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/javax/net/ssl/SSLContext.html?is-external=true" title="class or interface in javax.net.ssl" class="externalLink">SSLContext</a> createJdkSslContext​(<a href="../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> options) |
| throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre> |
| <div class="block">Create a new SSLContext using the options specific in the given TransportOptions |
| instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>options</code> - the configured options used to create the SSLContext.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new SSLContext instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code> - if an error occurs while creating the context.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createJdkSslEngine(java.lang.String,int,javax.net.ssl.SSLContext,org.apache.qpid.protonj2.client.SslOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createJdkSslEngine</h4> |
| <pre class="methodSignature">public static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/javax/net/ssl/SSLEngine.html?is-external=true" title="class or interface in javax.net.ssl" class="externalLink">SSLEngine</a> createJdkSslEngine​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> host, |
| int port, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/javax/net/ssl/SSLContext.html?is-external=true" title="class or interface in javax.net.ssl" class="externalLink">SSLContext</a> context, |
| <a href="../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> options) |
| throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre> |
| <div class="block">Create a new JDK SSLEngine instance in client mode from the given SSLContext and |
| TransportOptions instances.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>host</code> - the host name or IP address that this transport connects to.</dd> |
| <dd><code>port</code> - the port on the given host that this transport connects to.</dd> |
| <dd><code>context</code> - the SSLContext to use when creating the engine.</dd> |
| <dd><code>options</code> - the TransportOptions to use to configure the new SSLEngine.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new SSLEngine instance in client mode.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code> - if an error occurs while creating the new SSLEngine.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createOpenSslContext(org.apache.qpid.protonj2.client.SslOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createOpenSslContext</h4> |
| <pre class="methodSignature">public static io.netty.handler.ssl.SslContext createOpenSslContext​(<a href="../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> options) |
| throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre> |
| <div class="block">Create a new Netty SslContext using the options specific in the given TransportOptions |
| instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>options</code> - the configured options used to create the SslContext.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new SslContext instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code> - if an error occurs while creating the context.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createOpenSslEngine(io.netty.buffer.ByteBufAllocator,java.lang.String,int,io.netty.handler.ssl.SslContext,org.apache.qpid.protonj2.client.SslOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>createOpenSslEngine</h4> |
| <pre class="methodSignature">public static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/javax/net/ssl/SSLEngine.html?is-external=true" title="class or interface in javax.net.ssl" class="externalLink">SSLEngine</a> createOpenSslEngine​(io.netty.buffer.ByteBufAllocator allocator, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> host, |
| int port, |
| io.netty.handler.ssl.SslContext context, |
| <a href="../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> options) |
| throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre> |
| <div class="block">Create a new OpenSSL SSLEngine instance in client mode from the given SSLContext and |
| TransportOptions instances.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>allocator</code> - the Netty ByteBufAllocator to use to create the OpenSSL engine</dd> |
| <dd><code>host</code> - the host name or IP address that this transport connects to.</dd> |
| <dd><code>port</code> - the port on the given host that this transport connects to.</dd> |
| <dd><code>context</code> - the Netty SslContext to use when creating the engine.</dd> |
| <dd><code>options</code> - the TransportOptions to use to configure the new SSLEngine.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new Netty managed SSLEngine instance in client mode.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code> - if an error occurs while creating the new SSLEngine.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/SslSupport.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses.html">All 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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
