Google Git
Sign in
apache / qpid-site / a52bbf4a24b0bdf923763f81d78481d22102177f / . / input / releases / qpid-protonj2-1.0.0-M9 / api / org / apache / qpid / protonj2 / client / SslOptions.html
blob: dbdc88361908be3f345bf954636a6c3e930ba0df [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>SslOptions (Qpid ProtonJ2 Parent 1.0.0-M9 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SslOptions (Qpid ProtonJ2 Parent 1.0.0-M9 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SslOptions.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.qpid.protonj2.client</a></div>
<h2 title="Class SslOptions" class="title">Class SslOptions</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.qpid.protonj2.client.SslOptions</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<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?is-external=true" title="class or interface in java.lang" class="externalLink">Cloneable</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">SslOptions</span>
extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>
implements <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Cloneable</a></pre>
<div class="block">Options for configuration of the client SSL layer</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_ALLOW_NATIVE_SSL">DEFAULT_ALLOW_NATIVE_SSL</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_CONTEXT_PROTOCOL">DEFAULT_CONTEXT_PROTOCOL</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_DISABLED_PROTOCOLS">DEFAULT_DISABLED_PROTOCOLS</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_SSL_PORT">DEFAULT_SSL_PORT</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_STORE_TYPE">DEFAULT_STORE_TYPE</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_TRUST_ALL">DEFAULT_TRUST_ALL</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_VERIFY_HOST">DEFAULT_VERIFY_HOST</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">SslOptions</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#allowNativeSSL()">allowNativeSSL</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#allowNativeSSL(boolean)">allowNativeSSL</a></span>&#8203;(boolean&nbsp;allowNativeSSL)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clone()">clone</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contextProtocol()">contextProtocol</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contextProtocol(java.lang.String)">contextProtocol</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;contextProtocol)</code></th>
<td class="colLast">
<div class="block">The protocol value to use when creating an SSLContext via
SSLContext.getInstance(protocol).</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected <a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copyInto(org.apache.qpid.protonj2.client.SslOptions)">copyInto</a></span>&#8203;(<a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a>&nbsp;other)</code></th>
<td class="colLast">
<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>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#defaultSslPort()">defaultSslPort</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#defaultSslPort(int)">defaultSslPort</a></span>&#8203;(int&nbsp;defaultSslPort)</code></th>
<td class="colLast">
<div class="block">Sets the default AMQP SSL port that should be used if the user did not provide a port value.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#disabledCipherSuites()">disabledCipherSuites</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#disabledCipherSuites(java.lang.String...)">disabledCipherSuites</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>...&nbsp;disabledCipherSuites)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#disabledProtocols()">disabledProtocols</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#disabledProtocols(java.lang.String...)">disabledProtocols</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>...&nbsp;disabledProtocols)</code></th>
<td class="colLast">
<div class="block">The protocols to be disable.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#enabledCipherSuites()">enabledCipherSuites</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#enabledCipherSuites(java.lang.String...)">enabledCipherSuites</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>...&nbsp;enabledCipherSuites)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#enabledProtocols()">enabledProtocols</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#enabledProtocols(java.lang.String...)">enabledProtocols</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>...&nbsp;enabledProtocols)</code></th>
<td class="colLast">
<div class="block">The protocols to be set as enabled.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#keyAlias()">keyAlias</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#keyAlias(java.lang.String)">keyAlias</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;keyAlias)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#keyStoreLocation()">keyStoreLocation</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#keyStoreLocation(java.lang.String)">keyStoreLocation</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;keyStoreLocation)</code></th>
<td class="colLast">
<div class="block">Sets the location on disk of the key store to use.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#keyStorePassword()">keyStorePassword</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#keyStorePassword(java.lang.String)">keyStorePassword</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;keyStorePassword)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#keyStoreType()">keyStoreType</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#keyStoreType(java.lang.String)">keyStoreType</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;keyStoreType)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/javax/net/ssl/SSLContext.html?is-external=true" title="class or interface in javax.net.ssl" class="externalLink">SSLContext</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sslContextOverride()">sslContextOverride</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sslContextOverride(javax.net.ssl.SSLContext)">sslContextOverride</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/javax/net/ssl/SSLContext.html?is-external=true" title="class or interface in javax.net.ssl" class="externalLink">SSLContext</a>&nbsp;sslContextOverride)</code></th>
<td class="colLast">
<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?is-external=true" title="class or interface in javax.net.ssl" class="externalLink"><code>SSLContext</code></a> that should be used when performing the
SSL handshake with the remote.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sslEnabled()">sslEnabled</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sslEnabled(boolean)">sslEnabled</a></span>&#8203;(boolean&nbsp;enable)</code></th>
<td class="colLast">
<div class="block">Enable or disable the transport level SSL encryption layer.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#storeType(java.lang.String)">storeType</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;storeType)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#trustAll()">trustAll</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#trustAll(boolean)">trustAll</a></span>&#8203;(boolean&nbsp;trustAll)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#trustStoreLocation()">trustStoreLocation</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#trustStoreLocation(java.lang.String)">trustStoreLocation</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;trustStoreLocation)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#trustStorePassword()">trustStorePassword</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#trustStorePassword(java.lang.String)">trustStorePassword</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;trustStorePassword)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#trustStoreType()">trustStoreType</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#trustStoreType(java.lang.String)">trustStoreType</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;trustStoreType)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#verifyHost()">verifyHost</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#verifyHost(boolean)">verifyHost</a></span>&#8203;(boolean&nbsp;verifyHost)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="DEFAULT_STORE_TYPE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_STORE_TYPE</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> DEFAULT_STORE_TYPE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.SslOptions.DEFAULT_STORE_TYPE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_CONTEXT_PROTOCOL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_CONTEXT_PROTOCOL</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> DEFAULT_CONTEXT_PROTOCOL</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.SslOptions.DEFAULT_CONTEXT_PROTOCOL">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_TRUST_ALL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_TRUST_ALL</h4>
<pre>public static final&nbsp;boolean DEFAULT_TRUST_ALL</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.SslOptions.DEFAULT_TRUST_ALL">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_VERIFY_HOST">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_VERIFY_HOST</h4>
<pre>public static final&nbsp;boolean DEFAULT_VERIFY_HOST</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.SslOptions.DEFAULT_VERIFY_HOST">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_DISABLED_PROTOCOLS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_DISABLED_PROTOCOLS</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt; DEFAULT_DISABLED_PROTOCOLS</pre>
</li>
</ul>
<a id="DEFAULT_SSL_PORT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_SSL_PORT</h4>
<pre>public static final&nbsp;int DEFAULT_SSL_PORT</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.SslOptions.DEFAULT_SSL_PORT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_ALLOW_NATIVE_SSL">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_ALLOW_NATIVE_SSL</h4>
<pre>public static final&nbsp;boolean DEFAULT_ALLOW_NATIVE_SSL</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.SslOptions.DEFAULT_ALLOW_NATIVE_SSL">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SslOptions</h4>
<pre>public&nbsp;SslOptions()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="clone()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clone</h4>
<pre class="methodSignature">public&nbsp;<a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a>&nbsp;clone()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd>
</dl>
</li>
</ul>
<a id="sslEnabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sslEnabled</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;sslEnabled()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the client transport will attempt to connect with SSL</dd>
</dl>
</li>
</ul>
<a id="sslEnabled(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sslEnabled</h4>
<pre class="methodSignature">public&nbsp;<a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a>&nbsp;sslEnabled&#8203;(boolean&nbsp;enable)</pre>
<div class="block">Enable or disable the transport level SSL encryption layer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enable</code> - boolean that controls if SSL is enabled or disabled.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SslOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="keyStoreLocation()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keyStoreLocation</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;keyStoreLocation()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the keyStoreLocation currently configured.</dd>
</dl>
</li>
</ul>
<a id="keyStoreLocation(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keyStoreLocation</h4>
<pre class="methodSignature">public&nbsp;<a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a>&nbsp;keyStoreLocation&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;keyStoreLocation)</pre>
<div class="block">Sets the location on disk of the key store to use.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>keyStoreLocation</code> - the keyStoreLocation to use to create the key manager.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this options instance.</dd>
</dl>
</li>
</ul>
<a id="keyStorePassword()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keyStorePassword</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;keyStorePassword()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the keyStorePassword</dd>
</dl>
</li>
</ul>
<a id="keyStorePassword(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keyStorePassword</h4>
<pre class="methodSignature">public&nbsp;<a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a>&nbsp;keyStorePassword&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;keyStorePassword)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>keyStorePassword</code> - the keyStorePassword to set</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this options instance.</dd>
</dl>
</li>
</ul>
<a id="trustStoreLocation()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>trustStoreLocation</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;trustStoreLocation()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the trustStoreLocation</dd>
</dl>
</li>
</ul>
<a id="trustStoreLocation(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>trustStoreLocation</h4>
<pre class="methodSignature">public&nbsp;<a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a>&nbsp;trustStoreLocation&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;trustStoreLocation)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>trustStoreLocation</code> - the trustStoreLocation to set</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this options instance.</dd>
</dl>
</li>
</ul>
<a id="trustStorePassword()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>trustStorePassword</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;trustStorePassword()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the trustStorePassword</dd>
</dl>
</li>
</ul>
<a id="trustStorePassword(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>trustStorePassword</h4>
<pre class="methodSignature">public&nbsp;<a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a>&nbsp;trustStorePassword&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;trustStorePassword)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>trustStorePassword</code> - the trustStorePassword to set</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this options instance.</dd>
</dl>
</li>
</ul>
<a id="storeType(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>storeType</h4>
<pre class="methodSignature">public&nbsp;<a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a>&nbsp;storeType&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;storeType)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>storeType</code> - the format that the store files are encoded in.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this options instance.</dd>
</dl>
</li>
</ul>
<a id="keyStoreType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keyStoreType</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;keyStoreType()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the keyStoreType</dd>
</dl>
</li>
</ul>
<a id="keyStoreType(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keyStoreType</h4>
<pre class="methodSignature">public&nbsp;<a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a>&nbsp;keyStoreType&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;keyStoreType)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>keyStoreType</code> - the format that the keyStore file is encoded in</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this options instance.</dd>
</dl>
</li>
</ul>
<a id="trustStoreType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>trustStoreType</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;trustStoreType()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the trustStoreType</dd>
</dl>
</li>
</ul>
<a id="trustStoreType(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>trustStoreType</h4>
<pre class="methodSignature">public&nbsp;<a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a>&nbsp;trustStoreType&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;trustStoreType)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>trustStoreType</code> - the format that the trustStore file is encoded in</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this options instance.</dd>
</dl>
</li>
</ul>
<a id="enabledCipherSuites()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enabledCipherSuites</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[]&nbsp;enabledCipherSuites()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the enabledCipherSuites</dd>
</dl>
</li>
</ul>
<a id="enabledCipherSuites(java.lang.String...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enabledCipherSuites</h4>
<pre class="methodSignature">public&nbsp;<a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a>&nbsp;enabledCipherSuites&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>...&nbsp;enabledCipherSuites)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enabledCipherSuites</code> - the enabledCipherSuites to set</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this options instance.</dd>
</dl>
</li>
</ul>
<a id="disabledCipherSuites()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disabledCipherSuites</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[]&nbsp;disabledCipherSuites()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the disabledCipherSuites</dd>
</dl>
</li>
</ul>
<a id="disabledCipherSuites(java.lang.String...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disabledCipherSuites</h4>
<pre class="methodSignature">public&nbsp;<a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a>&nbsp;disabledCipherSuites&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>...&nbsp;disabledCipherSuites)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>disabledCipherSuites</code> - the disabledCipherSuites to set</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this options instance.</dd>
</dl>
</li>
</ul>
<a id="enabledProtocols()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enabledProtocols</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[]&nbsp;enabledProtocols()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the enabledProtocols or null if the defaults should be used</dd>
</dl>
</li>
</ul>
<a id="enabledProtocols(java.lang.String...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enabledProtocols</h4>
<pre class="methodSignature">public&nbsp;<a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a>&nbsp;enabledProtocols&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>...&nbsp;enabledProtocols)</pre>
<div class="block">The protocols to be set as enabled.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enabledProtocols</code> - the enabled protocols to set, or null if the defaults should be used.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this options instance.</dd>
</dl>
</li>
</ul>
<a id="disabledProtocols()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disabledProtocols</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[]&nbsp;disabledProtocols()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the protocols to disable or null if none should be</dd>
</dl>
</li>
</ul>
<a id="disabledProtocols(java.lang.String...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disabledProtocols</h4>
<pre class="methodSignature">public&nbsp;<a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a>&nbsp;disabledProtocols&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>...&nbsp;disabledProtocols)</pre>
<div class="block">The protocols to be disable.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>disabledProtocols</code> - the protocols to disable, or null if none should be.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this options instance.</dd>
</dl>
</li>
</ul>
<a id="contextProtocol()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contextProtocol</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;contextProtocol()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the context protocol to use</dd>
</dl>
</li>
</ul>
<a id="contextProtocol(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contextProtocol</h4>
<pre class="methodSignature">public&nbsp;<a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a>&nbsp;contextProtocol&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;contextProtocol)</pre>
<div class="block">The protocol value to use when creating an SSLContext via
SSLContext.getInstance(protocol).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>contextProtocol</code> - the context protocol to use.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this options instance.</dd>
</dl>
</li>
</ul>
<a id="trustAll()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>trustAll</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;trustAll()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the trustAll</dd>
</dl>
</li>
</ul>
<a id="trustAll(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>trustAll</h4>
<pre class="methodSignature">public&nbsp;<a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a>&nbsp;trustAll&#8203;(boolean&nbsp;trustAll)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>trustAll</code> - the trustAll to set</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this options instance.</dd>
</dl>
</li>
</ul>
<a id="verifyHost()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>verifyHost</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;verifyHost()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the verifyHost</dd>
</dl>
</li>
</ul>
<a id="verifyHost(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>verifyHost</h4>
<pre class="methodSignature">public&nbsp;<a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a>&nbsp;verifyHost&#8203;(boolean&nbsp;verifyHost)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>verifyHost</code> - the verifyHost to set</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this options instance.</dd>
</dl>
</li>
</ul>
<a id="keyAlias()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keyAlias</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;keyAlias()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the key alias</dd>
</dl>
</li>
</ul>
<a id="keyAlias(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keyAlias</h4>
<pre class="methodSignature">public&nbsp;<a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a>&nbsp;keyAlias&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;keyAlias)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>keyAlias</code> - the key alias to use</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this options instance.</dd>
</dl>
</li>
</ul>
<a id="defaultSslPort()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultSslPort</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;defaultSslPort()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the currently configured default SSL port.</dd>
</dl>
</li>
</ul>
<a id="defaultSslPort(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultSslPort</h4>
<pre class="methodSignature">public&nbsp;<a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a>&nbsp;defaultSslPort&#8203;(int&nbsp;defaultSslPort)</pre>
<div class="block">Sets the default AMQP SSL port that should be used if the user did not provide a port value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>defaultSslPort</code> - the default AMQP SSL port to use when none provided by the user.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SslOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="sslContextOverride()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sslContextOverride</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/javax/net/ssl/SSLContext.html?is-external=true" title="class or interface in javax.net.ssl" class="externalLink">SSLContext</a>&nbsp;sslContextOverride()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the currently configured <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/javax/net/ssl/SSLContext.html?is-external=true" title="class or interface in javax.net.ssl" class="externalLink"><code>SSLContext</code></a> override or null if none set.</dd>
</dl>
</li>
</ul>
<a id="sslContextOverride(javax.net.ssl.SSLContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sslContextOverride</h4>
<pre class="methodSignature">public&nbsp;<a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a>&nbsp;sslContextOverride&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/javax/net/ssl/SSLContext.html?is-external=true" title="class or interface in javax.net.ssl" class="externalLink">SSLContext</a>&nbsp;sslContextOverride)</pre>
<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?is-external=true" title="class or interface in javax.net.ssl" class="externalLink"><code>SSLContext</code></a> that should be used when performing the
SSL handshake with the remote.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></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?is-external=true" title="class or interface in javax.net.ssl" class="externalLink"><code>SSLContext</code></a> used for authentication.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SslOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="allowNativeSSL()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allowNativeSSL</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;allowNativeSSL()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the an native SSL based encryption layer is allowed to be used instead of the JDK.</dd>
</dl>
</li>
</ul>
<a id="allowNativeSSL(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allowNativeSSL</h4>
<pre class="methodSignature">public&nbsp;<a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a>&nbsp;allowNativeSSL&#8203;(boolean&nbsp;allowNativeSSL)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>allowNativeSSL</code> - Configure if the transport should attempt to use native SSL support if available.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this options object.</dd>
</dl>
</li>
</ul>
<a id="copyInto(org.apache.qpid.protonj2.client.SslOptions)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>copyInto</h4>
<pre class="methodSignature">protected&nbsp;<a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a>&nbsp;copyInto&#8203;(<a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a>&nbsp;other)</pre>
<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>
<dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt>
<dd>the options instance that was copied into.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SslOptions.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>