blob: 0b7ce43064373ce36dbf1794cdff5e950300e1f2 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.14.1) on Mon Apr 04 09:09:38 CDT 2022 -->
<title>BasicAuthentication (Eclipse Jetty API Doc - v10.0.9)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-04">
<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="BasicAuthentication (Eclipse Jetty API Doc - v10.0.9)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":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 = true;
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/BasicAuthentication.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><a href="#nested.class.summary">Nested</a>&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>Field&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.util</a></div>
<h2 title="Class BasicAuthentication" class="title">Class BasicAuthentication</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="AbstractAuthentication.html" title="class in org.eclipse.jetty.client.util">org.eclipse.jetty.client.util.AbstractAuthentication</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.client.util.BasicAuthentication</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="../api/Authentication.html" title="interface in org.eclipse.jetty.client.api">Authentication</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">BasicAuthentication</span>
extends <a href="AbstractAuthentication.html" title="class in org.eclipse.jetty.client.util">AbstractAuthentication</a></pre>
<div class="block">Implementation of the HTTP "Basic" authentication defined in RFC 2617.
<p>
Applications should create objects of this class and add them to the
<a href="../api/AuthenticationStore.html" title="interface in org.eclipse.jetty.client.api"><code>AuthenticationStore</code></a> retrieved from the <a href="../HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a>
via <a href="../HttpClient.html#getAuthenticationStore()"><code>HttpClient.getAuthenticationStore()</code></a>.</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">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="BasicAuthentication.BasicResult.html" title="class in org.eclipse.jetty.client.util">BasicAuthentication.BasicResult</a></span></code></th>
<td class="colLast">
<div class="block">Basic authentication result.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.client.api.Authentication">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.client.api.<a href="../api/Authentication.html" title="interface in org.eclipse.jetty.client.api">Authentication</a></h3>
<code><a href="../api/Authentication.HeaderInfo.html" title="class in org.eclipse.jetty.client.api">Authentication.HeaderInfo</a>, <a href="../api/Authentication.Result.html" title="interface in org.eclipse.jetty.client.api">Authentication.Result</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.client.api.Authentication">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.eclipse.jetty.client.api.<a href="../api/Authentication.html" title="interface in org.eclipse.jetty.client.api">Authentication</a></h3>
<code><a href="../api/Authentication.html#ANY_REALM">ANY_REALM</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(java.net.URI,java.lang.String,java.lang.String,java.lang.String)">BasicAuthentication</a></span>&#8203;(java.net.URI&nbsp;uri,
java.lang.String&nbsp;realm,
java.lang.String&nbsp;user,
java.lang.String&nbsp;password)</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><a href="../api/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>&#8203;(<a href="../api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;request,
<a href="../api/ContentResponse.html" title="interface in org.eclipse.jetty.client.api">ContentResponse</a>&nbsp;response,
<a href="../api/Authentication.HeaderInfo.html" title="class in org.eclipse.jetty.client.api">Authentication.HeaderInfo</a>&nbsp;headerInfo,
<a href="../../util/Attributes.html" title="interface in org.eclipse.jetty.util">Attributes</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">Executes the authentication mechanism for the given request, returning a <a href="../api/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="../api/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>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getType()">getType</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.util.AbstractAuthentication">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.client.util.<a href="AbstractAuthentication.html" title="class in org.eclipse.jetty.client.util">AbstractAuthentication</a></h3>
<code><a href="AbstractAuthentication.html#getRealm()">getRealm</a>, <a href="AbstractAuthentication.html#getURI()">getURI</a>, <a href="AbstractAuthentication.html#matches(java.lang.String,java.net.URI,java.lang.String)">matches</a>, <a href="AbstractAuthentication.html#matchesURI(java.net.URI,java.net.URI)">matchesURI</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">
<!-- ========= 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;(java.net.URI,java.lang.String,java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BasicAuthentication</h4>
<pre>public&nbsp;BasicAuthentication&#8203;(java.net.URI&nbsp;uri,
java.lang.String&nbsp;realm,
java.lang.String&nbsp;user,
java.lang.String&nbsp;password)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uri</code> - the URI to match for the authentication</dd>
<dd><code>realm</code> - the realm to match for the authentication</dd>
<dd><code>user</code> - the user that wants to authenticate</dd>
<dd><code>password</code> - the password of the user</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="getType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getType()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="AbstractAuthentication.html#getType()">getType</a></code>&nbsp;in class&nbsp;<code><a href="AbstractAuthentication.html" title="class in org.eclipse.jetty.client.util">AbstractAuthentication</a></code></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">public&nbsp;<a href="../api/Authentication.Result.html" title="interface in org.eclipse.jetty.client.api">Authentication.Result</a>&nbsp;authenticate&#8203;(<a href="../api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;request,
<a href="../api/ContentResponse.html" title="interface in org.eclipse.jetty.client.api">ContentResponse</a>&nbsp;response,
<a href="../api/Authentication.HeaderInfo.html" title="class in org.eclipse.jetty.client.api">Authentication.HeaderInfo</a>&nbsp;headerInfo,
<a href="../../util/Attributes.html" title="interface in org.eclipse.jetty.util">Attributes</a>&nbsp;context)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/Authentication.html#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)">Authentication</a></code></span></div>
<div class="block">Executes the authentication mechanism for the given request, returning a <a href="../api/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="../api/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="../api/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/BasicAuthentication.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><a href="#nested.class.summary">Nested</a>&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>Field&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;2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>