blob: 8af9b20122278f395c55fcdb40aba1f153b9c98b [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.11) on Fri Oct 01 11:33:56 CDT 2021 -->
<title>WWWAuthenticationProtocolHandler (Jetty :: Project 9.4.44.v20210927 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2021-10-01">
<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="WWWAuthenticationProtocolHandler (Jetty :: Project 9.4.44.v20210927 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/WWWAuthenticationProtocolHandler.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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">org.eclipse.jetty.client</a></div>
<h2 title="Class WWWAuthenticationProtocolHandler" class="title">Class WWWAuthenticationProtocolHandler</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="AuthenticationProtocolHandler.html" title="class in org.eclipse.jetty.client">org.eclipse.jetty.client.AuthenticationProtocolHandler</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.client.WWWAuthenticationProtocolHandler</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="ProtocolHandler.html" title="interface in org.eclipse.jetty.client">ProtocolHandler</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">WWWAuthenticationProtocolHandler</span>
extends <a href="AuthenticationProtocolHandler.html" title="class in org.eclipse.jetty.client">AuthenticationProtocolHandler</a></pre>
<div class="block"><p>A protocol handler that handles the 401 response code
in association with the <code>WWW-Authenticate</code> header.</p></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="ProxyAuthenticationProtocolHandler.html" title="class in org.eclipse.jetty.client"><code>ProxyAuthenticationProtocolHandler</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== 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">&nbsp;</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="#NAME">NAME</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.client.AuthenticationProtocolHandler">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.jetty.client.<a href="AuthenticationProtocolHandler.html" title="class in org.eclipse.jetty.client">AuthenticationProtocolHandler</a></h3>
<code><a href="AuthenticationProtocolHandler.html#DEFAULT_MAX_CONTENT_LENGTH">DEFAULT_MAX_CONTENT_LENGTH</a>, <a href="AuthenticationProtocolHandler.html#LOG">LOG</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.client.HttpClient)">WWWAuthenticationProtocolHandler</a></span>&#8203;(<a href="HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a>&nbsp;client)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.client.HttpClient,int)">WWWAuthenticationProtocolHandler</a></span>&#8203;(<a href="HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a>&nbsp;client,
int&nbsp;maxContentLength)</code></th>
<td class="colLast">&nbsp;</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">&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></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>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#accept(org.eclipse.jetty.client.api.Request,org.eclipse.jetty.client.api.Response)">accept</a></span>&#8203;(<a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;request,
<a href="api/Response.html" title="interface in org.eclipse.jetty.client.api">Response</a>&nbsp;response)</code></th>
<td class="colLast">
<div class="block">Inspects the given <code>request</code> and <code>response</code>
to detect whether this protocol handler should handle them.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected <a href="../http/HttpHeader.html" title="enum in org.eclipse.jetty.http">HttpHeader</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAuthenticateHeader()">getAuthenticateHeader</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAuthenticationAttribute()">getAuthenticationAttribute</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected java.net.URI</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAuthenticationURI(org.eclipse.jetty.client.api.Request)">getAuthenticationURI</a></span>&#8203;(<a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;request)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected <a href="../http/HttpHeader.html" title="enum in org.eclipse.jetty.http">HttpHeader</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAuthorizationHeader()">getAuthorizationHeader</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getName()">getName</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.client.AuthenticationProtocolHandler">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.client.<a href="AuthenticationProtocolHandler.html" title="class in org.eclipse.jetty.client">AuthenticationProtocolHandler</a></h3>
<code><a href="AuthenticationProtocolHandler.html#getHeaderInfo(java.lang.String)">getHeaderInfo</a>, <a href="AuthenticationProtocolHandler.html#getHttpClient()">getHttpClient</a>, <a href="AuthenticationProtocolHandler.html#getResponseListener()">getResponseListener</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="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>
</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="NAME">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>NAME</h4>
<pre>public static final&nbsp;java.lang.String NAME</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.eclipse.jetty.client.WWWAuthenticationProtocolHandler.NAME">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(org.eclipse.jetty.client.HttpClient)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WWWAuthenticationProtocolHandler</h4>
<pre>public&nbsp;WWWAuthenticationProtocolHandler&#8203;(<a href="HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a>&nbsp;client)</pre>
</li>
</ul>
<a id="&lt;init&gt;(org.eclipse.jetty.client.HttpClient,int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WWWAuthenticationProtocolHandler</h4>
<pre>public&nbsp;WWWAuthenticationProtocolHandler&#8203;(<a href="HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a>&nbsp;client,
int&nbsp;maxContentLength)</pre>
</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="getName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getName()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a unique name among protocol handlers</dd>
</dl>
</li>
</ul>
<a id="accept(org.eclipse.jetty.client.api.Request,org.eclipse.jetty.client.api.Response)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>accept</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;accept&#8203;(<a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;request,
<a href="api/Response.html" title="interface in org.eclipse.jetty.client.api">Response</a>&nbsp;response)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="ProtocolHandler.html#accept(org.eclipse.jetty.client.api.Request,org.eclipse.jetty.client.api.Response)">ProtocolHandler</a></code></span></div>
<div class="block"><p>Inspects the given <code>request</code> and <code>response</code>
to detect whether this protocol handler should handle them.</p>
<p>For example, a redirect protocol handler can inspect the
response code and return true if it is a redirect response code.</p>
<p>This method is being called just after the response line has
been parsed, and before the response headers are available.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - the request to accept</dd>
<dd><code>response</code> - the response to accept</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this protocol handler can handle the given request and response</dd>
</dl>
</li>
</ul>
<a id="getAuthenticateHeader()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAuthenticateHeader</h4>
<pre class="methodSignature">protected&nbsp;<a href="../http/HttpHeader.html" title="enum in org.eclipse.jetty.http">HttpHeader</a>&nbsp;getAuthenticateHeader()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="AuthenticationProtocolHandler.html#getAuthenticateHeader()">getAuthenticateHeader</a></code>&nbsp;in class&nbsp;<code><a href="AuthenticationProtocolHandler.html" title="class in org.eclipse.jetty.client">AuthenticationProtocolHandler</a></code></dd>
</dl>
</li>
</ul>
<a id="getAuthorizationHeader()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAuthorizationHeader</h4>
<pre class="methodSignature">protected&nbsp;<a href="../http/HttpHeader.html" title="enum in org.eclipse.jetty.http">HttpHeader</a>&nbsp;getAuthorizationHeader()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="AuthenticationProtocolHandler.html#getAuthorizationHeader()">getAuthorizationHeader</a></code>&nbsp;in class&nbsp;<code><a href="AuthenticationProtocolHandler.html" title="class in org.eclipse.jetty.client">AuthenticationProtocolHandler</a></code></dd>
</dl>
</li>
</ul>
<a id="getAuthenticationURI(org.eclipse.jetty.client.api.Request)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAuthenticationURI</h4>
<pre class="methodSignature">protected&nbsp;java.net.URI&nbsp;getAuthenticationURI&#8203;(<a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;request)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="AuthenticationProtocolHandler.html#getAuthenticationURI(org.eclipse.jetty.client.api.Request)">getAuthenticationURI</a></code>&nbsp;in class&nbsp;<code><a href="AuthenticationProtocolHandler.html" title="class in org.eclipse.jetty.client">AuthenticationProtocolHandler</a></code></dd>
</dl>
</li>
</ul>
<a id="getAuthenticationAttribute()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getAuthenticationAttribute</h4>
<pre class="methodSignature">protected&nbsp;java.lang.String&nbsp;getAuthenticationAttribute()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="AuthenticationProtocolHandler.html#getAuthenticationAttribute()">getAuthenticationAttribute</a></code>&nbsp;in class&nbsp;<code><a href="AuthenticationProtocolHandler.html" title="class in org.eclipse.jetty.client">AuthenticationProtocolHandler</a></code></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/WWWAuthenticationProtocolHandler.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&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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 1995&#x2013;2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>