| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SslSupport (Qpid ProtonJ2 Parent 1.0.0-M19 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.qpid.protonj2.client.transport.netty4, class: SslSupport"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/SslSupport.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <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="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.qpid.protonj2.client.transport.netty4</a></div> |
| <h1 title="Class SslSupport" class="title">Class SslSupport</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.qpid.protonj2.client.transport.netty4.SslSupport</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">SslSupport</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> |
| <div class="block">Static class that provides various utility methods used by Transport implementations.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">SslSupport</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/javax/net/ssl/SSLContext.html" title="class or interface in javax.net.ssl" class="external-link">SSLContext</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createJdkSslContext(org.apache.qpid.protonj2.client.SslOptions)" class="member-name-link">createJdkSslContext</a><wbr>(<a href="../../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> options)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Create a new SSLContext using the options specific in the given TransportOptions |
| instance.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/javax/net/ssl/SSLEngine.html" title="class or interface in javax.net.ssl" class="external-link">SSLEngine</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createJdkSslEngine(java.lang.String,int,javax.net.ssl.SSLContext,org.apache.qpid.protonj2.client.SslOptions)" class="member-name-link">createJdkSslEngine</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> host, |
| int port, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/javax/net/ssl/SSLContext.html" title="class or interface in javax.net.ssl" class="external-link">SSLContext</a> context, |
| <a href="../../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> options)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Create a new JDK SSLEngine instance in client mode from the given SSLContext and |
| TransportOptions instances.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static io.netty.handler.ssl.SslContext</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createOpenSslContext(org.apache.qpid.protonj2.client.SslOptions)" class="member-name-link">createOpenSslContext</a><wbr>(<a href="../../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> options)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Create a new Netty SslContext using the options specific in the given TransportOptions |
| instance.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/javax/net/ssl/SSLEngine.html" title="class or interface in javax.net.ssl" class="external-link">SSLEngine</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createOpenSslEngine(io.netty.buffer.ByteBufAllocator,java.lang.String,int,io.netty.handler.ssl.SslContext,org.apache.qpid.protonj2.client.SslOptions)" class="member-name-link">createOpenSslEngine</a><wbr>(io.netty.buffer.ByteBufAllocator allocator, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">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></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Create a new OpenSSL SSLEngine instance in client mode from the given SSLContext and |
| TransportOptions instances.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static io.netty.handler.ssl.SslHandler</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createSslHandler(io.netty.buffer.ByteBufAllocator,java.lang.String,int,org.apache.qpid.protonj2.client.SslOptions)" class="member-name-link">createSslHandler</a><wbr>(io.netty.buffer.ByteBufAllocator allocator, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> host, |
| int port, |
| <a href="../../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> options)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a Netty SslHandler instance for use in Transports that require |
| an SSL encoder / decoder.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isOpenSSLPossible(org.apache.qpid.protonj2.client.SslOptions)" class="member-name-link">isOpenSSLPossible</a><wbr>(<a href="../../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> options)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Determines if Netty OpenSSL support is available and applicable based on the configuration |
| in the given TransportOptions instance.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>SslSupport</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SslSupport</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="isOpenSSLPossible(org.apache.qpid.protonj2.client.SslOptions)"> |
| <h3>isOpenSSLPossible</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">isOpenSSLPossible</span><wbr><span class="parameters">(<a href="../../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> options)</span></div> |
| <div class="block">Determines if Netty OpenSSL support is available and applicable based on the configuration |
| in the given TransportOptions instance.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>options</code> - The configuration of the Transport being created.</dd> |
| <dt>Returns:</dt> |
| <dd>true if OpenSSL support is available and usable given the requested configuration.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createSslHandler(io.netty.buffer.ByteBufAllocator,java.lang.String,int,org.apache.qpid.protonj2.client.SslOptions)"> |
| <h3>createSslHandler</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">io.netty.handler.ssl.SslHandler</span> <span class="element-name">createSslHandler</span><wbr><span class="parameters">(io.netty.buffer.ByteBufAllocator allocator, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> host, |
| int port, |
| <a href="../../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> options)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div> |
| <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 class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>a new SslHandler that is configured from the given options.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></code> - if an error occurs while creating the SslHandler instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createJdkSslContext(org.apache.qpid.protonj2.client.SslOptions)"> |
| <h3>createJdkSslContext</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/javax/net/ssl/SSLContext.html" title="class or interface in javax.net.ssl" class="external-link">SSLContext</a></span> <span class="element-name">createJdkSslContext</span><wbr><span class="parameters">(<a href="../../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> options)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div> |
| <div class="block">Create a new SSLContext using the options specific in the given TransportOptions |
| instance.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>options</code> - the configured options used to create the SSLContext.</dd> |
| <dt>Returns:</dt> |
| <dd>a new SSLContext instance.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></code> - if an error occurs while creating the context.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createJdkSslEngine(java.lang.String,int,javax.net.ssl.SSLContext,org.apache.qpid.protonj2.client.SslOptions)"> |
| <h3>createJdkSslEngine</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/javax/net/ssl/SSLEngine.html" title="class or interface in javax.net.ssl" class="external-link">SSLEngine</a></span> <span class="element-name">createJdkSslEngine</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> host, |
| int port, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/javax/net/ssl/SSLContext.html" title="class or interface in javax.net.ssl" class="external-link">SSLContext</a> context, |
| <a href="../../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> options)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div> |
| <div class="block">Create a new JDK SSLEngine instance in client mode from the given SSLContext and |
| TransportOptions instances.</div> |
| <dl class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>a new SSLEngine instance in client mode.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></code> - if an error occurs while creating the new SSLEngine.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createOpenSslContext(org.apache.qpid.protonj2.client.SslOptions)"> |
| <h3>createOpenSslContext</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">io.netty.handler.ssl.SslContext</span> <span class="element-name">createOpenSslContext</span><wbr><span class="parameters">(<a href="../../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> options)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div> |
| <div class="block">Create a new Netty SslContext using the options specific in the given TransportOptions |
| instance.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>options</code> - the configured options used to create the SslContext.</dd> |
| <dt>Returns:</dt> |
| <dd>a new SslContext instance.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></code> - if an error occurs while creating the context.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createOpenSslEngine(io.netty.buffer.ByteBufAllocator,java.lang.String,int,io.netty.handler.ssl.SslContext,org.apache.qpid.protonj2.client.SslOptions)"> |
| <h3>createOpenSslEngine</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/javax/net/ssl/SSLEngine.html" title="class or interface in javax.net.ssl" class="external-link">SSLEngine</a></span> <span class="element-name">createOpenSslEngine</span><wbr><span class="parameters">(io.netty.buffer.ByteBufAllocator allocator, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">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)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div> |
| <div class="block">Create a new OpenSSL SSLEngine instance in client mode from the given SSLContext and |
| TransportOptions instances.</div> |
| <dl class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>a new Netty managed SSLEngine instance in client mode.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></code> - if an error occurs while creating the new SSLEngine.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
