| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.7) on Fri Jun 12 14:11:40 EDT 2020 --> |
| <title>Authentication (Jetty :: Project 9.4.30.v20200611 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2020-06-12"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Authentication (Jetty :: Project 9.4.30.v20200611 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = false; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/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><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.eclipse.jetty.client.api</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 Implementing Classes:</dt> |
| <dd><code><a href="../util/AbstractAuthentication.html" title="class in org.eclipse.jetty.client.util">AbstractAuthentication</a></code>, <code><a href="../util/BasicAuthentication.html" title="class in org.eclipse.jetty.client.util">BasicAuthentication</a></code>, <code><a href="../util/DigestAuthentication.html" title="class in org.eclipse.jetty.client.util">DigestAuthentication</a></code>, <code><a href="../util/SPNEGOAuthentication.html" title="class in org.eclipse.jetty.client.util">SPNEGOAuthentication</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">Authentication</span></pre> |
| <div class="block"><a href="Authentication.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication</code></a> represents a mechanism to authenticate requests for protected resources. |
| <p> |
| <a href="Authentication.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication</code></a>s are added to an <a href="AuthenticationStore.html" title="interface in org.eclipse.jetty.client.api"><code>AuthenticationStore</code></a>, which is then |
| <a href="#matches(java.lang.String,java.net.URI,java.lang.String)"><code>queried</code></a> to find the right |
| <a href="Authentication.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication</code></a> mechanism to use based on its type, URI and realm, as returned by |
| <code>WWW-Authenticate</code> response headers. |
| <p> |
| If an <a href="Authentication.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication</code></a> mechanism is found, it is then |
| <a href="#authenticate(org.eclipse.jetty.client.api.Request,org.eclipse.jetty.client.api.ContentResponse,org.eclipse.jetty.client.api.Authentication.HeaderInfo,org.eclipse.jetty.util.Attributes)"><code>executed</code></a> for the given request, |
| returning an <a href="Authentication.Result.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication.Result</code></a>, which is then stored in the <a href="AuthenticationStore.html" title="interface in org.eclipse.jetty.client.api"><code>AuthenticationStore</code></a> |
| so that subsequent requests can be preemptively authenticated.</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 class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Authentication.HeaderInfo.html" title="class in org.eclipse.jetty.client.api">Authentication.HeaderInfo</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Structure holding information about the <code>WWW-Authenticate</code> (or <code>Proxy-Authenticate</code>) header.</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.Result.html" title="interface in org.eclipse.jetty.client.api">Authentication.Result</a></span></code></th> |
| <td class="colLast"> |
| <div class="block"><a href="Authentication.Result.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication.Result</code></a> holds the information needed to authenticate a <a href="Request.html" title="interface in org.eclipse.jetty.client.api"><code>Request</code></a> via <a href="Authentication.Result.html#apply(org.eclipse.jetty.client.api.Request)"><code>Authentication.Result.apply(org.eclipse.jetty.client.api.Request)</code></a>.</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 java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ANY_REALM">ANY_REALM</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Constant used to indicate that any realm will match.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="Authentication.Result.html" title="interface in org.eclipse.jetty.client.api">Authentication.Result</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#authenticate(org.eclipse.jetty.client.api.Request,org.eclipse.jetty.client.api.ContentResponse,org.eclipse.jetty.client.api.Authentication.HeaderInfo,org.eclipse.jetty.util.Attributes)">authenticate</a></span>​(<a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> request, |
| <a href="ContentResponse.html" title="interface in org.eclipse.jetty.client.api">ContentResponse</a> response, |
| <a href="Authentication.HeaderInfo.html" title="class in org.eclipse.jetty.client.api">Authentication.HeaderInfo</a> headerInfo, |
| <a href="../../util/Attributes.html" title="interface in org.eclipse.jetty.util">Attributes</a> context)</code></th> |
| <td class="colLast"> |
| <div class="block">Executes the authentication mechanism for the given request, returning a <a href="Authentication.Result.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication.Result</code></a> that can be |
| used to actually authenticate the request via <a href="Authentication.Result.html#apply(org.eclipse.jetty.client.api.Request)"><code>Authentication.Result.apply(Request)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#matches(java.lang.String,java.net.URI,java.lang.String)">matches</a></span>​(java.lang.String type, |
| java.net.URI uri, |
| java.lang.String realm)</code></th> |
| <td class="colLast"> |
| <div class="block">Matches <a href="Authentication.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication</code></a>s based on the given parameters</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="ANY_REALM"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ANY_REALM</h4> |
| <pre>static final java.lang.String ANY_REALM</pre> |
| <div class="block">Constant used to indicate that any realm will match.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#matches(java.lang.String,java.net.URI,java.lang.String)"><code>matches(String, URI, String)</code></a>, |
| <a href="../../../../../constant-values.html#org.eclipse.jetty.client.api.Authentication.ANY_REALM">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="matches(java.lang.String,java.net.URI,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>matches</h4> |
| <pre class="methodSignature">boolean matches​(java.lang.String type, |
| java.net.URI uri, |
| java.lang.String realm)</pre> |
| <div class="block">Matches <a href="Authentication.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication</code></a>s based on the given parameters</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - the <a href="Authentication.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication</code></a> type such as "Basic" or "Digest"</dd> |
| <dd><code>uri</code> - the request URI</dd> |
| <dd><code>realm</code> - the authentication realm as provided in the <code>WWW-Authenticate</code> response header</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if this authentication matches, false otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="authenticate(org.eclipse.jetty.client.api.Request,org.eclipse.jetty.client.api.ContentResponse,org.eclipse.jetty.client.api.Authentication.HeaderInfo,org.eclipse.jetty.util.Attributes)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>authenticate</h4> |
| <pre class="methodSignature"><a href="Authentication.Result.html" title="interface in org.eclipse.jetty.client.api">Authentication.Result</a> authenticate​(<a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> request, |
| <a href="ContentResponse.html" title="interface in org.eclipse.jetty.client.api">ContentResponse</a> response, |
| <a href="Authentication.HeaderInfo.html" title="class in org.eclipse.jetty.client.api">Authentication.HeaderInfo</a> headerInfo, |
| <a href="../../util/Attributes.html" title="interface in org.eclipse.jetty.util">Attributes</a> context)</pre> |
| <div class="block">Executes the authentication mechanism for the given request, returning a <a href="Authentication.Result.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication.Result</code></a> that can be |
| used to actually authenticate the request via <a href="Authentication.Result.html#apply(org.eclipse.jetty.client.api.Request)"><code>Authentication.Result.apply(Request)</code></a>. |
| <p> |
| If a request for <code>"/secure"</code> returns a <a href="Authentication.Result.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication.Result</code></a>, then the result may be used for other |
| requests such as <code>"/secure/foo"</code> or <code>"/secure/bar"</code>, unless those resources are protected |
| by other realms.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - the request to execute the authentication mechanism for</dd> |
| <dd><code>response</code> - the 401 response obtained in the previous attempt to request the protected resource</dd> |
| <dd><code>headerInfo</code> - the <code>WWW-Authenticate</code> (or <code>Proxy-Authenticate</code>) header chosen for this |
| authentication (among the many that the response may contain)</dd> |
| <dd><code>context</code> - the conversation context in case the authentication needs multiple exchanges |
| to be completed and information needs to be stored across exchanges</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the authentication result, or null if the authentication could not be performed</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/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><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 1995–2020 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
