You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
340 lines
18 KiB
340 lines
18 KiB
<!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 Nov 30 19:45:04 CET 2022 -->
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<title>AuthenticationStrategy (Apache HttpComponents Client 4.5.14 API)</title>
|
|
<meta name="date" content="2022-11-30">
|
|
<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="AuthenticationStrategy (Apache HttpComponents Client 4.5.14 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/AuthenticationStrategy.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">
|
|
<li><a href="../../../../org/apache/http/client/AuthenticationHandler.html" title="interface in org.apache.http.client"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../../org/apache/http/client/BackoffManager.html" title="interface in org.apache.http.client"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?org/apache/http/client/AuthenticationStrategy.html" target="_top">Frames</a></li>
|
|
<li><a href="AuthenticationStrategy.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>Nested | </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.apache.http.client</div>
|
|
<h2 title="Interface AuthenticationStrategy" class="title">Interface AuthenticationStrategy</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/apache/http/impl/client/ProxyAuthenticationStrategy.html" title="class in org.apache.http.impl.client">ProxyAuthenticationStrategy</a>, <a href="../../../../org/apache/http/impl/client/TargetAuthenticationStrategy.html" title="class in org.apache.http.impl.client">TargetAuthenticationStrategy</a></dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre>public interface <span class="strong">AuthenticationStrategy</span></pre>
|
|
<div class="block">/**
|
|
A handler for determining if an HTTP response represents an authentication challenge that was
|
|
sent back to the client as a result of authentication failure.
|
|
<p>
|
|
Implementations of this interface must be thread-safe. Access to shared data must be
|
|
synchronized as methods of this interface may be executed from multiple threads.</div>
|
|
<dl><dt><span class="strong">Since:</span></dt>
|
|
<dd>4.2</dd></dl>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========== 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>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../org/apache/http/client/AuthenticationStrategy.html#authFailed(org.apache.http.HttpHost,%20org.apache.http.auth.AuthScheme,%20org.apache.http.protocol.HttpContext)">authFailed</a></strong>(org.apache.http.HttpHost authhost,
|
|
<a href="../../../../org/apache/http/auth/AuthScheme.html" title="interface in org.apache.http.auth">AuthScheme</a> authScheme,
|
|
org.apache.http.protocol.HttpContext context)</code>
|
|
<div class="block">Callback invoked in case of unsuccessful authentication.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../org/apache/http/client/AuthenticationStrategy.html#authSucceeded(org.apache.http.HttpHost,%20org.apache.http.auth.AuthScheme,%20org.apache.http.protocol.HttpContext)">authSucceeded</a></strong>(org.apache.http.HttpHost authhost,
|
|
<a href="../../../../org/apache/http/auth/AuthScheme.html" title="interface in org.apache.http.auth">AuthScheme</a> authScheme,
|
|
org.apache.http.protocol.HttpContext context)</code>
|
|
<div class="block">Callback invoked in case of successful authentication.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,org.apache.http.Header></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../org/apache/http/client/AuthenticationStrategy.html#getChallenges(org.apache.http.HttpHost,%20org.apache.http.HttpResponse,%20org.apache.http.protocol.HttpContext)">getChallenges</a></strong>(org.apache.http.HttpHost authhost,
|
|
org.apache.http.HttpResponse response,
|
|
org.apache.http.protocol.HttpContext context)</code>
|
|
<div class="block">Extracts from the given HTTP response a collection of authentication
|
|
challenges, each of which represents an authentication scheme supported
|
|
by the authentication host.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../org/apache/http/client/AuthenticationStrategy.html#isAuthenticationRequested(org.apache.http.HttpHost,%20org.apache.http.HttpResponse,%20org.apache.http.protocol.HttpContext)">isAuthenticationRequested</a></strong>(org.apache.http.HttpHost authhost,
|
|
org.apache.http.HttpResponse response,
|
|
org.apache.http.protocol.HttpContext context)</code>
|
|
<div class="block">Determines if the given HTTP response response represents
|
|
an authentication challenge that was sent back as a result
|
|
of authentication failure.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/6/docs/api/java/util/Queue.html?is-external=true" title="class or interface in java.util">Queue</a><<a href="../../../../org/apache/http/auth/AuthOption.html" title="class in org.apache.http.auth">AuthOption</a>></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../org/apache/http/client/AuthenticationStrategy.html#select(java.util.Map,%20org.apache.http.HttpHost,%20org.apache.http.HttpResponse,%20org.apache.http.protocol.HttpContext)">select</a></strong>(<a href="https://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,org.apache.http.Header> challenges,
|
|
org.apache.http.HttpHost authhost,
|
|
org.apache.http.HttpResponse response,
|
|
org.apache.http.protocol.HttpContext context)</code>
|
|
<div class="block">Selects one authentication challenge out of all available and
|
|
creates and generates <a href="../../../../org/apache/http/auth/AuthOption.html" title="class in org.apache.http.auth"><code>AuthOption</code></a> instance capable of
|
|
processing that challenge.</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="isAuthenticationRequested(org.apache.http.HttpHost, org.apache.http.HttpResponse, org.apache.http.protocol.HttpContext)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isAuthenticationRequested</h4>
|
|
<pre>boolean isAuthenticationRequested(org.apache.http.HttpHost authhost,
|
|
org.apache.http.HttpResponse response,
|
|
org.apache.http.protocol.HttpContext context)</pre>
|
|
<div class="block">Determines if the given HTTP response response represents
|
|
an authentication challenge that was sent back as a result
|
|
of authentication failure.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>authhost</code> - authentication host.</dd><dd><code>response</code> - HTTP response.</dd><dd><code>context</code> - HTTP context.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if user authentication is required,
|
|
<code>false</code> otherwise.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getChallenges(org.apache.http.HttpHost, org.apache.http.HttpResponse, org.apache.http.protocol.HttpContext)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getChallenges</h4>
|
|
<pre><a href="https://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,org.apache.http.Header> getChallenges(org.apache.http.HttpHost authhost,
|
|
org.apache.http.HttpResponse response,
|
|
org.apache.http.protocol.HttpContext context)
|
|
throws <a href="../../../../org/apache/http/auth/MalformedChallengeException.html" title="class in org.apache.http.auth">MalformedChallengeException</a></pre>
|
|
<div class="block">Extracts from the given HTTP response a collection of authentication
|
|
challenges, each of which represents an authentication scheme supported
|
|
by the authentication host.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>authhost</code> - authentication host.</dd><dd><code>response</code> - HTTP response.</dd><dd><code>context</code> - HTTP context.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>a collection of challenges keyed by names of corresponding
|
|
authentication schemes.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="../../../../org/apache/http/auth/MalformedChallengeException.html" title="class in org.apache.http.auth">MalformedChallengeException</a></code> - if one of the authentication
|
|
challenges is not valid or malformed.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="select(java.util.Map, org.apache.http.HttpHost, org.apache.http.HttpResponse, org.apache.http.protocol.HttpContext)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>select</h4>
|
|
<pre><a href="https://docs.oracle.com/javase/6/docs/api/java/util/Queue.html?is-external=true" title="class or interface in java.util">Queue</a><<a href="../../../../org/apache/http/auth/AuthOption.html" title="class in org.apache.http.auth">AuthOption</a>> select(<a href="https://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,org.apache.http.Header> challenges,
|
|
org.apache.http.HttpHost authhost,
|
|
org.apache.http.HttpResponse response,
|
|
org.apache.http.protocol.HttpContext context)
|
|
throws <a href="../../../../org/apache/http/auth/MalformedChallengeException.html" title="class in org.apache.http.auth">MalformedChallengeException</a></pre>
|
|
<div class="block">Selects one authentication challenge out of all available and
|
|
creates and generates <a href="../../../../org/apache/http/auth/AuthOption.html" title="class in org.apache.http.auth"><code>AuthOption</code></a> instance capable of
|
|
processing that challenge.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>challenges</code> - collection of challenges.</dd><dd><code>authhost</code> - authentication host.</dd><dd><code>response</code> - HTTP response.</dd><dd><code>context</code> - HTTP context.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>authentication auth schemes that can be used for authentication. Can be empty.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="../../../../org/apache/http/auth/MalformedChallengeException.html" title="class in org.apache.http.auth">MalformedChallengeException</a></code> - if one of the authentication
|
|
challenges is not valid or malformed.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="authSucceeded(org.apache.http.HttpHost, org.apache.http.auth.AuthScheme, org.apache.http.protocol.HttpContext)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>authSucceeded</h4>
|
|
<pre>void authSucceeded(org.apache.http.HttpHost authhost,
|
|
<a href="../../../../org/apache/http/auth/AuthScheme.html" title="interface in org.apache.http.auth">AuthScheme</a> authScheme,
|
|
org.apache.http.protocol.HttpContext context)</pre>
|
|
<div class="block">Callback invoked in case of successful authentication.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>authhost</code> - authentication host.</dd><dd><code>authScheme</code> - authentication scheme used.</dd><dd><code>context</code> - HTTP context.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="authFailed(org.apache.http.HttpHost, org.apache.http.auth.AuthScheme, org.apache.http.protocol.HttpContext)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>authFailed</h4>
|
|
<pre>void authFailed(org.apache.http.HttpHost authhost,
|
|
<a href="../../../../org/apache/http/auth/AuthScheme.html" title="interface in org.apache.http.auth">AuthScheme</a> authScheme,
|
|
org.apache.http.protocol.HttpContext context)</pre>
|
|
<div class="block">Callback invoked in case of unsuccessful authentication.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>authhost</code> - authentication host.</dd><dd><code>authScheme</code> - authentication scheme used.</dd><dd><code>context</code> - HTTP context.</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/AuthenticationStrategy.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">
|
|
<li><a href="../../../../org/apache/http/client/AuthenticationHandler.html" title="interface in org.apache.http.client"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../../org/apache/http/client/BackoffManager.html" title="interface in org.apache.http.client"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?org/apache/http/client/AuthenticationStrategy.html" target="_top">Frames</a></li>
|
|
<li><a href="AuthenticationStrategy.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>Nested | </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 © 1999–2022 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
|
|
</body>
|
|
</html>
|