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.
372 lines
18 KiB
372 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>AuthScheme (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="AuthScheme (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/AuthScheme.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/auth/AuthProtocolState.html" title="enum in org.apache.http.auth"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../../org/apache/http/auth/AuthSchemeFactory.html" title="interface in org.apache.http.auth"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?org/apache/http/auth/AuthScheme.html" target="_top">Frames</a></li>
|
|
<li><a href="AuthScheme.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.auth</div>
|
|
<h2 title="Interface AuthScheme" class="title">Interface AuthScheme</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Known Subinterfaces:</dt>
|
|
<dd><a href="../../../../org/apache/http/auth/ContextAwareAuthScheme.html" title="interface in org.apache.http.auth">ContextAwareAuthScheme</a></dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>All Known Implementing Classes:</dt>
|
|
<dd><a href="../../../../org/apache/http/impl/auth/AuthSchemeBase.html" title="class in org.apache.http.impl.auth">AuthSchemeBase</a>, <a href="../../../../org/apache/http/impl/auth/BasicScheme.html" title="class in org.apache.http.impl.auth">BasicScheme</a>, <a href="../../../../org/apache/http/impl/auth/DigestScheme.html" title="class in org.apache.http.impl.auth">DigestScheme</a>, <a href="../../../../org/apache/http/impl/auth/GGSSchemeBase.html" title="class in org.apache.http.impl.auth">GGSSchemeBase</a>, <a href="../../../../org/apache/http/impl/auth/KerberosScheme.html" title="class in org.apache.http.impl.auth">KerberosScheme</a>, <a href="../../../../org/apache/http/impl/auth/NegotiateScheme.html" title="class in org.apache.http.impl.auth">NegotiateScheme</a>, <a href="../../../../org/apache/http/impl/auth/NTLMScheme.html" title="class in org.apache.http.impl.auth">NTLMScheme</a>, <a href="../../../../org/apache/http/impl/auth/RFC2617Scheme.html" title="class in org.apache.http.impl.auth">RFC2617Scheme</a>, <a href="../../../../org/apache/http/impl/auth/SPNegoScheme.html" title="class in org.apache.http.impl.auth">SPNegoScheme</a>, <a href="../../../../org/apache/http/impl/auth/win/WindowsNegotiateScheme.html" title="class in org.apache.http.impl.auth.win">WindowsNegotiateScheme</a></dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre>public interface <span class="strong">AuthScheme</span></pre>
|
|
<div class="block">This interface represents an abstract challenge-response oriented
|
|
authentication scheme.
|
|
<p>
|
|
An authentication scheme should be able to support the following
|
|
functions:
|
|
<ul>
|
|
<li>Parse and process the challenge sent by the target server
|
|
in response to request for a protected resource
|
|
<li>Provide its textual designation
|
|
<li>Provide its parameters, if available
|
|
<li>Provide the realm this authentication scheme is applicable to,
|
|
if available
|
|
<li>Generate authorization string for the given set of credentials
|
|
and the HTTP request in response to the authorization challenge.
|
|
</ul>
|
|
<p>
|
|
Authentication schemes may be stateful involving a series of
|
|
challenge-response exchanges.
|
|
<p>
|
|
IMPORTANT: implementations of this interface MUST also implement <a href="../../../../org/apache/http/auth/ContextAwareAuthScheme.html" title="interface in org.apache.http.auth"><code>ContextAwareAuthScheme</code></a>
|
|
interface in order to remain API compatible with newer versions of HttpClient.</div>
|
|
<dl><dt><span class="strong">Since:</span></dt>
|
|
<dd>4.0</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>org.apache.http.Header</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../org/apache/http/auth/AuthScheme.html#authenticate(org.apache.http.auth.Credentials,%20org.apache.http.HttpRequest)">authenticate</a></strong>(<a href="../../../../org/apache/http/auth/Credentials.html" title="interface in org.apache.http.auth">Credentials</a> credentials,
|
|
org.apache.http.HttpRequest request)</code>
|
|
<div class="block"><strong>Deprecated.</strong>
|
|
<div class="block"><i>(4.1) Use <a href="../../../../org/apache/http/auth/ContextAwareAuthScheme.html#authenticate(org.apache.http.auth.Credentials,%20org.apache.http.HttpRequest,%20org.apache.http.protocol.HttpContext)"><code>ContextAwareAuthScheme.authenticate(Credentials, HttpRequest, org.apache.http.protocol.HttpContext)</code></a></i></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><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></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../org/apache/http/auth/AuthScheme.html#getParameter(java.lang.String)">getParameter</a></strong>(<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> name)</code>
|
|
<div class="block">Returns authentication parameter with the given name, if available.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><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></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../org/apache/http/auth/AuthScheme.html#getRealm()">getRealm</a></strong>()</code>
|
|
<div class="block">Returns authentication realm.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><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></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../org/apache/http/auth/AuthScheme.html#getSchemeName()">getSchemeName</a></strong>()</code>
|
|
<div class="block">Returns textual designation of the given authentication scheme.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../org/apache/http/auth/AuthScheme.html#isComplete()">isComplete</a></strong>()</code>
|
|
<div class="block">Authentication process may involve a series of challenge-response exchanges.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../org/apache/http/auth/AuthScheme.html#isConnectionBased()">isConnectionBased</a></strong>()</code>
|
|
<div class="block">Tests if the authentication scheme is provides authorization on a per
|
|
connection basis instead of usual per request basis</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../org/apache/http/auth/AuthScheme.html#processChallenge(org.apache.http.Header)">processChallenge</a></strong>(org.apache.http.Header header)</code>
|
|
<div class="block">Processes the given challenge token.</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="processChallenge(org.apache.http.Header)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>processChallenge</h4>
|
|
<pre>void processChallenge(org.apache.http.Header header)
|
|
throws <a href="../../../../org/apache/http/auth/MalformedChallengeException.html" title="class in org.apache.http.auth">MalformedChallengeException</a></pre>
|
|
<div class="block">Processes the given challenge token. Some authentication schemes
|
|
may involve multiple challenge-response exchanges. Such schemes must be able
|
|
to maintain the state information when dealing with sequential challenges</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>header</code> - the challenge header</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></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSchemeName()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSchemeName</h4>
|
|
<pre><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> getSchemeName()</pre>
|
|
<div class="block">Returns textual designation of the given authentication scheme.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>the name of the given authentication scheme</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getParameter(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getParameter</h4>
|
|
<pre><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> getParameter(<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> name)</pre>
|
|
<div class="block">Returns authentication parameter with the given name, if available.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The name of the parameter to be returned</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>the parameter with the given name</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getRealm()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getRealm</h4>
|
|
<pre><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> getRealm()</pre>
|
|
<div class="block">Returns authentication realm. If the concept of an authentication
|
|
realm is not applicable to the given authentication scheme, returns
|
|
<code>null</code>.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>the authentication realm</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="isConnectionBased()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isConnectionBased</h4>
|
|
<pre>boolean isConnectionBased()</pre>
|
|
<div class="block">Tests if the authentication scheme is provides authorization on a per
|
|
connection basis instead of usual per request basis</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the scheme is connection based, <code>false</code>
|
|
if the scheme is request based.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="isComplete()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isComplete</h4>
|
|
<pre>boolean isComplete()</pre>
|
|
<div class="block">Authentication process may involve a series of challenge-response exchanges.
|
|
This method tests if the authorization process has been completed, either
|
|
successfully or unsuccessfully, that is, all the required authorization
|
|
challenges have been processed in their entirety.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the authentication process has been completed,
|
|
<code>false</code> otherwise.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="authenticate(org.apache.http.auth.Credentials, org.apache.http.HttpRequest)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>authenticate</h4>
|
|
<pre><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
org.apache.http.Header authenticate(<a href="../../../../org/apache/http/auth/Credentials.html" title="interface in org.apache.http.auth">Credentials</a> credentials,
|
|
org.apache.http.HttpRequest request)
|
|
throws <a href="../../../../org/apache/http/auth/AuthenticationException.html" title="class in org.apache.http.auth">AuthenticationException</a></pre>
|
|
<div class="block"><span class="strong">Deprecated.</span> <i>(4.1) Use <a href="../../../../org/apache/http/auth/ContextAwareAuthScheme.html#authenticate(org.apache.http.auth.Credentials,%20org.apache.http.HttpRequest,%20org.apache.http.protocol.HttpContext)"><code>ContextAwareAuthScheme.authenticate(Credentials, HttpRequest, org.apache.http.protocol.HttpContext)</code></a></i></div>
|
|
<div class="block">Produces an authorization string for the given set of <a href="../../../../org/apache/http/auth/Credentials.html" title="interface in org.apache.http.auth"><code>Credentials</code></a>.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>credentials</code> - The set of credentials to be used for athentication</dd><dd><code>request</code> - The request being authenticated</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>the authorization string</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="../../../../org/apache/http/auth/AuthenticationException.html" title="class in org.apache.http.auth">AuthenticationException</a></code> - if authorization string cannot
|
|
be generated due to an authentication failure</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/AuthScheme.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/auth/AuthProtocolState.html" title="enum in org.apache.http.auth"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../../org/apache/http/auth/AuthSchemeFactory.html" title="interface in org.apache.http.auth"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?org/apache/http/auth/AuthScheme.html" target="_top">Frames</a></li>
|
|
<li><a href="AuthScheme.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>
|