| <!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 (version 1.7.0_80) on Wed Jun 07 15:10:53 EDT 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Authentication (Jetty :: Project 9.2.22.v20170606 API)</title> |
| <meta name="date" content="2017-06-07"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Authentication (Jetty :: Project 9.2.22.v20170606 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/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 class="aboutLanguage"><em><script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-1149868-7']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script></em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../org/eclipse/jetty/client/api/Authentication.HeaderInfo.html" title="class in org.eclipse.jetty.client.api"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/jetty/client/api/Authentication.html" target="_top">Frames</a></li> |
| <li><a href="Authentication.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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: </li> |
| <li><a href="#nested_class_summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.client.api</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><a href="../../../../../org/eclipse/jetty/client/util/AbstractAuthentication.html" title="class in org.eclipse.jetty.client.util">AbstractAuthentication</a>, <a href="../../../../../org/eclipse/jetty/client/util/BasicAuthentication.html" title="class in org.eclipse.jetty.client.util">BasicAuthentication</a>, <a href="../../../../../org/eclipse/jetty/client/util/DigestAuthentication.html" title="class in org.eclipse.jetty.client.util">DigestAuthentication</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">Authentication</span></pre> |
| <div class="block"><a href="../../../../../org/eclipse/jetty/client/api/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="../../../../../org/eclipse/jetty/client/api/Authentication.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication</code></a>s are added to an <a href="../../../../../org/eclipse/jetty/client/api/AuthenticationStore.html" title="interface in org.eclipse.jetty.client.api"><code>AuthenticationStore</code></a>, which is then |
| <a href="../../../../../org/eclipse/jetty/client/api/Authentication.html#matches(java.lang.String,%20java.net.URI,%20java.lang.String)"><code>queried</code></a> to find the right |
| <a href="../../../../../org/eclipse/jetty/client/api/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="../../../../../org/eclipse/jetty/client/api/Authentication.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication</code></a> mechanism is found, it is then |
| <a href="../../../../../org/eclipse/jetty/client/api/Authentication.html#authenticate(org.eclipse.jetty.client.api.Request,%20org.eclipse.jetty.client.api.ContentResponse,%20org.eclipse.jetty.client.api.Authentication.HeaderInfo,%20org.eclipse.jetty.util.Attributes)"><code>executed</code></a> for the given request, |
| returning an <a href="../../../../../org/eclipse/jetty/client/api/Authentication.Result.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication.Result</code></a>, which is then stored in the <a href="../../../../../org/eclipse/jetty/client/api/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 ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_class_summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/client/api/Authentication.HeaderInfo.html" title="class in org.eclipse.jetty.client.api">Authentication.HeaderInfo</a></strong></code> |
| <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> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/client/api/Authentication.Result.html" title="interface in org.eclipse.jetty.client.api">Authentication.Result</a></strong></code> |
| <div class="block"><a href="../../../../../org/eclipse/jetty/client/api/Result.html" title="class in org.eclipse.jetty.client.api"><code>Result</code></a> holds the information needed to authenticate a <a href="../../../../../org/eclipse/jetty/client/api/Request.html" title="interface in org.eclipse.jetty.client.api"><code>Request</code></a> via <a href="../../../../../org/eclipse/jetty/client/api/Authentication.Result.html#apply(org.eclipse.jetty.client.api.Request)"><code>Authentication.Result.apply(Request)</code></a>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/client/api/Authentication.Result.html" title="interface in org.eclipse.jetty.client.api">Authentication.Result</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/client/api/Authentication.html#authenticate(org.eclipse.jetty.client.api.Request,%20org.eclipse.jetty.client.api.ContentResponse,%20org.eclipse.jetty.client.api.Authentication.HeaderInfo,%20org.eclipse.jetty.util.Attributes)">authenticate</a></strong>(<a href="../../../../../org/eclipse/jetty/client/api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> request, |
| <a href="../../../../../org/eclipse/jetty/client/api/ContentResponse.html" title="interface in org.eclipse.jetty.client.api">ContentResponse</a> response, |
| <a href="../../../../../org/eclipse/jetty/client/api/Authentication.HeaderInfo.html" title="class in org.eclipse.jetty.client.api">Authentication.HeaderInfo</a> headerInfo, |
| <a href="../../../../../org/eclipse/jetty/util/Attributes.html" title="interface in org.eclipse.jetty.util">Attributes</a> context)</code> |
| <div class="block">Executes the authentication mechanism for the given request, returning a <a href="../../../../../org/eclipse/jetty/client/api/Result.html" title="class in org.eclipse.jetty.client.api"><code>Result</code></a> that can be |
| used to actually authenticate the request via <code>Result#apply(Request)</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/client/api/Authentication.html#matches(java.lang.String,%20java.net.URI,%20java.lang.String)">matches</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> uri, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> realm)</code> |
| <div class="block">Matches <a href="../../../../../org/eclipse/jetty/client/api/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> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="matches(java.lang.String, java.net.URI, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>matches</h4> |
| <pre>boolean matches(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> uri, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> realm)</pre> |
| <div class="block">Matches <a href="../../../../../org/eclipse/jetty/client/api/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="strong">Parameters:</span></dt><dd><code>type</code> - the <a href="../../../../../org/eclipse/jetty/client/api/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="strong">Returns:</span></dt><dd>true if this authentication matches, false otherwise</dd></dl> |
| </li> |
| </ul> |
| <a name="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><a href="../../../../../org/eclipse/jetty/client/api/Authentication.Result.html" title="interface in org.eclipse.jetty.client.api">Authentication.Result</a> authenticate(<a href="../../../../../org/eclipse/jetty/client/api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> request, |
| <a href="../../../../../org/eclipse/jetty/client/api/ContentResponse.html" title="interface in org.eclipse.jetty.client.api">ContentResponse</a> response, |
| <a href="../../../../../org/eclipse/jetty/client/api/Authentication.HeaderInfo.html" title="class in org.eclipse.jetty.client.api">Authentication.HeaderInfo</a> headerInfo, |
| <a href="../../../../../org/eclipse/jetty/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="../../../../../org/eclipse/jetty/client/api/Result.html" title="class in org.eclipse.jetty.client.api"><code>Result</code></a> that can be |
| used to actually authenticate the request via <code>Result#apply(Request)</code>. |
| <p /> |
| If a request for <code>"/secure"</code> returns a <a href="../../../../../org/eclipse/jetty/client/api/Result.html" title="class in org.eclipse.jetty.client.api"><code>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="strong">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="strong">Returns:</span></dt><dd>the authentication result, or null if the authentication could not be performed</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/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 class="aboutLanguage"><em><script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-1149868-7']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script></em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../org/eclipse/jetty/client/api/Authentication.HeaderInfo.html" title="class in org.eclipse.jetty.client.api"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/jetty/client/api/Authentication.html" target="_top">Frames</a></li> |
| <li><a href="Authentication.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested_class_summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 1995-2017 <a href="http://webtide.com">Webtide</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
