| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SslOptions (Qpid ProtonJ2 Parent 1.0.0-M20 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, class: SslOptions"> |
| <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/SslOptions.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><a href="#field-summary">Field</a> | </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><a href="#field-detail">Field</a> | </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</a></div> |
| <h1 title="Class SslOptions" class="title">Class SslOptions</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.SslOptions</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SslOptions</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> |
| implements <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></span></div> |
| <div class="block">Options for configuration of the client SSL layer</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_ALLOW_NATIVE_SSL" class="member-name-link">DEFAULT_ALLOW_NATIVE_SSL</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <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></code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_CONTEXT_PROTOCOL" class="member-name-link">DEFAULT_CONTEXT_PROTOCOL</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<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>></code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_DISABLED_PROTOCOLS" class="member-name-link">DEFAULT_DISABLED_PROTOCOLS</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_SSL_PORT" class="member-name-link">DEFAULT_SSL_PORT</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final <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></code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_STORE_TYPE" class="member-name-link">DEFAULT_STORE_TYPE</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_TRUST_ALL" class="member-name-link">DEFAULT_TRUST_ALL</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_VERIFY_HOST" class="member-name-link">DEFAULT_VERIFY_HOST</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== 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">SslOptions</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-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance 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-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#allowNativeSSL()" class="member-name-link">allowNativeSSL</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#allowNativeSSL(boolean)" class="member-name-link">allowNativeSSL</a><wbr>(boolean allowNativeSSL)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clone()" class="member-name-link">clone</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#contextProtocol()" class="member-name-link">contextProtocol</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#contextProtocol(java.lang.String)" class="member-name-link">contextProtocol</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> contextProtocol)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The protocol value to use when creating an SSLContext via |
| SSLContext.getInstance(protocol).</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#copyInto(org.apache.qpid.protonj2.client.SslOptions)" class="member-name-link">copyInto</a><wbr>(<a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> other)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Copy all configuration into the given <a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SslOptions</code></a> from this instance.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#defaultSslPort()" class="member-name-link">defaultSslPort</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#defaultSslPort(int)" class="member-name-link">defaultSslPort</a><wbr>(int defaultSslPort)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the default AMQP SSL port that should be used if the user did not provide a port value.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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>[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#disabledCipherSuites()" class="member-name-link">disabledCipherSuites</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#disabledCipherSuites(java.lang.String...)" class="member-name-link">disabledCipherSuites</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>... disabledCipherSuites)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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>[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#disabledProtocols()" class="member-name-link">disabledProtocols</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#disabledProtocols(java.lang.String...)" class="member-name-link">disabledProtocols</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>... disabledProtocols)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The protocols to be disable.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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>[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#enabledCipherSuites()" class="member-name-link">enabledCipherSuites</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#enabledCipherSuites(java.lang.String...)" class="member-name-link">enabledCipherSuites</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>... enabledCipherSuites)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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>[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#enabledProtocols()" class="member-name-link">enabledProtocols</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#enabledProtocols(java.lang.String...)" class="member-name-link">enabledProtocols</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>... enabledProtocols)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The protocols to be set as enabled.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#keyAlias()" class="member-name-link">keyAlias</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#keyAlias(java.lang.String)" class="member-name-link">keyAlias</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> keyAlias)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#keyStoreLocation()" class="member-name-link">keyStoreLocation</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#keyStoreLocation(java.lang.String)" class="member-name-link">keyStoreLocation</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> keyStoreLocation)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the location on disk of the key store to use.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#keyStorePassword()" class="member-name-link">keyStorePassword</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#keyStorePassword(java.lang.String)" class="member-name-link">keyStorePassword</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> keyStorePassword)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#keyStoreType()" class="member-name-link">keyStoreType</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#keyStoreType(java.lang.String)" class="member-name-link">keyStoreType</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> keyStoreType)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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-tab2 method-summary-table-tab4"><code><a href="#sslContextOverride()" class="member-name-link">sslContextOverride</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sslContextOverride(javax.net.ssl.SSLContext)" class="member-name-link">sslContextOverride</a><wbr>(<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> sslContextOverride)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Provides a user configured <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"><code>SSLContext</code></a> that should be used when performing the |
| SSL handshake with the remote.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sslEnabled()" class="member-name-link">sslEnabled</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sslEnabled(boolean)" class="member-name-link">sslEnabled</a><wbr>(boolean enable)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Enable or disable the transport level SSL encryption layer.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#storeType(java.lang.String)" class="member-name-link">storeType</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> storeType)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#trustAll()" class="member-name-link">trustAll</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#trustAll(boolean)" class="member-name-link">trustAll</a><wbr>(boolean trustAll)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#trustStoreLocation()" class="member-name-link">trustStoreLocation</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#trustStoreLocation(java.lang.String)" class="member-name-link">trustStoreLocation</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> trustStoreLocation)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#trustStorePassword()" class="member-name-link">trustStorePassword</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#trustStorePassword(java.lang.String)" class="member-name-link">trustStorePassword</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> trustStorePassword)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#trustStoreType()" class="member-name-link">trustStoreType</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#trustStoreType(java.lang.String)" class="member-name-link">trustStoreType</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> trustStoreType)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#verifyHost()" class="member-name-link">verifyHost</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#verifyHost(boolean)" class="member-name-link">verifyHost</a><wbr>(boolean verifyHost)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </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#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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="DEFAULT_STORE_TYPE"> |
| <h3>DEFAULT_STORE_TYPE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><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></span> <span class="element-name">DEFAULT_STORE_TYPE</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.SslOptions.DEFAULT_STORE_TYPE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_CONTEXT_PROTOCOL"> |
| <h3>DEFAULT_CONTEXT_PROTOCOL</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><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></span> <span class="element-name">DEFAULT_CONTEXT_PROTOCOL</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.SslOptions.DEFAULT_CONTEXT_PROTOCOL">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_TRUST_ALL"> |
| <h3>DEFAULT_TRUST_ALL</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">boolean</span> <span class="element-name">DEFAULT_TRUST_ALL</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.SslOptions.DEFAULT_TRUST_ALL">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_VERIFY_HOST"> |
| <h3>DEFAULT_VERIFY_HOST</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">boolean</span> <span class="element-name">DEFAULT_VERIFY_HOST</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.SslOptions.DEFAULT_VERIFY_HOST">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_DISABLED_PROTOCOLS"> |
| <h3>DEFAULT_DISABLED_PROTOCOLS</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<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>></span> <span class="element-name">DEFAULT_DISABLED_PROTOCOLS</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_SSL_PORT"> |
| <h3>DEFAULT_SSL_PORT</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">DEFAULT_SSL_PORT</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.SslOptions.DEFAULT_SSL_PORT">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_ALLOW_NATIVE_SSL"> |
| <h3>DEFAULT_ALLOW_NATIVE_SSL</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">boolean</span> <span class="element-name">DEFAULT_ALLOW_NATIVE_SSL</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.SslOptions.DEFAULT_ALLOW_NATIVE_SSL">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= 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>SslOptions</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SslOptions</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="clone()"> |
| <h3>clone</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></span> <span class="element-name">clone</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><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></code> in class <code><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></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="sslEnabled()"> |
| <h3>sslEnabled</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">sslEnabled</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if the client transport will attempt to connect with SSL</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="sslEnabled(boolean)"> |
| <h3>sslEnabled</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></span> <span class="element-name">sslEnabled</span><wbr><span class="parameters">(boolean enable)</span></div> |
| <div class="block">Enable or disable the transport level SSL encryption layer.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>enable</code> - boolean that controls if SSL is enabled or disabled.</dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SslOptions</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="keyStoreLocation()"> |
| <h3>keyStoreLocation</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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></span> <span class="element-name">keyStoreLocation</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the keyStoreLocation currently configured.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="keyStoreLocation(java.lang.String)"> |
| <h3>keyStoreLocation</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></span> <span class="element-name">keyStoreLocation</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> keyStoreLocation)</span></div> |
| <div class="block">Sets the location on disk of the key store to use.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>keyStoreLocation</code> - the keyStoreLocation to use to create the key manager.</dd> |
| <dt>Returns:</dt> |
| <dd>this options instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="keyStorePassword()"> |
| <h3>keyStorePassword</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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></span> <span class="element-name">keyStorePassword</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the keyStorePassword</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="keyStorePassword(java.lang.String)"> |
| <h3>keyStorePassword</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></span> <span class="element-name">keyStorePassword</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> keyStorePassword)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>keyStorePassword</code> - the keyStorePassword to set</dd> |
| <dt>Returns:</dt> |
| <dd>this options instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="trustStoreLocation()"> |
| <h3>trustStoreLocation</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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></span> <span class="element-name">trustStoreLocation</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the trustStoreLocation</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="trustStoreLocation(java.lang.String)"> |
| <h3>trustStoreLocation</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></span> <span class="element-name">trustStoreLocation</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> trustStoreLocation)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>trustStoreLocation</code> - the trustStoreLocation to set</dd> |
| <dt>Returns:</dt> |
| <dd>this options instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="trustStorePassword()"> |
| <h3>trustStorePassword</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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></span> <span class="element-name">trustStorePassword</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the trustStorePassword</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="trustStorePassword(java.lang.String)"> |
| <h3>trustStorePassword</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></span> <span class="element-name">trustStorePassword</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> trustStorePassword)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>trustStorePassword</code> - the trustStorePassword to set</dd> |
| <dt>Returns:</dt> |
| <dd>this options instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="storeType(java.lang.String)"> |
| <h3>storeType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></span> <span class="element-name">storeType</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> storeType)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>storeType</code> - the format that the store files are encoded in.</dd> |
| <dt>Returns:</dt> |
| <dd>this options instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="keyStoreType()"> |
| <h3>keyStoreType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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></span> <span class="element-name">keyStoreType</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the keyStoreType</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="keyStoreType(java.lang.String)"> |
| <h3>keyStoreType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></span> <span class="element-name">keyStoreType</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> keyStoreType)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>keyStoreType</code> - the format that the keyStore file is encoded in</dd> |
| <dt>Returns:</dt> |
| <dd>this options instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="trustStoreType()"> |
| <h3>trustStoreType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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></span> <span class="element-name">trustStoreType</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the trustStoreType</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="trustStoreType(java.lang.String)"> |
| <h3>trustStoreType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></span> <span class="element-name">trustStoreType</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> trustStoreType)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>trustStoreType</code> - the format that the trustStore file is encoded in</dd> |
| <dt>Returns:</dt> |
| <dd>this options instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="enabledCipherSuites()"> |
| <h3>enabledCipherSuites</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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>[]</span> <span class="element-name">enabledCipherSuites</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the enabledCipherSuites</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="enabledCipherSuites(java.lang.String...)"> |
| <h3>enabledCipherSuites</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></span> <span class="element-name">enabledCipherSuites</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>... enabledCipherSuites)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>enabledCipherSuites</code> - the enabledCipherSuites to set</dd> |
| <dt>Returns:</dt> |
| <dd>this options instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="disabledCipherSuites()"> |
| <h3>disabledCipherSuites</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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>[]</span> <span class="element-name">disabledCipherSuites</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the disabledCipherSuites</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="disabledCipherSuites(java.lang.String...)"> |
| <h3>disabledCipherSuites</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></span> <span class="element-name">disabledCipherSuites</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>... disabledCipherSuites)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>disabledCipherSuites</code> - the disabledCipherSuites to set</dd> |
| <dt>Returns:</dt> |
| <dd>this options instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="enabledProtocols()"> |
| <h3>enabledProtocols</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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>[]</span> <span class="element-name">enabledProtocols</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the enabledProtocols or null if the defaults should be used</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="enabledProtocols(java.lang.String...)"> |
| <h3>enabledProtocols</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></span> <span class="element-name">enabledProtocols</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>... enabledProtocols)</span></div> |
| <div class="block">The protocols to be set as enabled.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>enabledProtocols</code> - the enabled protocols to set, or null if the defaults should be used.</dd> |
| <dt>Returns:</dt> |
| <dd>this options instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="disabledProtocols()"> |
| <h3>disabledProtocols</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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>[]</span> <span class="element-name">disabledProtocols</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the protocols to disable or null if none should be</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="disabledProtocols(java.lang.String...)"> |
| <h3>disabledProtocols</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></span> <span class="element-name">disabledProtocols</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>... disabledProtocols)</span></div> |
| <div class="block">The protocols to be disable.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>disabledProtocols</code> - the protocols to disable, or null if none should be.</dd> |
| <dt>Returns:</dt> |
| <dd>this options instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="contextProtocol()"> |
| <h3>contextProtocol</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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></span> <span class="element-name">contextProtocol</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the context protocol to use</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="contextProtocol(java.lang.String)"> |
| <h3>contextProtocol</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></span> <span class="element-name">contextProtocol</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> contextProtocol)</span></div> |
| <div class="block">The protocol value to use when creating an SSLContext via |
| SSLContext.getInstance(protocol).</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>contextProtocol</code> - the context protocol to use.</dd> |
| <dt>Returns:</dt> |
| <dd>this options instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="trustAll()"> |
| <h3>trustAll</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">trustAll</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the trustAll</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="trustAll(boolean)"> |
| <h3>trustAll</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></span> <span class="element-name">trustAll</span><wbr><span class="parameters">(boolean trustAll)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>trustAll</code> - the trustAll to set</dd> |
| <dt>Returns:</dt> |
| <dd>this options instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="verifyHost()"> |
| <h3>verifyHost</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">verifyHost</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the verifyHost</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="verifyHost(boolean)"> |
| <h3>verifyHost</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></span> <span class="element-name">verifyHost</span><wbr><span class="parameters">(boolean verifyHost)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>verifyHost</code> - the verifyHost to set</dd> |
| <dt>Returns:</dt> |
| <dd>this options instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="keyAlias()"> |
| <h3>keyAlias</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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></span> <span class="element-name">keyAlias</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the key alias</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="keyAlias(java.lang.String)"> |
| <h3>keyAlias</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></span> <span class="element-name">keyAlias</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> keyAlias)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>keyAlias</code> - the key alias to use</dd> |
| <dt>Returns:</dt> |
| <dd>this options instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="defaultSslPort()"> |
| <h3>defaultSslPort</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">defaultSslPort</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the currently configured default SSL port.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="defaultSslPort(int)"> |
| <h3>defaultSslPort</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></span> <span class="element-name">defaultSslPort</span><wbr><span class="parameters">(int defaultSslPort)</span></div> |
| <div class="block">Sets the default AMQP SSL port that should be used if the user did not provide a port value.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>defaultSslPort</code> - the default AMQP SSL port to use when none provided by the user.</dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SslOptions</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="sslContextOverride()"> |
| <h3>sslContextOverride</h3> |
| <div class="member-signature"><span class="modifiers">public</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">sslContextOverride</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the currently configured <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"><code>SSLContext</code></a> override or null if none set.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="sslContextOverride(javax.net.ssl.SSLContext)"> |
| <h3>sslContextOverride</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></span> <span class="element-name">sslContextOverride</span><wbr><span class="parameters">(<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> sslContextOverride)</span></div> |
| <div class="block">Provides a user configured <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"><code>SSLContext</code></a> that should be used when performing the |
| SSL handshake with the remote.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sslContextOverride</code> - User defined <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"><code>SSLContext</code></a> used for authentication.</dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SslOptions</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="allowNativeSSL()"> |
| <h3>allowNativeSSL</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">allowNativeSSL</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if the an native SSL based encryption layer is allowed to be used instead of the JDK.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="allowNativeSSL(boolean)"> |
| <h3>allowNativeSSL</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></span> <span class="element-name">allowNativeSSL</span><wbr><span class="parameters">(boolean allowNativeSSL)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>allowNativeSSL</code> - Configure if the transport should attempt to use native SSL support if available.</dd> |
| <dt>Returns:</dt> |
| <dd>this options object.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="copyInto(org.apache.qpid.protonj2.client.SslOptions)"> |
| <h3>copyInto</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></span> <span class="element-name">copyInto</span><wbr><span class="parameters">(<a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> other)</span></div> |
| <div class="block">Copy all configuration into the given <a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SslOptions</code></a> from this instance.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>other</code> - another <a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SslOptions</code></a> instance that will receive the configuration from this instance.</dd> |
| <dt>Returns:</dt> |
| <dd>the options instance that was copied into.</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> |