Google Git
Sign in
eclipse / www.eclipse.org / jetty / 244b31480d88c4c2e783a862c86c320807c66eb3 / . / javadoc / 9.3.24.v20180605 / org / eclipse / jetty / security / authentication / ClientCertAuthenticator.html
blob: 4b221a12ede2f03a3e93605d7d39eea5cb0fbf7b [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_92) on Thu Jun 07 14:26:29 EDT 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClientCertAuthenticator (Jetty :: Project 9.3.24.v20180605 API)</title>
<meta name="date" content="2018-06-07">
<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="ClientCertAuthenticator (Jetty :: Project 9.3.24.v20180605 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":42,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10};
var tabs = {65535:["t0","All 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";
</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/ClientCertAuthenticator.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/eclipse/jetty/security/authentication/BasicAuthenticator.html" title="class in org.eclipse.jetty.security.authentication"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/jetty/security/authentication/DeferredAuthentication.html" title="class in org.eclipse.jetty.security.authentication"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/jetty/security/authentication/ClientCertAuthenticator.html" target="_top">Frames</a></li>
<li><a href="ClientCertAuthenticator.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><a href="#fields.inherited.from.class.org.eclipse.jetty.security.authentication.LoginAuthenticator">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>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.eclipse.jetty.security.authentication</div>
<h2 title="Class ClientCertAuthenticator" class="title">Class ClientCertAuthenticator</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/eclipse/jetty/security/authentication/LoginAuthenticator.html" title="class in org.eclipse.jetty.security.authentication">org.eclipse.jetty.security.authentication.LoginAuthenticator</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.security.authentication.ClientCertAuthenticator</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/eclipse/jetty/security/Authenticator.html" title="interface in org.eclipse.jetty.security">Authenticator</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">ClientCertAuthenticator</span>
extends <a href="../../../../../org/eclipse/jetty/security/authentication/LoginAuthenticator.html" title="class in org.eclipse.jetty.security.authentication">LoginAuthenticator</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.eclipse.jetty.security.Authenticator">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.security.<a href="../../../../../org/eclipse/jetty/security/Authenticator.html" title="interface in org.eclipse.jetty.security">Authenticator</a></h3>
<code><a href="../../../../../org/eclipse/jetty/security/Authenticator.AuthConfiguration.html" title="interface in org.eclipse.jetty.security">Authenticator.AuthConfiguration</a>, <a href="../../../../../org/eclipse/jetty/security/Authenticator.Factory.html" title="interface in org.eclipse.jetty.security">Authenticator.Factory</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.eclipse.jetty.security.authentication.LoginAuthenticator">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.jetty.security.authentication.<a href="../../../../../org/eclipse/jetty/security/authentication/LoginAuthenticator.html" title="class in org.eclipse.jetty.security.authentication">LoginAuthenticator</a></h3>
<code><a href="../../../../../org/eclipse/jetty/security/authentication/LoginAuthenticator.html#Z:Z_identityService">_identityService</a>, <a href="../../../../../org/eclipse/jetty/security/authentication/LoginAuthenticator.html#Z:Z_loginService">_loginService</a></code></li>
</ul>
</li>
</ul>
<!-- ======== 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/eclipse/jetty/security/authentication/ClientCertAuthenticator.html#ClientCertAuthenticator--">ClientCertAuthenticator</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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/security/authentication/ClientCertAuthenticator.html#getAuthMethod--">getAuthMethod</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/security/authentication/ClientCertAuthenticator.html#getCrlPath--">getCrlPath</a></span>()</code>
<div class="block">Get the crlPath.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected java.security.KeyStore</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/security/authentication/ClientCertAuthenticator.html#getKeyStore-java.io.InputStream-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">getKeyStore</a></span>(java.io.InputStream&nbsp;storeStream,
java.lang.String&nbsp;storePath,
java.lang.String&nbsp;storeType,
java.lang.String&nbsp;storeProvider,
java.lang.String&nbsp;storePassword)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected java.security.KeyStore</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/security/authentication/ClientCertAuthenticator.html#getKeyStore-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">getKeyStore</a></span>(java.lang.String&nbsp;storePath,
java.lang.String&nbsp;storeType,
java.lang.String&nbsp;storeProvider,
java.lang.String&nbsp;storePassword)</code>
<div class="block">Loads keystore using an input stream or a file path in the same
order of precedence.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/security/authentication/ClientCertAuthenticator.html#getMaxCertPathLength--">getMaxCertPathLength</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/security/authentication/ClientCertAuthenticator.html#getOcspResponderURL--">getOcspResponderURL</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/security/authentication/ClientCertAuthenticator.html#getTrustStore--">getTrustStore</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/security/authentication/ClientCertAuthenticator.html#getTrustStoreProvider--">getTrustStoreProvider</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/security/authentication/ClientCertAuthenticator.html#getTrustStoreType--">getTrustStoreType</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/security/authentication/ClientCertAuthenticator.html#isEnableCRLDP--">isEnableCRLDP</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/security/authentication/ClientCertAuthenticator.html#isEnableOCSP--">isEnableOCSP</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/security/authentication/ClientCertAuthenticator.html#isValidateCerts--">isValidateCerts</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>protected java.util.Collection&lt;? extends java.security.cert.CRL&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/security/authentication/ClientCertAuthenticator.html#loadCRL-java.lang.String-">loadCRL</a></span>(java.lang.String&nbsp;crlPath)</code>
<div class="block">Loads certificate revocation list (CRL) from a file.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/security/authentication/ClientCertAuthenticator.html#secureResponse-javax.servlet.ServletRequest-javax.servlet.ServletResponse-boolean-org.eclipse.jetty.server.Authentication.User-">secureResponse</a></span>(javax.servlet.ServletRequest&nbsp;req,
javax.servlet.ServletResponse&nbsp;res,
boolean&nbsp;mandatory,
<a href="../../../../../org/eclipse/jetty/server/Authentication.User.html" title="interface in org.eclipse.jetty.server">Authentication.User</a>&nbsp;validatedUser)</code>
<div class="block">is response secure</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/eclipse/jetty/security/authentication/ClientCertAuthenticator.html#setCrlPath-java.lang.String-">setCrlPath</a></span>(java.lang.String&nbsp;crlPath)</code>
<div class="block">Set the crlPath.</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/eclipse/jetty/security/authentication/ClientCertAuthenticator.html#setEnableCRLDP-boolean-">setEnableCRLDP</a></span>(boolean&nbsp;enableCRLDP)</code>
<div class="block">Enables CRL Distribution Points Support</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/eclipse/jetty/security/authentication/ClientCertAuthenticator.html#setEnableOCSP-boolean-">setEnableOCSP</a></span>(boolean&nbsp;enableOCSP)</code>
<div class="block">Enables On-Line Certificate Status Protocol support</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/eclipse/jetty/security/authentication/ClientCertAuthenticator.html#setMaxCertPathLength-int-">setMaxCertPathLength</a></span>(int&nbsp;maxCertPathLength)</code>&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/security/authentication/ClientCertAuthenticator.html#setOcspResponderURL-java.lang.String-">setOcspResponderURL</a></span>(java.lang.String&nbsp;ocspResponderURL)</code>
<div class="block">Set the location of the OCSP Responder.</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/eclipse/jetty/security/authentication/ClientCertAuthenticator.html#setTrustStore-java.lang.String-">setTrustStore</a></span>(java.lang.String&nbsp;trustStorePath)</code>&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/security/authentication/ClientCertAuthenticator.html#setTrustStorePassword-java.lang.String-">setTrustStorePassword</a></span>(java.lang.String&nbsp;password)</code>&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/security/authentication/ClientCertAuthenticator.html#setTrustStoreProvider-java.lang.String-">setTrustStoreProvider</a></span>(java.lang.String&nbsp;trustStoreProvider)</code>&nbsp;</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/security/authentication/ClientCertAuthenticator.html#setTrustStoreType-java.lang.String-">setTrustStoreType</a></span>(java.lang.String&nbsp;trustStoreType)</code>&nbsp;</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/security/authentication/ClientCertAuthenticator.html#setValidateCerts-boolean-">setValidateCerts</a></span>(boolean&nbsp;validateCerts)</code>&nbsp;</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/server/Authentication.html" title="interface in org.eclipse.jetty.server">Authentication</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/security/authentication/ClientCertAuthenticator.html#validateRequest-javax.servlet.ServletRequest-javax.servlet.ServletResponse-boolean-">validateRequest</a></span>(javax.servlet.ServletRequest&nbsp;req,
javax.servlet.ServletResponse&nbsp;res,
boolean&nbsp;mandatory)</code>
<div class="block">Validate a request</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.jetty.security.authentication.LoginAuthenticator">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.security.authentication.<a href="../../../../../org/eclipse/jetty/security/authentication/LoginAuthenticator.html" title="class in org.eclipse.jetty.security.authentication">LoginAuthenticator</a></h3>
<code><a href="../../../../../org/eclipse/jetty/security/authentication/LoginAuthenticator.html#getLoginService--">getLoginService</a>, <a href="../../../../../org/eclipse/jetty/security/authentication/LoginAuthenticator.html#login-java.lang.String-java.lang.Object-javax.servlet.ServletRequest-">login</a>, <a href="../../../../../org/eclipse/jetty/security/authentication/LoginAuthenticator.html#prepareRequest-javax.servlet.ServletRequest-">prepareRequest</a>, <a href="../../../../../org/eclipse/jetty/security/authentication/LoginAuthenticator.html#renewSession-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">renewSession</a>, <a href="../../../../../org/eclipse/jetty/security/authentication/LoginAuthenticator.html#setConfiguration-org.eclipse.jetty.security.Authenticator.AuthConfiguration-">setConfiguration</a></code></li>
</ul>
<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="ClientCertAuthenticator--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ClientCertAuthenticator</h4>
<pre>public&nbsp;ClientCertAuthenticator()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getAuthMethod--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAuthMethod</h4>
<pre>public&nbsp;java.lang.String&nbsp;getAuthMethod()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The name of the authentication method</dd>
</dl>
</li>
</ul>
<a name="validateRequest-javax.servlet.ServletRequest-javax.servlet.ServletResponse-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validateRequest</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/jetty/server/Authentication.html" title="interface in org.eclipse.jetty.server">Authentication</a>&nbsp;validateRequest(javax.servlet.ServletRequest&nbsp;req,
javax.servlet.ServletResponse&nbsp;res,
boolean&nbsp;mandatory)
throws <a href="../../../../../org/eclipse/jetty/security/ServerAuthException.html" title="class in org.eclipse.jetty.security">ServerAuthException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/eclipse/jetty/security/Authenticator.html#validateRequest-javax.servlet.ServletRequest-javax.servlet.ServletResponse-boolean-">Authenticator</a></code></span></div>
<div class="block">Validate a request</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>req</code> - The request</dd>
<dd><code>res</code> - The response</dd>
<dd><code>mandatory</code> - True if authentication is mandatory.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An Authentication. If Authentication is successful, this will be a <a href="../../../../../org/eclipse/jetty/server/Authentication.User.html" title="interface in org.eclipse.jetty.server"><code>Authentication.User</code></a>. If a response has
been sent by the Authenticator (which can be done for both successful and unsuccessful authentications), then the result will
implement <a href="../../../../../org/eclipse/jetty/server/Authentication.ResponseSent.html" title="interface in org.eclipse.jetty.server"><code>Authentication.ResponseSent</code></a>. If Authentication is not manditory, then a
<a href="../../../../../org/eclipse/jetty/server/Authentication.Deferred.html" title="interface in org.eclipse.jetty.server"><code>Authentication.Deferred</code></a> may be returned.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/eclipse/jetty/security/ServerAuthException.html" title="class in org.eclipse.jetty.security">ServerAuthException</a></code> - if unable to validate request</dd>
</dl>
</li>
</ul>
<a name="getKeyStore-java.io.InputStream-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKeyStore</h4>
<pre>@Deprecated
protected&nbsp;java.security.KeyStore&nbsp;getKeyStore(java.io.InputStream&nbsp;storeStream,
java.lang.String&nbsp;storePath,
java.lang.String&nbsp;storeType,
java.lang.String&nbsp;storeProvider,
java.lang.String&nbsp;storePassword)
throws java.lang.Exception</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a name="getKeyStore-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKeyStore</h4>
<pre>protected&nbsp;java.security.KeyStore&nbsp;getKeyStore(java.lang.String&nbsp;storePath,
java.lang.String&nbsp;storeType,
java.lang.String&nbsp;storeProvider,
java.lang.String&nbsp;storePassword)
throws java.lang.Exception</pre>
<div class="block">Loads keystore using an input stream or a file path in the same
order of precedence.
Required for integrations to be able to override the mechanism
used to load a keystore in order to provide their own implementation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>storePath</code> - path of keystore file</dd>
<dd><code>storeType</code> - keystore type</dd>
<dd><code>storeProvider</code> - keystore provider</dd>
<dd><code>storePassword</code> - keystore password</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>created keystore</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if unable to get keystore</dd>
</dl>
</li>
</ul>
<a name="loadCRL-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadCRL</h4>
<pre>protected&nbsp;java.util.Collection&lt;? extends java.security.cert.CRL&gt;&nbsp;loadCRL(java.lang.String&nbsp;crlPath)
throws java.lang.Exception</pre>
<div class="block">Loads certificate revocation list (CRL) from a file.
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>a (possibly empty) collection view of java.security.cert.CRL objects initialized with the data from the
input stream.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if unable to load CRL</dd>
</dl>
</li>
</ul>
<a name="secureResponse-javax.servlet.ServletRequest-javax.servlet.ServletResponse-boolean-org.eclipse.jetty.server.Authentication.User-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>secureResponse</h4>
<pre>public&nbsp;boolean&nbsp;secureResponse(javax.servlet.ServletRequest&nbsp;req,
javax.servlet.ServletResponse&nbsp;res,
boolean&nbsp;mandatory,
<a href="../../../../../org/eclipse/jetty/server/Authentication.User.html" title="interface in org.eclipse.jetty.server">Authentication.User</a>&nbsp;validatedUser)
throws <a href="../../../../../org/eclipse/jetty/security/ServerAuthException.html" title="class in org.eclipse.jetty.security">ServerAuthException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/eclipse/jetty/security/Authenticator.html#secureResponse-javax.servlet.ServletRequest-javax.servlet.ServletResponse-boolean-org.eclipse.jetty.server.Authentication.User-">Authenticator</a></code></span></div>
<div class="block">is response secure</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>req</code> - the request</dd>
<dd><code>res</code> - the response</dd>
<dd><code>mandatory</code> - if security is mandator</dd>
<dd><code>validatedUser</code> - the user that was validated</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if response is secure</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/eclipse/jetty/security/ServerAuthException.html" title="class in org.eclipse.jetty.security">ServerAuthException</a></code> - if unable to test response</dd>
</dl>
</li>
</ul>
<a name="isValidateCerts--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValidateCerts</h4>
<pre>public&nbsp;boolean&nbsp;isValidateCerts()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if SSL certificate has to be validated</dd>
</dl>
</li>
</ul>
<a name="setValidateCerts-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setValidateCerts</h4>
<pre>public&nbsp;void&nbsp;setValidateCerts(boolean&nbsp;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 name="getTrustStore--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTrustStore</h4>
<pre>public&nbsp;java.lang.String&nbsp;getTrustStore()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The file name or URL of the trust store location</dd>
</dl>
</li>
</ul>
<a name="setTrustStore-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTrustStore</h4>
<pre>public&nbsp;void&nbsp;setTrustStore(java.lang.String&nbsp;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 name="getTrustStoreProvider--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTrustStoreProvider</h4>
<pre>public&nbsp;java.lang.String&nbsp;getTrustStoreProvider()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The provider of the trust store</dd>
</dl>
</li>
</ul>
<a name="setTrustStoreProvider-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTrustStoreProvider</h4>
<pre>public&nbsp;void&nbsp;setTrustStoreProvider(java.lang.String&nbsp;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 name="getTrustStoreType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTrustStoreType</h4>
<pre>public&nbsp;java.lang.String&nbsp;getTrustStoreType()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The type of the trust store (default "JKS")</dd>
</dl>
</li>
</ul>
<a name="setTrustStoreType-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTrustStoreType</h4>
<pre>public&nbsp;void&nbsp;setTrustStoreType(java.lang.String&nbsp;trustStoreType)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>trustStoreType</code> - The type of the trust store (default "JKS")</dd>
</dl>
</li>
</ul>
<a name="setTrustStorePassword-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTrustStorePassword</h4>
<pre>public&nbsp;void&nbsp;setTrustStorePassword(java.lang.String&nbsp;password)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>password</code> - The password for the trust store</dd>
</dl>
</li>
</ul>
<a name="getCrlPath--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCrlPath</h4>
<pre>public&nbsp;java.lang.String&nbsp;getCrlPath()</pre>
<div class="block">Get the crlPath.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the crlPath</dd>
</dl>
</li>
</ul>
<a name="setCrlPath-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCrlPath</h4>
<pre>public&nbsp;void&nbsp;setCrlPath(java.lang.String&nbsp;crlPath)</pre>
<div class="block">Set the crlPath.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>crlPath</code> - the crlPath to set</dd>
</dl>
</li>
</ul>
<a name="getMaxCertPathLength--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxCertPathLength</h4>
<pre>public&nbsp;int&nbsp;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 name="setMaxCertPathLength-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxCertPathLength</h4>
<pre>public&nbsp;void&nbsp;setMaxCertPathLength(int&nbsp;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 name="isEnableCRLDP--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEnableCRLDP</h4>
<pre>public&nbsp;boolean&nbsp;isEnableCRLDP()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if CRL Distribution Points support is enabled</dd>
</dl>
</li>
</ul>
<a name="setEnableCRLDP-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEnableCRLDP</h4>
<pre>public&nbsp;void&nbsp;setEnableCRLDP(boolean&nbsp;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 name="isEnableOCSP--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEnableOCSP</h4>
<pre>public&nbsp;boolean&nbsp;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 name="setEnableOCSP-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEnableOCSP</h4>
<pre>public&nbsp;void&nbsp;setEnableOCSP(boolean&nbsp;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 name="getOcspResponderURL--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOcspResponderURL</h4>
<pre>public&nbsp;java.lang.String&nbsp;getOcspResponderURL()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Location of the OCSP Responder</dd>
</dl>
</li>
</ul>
<a name="setOcspResponderURL-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setOcspResponderURL</h4>
<pre>public&nbsp;void&nbsp;setOcspResponderURL(java.lang.String&nbsp;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>
</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/ClientCertAuthenticator.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/eclipse/jetty/security/authentication/BasicAuthenticator.html" title="class in org.eclipse.jetty.security.authentication"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/jetty/security/authentication/DeferredAuthentication.html" title="class in org.eclipse.jetty.security.authentication"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/jetty/security/authentication/ClientCertAuthenticator.html" target="_top">Frames</a></li>
<li><a href="ClientCertAuthenticator.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><a href="#fields.inherited.from.class.org.eclipse.jetty.security.authentication.LoginAuthenticator">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>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; 1995&#x2013;2018 <a href="http://webtide.com">Webtide</a>. All rights reserved.</small></p>
</body>
</html>