blob: dcee71401aacfd45a9244d477e5bd1b393966f72 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_191) on Sat Mar 16 19:15:32 CET 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SslContextFactory (Apache MINA 2.0.0-M2 API Documentation)</title>
<meta name="date" content="2019-03-16">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SslContextFactory (Apache MINA 2.0.0-M2 API Documentation)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.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">
<li><a href="../../../../../org/apache/mina/filter/ssl/KeyStoreFactory.html" title="class in org.apache.mina.filter.ssl"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/mina/filter/ssl/SslFilter.html" title="class in org.apache.mina.filter.ssl"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/mina/filter/ssl/SslContextFactory.html" target="_top">Frames</a></li>
<li><a href="SslContextFactory.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.mina.filter.ssl</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>org.apache.mina.filter.ssl.SslContextFactory</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">SslContextFactory</span>
extends java.lang.Object</pre>
<div class="block">A factory that creates and configures a new <code>SSLContext</code>.
<p>
If no properties are set the returned <code>SSLContext</code> will
be equivalent to what the following creates:
<pre>
SSLContext c = SSLContext.getInstance( "TLS" );
c.init(null, null, null);
</pre>
</p>
<p>
Use the properties prefixed with <code>keyManagerFactory</code> to control
the creation of the <code>KeyManager</code> to be used.
</p>
<p>
Use the properties prefixed with <code>trustManagerFactory</code> to control
the creation of the <code>TrustManagerFactory</code> to be used.
</p></div>
<dl>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>$Rev: 636238 $, $Date: 2008-03-12 08:36:04 +0100 (Wed, 12 Mar 2008) $</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>The Apache MINA Project (dev@mina.apache.org)</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#SslContextFactory--">SslContextFactory</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>javax.net.ssl.SSLContext</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#newInstance--">newInstance</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setClientSessionCacheSize-int-">setClientSessionCacheSize</a></span>(int&nbsp;size)</code>
<div class="block">Sets the SSLSession cache size for the <code>SSLSessionContext</code> for use in client mode.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setClientSessionTimeout-int-">setClientSessionTimeout</a></span>(int&nbsp;seconds)</code>
<div class="block">Set the SSLSession timeout limit for the <code>SSLSessionContext</code> for use in client mode.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setKeyManagerFactory-javax.net.ssl.KeyManagerFactory-">setKeyManagerFactory</a></span>(javax.net.ssl.KeyManagerFactory&nbsp;factory)</code>
<div class="block">Sets the <code>KeyManagerFactory</code> to use.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setKeyManagerFactoryAlgorithm-java.lang.String-">setKeyManagerFactoryAlgorithm</a></span>(java.lang.String&nbsp;algorithm)</code>
<div class="block">Sets the algorithm to use when creating the <code>KeyManagerFactory</code>
using <code>KeyManagerFactory.getInstance(java.lang.String)</code> or
<code>KeyManagerFactory.getInstance(java.lang.String, java.lang.String)</code>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setKeyManagerFactoryAlgorithmUseDefault-boolean-">setKeyManagerFactoryAlgorithmUseDefault</a></span>(boolean&nbsp;useDefault)</code>
<div class="block">If this is set to <code>true</code> while no <code>KeyManagerFactory</code>
has been set using <a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setKeyManagerFactory-javax.net.ssl.KeyManagerFactory-"><code>setKeyManagerFactory(KeyManagerFactory)</code></a> and
no algorithm has been set using
<a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setKeyManagerFactoryAlgorithm-java.lang.String-"><code>setKeyManagerFactoryAlgorithm(String)</code></a> the default algorithm
return by <code>KeyManagerFactory.getDefaultAlgorithm()</code> will be used.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setKeyManagerFactoryKeyStore-java.security.KeyStore-">setKeyManagerFactoryKeyStore</a></span>(java.security.KeyStore&nbsp;keyStore)</code>
<div class="block">Sets the <code>KeyStore</code> which will be used in the call to
<code>KeyManagerFactory.init(java.security.KeyStore, char[])</code> when
the <code>SSLContext</code> is created.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setKeyManagerFactoryKeyStorePassword-java.lang.String-">setKeyManagerFactoryKeyStorePassword</a></span>(java.lang.String&nbsp;password)</code>
<div class="block">Sets the password which will be used in the call to
<code>KeyManagerFactory.init(java.security.KeyStore, char[])</code> when
the <code>SSLContext</code> is created.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setKeyManagerFactoryProvider-java.lang.String-">setKeyManagerFactoryProvider</a></span>(java.lang.String&nbsp;provider)</code>
<div class="block">Sets the provider to use when creating the <code>KeyManagerFactory</code>
using
<code>KeyManagerFactory.getInstance(java.lang.String, java.lang.String)</code>.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setProtocol-java.lang.String-">setProtocol</a></span>(java.lang.String&nbsp;protocol)</code>
<div class="block">Sets the protocol to use when creating the <code>SSLContext</code>.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setProvider-java.lang.String-">setProvider</a></span>(java.lang.String&nbsp;provider)</code>
<div class="block">Sets the provider of the new <code>SSLContext</code>.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setSecureRandom-java.security.SecureRandom-">setSecureRandom</a></span>(java.security.SecureRandom&nbsp;secureRandom)</code>
<div class="block">Sets the <code>SecureRandom</code> to use when initializing the
<code>SSLContext</code>.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setServerSessionCacheSize-int-">setServerSessionCacheSize</a></span>(int&nbsp;serverSessionCacheSize)</code>
<div class="block">Sets the SSLSession cache size for the <code>SSLSessionContext</code> for use in server mode.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setServerSessionTimeout-int-">setServerSessionTimeout</a></span>(int&nbsp;serverSessionTimeout)</code>
<div class="block">Set the SSLSession timeout limit for the <code>SSLSessionContext</code> for use in server mode.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setTrustManagerFactory-javax.net.ssl.TrustManagerFactory-">setTrustManagerFactory</a></span>(javax.net.ssl.TrustManagerFactory&nbsp;factory)</code>
<div class="block">Sets the <code>TrustManagerFactory</code> to use.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setTrustManagerFactoryAlgorithm-java.lang.String-">setTrustManagerFactoryAlgorithm</a></span>(java.lang.String&nbsp;algorithm)</code>
<div class="block">Sets the algorithm to use when creating the <code>TrustManagerFactory</code>
using <code>TrustManagerFactory.getInstance(java.lang.String)</code> or
<code>TrustManagerFactory.getInstance(java.lang.String, java.lang.String)</code>.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setTrustManagerFactoryAlgorithmUseDefault-boolean-">setTrustManagerFactoryAlgorithmUseDefault</a></span>(boolean&nbsp;useDefault)</code>
<div class="block">If this is set to <code>true</code> while no <code>TrustManagerFactory</code>
has been set using <a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setTrustManagerFactory-javax.net.ssl.TrustManagerFactory-"><code>setTrustManagerFactory(TrustManagerFactory)</code></a> and
no algorithm has been set using
<a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setTrustManagerFactoryAlgorithm-java.lang.String-"><code>setTrustManagerFactoryAlgorithm(String)</code></a> the default algorithm
return by <code>TrustManagerFactory.getDefaultAlgorithm()</code> will be used.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setTrustManagerFactoryKeyStore-java.security.KeyStore-">setTrustManagerFactoryKeyStore</a></span>(java.security.KeyStore&nbsp;keyStore)</code>
<div class="block">Sets the <code>KeyStore</code> which will be used in the call to
<code>TrustManagerFactory.init(java.security.KeyStore)</code> when
the <code>SSLContext</code> is created.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setTrustManagerFactoryParameters-javax.net.ssl.ManagerFactoryParameters-">setTrustManagerFactoryParameters</a></span>(javax.net.ssl.ManagerFactoryParameters&nbsp;parameters)</code>
<div class="block">Sets the <code>ManagerFactoryParameters</code> which will be used in the call to
<code>TrustManagerFactory.init(javax.net.ssl.ManagerFactoryParameters)</code> when
the <code>SSLContext</code> is created.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setTrustManagerFactoryProvider-java.lang.String-">setTrustManagerFactoryProvider</a></span>(java.lang.String&nbsp;provider)</code>
<div class="block">Sets the provider to use when creating the <code>TrustManagerFactory</code>
using
<code>TrustManagerFactory.getInstance(java.lang.String, java.lang.String)</code>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SslContextFactory--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SslContextFactory</h4>
<pre>public&nbsp;SslContextFactory()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="newInstance--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newInstance</h4>
<pre>public&nbsp;javax.net.ssl.SSLContext&nbsp;newInstance()
throws java.lang.Exception</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a name="setProvider-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProvider</h4>
<pre>public&nbsp;void&nbsp;setProvider(java.lang.String&nbsp;provider)</pre>
<div class="block">Sets the provider of the new <code>SSLContext</code>. The default value is
<tt>null</tt>, which means the default provider will be used.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>provider</code> - the name of the <code>SSLContext</code> provider</dd>
</dl>
</li>
</ul>
<a name="setProtocol-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProtocol</h4>
<pre>public&nbsp;void&nbsp;setProtocol(java.lang.String&nbsp;protocol)</pre>
<div class="block">Sets the protocol to use when creating the <code>SSLContext</code>. The
default is <code>TLS</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>protocol</code> - the name of the protocol.</dd>
</dl>
</li>
</ul>
<a name="setKeyManagerFactoryAlgorithmUseDefault-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setKeyManagerFactoryAlgorithmUseDefault</h4>
<pre>public&nbsp;void&nbsp;setKeyManagerFactoryAlgorithmUseDefault(boolean&nbsp;useDefault)</pre>
<div class="block">If this is set to <code>true</code> while no <code>KeyManagerFactory</code>
has been set using <a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setKeyManagerFactory-javax.net.ssl.KeyManagerFactory-"><code>setKeyManagerFactory(KeyManagerFactory)</code></a> and
no algorithm has been set using
<a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setKeyManagerFactoryAlgorithm-java.lang.String-"><code>setKeyManagerFactoryAlgorithm(String)</code></a> the default algorithm
return by <code>KeyManagerFactory.getDefaultAlgorithm()</code> will be used.
The default value of this property is <tt>true<tt/>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>useDefault</code> - <code>true</code> or <code>false</code>.</dd>
</dl>
</li>
</ul>
<a name="setTrustManagerFactoryAlgorithmUseDefault-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTrustManagerFactoryAlgorithmUseDefault</h4>
<pre>public&nbsp;void&nbsp;setTrustManagerFactoryAlgorithmUseDefault(boolean&nbsp;useDefault)</pre>
<div class="block">If this is set to <code>true</code> while no <code>TrustManagerFactory</code>
has been set using <a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setTrustManagerFactory-javax.net.ssl.TrustManagerFactory-"><code>setTrustManagerFactory(TrustManagerFactory)</code></a> and
no algorithm has been set using
<a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setTrustManagerFactoryAlgorithm-java.lang.String-"><code>setTrustManagerFactoryAlgorithm(String)</code></a> the default algorithm
return by <code>TrustManagerFactory.getDefaultAlgorithm()</code> will be used.
The default value of this property is <tt>true<tt/>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>useDefault</code> - <code>true</code> or <code>false</code>.</dd>
</dl>
</li>
</ul>
<a name="setKeyManagerFactory-javax.net.ssl.KeyManagerFactory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setKeyManagerFactory</h4>
<pre>public&nbsp;void&nbsp;setKeyManagerFactory(javax.net.ssl.KeyManagerFactory&nbsp;factory)</pre>
<div class="block">Sets the <code>KeyManagerFactory</code> to use. If this is set the properties
which are used by this factory bean to create a <code>KeyManagerFactory</code>
will all be ignored.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>factory</code> - the factory.</dd>
</dl>
</li>
</ul>
<a name="setKeyManagerFactoryAlgorithm-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setKeyManagerFactoryAlgorithm</h4>
<pre>public&nbsp;void&nbsp;setKeyManagerFactoryAlgorithm(java.lang.String&nbsp;algorithm)</pre>
<div class="block">Sets the algorithm to use when creating the <code>KeyManagerFactory</code>
using <code>KeyManagerFactory.getInstance(java.lang.String)</code> or
<code>KeyManagerFactory.getInstance(java.lang.String, java.lang.String)</code>.
<p>
This property will be ignored if a <code>KeyManagerFactory</code> has been
set directly using <a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setKeyManagerFactory-javax.net.ssl.KeyManagerFactory-"><code>setKeyManagerFactory(KeyManagerFactory)</code></a>.
</p>
<p>
If this property isn't set while no <code>KeyManagerFactory</code> has been
set using <a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setKeyManagerFactory-javax.net.ssl.KeyManagerFactory-"><code>setKeyManagerFactory(KeyManagerFactory)</code></a> and
<a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setKeyManagerFactoryAlgorithmUseDefault-boolean-"><code>setKeyManagerFactoryAlgorithmUseDefault(boolean)</code></a> has been set to
<code>true</code> the value returned
by <code>KeyManagerFactory.getDefaultAlgorithm()</code> will be used instead.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>algorithm</code> - the algorithm to use.</dd>
</dl>
</li>
</ul>
<a name="setKeyManagerFactoryProvider-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setKeyManagerFactoryProvider</h4>
<pre>public&nbsp;void&nbsp;setKeyManagerFactoryProvider(java.lang.String&nbsp;provider)</pre>
<div class="block">Sets the provider to use when creating the <code>KeyManagerFactory</code>
using
<code>KeyManagerFactory.getInstance(java.lang.String, java.lang.String)</code>.
<p>
This property will be ignored if a <code>KeyManagerFactory</code> has been
set directly using <a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setKeyManagerFactory-javax.net.ssl.KeyManagerFactory-"><code>setKeyManagerFactory(KeyManagerFactory)</code></a>.
</p>
<p>
If this property isn't set and no <code>KeyManagerFactory</code> has been set
using <a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setKeyManagerFactory-javax.net.ssl.KeyManagerFactory-"><code>setKeyManagerFactory(KeyManagerFactory)</code></a>
<code>KeyManagerFactory.getInstance(java.lang.String)</code> will be used
to create the <code>KeyManagerFactory</code>.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>provider</code> - the name of the provider.</dd>
</dl>
</li>
</ul>
<a name="setKeyManagerFactoryKeyStore-java.security.KeyStore-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setKeyManagerFactoryKeyStore</h4>
<pre>public&nbsp;void&nbsp;setKeyManagerFactoryKeyStore(java.security.KeyStore&nbsp;keyStore)</pre>
<div class="block">Sets the <code>KeyStore</code> which will be used in the call to
<code>KeyManagerFactory.init(java.security.KeyStore, char[])</code> when
the <code>SSLContext</code> is created.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>keyStore</code> - the key store.</dd>
</dl>
</li>
</ul>
<a name="setKeyManagerFactoryKeyStorePassword-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setKeyManagerFactoryKeyStorePassword</h4>
<pre>public&nbsp;void&nbsp;setKeyManagerFactoryKeyStorePassword(java.lang.String&nbsp;password)</pre>
<div class="block">Sets the password which will be used in the call to
<code>KeyManagerFactory.init(java.security.KeyStore, char[])</code> when
the <code>SSLContext</code> is created.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>password</code> - the password. Use <code>null</code> to disable password.</dd>
</dl>
</li>
</ul>
<a name="setTrustManagerFactory-javax.net.ssl.TrustManagerFactory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTrustManagerFactory</h4>
<pre>public&nbsp;void&nbsp;setTrustManagerFactory(javax.net.ssl.TrustManagerFactory&nbsp;factory)</pre>
<div class="block">Sets the <code>TrustManagerFactory</code> to use. If this is set the
properties which are used by this factory bean to create a
<code>TrustManagerFactory</code> will all be ignored.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>factory</code> - the factory.</dd>
</dl>
</li>
</ul>
<a name="setTrustManagerFactoryAlgorithm-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTrustManagerFactoryAlgorithm</h4>
<pre>public&nbsp;void&nbsp;setTrustManagerFactoryAlgorithm(java.lang.String&nbsp;algorithm)</pre>
<div class="block">Sets the algorithm to use when creating the <code>TrustManagerFactory</code>
using <code>TrustManagerFactory.getInstance(java.lang.String)</code> or
<code>TrustManagerFactory.getInstance(java.lang.String, java.lang.String)</code>.
<p>
This property will be ignored if a <code>TrustManagerFactory</code> has been
set directly using <a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setTrustManagerFactory-javax.net.ssl.TrustManagerFactory-"><code>setTrustManagerFactory(TrustManagerFactory)</code></a>.
</p>
<p>
If this property isn't set while no <code>TrustManagerFactory</code> has been
set using <a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setTrustManagerFactory-javax.net.ssl.TrustManagerFactory-"><code>setTrustManagerFactory(TrustManagerFactory)</code></a> and
<a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setTrustManagerFactoryAlgorithmUseDefault-boolean-"><code>setTrustManagerFactoryAlgorithmUseDefault(boolean)</code></a> has been set to
<code>true</code> the value returned
by <code>TrustManagerFactory.getDefaultAlgorithm()</code> will be used instead.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>algorithm</code> - the algorithm to use.</dd>
</dl>
</li>
</ul>
<a name="setTrustManagerFactoryKeyStore-java.security.KeyStore-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTrustManagerFactoryKeyStore</h4>
<pre>public&nbsp;void&nbsp;setTrustManagerFactoryKeyStore(java.security.KeyStore&nbsp;keyStore)</pre>
<div class="block">Sets the <code>KeyStore</code> which will be used in the call to
<code>TrustManagerFactory.init(java.security.KeyStore)</code> when
the <code>SSLContext</code> is created.
<p>
This property will be ignored if <code>ManagerFactoryParameters</code> has been
set directly using <a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setTrustManagerFactoryParameters-javax.net.ssl.ManagerFactoryParameters-"><code>setTrustManagerFactoryParameters(ManagerFactoryParameters)</code></a>.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>keyStore</code> - the key store.</dd>
</dl>
</li>
</ul>
<a name="setTrustManagerFactoryParameters-javax.net.ssl.ManagerFactoryParameters-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTrustManagerFactoryParameters</h4>
<pre>public&nbsp;void&nbsp;setTrustManagerFactoryParameters(javax.net.ssl.ManagerFactoryParameters&nbsp;parameters)</pre>
<div class="block">Sets the <code>ManagerFactoryParameters</code> which will be used in the call to
<code>TrustManagerFactory.init(javax.net.ssl.ManagerFactoryParameters)</code> when
the <code>SSLContext</code> is created.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parameters</code> - describing provider-specific trust material.</dd>
</dl>
</li>
</ul>
<a name="setTrustManagerFactoryProvider-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTrustManagerFactoryProvider</h4>
<pre>public&nbsp;void&nbsp;setTrustManagerFactoryProvider(java.lang.String&nbsp;provider)</pre>
<div class="block">Sets the provider to use when creating the <code>TrustManagerFactory</code>
using
<code>TrustManagerFactory.getInstance(java.lang.String, java.lang.String)</code>.
<p>
This property will be ignored if a <code>TrustManagerFactory</code> has been
set directly using <a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setTrustManagerFactory-javax.net.ssl.TrustManagerFactory-"><code>setTrustManagerFactory(TrustManagerFactory)</code></a>.
</p>
<p>
If this property isn't set and no <code>TrustManagerFactory</code> has been set
using <a href="../../../../../org/apache/mina/filter/ssl/SslContextFactory.html#setTrustManagerFactory-javax.net.ssl.TrustManagerFactory-"><code>setTrustManagerFactory(TrustManagerFactory)</code></a>
<code>TrustManagerFactory.getInstance(java.lang.String)</code> will be used
to create the <code>TrustManagerFactory</code>.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>provider</code> - the name of the provider.</dd>
</dl>
</li>
</ul>
<a name="setSecureRandom-java.security.SecureRandom-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSecureRandom</h4>
<pre>public&nbsp;void&nbsp;setSecureRandom(java.security.SecureRandom&nbsp;secureRandom)</pre>
<div class="block">Sets the <code>SecureRandom</code> to use when initializing the
<code>SSLContext</code>. The JVM's default will be used if this isn't set.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>secureRandom</code> - the <code>SecureRandom</code> or <code>null</code> if the
JVM's default should be used.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>SSLContext.init(javax.net.ssl.KeyManager[], javax.net.ssl.TrustManager[], java.security.SecureRandom)</code></dd>
</dl>
</li>
</ul>
<a name="setClientSessionCacheSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setClientSessionCacheSize</h4>
<pre>public&nbsp;void&nbsp;setClientSessionCacheSize(int&nbsp;size)</pre>
<div class="block">Sets the SSLSession cache size for the <code>SSLSessionContext</code> for use in client mode.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>size</code> - the new session cache size limit; zero means there is no limit.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>SSLSessionContext.setSessionCacheSize(int size)</code></dd>
</dl>
</li>
</ul>
<a name="setClientSessionTimeout-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setClientSessionTimeout</h4>
<pre>public&nbsp;void&nbsp;setClientSessionTimeout(int&nbsp;seconds)</pre>
<div class="block">Set the SSLSession timeout limit for the <code>SSLSessionContext</code> for use in client mode.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>seconds</code> - the new session timeout limit in seconds; zero means there is no limit.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>SSLSessionContext.setSessionTimeout(int seconds)</code></dd>
</dl>
</li>
</ul>
<a name="setServerSessionCacheSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setServerSessionCacheSize</h4>
<pre>public&nbsp;void&nbsp;setServerSessionCacheSize(int&nbsp;serverSessionCacheSize)</pre>
<div class="block">Sets the SSLSession cache size for the <code>SSLSessionContext</code> for use in server mode.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>serverSessionCacheSize</code> - the new session cache size limit; zero means there is no limit.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>SSLSessionContext.setSessionCacheSize(int)</code></dd>
</dl>
</li>
</ul>
<a name="setServerSessionTimeout-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setServerSessionTimeout</h4>
<pre>public&nbsp;void&nbsp;setServerSessionTimeout(int&nbsp;serverSessionTimeout)</pre>
<div class="block">Set the SSLSession timeout limit for the <code>SSLSessionContext</code> for use in server mode.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>serverSessionTimeout</code> - the new session timeout limit in seconds; zero means there is no limit.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>SSLSessionContext.setSessionTimeout(int)</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.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">
<li><a href="../../../../../org/apache/mina/filter/ssl/KeyStoreFactory.html" title="class in org.apache.mina.filter.ssl"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/mina/filter/ssl/SslFilter.html" title="class in org.apache.mina.filter.ssl"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/mina/filter/ssl/SslContextFactory.html" target="_top">Frames</a></li>
<li><a href="SslContextFactory.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2004-2019 <a href="http://mina.apache.org/">Apache MINA Project</a>. All Rights Reserved.</small></p>
</body>
</html>