blob: 8bb02b4acf79de5d669fc98228d0f768155b87fa [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>AuthenticationStore (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="AuthenticationStore (Jetty :: Project 9.4.44.v20210927 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":18,"i7":6,"i8":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/AuthenticationStore.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>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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.api</a></div>
<h2 title="Interface AuthenticationStore" class="title">Interface AuthenticationStore</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="../HttpAuthenticationStore.html" title="class in org.eclipse.jetty.client">HttpAuthenticationStore</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">AuthenticationStore</span></pre>
<div class="block">A store for <a href="Authentication.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication</code></a>s and <a href="Authentication.Result.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication.Result</code></a>s.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addAuthentication(org.eclipse.jetty.client.api.Authentication)">addAuthentication</a></span>&#8203;(<a href="Authentication.html" title="interface in org.eclipse.jetty.client.api">Authentication</a>&nbsp;authentication)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addAuthenticationResult(org.eclipse.jetty.client.api.Authentication.Result)">addAuthenticationResult</a></span>&#8203;(<a href="Authentication.Result.html" title="interface in org.eclipse.jetty.client.api">Authentication.Result</a>&nbsp;result)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clearAuthenticationResults()">clearAuthenticationResults</a></span>()</code></th>
<td class="colLast">
<div class="block">Removes all authentication results stored</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clearAuthentications()">clearAuthentications</a></span>()</code></th>
<td class="colLast">
<div class="block">Removes all <a href="Authentication.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication</code></a>s stored</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="Authentication.html" title="interface in org.eclipse.jetty.client.api">Authentication</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findAuthentication(java.lang.String,java.net.URI,java.lang.String)">findAuthentication</a></span>&#8203;(java.lang.String&nbsp;type,
java.net.URI&nbsp;uri,
java.lang.String&nbsp;realm)</code></th>
<td class="colLast">
<div class="block">Returns the authentication that matches the given type (for example, "Basic" or "Digest"),
the given request URI and the given realm.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<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="#findAuthenticationResult(java.net.URI)">findAuthenticationResult</a></span>&#8203;(java.net.URI&nbsp;uri)</code></th>
<td class="colLast">
<div class="block">Returns an <a href="Authentication.Result.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication.Result</code></a> that matches the given URI, or null if no
<a href="Authentication.Result.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication.Result</code></a>s match the given URI.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>default boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasAuthenticationResults()">hasAuthenticationResults</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeAuthentication(org.eclipse.jetty.client.api.Authentication)">removeAuthentication</a></span>&#8203;(<a href="Authentication.html" title="interface in org.eclipse.jetty.client.api">Authentication</a>&nbsp;authentication)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeAuthenticationResult(org.eclipse.jetty.client.api.Authentication.Result)">removeAuthenticationResult</a></span>&#8203;(<a href="Authentication.Result.html" title="interface in org.eclipse.jetty.client.api">Authentication.Result</a>&nbsp;result)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="addAuthentication(org.eclipse.jetty.client.api.Authentication)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addAuthentication</h4>
<pre class="methodSignature">void&nbsp;addAuthentication&#8203;(<a href="Authentication.html" title="interface in org.eclipse.jetty.client.api">Authentication</a>&nbsp;authentication)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>authentication</code> - the <a href="Authentication.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication</code></a> to add</dd>
</dl>
</li>
</ul>
<a id="removeAuthentication(org.eclipse.jetty.client.api.Authentication)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAuthentication</h4>
<pre class="methodSignature">void&nbsp;removeAuthentication&#8203;(<a href="Authentication.html" title="interface in org.eclipse.jetty.client.api">Authentication</a>&nbsp;authentication)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>authentication</code> - the <a href="Authentication.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication</code></a> to remove</dd>
</dl>
</li>
</ul>
<a id="clearAuthentications()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearAuthentications</h4>
<pre class="methodSignature">void&nbsp;clearAuthentications()</pre>
<div class="block">Removes all <a href="Authentication.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication</code></a>s stored</div>
</li>
</ul>
<a id="findAuthentication(java.lang.String,java.net.URI,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findAuthentication</h4>
<pre class="methodSignature"><a href="Authentication.html" title="interface in org.eclipse.jetty.client.api">Authentication</a>&nbsp;findAuthentication&#8203;(java.lang.String&nbsp;type,
java.net.URI&nbsp;uri,
java.lang.String&nbsp;realm)</pre>
<div class="block">Returns the authentication that matches the given type (for example, "Basic" or "Digest"),
the given request URI and the given realm.
If no such authentication can be found, returns null.</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</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the authentication that matches the given parameters, or null</dd>
</dl>
</li>
</ul>
<a id="addAuthenticationResult(org.eclipse.jetty.client.api.Authentication.Result)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addAuthenticationResult</h4>
<pre class="methodSignature">void&nbsp;addAuthenticationResult&#8203;(<a href="Authentication.Result.html" title="interface in org.eclipse.jetty.client.api">Authentication.Result</a>&nbsp;result)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>result</code> - the <a href="Authentication.Result.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication.Result</code></a> to add</dd>
</dl>
</li>
</ul>
<a id="removeAuthenticationResult(org.eclipse.jetty.client.api.Authentication.Result)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAuthenticationResult</h4>
<pre class="methodSignature">void&nbsp;removeAuthenticationResult&#8203;(<a href="Authentication.Result.html" title="interface in org.eclipse.jetty.client.api">Authentication.Result</a>&nbsp;result)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>result</code> - the <a href="Authentication.Result.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication.Result</code></a> to remove</dd>
</dl>
</li>
</ul>
<a id="clearAuthenticationResults()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearAuthenticationResults</h4>
<pre class="methodSignature">void&nbsp;clearAuthenticationResults()</pre>
<div class="block">Removes all authentication results stored</div>
</li>
</ul>
<a id="findAuthenticationResult(java.net.URI)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findAuthenticationResult</h4>
<pre class="methodSignature"><a href="Authentication.Result.html" title="interface in org.eclipse.jetty.client.api">Authentication.Result</a>&nbsp;findAuthenticationResult&#8203;(java.net.URI&nbsp;uri)</pre>
<div class="block">Returns an <a href="Authentication.Result.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication.Result</code></a> that matches the given URI, or null if no
<a href="Authentication.Result.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication.Result</code></a>s match the given URI.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uri</code> - the request URI</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="Authentication.Result.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication.Result</code></a> that matches the given URI, or null</dd>
</dl>
</li>
</ul>
<a id="hasAuthenticationResults()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>hasAuthenticationResults</h4>
<pre class="methodSignature">default&nbsp;boolean&nbsp;hasAuthenticationResults()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>false if there are no stored authentication results, true if there may be some.</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/AuthenticationStore.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>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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>