| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) on Thu Sep 15 14:13:16 CDT 2022 --> |
| <title>ConfigurableSpnegoAuthenticator (Eclipse Jetty API Doc - v11.0.12)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-09-15"> |
| <meta name="description" content="declaration: package: org.eclipse.jetty.security.authentication, class: ConfigurableSpnegoAuthenticator"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/ConfigurableSpnegoAuthenticator.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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <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="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.eclipse.jetty.security.authentication</a></div> |
| <h1 title="Class ConfigurableSpnegoAuthenticator" class="title">Class ConfigurableSpnegoAuthenticator</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="LoginAuthenticator.html" title="class in org.eclipse.jetty.security.authentication">org.eclipse.jetty.security.authentication.LoginAuthenticator</a> |
| <div class="inheritance">org.eclipse.jetty.security.authentication.ConfigurableSpnegoAuthenticator</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../Authenticator.html" title="interface in org.eclipse.jetty.security">Authenticator</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ConfigurableSpnegoAuthenticator</span> |
| <span class="extends-implements">extends <a href="LoginAuthenticator.html" title="class in org.eclipse.jetty.security.authentication">LoginAuthenticator</a></span></div> |
| <div class="block"><p>A LoginAuthenticator that uses SPNEGO and the GSS API to authenticate requests.</p> |
| <p>A successful authentication from a client is cached for a configurable |
| <a href="#getAuthenticationDuration()"><code>duration</code></a> using the HTTP session; this avoids |
| that the client is asked to authenticate for every request.</p></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../ConfigurableSpnegoLoginService.html" title="class in org.eclipse.jetty.security"><code>ConfigurableSpnegoLoginService</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.eclipse.jetty.security.Authenticator">Nested classes/interfaces inherited from interface org.eclipse.jetty.security.<a href="../Authenticator.html" title="interface in org.eclipse.jetty.security">Authenticator</a></h2> |
| <code><a href="../Authenticator.AuthConfiguration.html" title="interface in org.eclipse.jetty.security">Authenticator.AuthConfiguration</a>, <a href="../Authenticator.Factory.html" title="interface in org.eclipse.jetty.security">Authenticator.Factory</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.eclipse.jetty.security.authentication.LoginAuthenticator">Fields inherited from class org.eclipse.jetty.security.authentication.<a href="LoginAuthenticator.html" title="class in org.eclipse.jetty.security.authentication">LoginAuthenticator</a></h3> |
| <code><a href="LoginAuthenticator.html#_identityService">_identityService</a>, <a href="LoginAuthenticator.html#_loginService">_loginService</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ConfigurableSpnegoAuthenticator</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">ConfigurableSpnegoAuthenticator</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> authMethod)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Allow for a custom authMethod value to be set for instances where SPNEGO may not be appropriate</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAuthenticationDuration()" class="member-name-link">getAuthenticationDuration</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAuthMethod()" class="member-name-link">getAuthMethod</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../server/UserIdentity.html" title="interface in org.eclipse.jetty.server">UserIdentity</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#login(java.lang.String,java.lang.Object,jakarta.servlet.ServletRequest)" class="member-name-link">login</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> username, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> password, |
| jakarta.servlet.ServletRequest servletRequest)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Only renew the session id if the user has been fully authenticated, don't |
| renew the session for any of the intermediate request/response handshakes.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#secureResponse(jakarta.servlet.ServletRequest,jakarta.servlet.ServletResponse,boolean,org.eclipse.jetty.server.Authentication.User)" class="member-name-link">secureResponse</a><wbr>(jakarta.servlet.ServletRequest request, |
| jakarta.servlet.ServletResponse response, |
| boolean mandatory, |
| <a href="../../server/Authentication.User.html" title="interface in org.eclipse.jetty.server">Authentication.User</a> validatedUser)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">is response secure</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAuthenticationDuration(java.time.Duration)" class="member-name-link">setAuthenticationDuration</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a> authenticationDuration)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the duration of the authentication.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../server/Authentication.html" title="interface in org.eclipse.jetty.server">Authentication</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#validateRequest(jakarta.servlet.ServletRequest,jakarta.servlet.ServletResponse,boolean)" class="member-name-link">validateRequest</a><wbr>(jakarta.servlet.ServletRequest req, |
| jakarta.servlet.ServletResponse res, |
| boolean mandatory)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Validate a request</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.security.authentication.LoginAuthenticator">Methods inherited from class org.eclipse.jetty.security.authentication.<a href="LoginAuthenticator.html" title="class in org.eclipse.jetty.security.authentication">LoginAuthenticator</a></h3> |
| <code><a href="LoginAuthenticator.html#getLoginService()">getLoginService</a>, <a href="LoginAuthenticator.html#logout(jakarta.servlet.ServletRequest)">logout</a>, <a href="LoginAuthenticator.html#prepareRequest(jakarta.servlet.ServletRequest)">prepareRequest</a>, <a href="LoginAuthenticator.html#renewSession(jakarta.servlet.http.HttpServletRequest,jakarta.servlet.http.HttpServletResponse)">renewSession</a>, <a href="LoginAuthenticator.html#setConfiguration(org.eclipse.jetty.security.Authenticator.AuthConfiguration)">setConfiguration</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>ConfigurableSpnegoAuthenticator</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ConfigurableSpnegoAuthenticator</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String)"> |
| <h3>ConfigurableSpnegoAuthenticator</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ConfigurableSpnegoAuthenticator</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> authMethod)</span></div> |
| <div class="block">Allow for a custom authMethod value to be set for instances where SPNEGO may not be appropriate</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>authMethod</code> - the auth method</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getAuthMethod()"> |
| <h3>getAuthMethod</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getAuthMethod</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The name of the authentication method</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAuthenticationDuration()"> |
| <h3>getAuthenticationDuration</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a></span> <span class="element-name">getAuthenticationDuration</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the authentication duration</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setAuthenticationDuration(java.time.Duration)"> |
| <h3>setAuthenticationDuration</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setAuthenticationDuration</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a> authenticationDuration)</span></div> |
| <div class="block"><p>Sets the duration of the authentication.</p> |
| <p>A negative duration means that the authentication is only valid for the current request.</p> |
| <p>A zero duration means that the authentication is valid forever.</p> |
| <p>A positive value means that the authentication is valid for the specified duration.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>authenticationDuration</code> - the authentication duration</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="login(java.lang.String,java.lang.Object,jakarta.servlet.ServletRequest)"> |
| <h3>login</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../server/UserIdentity.html" title="interface in org.eclipse.jetty.server">UserIdentity</a></span> <span class="element-name">login</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> username, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> password, |
| jakarta.servlet.ServletRequest servletRequest)</span></div> |
| <div class="block">Only renew the session id if the user has been fully authenticated, don't |
| renew the session for any of the intermediate request/response handshakes.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="LoginAuthenticator.html#login(java.lang.String,java.lang.Object,jakarta.servlet.ServletRequest)">login</a></code> in class <code><a href="LoginAuthenticator.html" title="class in org.eclipse.jetty.security.authentication">LoginAuthenticator</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>username</code> - the username of the client to be authenticated</dd> |
| <dd><code>password</code> - the user's credential</dd> |
| <dd><code>servletRequest</code> - the inbound request that needs authentication</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="validateRequest(jakarta.servlet.ServletRequest,jakarta.servlet.ServletResponse,boolean)"> |
| <h3>validateRequest</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../server/Authentication.html" title="interface in org.eclipse.jetty.server">Authentication</a></span> <span class="element-name">validateRequest</span><wbr><span class="parameters">(jakarta.servlet.ServletRequest req, |
| jakarta.servlet.ServletResponse res, |
| boolean mandatory)</span> |
| throws <span class="exceptions"><a href="../ServerAuthException.html" title="class in org.eclipse.jetty.security">ServerAuthException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Authenticator.html#validateRequest(jakarta.servlet.ServletRequest,jakarta.servlet.ServletResponse,boolean)">Authenticator</a></code></span></div> |
| <div class="block">Validate a request</div> |
| <dl class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>An Authentication. If Authentication is successful, this will be a <a href="../../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="../../server/Authentication.ResponseSent.html" title="interface in org.eclipse.jetty.server"><code>Authentication.ResponseSent</code></a>. If Authentication is not mandatory, then a |
| <a href="../../server/Authentication.Deferred.html" title="interface in org.eclipse.jetty.server"><code>Authentication.Deferred</code></a> may be returned.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../ServerAuthException.html" title="class in org.eclipse.jetty.security">ServerAuthException</a></code> - if unable to validate request</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="secureResponse(jakarta.servlet.ServletRequest,jakarta.servlet.ServletResponse,boolean,org.eclipse.jetty.server.Authentication.User)"> |
| <h3>secureResponse</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">secureResponse</span><wbr><span class="parameters">(jakarta.servlet.ServletRequest request, |
| jakarta.servlet.ServletResponse response, |
| boolean mandatory, |
| <a href="../../server/Authentication.User.html" title="interface in org.eclipse.jetty.server">Authentication.User</a> validatedUser)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Authenticator.html#secureResponse(jakarta.servlet.ServletRequest,jakarta.servlet.ServletResponse,boolean,org.eclipse.jetty.server.Authentication.User)">Authenticator</a></code></span></div> |
| <div class="block">is response secure</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>request</code> - the request</dd> |
| <dd><code>response</code> - the response</dd> |
| <dd><code>mandatory</code> - if security is mandator</dd> |
| <dd><code>validatedUser</code> - the user that was validated</dd> |
| <dt>Returns:</dt> |
| <dd>true if response is secure</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 1995–2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |