| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.10) on Fri Feb 26 09:50:23 CST 2021 --> |
| <title>Authentication (Jetty :: Project 9.4.38.v20210224 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2021-02-26"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Authentication (Jetty :: Project 9.4.38.v20210224 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = false; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Authentication.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li>Method</li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li>Method</li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.eclipse.jetty.server</a></div> |
| <h2 title="Interface Authentication" class="title">Interface Authentication</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="Authentication.Challenge.html" title="interface in org.eclipse.jetty.server">Authentication.Challenge</a></code>, <code><a href="Authentication.Deferred.html" title="interface in org.eclipse.jetty.server">Authentication.Deferred</a></code>, <code><a href="Authentication.Failure.html" title="interface in org.eclipse.jetty.server">Authentication.Failure</a></code>, <code><a href="Authentication.LoginAuthentication.html" title="interface in org.eclipse.jetty.server">Authentication.LoginAuthentication</a></code>, <code><a href="Authentication.LogoutAuthentication.html" title="interface in org.eclipse.jetty.server">Authentication.LogoutAuthentication</a></code>, <code><a href="Authentication.NonAuthenticated.html" title="interface in org.eclipse.jetty.server">Authentication.NonAuthenticated</a></code>, <code><a href="Authentication.ResponseSent.html" title="interface in org.eclipse.jetty.server">Authentication.ResponseSent</a></code>, <code><a href="Authentication.SendSuccess.html" title="interface in org.eclipse.jetty.server">Authentication.SendSuccess</a></code>, <code><a href="Authentication.User.html" title="interface in org.eclipse.jetty.server">Authentication.User</a></code>, <code><a href="Authentication.Wrapped.html" title="interface in org.eclipse.jetty.server">Authentication.Wrapped</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../security/AbstractUserAuthentication.html" title="class in org.eclipse.jetty.security">AbstractUserAuthentication</a></code>, <code><a href="../security/authentication/DeferredAuthentication.html" title="class in org.eclipse.jetty.security.authentication">DeferredAuthentication</a></code>, <code><a href="../security/authentication/FormAuthenticator.FormAuthentication.html" title="class in org.eclipse.jetty.security.authentication">FormAuthenticator.FormAuthentication</a></code>, <code><a href="../security/LoggedOutAuthentication.html" title="class in org.eclipse.jetty.security">LoggedOutAuthentication</a></code>, <code><a href="../security/openid/OpenIdAuthenticator.OpenIdAuthentication.html" title="class in org.eclipse.jetty.security.openid">OpenIdAuthenticator.OpenIdAuthentication</a></code>, <code><a href="../security/authentication/SessionAuthentication.html" title="class in org.eclipse.jetty.security.authentication">SessionAuthentication</a></code>, <code><a href="../security/UserAuthentication.html" title="class in org.eclipse.jetty.security">UserAuthentication</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">Authentication</span></pre> |
| <div class="block">The Authentication state of a request. |
| <p> |
| The Authentication state can be one of several sub-types that |
| reflects where the request is in the many different authentication |
| cycles. Authentication might not yet be checked or it might be checked |
| and failed, checked and deferred or succeeded.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Authentication.Challenge.html" title="interface in org.eclipse.jetty.server">Authentication.Challenge</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">An Authentication Challenge has been sent.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Authentication.Deferred.html" title="interface in org.eclipse.jetty.server">Authentication.Deferred</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">A deferred authentication with methods to progress |
| the authentication process.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Authentication.Failed.html" title="class in org.eclipse.jetty.server">Authentication.Failed</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Authentication.Failure.html" title="interface in org.eclipse.jetty.server">Authentication.Failure</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">An Authentication Failure has been sent.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Authentication.LoginAuthentication.html" title="interface in org.eclipse.jetty.server">Authentication.LoginAuthentication</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">An authentication that is capable of performing a programmatic login |
| operation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Authentication.LogoutAuthentication.html" title="interface in org.eclipse.jetty.server">Authentication.LogoutAuthentication</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">An authentication that is capable of performing a programmatic |
| logout operation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Authentication.NonAuthenticated.html" title="interface in org.eclipse.jetty.server">Authentication.NonAuthenticated</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">After a logout, the authentication reverts to a state |
| where it is possible to programmatically log in again.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Authentication.ResponseSent.html" title="interface in org.eclipse.jetty.server">Authentication.ResponseSent</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Authentication Response sent state.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Authentication.SendSuccess.html" title="interface in org.eclipse.jetty.server">Authentication.SendSuccess</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Authentication.User.html" title="interface in org.eclipse.jetty.server">Authentication.User</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">A successful Authentication with User information.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Authentication.Wrapped.html" title="interface in org.eclipse.jetty.server">Authentication.Wrapped</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">A wrapped authentication with methods provide the |
| wrapped request/response for use by the application</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="Authentication.html" title="interface in org.eclipse.jetty.server">Authentication</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#NOT_CHECKED">NOT_CHECKED</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Authentication not checked</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="Authentication.html" title="interface in org.eclipse.jetty.server">Authentication</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SEND_CONTINUE">SEND_CONTINUE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Authentication challenge sent.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="Authentication.html" title="interface in org.eclipse.jetty.server">Authentication</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SEND_FAILURE">SEND_FAILURE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Authentication failure sent.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="Authentication.html" title="interface in org.eclipse.jetty.server">Authentication</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SEND_SUCCESS">SEND_SUCCESS</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="Authentication.html" title="interface in org.eclipse.jetty.server">Authentication</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#UNAUTHENTICATED">UNAUTHENTICATED</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Unauthenticated state.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="UNAUTHENTICATED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>UNAUTHENTICATED</h4> |
| <pre>static final <a href="Authentication.html" title="interface in org.eclipse.jetty.server">Authentication</a> UNAUTHENTICATED</pre> |
| <div class="block">Unauthenticated state. |
| <p> |
| This convenience instance is for non mandatory authentication where credentials |
| have been presented and checked, but failed authentication.</div> |
| </li> |
| </ul> |
| <a id="NOT_CHECKED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NOT_CHECKED</h4> |
| <pre>static final <a href="Authentication.html" title="interface in org.eclipse.jetty.server">Authentication</a> NOT_CHECKED</pre> |
| <div class="block">Authentication not checked |
| <p> |
| This convenience instance us for non mandatory authentication when no |
| credentials are present to be checked.</div> |
| </li> |
| </ul> |
| <a id="SEND_CONTINUE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SEND_CONTINUE</h4> |
| <pre>static final <a href="Authentication.html" title="interface in org.eclipse.jetty.server">Authentication</a> SEND_CONTINUE</pre> |
| <div class="block">Authentication challenge sent. |
| <p> |
| This convenience instance is for when an authentication challenge has been sent.</div> |
| </li> |
| </ul> |
| <a id="SEND_FAILURE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SEND_FAILURE</h4> |
| <pre>static final <a href="Authentication.html" title="interface in org.eclipse.jetty.server">Authentication</a> SEND_FAILURE</pre> |
| <div class="block">Authentication failure sent. |
| <p> |
| This convenience instance is for when an authentication failure has been sent.</div> |
| </li> |
| </ul> |
| <a id="SEND_SUCCESS"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SEND_SUCCESS</h4> |
| <pre>static final <a href="Authentication.html" title="interface in org.eclipse.jetty.server">Authentication</a> SEND_SUCCESS</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Authentication.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li>Method</li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li>Method</li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 1995–2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
