| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.6) on Fri May 22 12:37:48 EDT 2020 --> |
| <title>SslContextFactory (Jetty :: Project 9.4.29.v20200521 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2020-05-22"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SslContextFactory (Jetty :: Project 9.4.29.v20200521 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":9,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":9,"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":42,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":42,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":10,"i69":10,"i70":10,"i71":10,"i72":10,"i73":10,"i74":10,"i75":42,"i76":10,"i77":10,"i78":10,"i79":10,"i80":10,"i81":10,"i82":10,"i83":10,"i84":10,"i85":10,"i86":10,"i87":10,"i88":10,"i89":10,"i90":10,"i91":10,"i92":10,"i93":10,"i94":10,"i95":10,"i96":10,"i97":10,"i98":10,"i99":10,"i100":10,"i101":10,"i102":10,"i103":10,"i104":10,"i105":10,"i106":42,"i107":10,"i108":10,"i109":10,"i110":10,"i111":10,"i112":10,"i113":10,"i114":10,"i115":10,"i116":10,"i117":10,"i118":10,"i119":10,"i120":10,"i121":10,"i122":10,"i123":10,"i124":10,"i125":10,"i126":10,"i127":10,"i128":10,"i129":42,"i130":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = false; |
| loadScripts(document, 'script');</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/SslContextFactory.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="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </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="subNavList"> |
| <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> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.eclipse.jetty.util.ssl</a></div> |
| <h2 title="Class SslContextFactory" class="title">Class SslContextFactory</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">org.eclipse.jetty.util.component.AbstractLifeCycle</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.jetty.util.ssl.SslContextFactory</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code>, <code><a href="../component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></code></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="SslContextFactory.Client.html" title="class in org.eclipse.jetty.util.ssl">SslContextFactory.Client</a></code>, <code><a href="SslContextFactory.Server.html" title="class in org.eclipse.jetty.util.ssl">SslContextFactory.Server</a></code></dd> |
| </dl> |
| <hr> |
| <pre><a href="../annotation/ManagedObject.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedObject</a> |
| public class <span class="typeNameLabel">SslContextFactory</span> |
| extends <a href="../component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a> |
| implements <a href="../component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></pre> |
| <div class="block"><p>SslContextFactory is used to configure SSL parameters |
| to be used by server and client connectors.</p> |
| <p>Use <a href="SslContextFactory.Server.html" title="class in org.eclipse.jetty.util.ssl"><code>SslContextFactory.Server</code></a> to configure server-side connectors, |
| and <a href="SslContextFactory.Client.html" title="class in org.eclipse.jetty.util.ssl"><code>SslContextFactory.Client</code></a> to configure HTTP or WebSocket clients.</p></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SslContextFactory.Client.html" title="class in org.eclipse.jetty.util.ssl">SslContextFactory.Client</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SslContextFactory.Server.html" title="class in org.eclipse.jetty.util.ssl">SslContextFactory.Server</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SslContextFactory.X509ExtendedKeyManagerWrapper.html" title="class in org.eclipse.jetty.util.ssl">SslContextFactory.X509ExtendedKeyManagerWrapper</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">A wrapper that delegates to another (if not <code>null</code>) X509ExtendedKeyManager.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SslContextFactory.X509ExtendedTrustManagerWrapper.html" title="class in org.eclipse.jetty.util.ssl">SslContextFactory.X509ExtendedTrustManagerWrapper</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">A wrapper that delegates to another (if not <code>null</code>) X509ExtendedTrustManager.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.<a href="../component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3> |
| <code><a href="../component/AbstractLifeCycle.AbstractLifeCycleListener.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle.AbstractLifeCycleListener</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.LifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.<a href="../component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></h3> |
| <code><a href="../component/LifeCycle.Listener.html" title="interface in org.eclipse.jetty.util.component">LifeCycle.Listener</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- =========== 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"> </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 java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_KEYMANAGERFACTORY_ALGORITHM">DEFAULT_KEYMANAGERFACTORY_ALGORITHM</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_TRUSTMANAGERFACTORY_ALGORITHM">DEFAULT_TRUSTMANAGERFACTORY_ALGORITHM</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#KEYPASSWORD_PROPERTY">KEYPASSWORD_PROPERTY</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">String name of key password property.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PASSWORD_PROPERTY">PASSWORD_PROPERTY</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">String name of keystore password property.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static javax.net.ssl.TrustManager[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#TRUST_ALL_CERTS">TRUST_ALL_CERTS</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.eclipse.jetty.util.component.<a href="../component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3> |
| <code><a href="../component/AbstractLifeCycle.html#FAILED">FAILED</a>, <a href="../component/AbstractLifeCycle.html#RUNNING">RUNNING</a>, <a href="../component/AbstractLifeCycle.html#STARTED">STARTED</a>, <a href="../component/AbstractLifeCycle.html#STARTING">STARTING</a>, <a href="../component/AbstractLifeCycle.html#STOPPED">STOPPED</a>, <a href="../component/AbstractLifeCycle.html#STOPPING">STOPPING</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.util.component.Dumpable"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.eclipse.jetty.util.component.<a href="../component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h3> |
| <code><a href="../component/Dumpable.html#KEY">KEY</a></code></li> |
| </ul> |
| </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"> </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()">SslContextFactory</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="SslContextFactory.Client.html#%3Cinit%3E()"><code>Client()</code></a> or <a href="SslContextFactory.Server.html#%3Cinit%3E()"><code>Server()</code></a> instead</div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(boolean)">SslContextFactory</a></span>​(boolean trustAll)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="SslContextFactory.Client.html#%3Cinit%3E(boolean)"><code>Client(boolean)</code></a> instead</div> |
| </div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String)">SslContextFactory</a></span>​(java.lang.String keyStorePath)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#setKeyStorePath(java.lang.String)"><code>setKeyStorePath(String)</code></a> instead</div> |
| </div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addExcludeCipherSuites(java.lang.String...)">addExcludeCipherSuites</a></span>​(java.lang.String... cipher)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addExcludeProtocols(java.lang.String...)">addExcludeProtocols</a></span>​(java.lang.String... protocol)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkCiphers(javax.net.ssl.SSLParameters)">checkCiphers</a></span>​(javax.net.ssl.SSLParameters supported)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkConfiguration()">checkConfiguration</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkEndPointIdentificationAlgorithm()">checkEndPointIdentificationAlgorithm</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkProtocols(javax.net.ssl.SSLParameters)">checkProtocols</a></span>​(javax.net.ssl.SSLParameters supported)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkTrustAll()">checkTrustAll</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#customize(javax.net.ssl.SSLEngine)">customize</a></span>​(javax.net.ssl.SSLEngine sslEngine)</code></th> |
| <td class="colLast"> |
| <div class="block">Customize an SslEngine instance with the configuration of this factory, |
| by calling <a href="#customize(javax.net.ssl.SSLParameters)"><code>customize(SSLParameters)</code></a></div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>javax.net.ssl.SSLParameters</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#customize(javax.net.ssl.SSLParameters)">customize</a></span>​(javax.net.ssl.SSLParameters sslParams)</code></th> |
| <td class="colLast"> |
| <div class="block">Customize an SslParameters instance with the configuration of this factory.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deduceKeyLength(java.lang.String)">deduceKeyLength</a></span>​(java.lang.String cipherSuite)</code></th> |
| <td class="colLast"> |
| <div class="block">Given the name of a TLS/SSL cipher suite, return an int representing it effective stream |
| cipher key strength.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doStart()">doStart</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates the SSLContext object and starts the lifecycle</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doStop()">doStop</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dump()">dump</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dump(java.lang.Appendable,java.lang.String)">dump</a></span>​(java.lang.Appendable out, |
| java.lang.String indent)</code></th> |
| <td class="colLast"> |
| <div class="block">Dump this object (and children) into an Appendable using the provided indent after any new lines.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>java.util.Set<java.lang.String></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAliases()">getAliases</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCertAlias()">getCertAlias</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>static java.security.cert.X509Certificate[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCertChain(javax.net.ssl.SSLSession)">getCertChain</a></span>​(javax.net.ssl.SSLSession sslSession)</code></th> |
| <td class="colLast"> |
| <div class="block">Obtain the X509 Certificate Chain from the provided SSLSession using the |
| default <code>CertificateFactory</code> behaviors</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>protected java.security.cert.CertificateFactory</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCertificateFactoryInstance(java.lang.String)">getCertificateFactoryInstance</a></span>​(java.lang.String type)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>protected java.security.cert.CertStore</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCertStoreInstance(java.util.Collection)">getCertStoreInstance</a></span>​(java.util.Collection<? extends java.security.cert.CRL> crls)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>java.util.Comparator<java.lang.String></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCipherComparator()">getCipherComparator</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCrlPath()">getCrlPath</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEndpointIdentificationAlgorithm()">getEndpointIdentificationAlgorithm</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>java.lang.String[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExcludeCipherSuites()">getExcludeCipherSuites</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExcludeProtocols()">getExcludeProtocols</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>javax.net.ssl.HostnameVerifier</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHostnameVerifier()">getHostnameVerifier</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIncludeCipherSuites()">getIncludeCipherSuites</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>java.lang.String[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIncludeProtocols()">getIncludeProtocols</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getKeyManagerFactoryAlgorithm()">getKeyManagerFactoryAlgorithm</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>protected javax.net.ssl.KeyManagerFactory</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getKeyManagerFactoryInstance()">getKeyManagerFactoryInstance</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>protected javax.net.ssl.KeyManager[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getKeyManagers(java.security.KeyStore)">getKeyManagers</a></span>​(java.security.KeyStore keyStore)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>java.security.KeyStore</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getKeyStore()">getKeyStore</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getKeyStorePath()">getKeyStorePath</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getKeyStoreProvider()">getKeyStoreProvider</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code><a href="../resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getKeyStoreResource()">getKeyStoreResource</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getKeyStoreType()">getKeyStoreType</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxCertPathLength()">getMaxCertPathLength</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNeedClientAuth()">getNeedClientAuth</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="SslContextFactory.Server.html#getNeedClientAuth()"><code>SslContextFactory.Server.getNeedClientAuth()</code></a> instead</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOcspResponderURL()">getOcspResponderURL</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../security/Password.html" title="class in org.eclipse.jetty.util.security">Password</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPassword(java.lang.String)">getPassword</a></span>​(java.lang.String realm)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the password object for the given realm.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>java.security.cert.PKIXCertPathChecker</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPkixCertPathChecker()">getPkixCertPathChecker</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProtocol()">getProtocol</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProvider()">getProvider</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"> |
| Get the optional Security Provider name.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRenegotiationLimit()">getRenegotiationLimit</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSecureRandomAlgorithm()">getSecureRandomAlgorithm</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code>protected java.security.SecureRandom</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSecureRandomInstance()">getSecureRandomInstance</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSelectedCipherSuites()">getSelectedCipherSuites</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code>java.lang.String[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSelectedProtocols()">getSelectedProtocols</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code>javax.net.ssl.SSLContext</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSslContext()">getSslContext</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code>protected javax.net.ssl.SSLContext</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSSLContextInstance()">getSSLContextInstance</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSslSessionCacheSize()">getSslSessionCacheSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get SSL session cache size.</div> |
| </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSslSessionTimeout()">getSslSessionTimeout</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get SSL session timeout.</div> |
| </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTrustManagerFactoryAlgorithm()">getTrustManagerFactoryAlgorithm</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code>protected javax.net.ssl.TrustManagerFactory</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTrustManagerFactoryInstance()">getTrustManagerFactoryInstance</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i53" class="rowColor"> |
| <td class="colFirst"><code>protected javax.net.ssl.TrustManager[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTrustManagers(java.security.KeyStore,java.util.Collection)">getTrustManagers</a></span>​(java.security.KeyStore trustStore, |
| java.util.Collection<? extends java.security.cert.CRL> crls)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i54" class="altColor"> |
| <td class="colFirst"><code>java.security.KeyStore</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTrustStore()">getTrustStore</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTrustStorePath()">getTrustStorePath</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i56" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTrustStoreProvider()">getTrustStoreProvider</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i57" class="rowColor"> |
| <td class="colFirst"><code><a href="../resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTrustStoreResource()">getTrustStoreResource</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i58" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTrustStoreType()">getTrustStoreType</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i59" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWantClientAuth()">getWantClientAuth</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="SslContextFactory.Server.html#getWantClientAuth()"><code>SslContextFactory.Server.getWantClientAuth()</code></a> instead</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i60" class="altColor"> |
| <td class="colFirst"><code><a href="X509.html" title="class in org.eclipse.jetty.util.ssl">X509</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getX509(java.lang.String)">getX509</a></span>​(java.lang.String alias)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i61" class="rowColor"> |
| <td class="colFirst"><code>java.security.cert.X509Certificate[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getX509CertChain(javax.net.ssl.SSLSession)">getX509CertChain</a></span>​(javax.net.ssl.SSLSession sslSession)</code></th> |
| <td class="colLast"> |
| <div class="block">Obtain the X509 Certificate Chain from the provided SSLSession using this |
| SslContextFactory's optional Provider specific <code>CertificateFactory</code>.</div> |
| </td> |
| </tr> |
| <tr id="i62" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEnableCRLDP()">isEnableCRLDP</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i63" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEnableOCSP()">isEnableOCSP</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i64" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRenegotiationAllowed()">isRenegotiationAllowed</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i65" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSessionCachingEnabled()">isSessionCachingEnabled</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i66" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isTrustAll()">isTrustAll</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i67" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isUseCipherSuitesOrder()">isUseCipherSuitesOrder</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i68" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isValidateCerts()">isValidateCerts</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i69" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isValidatePeerCerts()">isValidatePeerCerts</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i70" class="altColor"> |
| <td class="colFirst"><code>protected java.util.Collection<? extends java.security.cert.CRL></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadCRL(java.lang.String)">loadCRL</a></span>​(java.lang.String crlPath)</code></th> |
| <td class="colLast"> |
| <div class="block">Loads certificate revocation list (CRL) from a file.</div> |
| </td> |
| </tr> |
| <tr id="i71" class="rowColor"> |
| <td class="colFirst"><code>protected java.security.KeyStore</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadKeyStore(org.eclipse.jetty.util.resource.Resource)">loadKeyStore</a></span>​(<a href="../resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> resource)</code></th> |
| <td class="colLast"> |
| <div class="block">Override this method to provide alternate way to load a keystore.</div> |
| </td> |
| </tr> |
| <tr id="i72" class="altColor"> |
| <td class="colFirst"><code>protected java.security.KeyStore</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadTrustStore(org.eclipse.jetty.util.resource.Resource)">loadTrustStore</a></span>​(<a href="../resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> resource)</code></th> |
| <td class="colLast"> |
| <div class="block">Override this method to provide alternate way to load a truststore.</div> |
| </td> |
| </tr> |
| <tr id="i73" class="rowColor"> |
| <td class="colFirst"><code><a href="../security/Password.html" title="class in org.eclipse.jetty.util.security">Password</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newPassword(java.lang.String)">newPassword</a></span>​(java.lang.String password)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new Password object.</div> |
| </td> |
| </tr> |
| <tr id="i74" class="altColor"> |
| <td class="colFirst"><code>protected java.security.cert.PKIXBuilderParameters</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newPKIXBuilderParameters(java.security.KeyStore,java.util.Collection)">newPKIXBuilderParameters</a></span>​(java.security.KeyStore trustStore, |
| java.util.Collection<? extends java.security.cert.CRL> crls)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i75" class="rowColor"> |
| <td class="colFirst"><code>protected javax.net.ssl.X509ExtendedKeyManager</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newSniX509ExtendedKeyManager(javax.net.ssl.X509ExtendedKeyManager)">newSniX509ExtendedKeyManager</a></span>​(javax.net.ssl.X509ExtendedKeyManager keyManager)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="SslContextFactory.Server.html#newSniX509ExtendedKeyManager(javax.net.ssl.X509ExtendedKeyManager)"><code>SslContextFactory.Server.newSniX509ExtendedKeyManager(X509ExtendedKeyManager)</code></a> instead</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i76" class="altColor"> |
| <td class="colFirst"><code>javax.net.ssl.SSLEngine</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newSSLEngine()">newSSLEngine</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Factory method for "scratch" <code>SSLEngine</code>s, usually only used for retrieving configuration |
| information such as the application buffer size or the list of protocols/ciphers.</div> |
| </td> |
| </tr> |
| <tr id="i77" class="rowColor"> |
| <td class="colFirst"><code>javax.net.ssl.SSLEngine</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newSSLEngine(java.lang.String,int)">newSSLEngine</a></span>​(java.lang.String host, |
| int port)</code></th> |
| <td class="colLast"> |
| <div class="block">General purpose factory method for creating <code>SSLEngine</code>s, although creation of |
| <code>SSLEngine</code>s on the server-side should prefer <a href="#newSSLEngine(java.net.InetSocketAddress)"><code>newSSLEngine(InetSocketAddress)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i78" class="altColor"> |
| <td class="colFirst"><code>javax.net.ssl.SSLEngine</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newSSLEngine(java.net.InetSocketAddress)">newSSLEngine</a></span>​(java.net.InetSocketAddress address)</code></th> |
| <td class="colLast"> |
| <div class="block">Server-side only factory method for creating <code>SSLEngine</code>s.</div> |
| </td> |
| </tr> |
| <tr id="i79" class="rowColor"> |
| <td class="colFirst"><code>javax.net.ssl.SSLServerSocket</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newSslServerSocket(java.lang.String,int,int)">newSslServerSocket</a></span>​(java.lang.String host, |
| int port, |
| int backlog)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i80" class="altColor"> |
| <td class="colFirst"><code>javax.net.ssl.SSLSocket</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newSslSocket()">newSslSocket</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i81" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#processIncludeCipherSuites(java.lang.String%5B%5D,java.util.List)">processIncludeCipherSuites</a></span>​(java.lang.String[] supportedCipherSuites, |
| java.util.List<java.lang.String> selectedCiphers)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i82" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reload(java.util.function.Consumer)">reload</a></span>​(java.util.function.Consumer<<a href="SslContextFactory.html" title="class in org.eclipse.jetty.util.ssl">SslContextFactory</a>> consumer)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i83" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeExcludedCipherSuites(java.util.List)">removeExcludedCipherSuites</a></span>​(java.util.List<java.lang.String> selectedCiphers)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i84" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selectCipherSuites(java.lang.String%5B%5D,java.lang.String%5B%5D)">selectCipherSuites</a></span>​(java.lang.String[] enabledCipherSuites, |
| java.lang.String[] supportedCipherSuites)</code></th> |
| <td class="colLast"> |
| <div class="block">Select cipher suites to be used by the connector |
| based on configured inclusion and exclusion lists |
| as well as enabled and supported cipher suite lists.</div> |
| </td> |
| </tr> |
| <tr id="i85" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selectProtocols(java.lang.String%5B%5D,java.lang.String%5B%5D)">selectProtocols</a></span>​(java.lang.String[] enabledProtocols, |
| java.lang.String[] supportedProtocols)</code></th> |
| <td class="colLast"> |
| <div class="block">Select protocols to be used by the connector |
| based on configured inclusion and exclusion lists |
| as well as enabled and supported protocols.</div> |
| </td> |
| </tr> |
| <tr id="i86" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCertAlias(java.lang.String)">setCertAlias</a></span>​(java.lang.String certAlias)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the default certificate Alias.</div> |
| </td> |
| </tr> |
| <tr id="i87" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCipherComparator(java.util.Comparator)">setCipherComparator</a></span>​(java.util.Comparator<java.lang.String> cipherComparator)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i88" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCrlPath(java.lang.String)">setCrlPath</a></span>​(java.lang.String crlPath)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i89" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setEnableCRLDP(boolean)">setEnableCRLDP</a></span>​(boolean enableCRLDP)</code></th> |
| <td class="colLast"> |
| <div class="block">Enables CRL Distribution Points Support</div> |
| </td> |
| </tr> |
| <tr id="i90" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setEnableOCSP(boolean)">setEnableOCSP</a></span>​(boolean enableOCSP)</code></th> |
| <td class="colLast"> |
| <div class="block">Enables On-Line Certificate Status Protocol support</div> |
| </td> |
| </tr> |
| <tr id="i91" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setEndpointIdentificationAlgorithm(java.lang.String)">setEndpointIdentificationAlgorithm</a></span>​(java.lang.String endpointIdentificationAlgorithm)</code></th> |
| <td class="colLast"> |
| <div class="block">When set to "HTTPS" hostname verification will be enabled.</div> |
| </td> |
| </tr> |
| <tr id="i92" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExcludeCipherSuites(java.lang.String...)">setExcludeCipherSuites</a></span>​(java.lang.String... cipherSuites)</code></th> |
| <td class="colLast"> |
| <div class="block">You can either use the exact cipher suite name or a a regular expression.</div> |
| </td> |
| </tr> |
| <tr id="i93" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExcludeProtocols(java.lang.String...)">setExcludeProtocols</a></span>​(java.lang.String... protocols)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i94" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setHostnameVerifier(javax.net.ssl.HostnameVerifier)">setHostnameVerifier</a></span>​(javax.net.ssl.HostnameVerifier hostnameVerifier)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets a <code>HostnameVerifier</code> used by a client to verify host names in the server certificate.</div> |
| </td> |
| </tr> |
| <tr id="i95" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIncludeCipherSuites(java.lang.String...)">setIncludeCipherSuites</a></span>​(java.lang.String... cipherSuites)</code></th> |
| <td class="colLast"> |
| <div class="block">You can either use the exact cipher suite name or a a regular expression.</div> |
| </td> |
| </tr> |
| <tr id="i96" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIncludeProtocols(java.lang.String...)">setIncludeProtocols</a></span>​(java.lang.String... protocols)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i97" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setKeyManagerFactoryAlgorithm(java.lang.String)">setKeyManagerFactoryAlgorithm</a></span>​(java.lang.String algorithm)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i98" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setKeyManagerPassword(java.lang.String)">setKeyManagerPassword</a></span>​(java.lang.String password)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i99" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setKeyStore(java.security.KeyStore)">setKeyStore</a></span>​(java.security.KeyStore keyStore)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the key store.</div> |
| </td> |
| </tr> |
| <tr id="i100" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setKeyStorePassword(java.lang.String)">setKeyStorePassword</a></span>​(java.lang.String password)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i101" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setKeyStorePath(java.lang.String)">setKeyStorePath</a></span>​(java.lang.String keyStorePath)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i102" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setKeyStoreProvider(java.lang.String)">setKeyStoreProvider</a></span>​(java.lang.String keyStoreProvider)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i103" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setKeyStoreResource(org.eclipse.jetty.util.resource.Resource)">setKeyStoreResource</a></span>​(<a href="../resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> resource)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the key store resource.</div> |
| </td> |
| </tr> |
| <tr id="i104" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setKeyStoreType(java.lang.String)">setKeyStoreType</a></span>​(java.lang.String keyStoreType)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i105" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMaxCertPathLength(int)">setMaxCertPathLength</a></span>​(int maxCertPathLength)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i106" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setNeedClientAuth(boolean)">setNeedClientAuth</a></span>​(boolean needClientAuth)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="SslContextFactory.Server.html#setNeedClientAuth(boolean)"><code>SslContextFactory.Server.setNeedClientAuth(boolean)</code></a> instead</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i107" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setOcspResponderURL(java.lang.String)">setOcspResponderURL</a></span>​(java.lang.String ocspResponderURL)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the location of the OCSP Responder.</div> |
| </td> |
| </tr> |
| <tr id="i108" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPkixCertPathChecker(java.security.cert.PKIXCertPathChecker)">setPkixCertPathChecker</a></span>​(java.security.cert.PKIXCertPathChecker pkixCertPatchChecker)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i109" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setProtocol(java.lang.String)">setProtocol</a></span>​(java.lang.String protocol)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i110" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setProvider(java.lang.String)">setProvider</a></span>​(java.lang.String provider)</code></th> |
| <td class="colLast"> |
| <div class="block"> |
| Set the optional Security Provider name.</div> |
| </td> |
| </tr> |
| <tr id="i111" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRenegotiationAllowed(boolean)">setRenegotiationAllowed</a></span>​(boolean renegotiationAllowed)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i112" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRenegotiationLimit(int)">setRenegotiationLimit</a></span>​(int renegotiationLimit)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i113" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSecureRandomAlgorithm(java.lang.String)">setSecureRandomAlgorithm</a></span>​(java.lang.String algorithm)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i114" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSessionCachingEnabled(boolean)">setSessionCachingEnabled</a></span>​(boolean enableSessionCaching)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the flag to enable SSL Session caching.</div> |
| </td> |
| </tr> |
| <tr id="i115" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSslContext(javax.net.ssl.SSLContext)">setSslContext</a></span>​(javax.net.ssl.SSLContext sslContext)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i116" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSslSessionCacheSize(int)">setSslSessionCacheSize</a></span>​(int sslSessionCacheSize)</code></th> |
| <td class="colLast"> |
| <div class="block">Set SSL session cache size.</div> |
| </td> |
| </tr> |
| <tr id="i117" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSslSessionTimeout(int)">setSslSessionTimeout</a></span>​(int sslSessionTimeout)</code></th> |
| <td class="colLast"> |
| <div class="block">Set SSL session timeout.</div> |
| </td> |
| </tr> |
| <tr id="i118" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTrustAll(boolean)">setTrustAll</a></span>​(boolean trustAll)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i119" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTrustManagerFactoryAlgorithm(java.lang.String)">setTrustManagerFactoryAlgorithm</a></span>​(java.lang.String algorithm)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i120" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTrustStore(java.security.KeyStore)">setTrustStore</a></span>​(java.security.KeyStore trustStore)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the trust store.</div> |
| </td> |
| </tr> |
| <tr id="i121" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTrustStorePassword(java.lang.String)">setTrustStorePassword</a></span>​(java.lang.String password)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i122" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTrustStorePath(java.lang.String)">setTrustStorePath</a></span>​(java.lang.String trustStorePath)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i123" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTrustStoreProvider(java.lang.String)">setTrustStoreProvider</a></span>​(java.lang.String trustStoreProvider)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i124" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTrustStoreResource(org.eclipse.jetty.util.resource.Resource)">setTrustStoreResource</a></span>​(<a href="../resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> resource)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the trust store resource.</div> |
| </td> |
| </tr> |
| <tr id="i125" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTrustStoreType(java.lang.String)">setTrustStoreType</a></span>​(java.lang.String trustStoreType)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i126" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setUseCipherSuitesOrder(boolean)">setUseCipherSuitesOrder</a></span>​(boolean useCipherSuitesOrder)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i127" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setValidateCerts(boolean)">setValidateCerts</a></span>​(boolean validateCerts)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i128" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setValidatePeerCerts(boolean)">setValidatePeerCerts</a></span>​(boolean validatePeerCerts)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i129" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setWantClientAuth(boolean)">setWantClientAuth</a></span>​(boolean wantClientAuth)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="SslContextFactory.Server.html#setWantClientAuth(boolean)"><code>SslContextFactory.Server.setWantClientAuth(boolean)</code></a> instead</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i130" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.jetty.util.component.<a href="../component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3> |
| <code><a href="../component/AbstractLifeCycle.html#addLifeCycleListener(org.eclipse.jetty.util.component.LifeCycle.Listener)">addLifeCycleListener</a>, <a href="../component/AbstractLifeCycle.html#getState()">getState</a>, <a href="../component/AbstractLifeCycle.html#getState(org.eclipse.jetty.util.component.LifeCycle)">getState</a>, <a href="../component/AbstractLifeCycle.html#getStopTimeout()">getStopTimeout</a>, <a href="../component/AbstractLifeCycle.html#isFailed()">isFailed</a>, <a href="../component/AbstractLifeCycle.html#isRunning()">isRunning</a>, <a href="../component/AbstractLifeCycle.html#isStarted()">isStarted</a>, <a href="../component/AbstractLifeCycle.html#isStarting()">isStarting</a>, <a href="../component/AbstractLifeCycle.html#isStopped()">isStopped</a>, <a href="../component/AbstractLifeCycle.html#isStopping()">isStopping</a>, <a href="../component/AbstractLifeCycle.html#removeLifeCycleListener(org.eclipse.jetty.util.component.LifeCycle.Listener)">removeLifeCycleListener</a>, <a href="../component/AbstractLifeCycle.html#setStopTimeout(long)">setStopTimeout</a>, <a href="../component/AbstractLifeCycle.html#start()">start</a>, <a href="../component/AbstractLifeCycle.html#stop()">stop</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.Dumpable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.jetty.util.component.<a href="../component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h3> |
| <code><a href="../component/Dumpable.html#dumpSelf()">dumpSelf</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="TRUST_ALL_CERTS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TRUST_ALL_CERTS</h4> |
| <pre>public static final javax.net.ssl.TrustManager[] TRUST_ALL_CERTS</pre> |
| </li> |
| </ul> |
| <a id="DEFAULT_KEYMANAGERFACTORY_ALGORITHM"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_KEYMANAGERFACTORY_ALGORITHM</h4> |
| <pre>public static final java.lang.String DEFAULT_KEYMANAGERFACTORY_ALGORITHM</pre> |
| </li> |
| </ul> |
| <a id="DEFAULT_TRUSTMANAGERFACTORY_ALGORITHM"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_TRUSTMANAGERFACTORY_ALGORITHM</h4> |
| <pre>public static final java.lang.String DEFAULT_TRUSTMANAGERFACTORY_ALGORITHM</pre> |
| </li> |
| </ul> |
| <a id="KEYPASSWORD_PROPERTY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>KEYPASSWORD_PROPERTY</h4> |
| <pre>public static final java.lang.String KEYPASSWORD_PROPERTY</pre> |
| <div class="block">String name of key password property.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.jetty.util.ssl.SslContextFactory.KEYPASSWORD_PROPERTY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="PASSWORD_PROPERTY"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>PASSWORD_PROPERTY</h4> |
| <pre>public static final java.lang.String PASSWORD_PROPERTY</pre> |
| <div class="block">String name of keystore password property.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.jetty.util.ssl.SslContextFactory.PASSWORD_PROPERTY">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="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SslContextFactory</h4> |
| <pre>@Deprecated |
| public SslContextFactory()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="SslContextFactory.Client.html#%3Cinit%3E()"><code>Client()</code></a> or <a href="SslContextFactory.Server.html#%3Cinit%3E()"><code>Server()</code></a> instead</div> |
| </div> |
| <div class="block">Construct an instance of SslContextFactory with the default configuration.</div> |
| </li> |
| </ul> |
| <a id="<init>(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SslContextFactory</h4> |
| <pre>@Deprecated |
| public SslContextFactory​(boolean trustAll)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="SslContextFactory.Client.html#%3Cinit%3E(boolean)"><code>Client(boolean)</code></a> instead</div> |
| </div> |
| <div class="block">Construct an instance of SslContextFactory |
| Default constructor for use in XmlConfiguration files</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>trustAll</code> - whether to blindly trust all certificates</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#setTrustAll(boolean)"><code>setTrustAll(boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SslContextFactory</h4> |
| <pre>@Deprecated |
| public SslContextFactory​(java.lang.String keyStorePath)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#setKeyStorePath(java.lang.String)"><code>setKeyStorePath(String)</code></a> instead</div> |
| </div> |
| <div class="block">Construct an instance of SslContextFactory</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>keyStorePath</code> - default keystore location</dd> |
| </dl> |
| </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="doStart()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doStart</h4> |
| <pre class="methodSignature">protected void doStart() |
| throws java.lang.Exception</pre> |
| <div class="block">Creates the SSLContext object and starts the lifecycle</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../component/AbstractLifeCycle.html#doStart()">doStart</a></code> in class <code><a href="../component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="checkConfiguration()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkConfiguration</h4> |
| <pre class="methodSignature">protected void checkConfiguration()</pre> |
| </li> |
| </ul> |
| <a id="checkTrustAll()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkTrustAll</h4> |
| <pre class="methodSignature">protected void checkTrustAll()</pre> |
| </li> |
| </ul> |
| <a id="checkEndPointIdentificationAlgorithm()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkEndPointIdentificationAlgorithm</h4> |
| <pre class="methodSignature">protected void checkEndPointIdentificationAlgorithm()</pre> |
| </li> |
| </ul> |
| <a id="checkProtocols(javax.net.ssl.SSLParameters)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkProtocols</h4> |
| <pre class="methodSignature">protected void checkProtocols​(javax.net.ssl.SSLParameters supported)</pre> |
| </li> |
| </ul> |
| <a id="checkCiphers(javax.net.ssl.SSLParameters)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkCiphers</h4> |
| <pre class="methodSignature">protected void checkCiphers​(javax.net.ssl.SSLParameters supported)</pre> |
| </li> |
| </ul> |
| <a id="dump()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dump</h4> |
| <pre class="methodSignature">public java.lang.String dump()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../component/Dumpable.html#dump()">dump</a></code> in interface <code><a href="../component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="dump(java.lang.Appendable,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dump</h4> |
| <pre class="methodSignature">public void dump​(java.lang.Appendable out, |
| java.lang.String indent) |
| throws java.io.IOException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../component/Dumpable.html#dump(java.lang.Appendable,java.lang.String)">Dumpable</a></code></span></div> |
| <div class="block">Dump this object (and children) into an Appendable using the provided indent after any new lines. |
| The indent should not be applied to the first object dumped.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../component/Dumpable.html#dump(java.lang.Appendable,java.lang.String)">dump</a></code> in interface <code><a href="../component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>out</code> - The appendable to dump to</dd> |
| <dd><code>indent</code> - The indent to apply after any new lines.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if unable to write to Appendable</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="doStop()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doStop</h4> |
| <pre class="methodSignature">protected void doStop() |
| throws java.lang.Exception</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../component/AbstractLifeCycle.html#doStop()">doStop</a></code> in class <code><a href="../component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSelectedProtocols()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSelectedProtocols</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>(<a href="../annotation/ManagedAttribute.html#value()">value</a>="The selected TLS protocol versions", |
| <a href="../annotation/ManagedAttribute.html#readonly()">readonly</a>=true) |
| public java.lang.String[] getSelectedProtocols()</pre> |
| </li> |
| </ul> |
| <a id="getSelectedCipherSuites()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSelectedCipherSuites</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>(<a href="../annotation/ManagedAttribute.html#value()">value</a>="The selected cipher suites", |
| <a href="../annotation/ManagedAttribute.html#readonly()">readonly</a>=true) |
| public java.lang.String[] getSelectedCipherSuites()</pre> |
| </li> |
| </ul> |
| <a id="getCipherComparator()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCipherComparator</h4> |
| <pre class="methodSignature">public java.util.Comparator<java.lang.String> getCipherComparator()</pre> |
| </li> |
| </ul> |
| <a id="setCipherComparator(java.util.Comparator)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCipherComparator</h4> |
| <pre class="methodSignature">public void setCipherComparator​(java.util.Comparator<java.lang.String> cipherComparator)</pre> |
| </li> |
| </ul> |
| <a id="getAliases()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAliases</h4> |
| <pre class="methodSignature">public java.util.Set<java.lang.String> getAliases()</pre> |
| </li> |
| </ul> |
| <a id="getX509(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getX509</h4> |
| <pre class="methodSignature">public <a href="X509.html" title="class in org.eclipse.jetty.util.ssl">X509</a> getX509​(java.lang.String alias)</pre> |
| </li> |
| </ul> |
| <a id="getExcludeProtocols()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExcludeProtocols</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("The excluded TLS protocols") |
| public java.lang.String[] getExcludeProtocols()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The array of protocol names to exclude from |
| <code>SSLEngine.setEnabledProtocols(String[])</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setExcludeProtocols(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExcludeProtocols</h4> |
| <pre class="methodSignature">public void setExcludeProtocols​(java.lang.String... protocols)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>protocols</code> - The array of protocol names to exclude from |
| <code>SSLEngine.setEnabledProtocols(String[])</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addExcludeProtocols(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addExcludeProtocols</h4> |
| <pre class="methodSignature">public void addExcludeProtocols​(java.lang.String... protocol)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>protocol</code> - Protocol names to add to <code>SSLEngine.setEnabledProtocols(String[])</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getIncludeProtocols()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIncludeProtocols</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("The included TLS protocols") |
| public java.lang.String[] getIncludeProtocols()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The array of protocol names to include in |
| <code>SSLEngine.setEnabledProtocols(String[])</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setIncludeProtocols(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIncludeProtocols</h4> |
| <pre class="methodSignature">public void setIncludeProtocols​(java.lang.String... protocols)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>protocols</code> - The array of protocol names to include in |
| <code>SSLEngine.setEnabledProtocols(String[])</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getExcludeCipherSuites()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExcludeCipherSuites</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("The excluded cipher suites") |
| public java.lang.String[] getExcludeCipherSuites()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The array of cipher suite names to exclude from |
| <code>SSLEngine.setEnabledCipherSuites(String[])</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setExcludeCipherSuites(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExcludeCipherSuites</h4> |
| <pre class="methodSignature">public void setExcludeCipherSuites​(java.lang.String... cipherSuites)</pre> |
| <div class="block">You can either use the exact cipher suite name or a a regular expression.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cipherSuites</code> - The array of cipher suite names to exclude from |
| <code>SSLEngine.setEnabledCipherSuites(String[])</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addExcludeCipherSuites(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addExcludeCipherSuites</h4> |
| <pre class="methodSignature">public void addExcludeCipherSuites​(java.lang.String... cipher)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cipher</code> - Cipher names to add to <code>SSLEngine.setEnabledCipherSuites(String[])</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getIncludeCipherSuites()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIncludeCipherSuites</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("The included cipher suites") |
| public java.lang.String[] getIncludeCipherSuites()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The array of cipher suite names to include in |
| <code>SSLEngine.setEnabledCipherSuites(String[])</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setIncludeCipherSuites(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIncludeCipherSuites</h4> |
| <pre class="methodSignature">public void setIncludeCipherSuites​(java.lang.String... cipherSuites)</pre> |
| <div class="block">You can either use the exact cipher suite name or a a regular expression.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cipherSuites</code> - The array of cipher suite names to include in |
| <code>SSLEngine.setEnabledCipherSuites(String[])</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isUseCipherSuitesOrder()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isUseCipherSuitesOrder</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("Whether to respect the cipher suites order") |
| public boolean isUseCipherSuitesOrder()</pre> |
| </li> |
| </ul> |
| <a id="setUseCipherSuitesOrder(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUseCipherSuitesOrder</h4> |
| <pre class="methodSignature">public void setUseCipherSuitesOrder​(boolean useCipherSuitesOrder)</pre> |
| </li> |
| </ul> |
| <a id="getKeyStorePath()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getKeyStorePath</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("The keyStore path") |
| public java.lang.String getKeyStorePath()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The file or URL of the SSL Key store.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setKeyStorePath(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setKeyStorePath</h4> |
| <pre class="methodSignature">public void setKeyStorePath​(java.lang.String keyStorePath)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>keyStorePath</code> - The file or URL of the SSL Key store.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getKeyStoreProvider()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getKeyStoreProvider</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("The keyStore provider name") |
| public java.lang.String getKeyStoreProvider()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The provider of the key store</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setKeyStoreProvider(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setKeyStoreProvider</h4> |
| <pre class="methodSignature">public void setKeyStoreProvider​(java.lang.String keyStoreProvider)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>keyStoreProvider</code> - The provider of the key store</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getKeyStoreType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getKeyStoreType</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("The keyStore type") |
| public java.lang.String getKeyStoreType()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The type of the key store (default "JKS")</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setKeyStoreType(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setKeyStoreType</h4> |
| <pre class="methodSignature">public void setKeyStoreType​(java.lang.String keyStoreType)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>keyStoreType</code> - The type of the key store (default "JKS")</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCertAlias()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCertAlias</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("The certificate alias") |
| public java.lang.String getCertAlias()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Alias of SSL certificate for the connector</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setCertAlias(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCertAlias</h4> |
| <pre class="methodSignature">public void setCertAlias​(java.lang.String certAlias)</pre> |
| <div class="block">Set the default certificate Alias. |
| <p>This can be used if there are multiple non-SNI certificates |
| to specify the certificate that should be used, or with SNI |
| certificates to set a certificate to try if no others match |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>certAlias</code> - Alias of SSL certificate for the connector</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTrustStorePath()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTrustStorePath</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("The trustStore path") |
| public java.lang.String getTrustStorePath()</pre> |
| </li> |
| </ul> |
| <a id="setTrustStorePath(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTrustStorePath</h4> |
| <pre class="methodSignature">public void setTrustStorePath​(java.lang.String trustStorePath)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>trustStorePath</code> - The file name or URL of the trust store location</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTrustStoreProvider()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTrustStoreProvider</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("The trustStore provider name") |
| public java.lang.String getTrustStoreProvider()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The provider of the trust store</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setTrustStoreProvider(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTrustStoreProvider</h4> |
| <pre class="methodSignature">public void setTrustStoreProvider​(java.lang.String trustStoreProvider)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>trustStoreProvider</code> - The provider of the trust store</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTrustStoreType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTrustStoreType</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("The trustStore type") |
| public java.lang.String getTrustStoreType()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The type of the trust store</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setTrustStoreType(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTrustStoreType</h4> |
| <pre class="methodSignature">public void setTrustStoreType​(java.lang.String trustStoreType)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>trustStoreType</code> - The type of the trust store</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getNeedClientAuth()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNeedClientAuth</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("Whether client authentication is needed") |
| @Deprecated |
| public boolean getNeedClientAuth()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="SslContextFactory.Server.html#getNeedClientAuth()"><code>SslContextFactory.Server.getNeedClientAuth()</code></a> instead</div> |
| </div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if SSL needs client authentication.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>SSLEngine.getNeedClientAuth()</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setNeedClientAuth(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNeedClientAuth</h4> |
| <pre class="methodSignature">@Deprecated |
| public void setNeedClientAuth​(boolean needClientAuth)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="SslContextFactory.Server.html#setNeedClientAuth(boolean)"><code>SslContextFactory.Server.setNeedClientAuth(boolean)</code></a> instead</div> |
| </div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>needClientAuth</code> - True if SSL needs client authentication.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>SSLEngine.getNeedClientAuth()</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getWantClientAuth()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWantClientAuth</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("Whether client authentication is wanted") |
| @Deprecated |
| public boolean getWantClientAuth()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="SslContextFactory.Server.html#getWantClientAuth()"><code>SslContextFactory.Server.getWantClientAuth()</code></a> instead</div> |
| </div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if SSL wants client authentication.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>SSLEngine.getWantClientAuth()</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setWantClientAuth(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setWantClientAuth</h4> |
| <pre class="methodSignature">@Deprecated |
| public void setWantClientAuth​(boolean wantClientAuth)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="SslContextFactory.Server.html#setWantClientAuth(boolean)"><code>SslContextFactory.Server.setWantClientAuth(boolean)</code></a> instead</div> |
| </div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>wantClientAuth</code> - True if SSL wants client authentication.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>SSLEngine.getWantClientAuth()</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isValidateCerts()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isValidateCerts</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("Whether certificates are validated") |
| public boolean isValidateCerts()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if SSL certificate has to be validated</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setValidateCerts(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValidateCerts</h4> |
| <pre class="methodSignature">public void setValidateCerts​(boolean validateCerts)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>validateCerts</code> - true if SSL certificates have to be validated</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isValidatePeerCerts()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isValidatePeerCerts</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("Whether peer certificates are validated") |
| public boolean isValidatePeerCerts()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if SSL certificates of the peer have to be validated</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setValidatePeerCerts(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValidatePeerCerts</h4> |
| <pre class="methodSignature">public void setValidatePeerCerts​(boolean validatePeerCerts)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>validatePeerCerts</code> - true if SSL certificates of the peer have to be validated</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setKeyStorePassword(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setKeyStorePassword</h4> |
| <pre class="methodSignature">public void setKeyStorePassword​(java.lang.String password)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>password</code> - The password for the key store. If null is passed and |
| a keystore is set, then |
| the <a href="#getPassword(java.lang.String)"><code>getPassword(String)</code></a> is used to |
| obtain a password either from the <a href="#PASSWORD_PROPERTY">"org.eclipse.jetty.ssl.password"</a> |
| system property or by prompting for manual entry.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setKeyManagerPassword(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setKeyManagerPassword</h4> |
| <pre class="methodSignature">public void setKeyManagerPassword​(java.lang.String password)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>password</code> - The password (if any) for the specific key within the key store. |
| If null is passed and the <a href="#KEYPASSWORD_PROPERTY">"org.eclipse.jetty.ssl.keypassword"</a> system property is set, |
| then the <a href="#getPassword(java.lang.String)"><code>getPassword(String)</code></a> is used to |
| obtain a password from the <a href="#KEYPASSWORD_PROPERTY">"org.eclipse.jetty.ssl.keypassword"</a> system property.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setTrustStorePassword(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTrustStorePassword</h4> |
| <pre class="methodSignature">public void setTrustStorePassword​(java.lang.String password)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>password</code> - The password for the truststore. If null is passed and a truststore is set |
| that is different from the keystore, then |
| the <a href="#getPassword(java.lang.String)"><code>getPassword(String)</code></a> is used to |
| obtain a password either from the <a href="#PASSWORD_PROPERTY">"org.eclipse.jetty.ssl.password"</a> |
| system property or by prompting for manual entry.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getProvider()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProvider</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("The provider name") |
| public java.lang.String getProvider()</pre> |
| <div class="block"><p> |
| Get the optional Security Provider name. |
| </p> |
| <p> |
| Security Provider name used with: |
| </p> |
| <ul> |
| <li><code>SecureRandom.getInstance(String, String)</code></li> |
| <li><code>SSLContext.getInstance(String, String)</code></li> |
| <li><code>TrustManagerFactory.getInstance(String, String)</code></li> |
| <li><code>KeyManagerFactory.getInstance(String, String)</code></li> |
| <li><code>CertStore.getInstance(String, CertStoreParameters, String)</code></li> |
| <li><code>CertificateFactory.getInstance(String, String)</code></li> |
| </ul></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The optional Security Provider name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setProvider(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProvider</h4> |
| <pre class="methodSignature">public void setProvider​(java.lang.String provider)</pre> |
| <div class="block"><p> |
| Set the optional Security Provider name. |
| </p> |
| <p> |
| Security Provider name used with: |
| </p> |
| <ul> |
| <li><code>SecureRandom.getInstance(String, String)</code></li> |
| <li><code>SSLContext.getInstance(String, String)</code></li> |
| <li><code>TrustManagerFactory.getInstance(String, String)</code></li> |
| <li><code>KeyManagerFactory.getInstance(String, String)</code></li> |
| <li><code>CertStore.getInstance(String, CertStoreParameters, String)</code></li> |
| <li><code>CertificateFactory.getInstance(String, String)</code></li> |
| </ul></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>provider</code> - The optional Security Provider name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getProtocol()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProtocol</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("The TLS protocol") |
| public java.lang.String getProtocol()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The SSL protocol (default "TLS") passed to |
| <code>SSLContext.getInstance(String, String)</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setProtocol(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProtocol</h4> |
| <pre class="methodSignature">public void setProtocol​(java.lang.String protocol)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>protocol</code> - The SSL protocol (default "TLS") passed to |
| <code>SSLContext.getInstance(String, String)</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSecureRandomAlgorithm()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSecureRandomAlgorithm</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("The SecureRandom algorithm") |
| public java.lang.String getSecureRandomAlgorithm()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The algorithm name, which if set is passed to |
| <code>SecureRandom.getInstance(String)</code> to obtain the <code>SecureRandom</code> instance passed to |
| <code>SSLContext.init(javax.net.ssl.KeyManager[], javax.net.ssl.TrustManager[], SecureRandom)</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSecureRandomAlgorithm(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSecureRandomAlgorithm</h4> |
| <pre class="methodSignature">public void setSecureRandomAlgorithm​(java.lang.String algorithm)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>algorithm</code> - The algorithm name, which if set is passed to |
| <code>SecureRandom.getInstance(String)</code> to obtain the <code>SecureRandom</code> instance passed to |
| <code>SSLContext.init(javax.net.ssl.KeyManager[], javax.net.ssl.TrustManager[], SecureRandom)</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getKeyManagerFactoryAlgorithm()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getKeyManagerFactoryAlgorithm</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("The KeyManagerFactory algorithm") |
| public java.lang.String getKeyManagerFactoryAlgorithm()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The algorithm name (default "SunX509") used by the <code>KeyManagerFactory</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setKeyManagerFactoryAlgorithm(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setKeyManagerFactoryAlgorithm</h4> |
| <pre class="methodSignature">public void setKeyManagerFactoryAlgorithm​(java.lang.String algorithm)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>algorithm</code> - The algorithm name (default "SunX509") used by the <code>KeyManagerFactory</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTrustManagerFactoryAlgorithm()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTrustManagerFactoryAlgorithm</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("The TrustManagerFactory algorithm") |
| public java.lang.String getTrustManagerFactoryAlgorithm()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The algorithm name (default "SunX509") used by the <code>TrustManagerFactory</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isTrustAll()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isTrustAll</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("Whether certificates should be trusted even if they are invalid") |
| public boolean isTrustAll()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if all certificates should be trusted if there is no KeyStore or TrustStore</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setTrustAll(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTrustAll</h4> |
| <pre class="methodSignature">public void setTrustAll​(boolean trustAll)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>trustAll</code> - True if all certificates should be trusted if there is no KeyStore or TrustStore</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setTrustManagerFactoryAlgorithm(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTrustManagerFactoryAlgorithm</h4> |
| <pre class="methodSignature">public void setTrustManagerFactoryAlgorithm​(java.lang.String algorithm)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>algorithm</code> - The algorithm name (default "SunX509") used by the <code>TrustManagerFactory</code> |
| Use the string "TrustAll" to install a trust manager that trusts all.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isRenegotiationAllowed()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRenegotiationAllowed</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("Whether renegotiation is allowed") |
| public boolean isRenegotiationAllowed()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether TLS renegotiation is allowed (true by default)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setRenegotiationAllowed(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRenegotiationAllowed</h4> |
| <pre class="methodSignature">public void setRenegotiationAllowed​(boolean renegotiationAllowed)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>renegotiationAllowed</code> - whether TLS renegotiation is allowed</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRenegotiationLimit()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRenegotiationLimit</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("The max number of renegotiations allowed") |
| public int getRenegotiationLimit()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The number of renegotiations allowed for this connection. When the limit |
| is 0 renegotiation will be denied. If the limit is less than 0 then no limit is applied.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setRenegotiationLimit(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRenegotiationLimit</h4> |
| <pre class="methodSignature">public void setRenegotiationLimit​(int renegotiationLimit)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>renegotiationLimit</code> - The number of renegotions allowed for this connection. |
| When the limit is 0 renegotiation will be denied. If the limit is less than 0 then no limit is applied. |
| Default 5.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCrlPath()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCrlPath</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("The path to the certificate revocation list file") |
| public java.lang.String getCrlPath()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Path to file that contains Certificate Revocation List</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setCrlPath(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCrlPath</h4> |
| <pre class="methodSignature">public void setCrlPath​(java.lang.String crlPath)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>crlPath</code> - Path to file that contains Certificate Revocation List</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMaxCertPathLength()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxCertPathLength</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("The maximum number of intermediate certificates") |
| public int getMaxCertPathLength()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Maximum number of intermediate certificates in |
| the certification path (-1 for unlimited)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setMaxCertPathLength(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxCertPathLength</h4> |
| <pre class="methodSignature">public void setMaxCertPathLength​(int maxCertPathLength)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maxCertPathLength</code> - maximum number of intermediate certificates in |
| the certification path (-1 for unlimited)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSslContext()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSslContext</h4> |
| <pre class="methodSignature">public javax.net.ssl.SSLContext getSslContext()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The SSLContext</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSslContext(javax.net.ssl.SSLContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSslContext</h4> |
| <pre class="methodSignature">public void setSslContext​(javax.net.ssl.SSLContext sslContext)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sslContext</code> - Set a preconfigured SSLContext</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getEndpointIdentificationAlgorithm()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEndpointIdentificationAlgorithm</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("The endpoint identification algorithm") |
| public java.lang.String getEndpointIdentificationAlgorithm()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the endpoint identification algorithm</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setEndpointIdentificationAlgorithm(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEndpointIdentificationAlgorithm</h4> |
| <pre class="methodSignature">public void setEndpointIdentificationAlgorithm​(java.lang.String endpointIdentificationAlgorithm)</pre> |
| <div class="block">When set to "HTTPS" hostname verification will be enabled. |
| Deployments can be vulnerable to a man-in-the-middle attack if a EndpointIndentificationAlgorithm |
| is not set.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>endpointIdentificationAlgorithm</code> - Set the endpointIdentificationAlgorithm</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#setHostnameVerifier(javax.net.ssl.HostnameVerifier)"><code>setHostnameVerifier(HostnameVerifier)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPkixCertPathChecker()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPkixCertPathChecker</h4> |
| <pre class="methodSignature">public java.security.cert.PKIXCertPathChecker getPkixCertPathChecker()</pre> |
| </li> |
| </ul> |
| <a id="setPkixCertPathChecker(java.security.cert.PKIXCertPathChecker)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPkixCertPathChecker</h4> |
| <pre class="methodSignature">public void setPkixCertPathChecker​(java.security.cert.PKIXCertPathChecker pkixCertPatchChecker)</pre> |
| </li> |
| </ul> |
| <a id="loadKeyStore(org.eclipse.jetty.util.resource.Resource)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadKeyStore</h4> |
| <pre class="methodSignature">protected java.security.KeyStore loadKeyStore​(<a href="../resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> resource) |
| throws java.lang.Exception</pre> |
| <div class="block">Override this method to provide alternate way to load a keystore.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resource</code> - the resource to load the keystore from</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the key store instance</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code> - if the keystore cannot be loaded</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="loadTrustStore(org.eclipse.jetty.util.resource.Resource)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadTrustStore</h4> |
| <pre class="methodSignature">protected java.security.KeyStore loadTrustStore​(<a href="../resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> resource) |
| throws java.lang.Exception</pre> |
| <div class="block">Override this method to provide alternate way to load a truststore.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resource</code> - the resource to load the truststore from</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the key store instance</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code> - if the truststore cannot be loaded</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="loadCRL(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadCRL</h4> |
| <pre class="methodSignature">protected java.util.Collection<? extends java.security.cert.CRL> loadCRL​(java.lang.String crlPath) |
| throws java.lang.Exception</pre> |
| <div class="block">Loads certificate revocation list (CRL) from a file. |
| <p> |
| Required for integrations to be able to override the mechanism used to |
| load CRL in order to provide their own implementation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>crlPath</code> - path of certificate revocation list file</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Collection of CRL's</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code> - if the certificate revocation list cannot be loaded</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getKeyManagers(java.security.KeyStore)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getKeyManagers</h4> |
| <pre class="methodSignature">protected javax.net.ssl.KeyManager[] getKeyManagers​(java.security.KeyStore keyStore) |
| throws java.lang.Exception</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newSniX509ExtendedKeyManager(javax.net.ssl.X509ExtendedKeyManager)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newSniX509ExtendedKeyManager</h4> |
| <pre class="methodSignature">@Deprecated |
| protected javax.net.ssl.X509ExtendedKeyManager newSniX509ExtendedKeyManager​(javax.net.ssl.X509ExtendedKeyManager keyManager)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="SslContextFactory.Server.html#newSniX509ExtendedKeyManager(javax.net.ssl.X509ExtendedKeyManager)"><code>SslContextFactory.Server.newSniX509ExtendedKeyManager(X509ExtendedKeyManager)</code></a> instead</div> |
| </div> |
| </li> |
| </ul> |
| <a id="getTrustManagers(java.security.KeyStore,java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTrustManagers</h4> |
| <pre class="methodSignature">protected javax.net.ssl.TrustManager[] getTrustManagers​(java.security.KeyStore trustStore, |
| java.util.Collection<? extends java.security.cert.CRL> crls) |
| throws java.lang.Exception</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newPKIXBuilderParameters(java.security.KeyStore,java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newPKIXBuilderParameters</h4> |
| <pre class="methodSignature">protected java.security.cert.PKIXBuilderParameters newPKIXBuilderParameters​(java.security.KeyStore trustStore, |
| java.util.Collection<? extends java.security.cert.CRL> crls) |
| throws java.lang.Exception</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="selectProtocols(java.lang.String[],java.lang.String[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>selectProtocols</h4> |
| <pre class="methodSignature">public void selectProtocols​(java.lang.String[] enabledProtocols, |
| java.lang.String[] supportedProtocols)</pre> |
| <div class="block">Select protocols to be used by the connector |
| based on configured inclusion and exclusion lists |
| as well as enabled and supported protocols.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>enabledProtocols</code> - Array of enabled protocols</dd> |
| <dd><code>supportedProtocols</code> - Array of supported protocols</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="selectCipherSuites(java.lang.String[],java.lang.String[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>selectCipherSuites</h4> |
| <pre class="methodSignature">protected void selectCipherSuites​(java.lang.String[] enabledCipherSuites, |
| java.lang.String[] supportedCipherSuites)</pre> |
| <div class="block">Select cipher suites to be used by the connector |
| based on configured inclusion and exclusion lists |
| as well as enabled and supported cipher suite lists.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>enabledCipherSuites</code> - Array of enabled cipher suites</dd> |
| <dd><code>supportedCipherSuites</code> - Array of supported cipher suites</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="processIncludeCipherSuites(java.lang.String[],java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>processIncludeCipherSuites</h4> |
| <pre class="methodSignature">protected void processIncludeCipherSuites​(java.lang.String[] supportedCipherSuites, |
| java.util.List<java.lang.String> selectedCiphers)</pre> |
| </li> |
| </ul> |
| <a id="removeExcludedCipherSuites(java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeExcludedCipherSuites</h4> |
| <pre class="methodSignature">protected void removeExcludedCipherSuites​(java.util.List<java.lang.String> selectedCiphers)</pre> |
| </li> |
| </ul> |
| <a id="isEnableCRLDP()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEnableCRLDP</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("Whether certificate revocation list distribution points is enabled") |
| public boolean isEnableCRLDP()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if CRL Distribution Points support is enabled</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setEnableCRLDP(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEnableCRLDP</h4> |
| <pre class="methodSignature">public void setEnableCRLDP​(boolean enableCRLDP)</pre> |
| <div class="block">Enables CRL Distribution Points Support</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>enableCRLDP</code> - true - turn on, false - turns off</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isEnableOCSP()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEnableOCSP</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("Whether online certificate status protocol support is enabled") |
| public boolean isEnableOCSP()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if On-Line Certificate Status Protocol support is enabled</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setEnableOCSP(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEnableOCSP</h4> |
| <pre class="methodSignature">public void setEnableOCSP​(boolean enableOCSP)</pre> |
| <div class="block">Enables On-Line Certificate Status Protocol support</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>enableOCSP</code> - true - turn on, false - turn off</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOcspResponderURL()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOcspResponderURL</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("The online certificate status protocol URL") |
| public java.lang.String getOcspResponderURL()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Location of the OCSP Responder</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setOcspResponderURL(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOcspResponderURL</h4> |
| <pre class="methodSignature">public void setOcspResponderURL​(java.lang.String ocspResponderURL)</pre> |
| <div class="block">Set the location of the OCSP Responder.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ocspResponderURL</code> - location of the OCSP Responder</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setKeyStore(java.security.KeyStore)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setKeyStore</h4> |
| <pre class="methodSignature">public void setKeyStore​(java.security.KeyStore keyStore)</pre> |
| <div class="block">Set the key store.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>keyStore</code> - the key store to set</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getKeyStore()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getKeyStore</h4> |
| <pre class="methodSignature">public java.security.KeyStore getKeyStore()</pre> |
| </li> |
| </ul> |
| <a id="setTrustStore(java.security.KeyStore)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTrustStore</h4> |
| <pre class="methodSignature">public void setTrustStore​(java.security.KeyStore trustStore)</pre> |
| <div class="block">Set the trust store.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>trustStore</code> - the trust store to set</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTrustStore()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTrustStore</h4> |
| <pre class="methodSignature">public java.security.KeyStore getTrustStore()</pre> |
| </li> |
| </ul> |
| <a id="setKeyStoreResource(org.eclipse.jetty.util.resource.Resource)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setKeyStoreResource</h4> |
| <pre class="methodSignature">public void setKeyStoreResource​(<a href="../resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> resource)</pre> |
| <div class="block">Set the key store resource.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resource</code> - the key store resource to set</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getKeyStoreResource()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getKeyStoreResource</h4> |
| <pre class="methodSignature">public <a href="../resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> getKeyStoreResource()</pre> |
| </li> |
| </ul> |
| <a id="setTrustStoreResource(org.eclipse.jetty.util.resource.Resource)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTrustStoreResource</h4> |
| <pre class="methodSignature">public void setTrustStoreResource​(<a href="../resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> resource)</pre> |
| <div class="block">Set the trust store resource.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resource</code> - the trust store resource to set</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTrustStoreResource()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTrustStoreResource</h4> |
| <pre class="methodSignature">public <a href="../resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> getTrustStoreResource()</pre> |
| </li> |
| </ul> |
| <a id="isSessionCachingEnabled()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSessionCachingEnabled</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("Whether TLS session caching is enabled") |
| public boolean isSessionCachingEnabled()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if SSL Session caching is enabled</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSessionCachingEnabled(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSessionCachingEnabled</h4> |
| <pre class="methodSignature">public void setSessionCachingEnabled​(boolean enableSessionCaching)</pre> |
| <div class="block">Set the flag to enable SSL Session caching. |
| If set to true, then the <code>SSLContext.createSSLEngine(String, int)</code> method is |
| used to pass host and port information as a hint for session reuse. Note that |
| this is only a hint and session may not be reused. Moreover, the hint is typically |
| only used on client side implementations and setting this to false does not |
| stop a server from accepting an offered session ID to reuse.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>enableSessionCaching</code> - the value of the flag</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSslSessionCacheSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSslSessionCacheSize</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("The maximum TLS session cache size") |
| public int getSslSessionCacheSize()</pre> |
| <div class="block">Get SSL session cache size. |
| Passed directly to <code>SSLSessionContext.setSessionCacheSize(int)</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>SSL session cache size</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSslSessionCacheSize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSslSessionCacheSize</h4> |
| <pre class="methodSignature">public void setSslSessionCacheSize​(int sslSessionCacheSize)</pre> |
| <div class="block">Set SSL session cache size. |
| <p>Set the max cache size to be set on <code>SSLSessionContext.setSessionCacheSize(int)</code> |
| when this factory is started.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sslSessionCacheSize</code> - SSL session cache size to set. A value of -1 (default) uses |
| the JVM default, 0 means unlimited and positive number is a max size.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSslSessionTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSslSessionTimeout</h4> |
| <pre class="methodSignature"><a href="../annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("The TLS session cache timeout, in seconds") |
| public int getSslSessionTimeout()</pre> |
| <div class="block">Get SSL session timeout.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>SSL session timeout</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSslSessionTimeout(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSslSessionTimeout</h4> |
| <pre class="methodSignature">public void setSslSessionTimeout​(int sslSessionTimeout)</pre> |
| <div class="block">Set SSL session timeout. |
| <p>Set the timeout in seconds to be set on <code>SSLSessionContext.setSessionTimeout(int)</code> |
| when this factory is started.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sslSessionTimeout</code> - SSL session timeout to set in seconds. A value of -1 (default) uses |
| the JVM default, 0 means unlimited and positive number is a timeout in seconds.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getHostnameVerifier()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHostnameVerifier</h4> |
| <pre class="methodSignature">public javax.net.ssl.HostnameVerifier getHostnameVerifier()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the HostnameVerifier used by a client to verify host names in the server certificate</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setHostnameVerifier(javax.net.ssl.HostnameVerifier)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHostnameVerifier</h4> |
| <pre class="methodSignature">public void setHostnameVerifier​(javax.net.ssl.HostnameVerifier hostnameVerifier)</pre> |
| <div class="block"><p>Sets a <code>HostnameVerifier</code> used by a client to verify host names in the server certificate.</p> |
| <p>The <code>HostnameVerifier</code> works in conjunction with <a href="#setEndpointIdentificationAlgorithm(java.lang.String)"><code>setEndpointIdentificationAlgorithm(String)</code></a>.</p> |
| <p>When <code>endpointIdentificationAlgorithm=="HTTPS"</code> (the default) the JDK TLS implementation |
| checks that the host name indication set by the client matches the host names in the server certificate. |
| If this check passes successfully, the <code>HostnameVerifier</code> is invoked and the application |
| can perform additional checks and allow/deny the connection to the server.</p> |
| <p>When <code>endpointIdentificationAlgorithm==null</code> the JDK TLS implementation will not check |
| the host names, and any check is therefore performed only by the <code>HostnameVerifier.</code></p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>hostnameVerifier</code> - the HostnameVerifier used by a client to verify host names in the server certificate</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPassword(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPassword</h4> |
| <pre class="methodSignature">protected <a href="../security/Password.html" title="class in org.eclipse.jetty.util.security">Password</a> getPassword​(java.lang.String realm)</pre> |
| <div class="block">Returns the password object for the given realm.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>realm</code> - the realm</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Password object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newPassword(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newPassword</h4> |
| <pre class="methodSignature">public <a href="../security/Password.html" title="class in org.eclipse.jetty.util.security">Password</a> newPassword​(java.lang.String password)</pre> |
| <div class="block">Creates a new Password object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>password</code> - the password string</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new Password object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newSslServerSocket(java.lang.String,int,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newSslServerSocket</h4> |
| <pre class="methodSignature">public javax.net.ssl.SSLServerSocket newSslServerSocket​(java.lang.String host, |
| int port, |
| int backlog) |
| throws java.io.IOException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newSslSocket()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newSslSocket</h4> |
| <pre class="methodSignature">public javax.net.ssl.SSLSocket newSslSocket() |
| throws java.io.IOException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCertificateFactoryInstance(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCertificateFactoryInstance</h4> |
| <pre class="methodSignature">protected java.security.cert.CertificateFactory getCertificateFactoryInstance​(java.lang.String type) |
| throws java.security.cert.CertificateException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.security.cert.CertificateException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCertStoreInstance(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCertStoreInstance</h4> |
| <pre class="methodSignature">protected java.security.cert.CertStore getCertStoreInstance​(java.util.Collection<? extends java.security.cert.CRL> crls) |
| throws java.security.InvalidAlgorithmParameterException, |
| java.security.NoSuchAlgorithmException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.security.InvalidAlgorithmParameterException</code></dd> |
| <dd><code>java.security.NoSuchAlgorithmException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getKeyManagerFactoryInstance()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getKeyManagerFactoryInstance</h4> |
| <pre class="methodSignature">protected javax.net.ssl.KeyManagerFactory getKeyManagerFactoryInstance() |
| throws java.security.NoSuchAlgorithmException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.security.NoSuchAlgorithmException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSecureRandomInstance()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSecureRandomInstance</h4> |
| <pre class="methodSignature">protected java.security.SecureRandom getSecureRandomInstance() |
| throws java.security.NoSuchAlgorithmException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.security.NoSuchAlgorithmException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSSLContextInstance()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSSLContextInstance</h4> |
| <pre class="methodSignature">protected javax.net.ssl.SSLContext getSSLContextInstance() |
| throws java.security.NoSuchAlgorithmException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.security.NoSuchAlgorithmException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTrustManagerFactoryInstance()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTrustManagerFactoryInstance</h4> |
| <pre class="methodSignature">protected javax.net.ssl.TrustManagerFactory getTrustManagerFactoryInstance() |
| throws java.security.NoSuchAlgorithmException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.security.NoSuchAlgorithmException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newSSLEngine()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newSSLEngine</h4> |
| <pre class="methodSignature">public javax.net.ssl.SSLEngine newSSLEngine()</pre> |
| <div class="block">Factory method for "scratch" <code>SSLEngine</code>s, usually only used for retrieving configuration |
| information such as the application buffer size or the list of protocols/ciphers. |
| <p> |
| This method should not be used for creating <code>SSLEngine</code>s that are used in actual socket |
| communication.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new, "scratch" <code>SSLEngine</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newSSLEngine(java.lang.String,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newSSLEngine</h4> |
| <pre class="methodSignature">public javax.net.ssl.SSLEngine newSSLEngine​(java.lang.String host, |
| int port)</pre> |
| <div class="block">General purpose factory method for creating <code>SSLEngine</code>s, although creation of |
| <code>SSLEngine</code>s on the server-side should prefer <a href="#newSSLEngine(java.net.InetSocketAddress)"><code>newSSLEngine(InetSocketAddress)</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>host</code> - the remote host</dd> |
| <dd><code>port</code> - the remote port</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new <code>SSLEngine</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newSSLEngine(java.net.InetSocketAddress)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newSSLEngine</h4> |
| <pre class="methodSignature">public javax.net.ssl.SSLEngine newSSLEngine​(java.net.InetSocketAddress address)</pre> |
| <div class="block">Server-side only factory method for creating <code>SSLEngine</code>s. |
| <p> |
| If the given <code>address</code> is null, it is equivalent to <a href="#newSSLEngine()"><code>newSSLEngine()</code></a>, otherwise |
| <a href="#newSSLEngine(java.lang.String,int)"><code>newSSLEngine(String, int)</code></a> is called. |
| <p> |
| Clients that wish to create <code>SSLEngine</code> instances must use <a href="#newSSLEngine(java.lang.String,int)"><code>newSSLEngine(String, int)</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>address</code> - the remote peer address</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new <code>SSLEngine</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="customize(javax.net.ssl.SSLEngine)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>customize</h4> |
| <pre class="methodSignature">public void customize​(javax.net.ssl.SSLEngine sslEngine)</pre> |
| <div class="block">Customize an SslEngine instance with the configuration of this factory, |
| by calling <a href="#customize(javax.net.ssl.SSLParameters)"><code>customize(SSLParameters)</code></a></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sslEngine</code> - the SSLEngine to customize</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="customize(javax.net.ssl.SSLParameters)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>customize</h4> |
| <pre class="methodSignature">public javax.net.ssl.SSLParameters customize​(javax.net.ssl.SSLParameters sslParams)</pre> |
| <div class="block">Customize an SslParameters instance with the configuration of this factory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sslParams</code> - The parameters to customize</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The passed instance of sslParams (returned as a convenience)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="reload(java.util.function.Consumer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reload</h4> |
| <pre class="methodSignature">public void reload​(java.util.function.Consumer<<a href="SslContextFactory.html" title="class in org.eclipse.jetty.util.ssl">SslContextFactory</a>> consumer) |
| throws java.lang.Exception</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getX509CertChain(javax.net.ssl.SSLSession)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getX509CertChain</h4> |
| <pre class="methodSignature">public java.security.cert.X509Certificate[] getX509CertChain​(javax.net.ssl.SSLSession sslSession)</pre> |
| <div class="block">Obtain the X509 Certificate Chain from the provided SSLSession using this |
| SslContextFactory's optional Provider specific <code>CertificateFactory</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sslSession</code> - the session to use for active peer certificates</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the certificate chain</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCertChain(javax.net.ssl.SSLSession)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCertChain</h4> |
| <pre class="methodSignature">public static java.security.cert.X509Certificate[] getCertChain​(javax.net.ssl.SSLSession sslSession)</pre> |
| <div class="block">Obtain the X509 Certificate Chain from the provided SSLSession using the |
| default <code>CertificateFactory</code> behaviors</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sslSession</code> - the session to use for active peer certificates</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the certificate chain</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deduceKeyLength(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deduceKeyLength</h4> |
| <pre class="methodSignature">public static int deduceKeyLength​(java.lang.String cipherSuite)</pre> |
| <div class="block">Given the name of a TLS/SSL cipher suite, return an int representing it effective stream |
| cipher key strength. i.e. How much entropy material is in the key material being fed into the |
| encryption routines. |
| <p> |
| This is based on the information on effective key lengths in RFC 2246 - The TLS Protocol |
| Version 1.0, Appendix C. CipherSuite definitions: |
| <pre> |
| Effective |
| Cipher Type Key Bits |
| |
| NULL * Stream 0 |
| IDEA_CBC Block 128 |
| RC2_CBC_40 * Block 40 |
| RC4_40 * Stream 40 |
| RC4_128 Stream 128 |
| DES40_CBC * Block 40 |
| DES_CBC Block 56 |
| 3DES_EDE_CBC Block 168 |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cipherSuite</code> - String name of the TLS cipher suite.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>int indicating the effective key entropy bit-length.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">public java.lang.String toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../component/AbstractLifeCycle.html#toString()">toString</a></code> in class <code><a href="../component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></code></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/SslContextFactory.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="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </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="subNavList"> |
| <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> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 1995–2020 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |