Package org.apache.http.impl.client
Class AuthenticationStrategyImpl
- java.lang.Object
-
- org.apache.http.impl.client.AuthenticationStrategyImpl
-
- All Implemented Interfaces:
AuthenticationStrategy
- Direct Known Subclasses:
ProxyAuthenticationStrategy
,TargetAuthenticationStrategy
@Contract(threading=IMMUTABLE) abstract class AuthenticationStrategyImpl extends java.lang.Object implements AuthenticationStrategy
-
-
Field Summary
Fields Modifier and Type Field Description private int
challengeCode
private static java.util.List<java.lang.String>
DEFAULT_SCHEME_PRIORITY
private java.lang.String
headerName
private org.apache.commons.logging.Log
log
-
Constructor Summary
Constructors Constructor Description AuthenticationStrategyImpl(int challengeCode, java.lang.String headerName)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
authFailed(org.apache.http.HttpHost authhost, AuthScheme authScheme, org.apache.http.protocol.HttpContext context)
Callback invoked in case of unsuccessful authentication.void
authSucceeded(org.apache.http.HttpHost authhost, AuthScheme authScheme, org.apache.http.protocol.HttpContext context)
Callback invoked in case of successful authentication.java.util.Map<java.lang.String,org.apache.http.Header>
getChallenges(org.apache.http.HttpHost authhost, org.apache.http.HttpResponse response, org.apache.http.protocol.HttpContext context)
Generates a map of challenge auth-scheme => Header entries.(package private) abstract java.util.Collection<java.lang.String>
getPreferredAuthSchemes(RequestConfig config)
boolean
isAuthenticationRequested(org.apache.http.HttpHost authhost, org.apache.http.HttpResponse response, org.apache.http.protocol.HttpContext context)
Determines if the given HTTP response response represents an authentication challenge that was sent back as a result of authentication failure.protected boolean
isCachable(AuthScheme authScheme)
java.util.Queue<AuthOption>
select(java.util.Map<java.lang.String,org.apache.http.Header> challenges, org.apache.http.HttpHost authhost, org.apache.http.HttpResponse response, org.apache.http.protocol.HttpContext context)
Selects one authentication challenge out of all available and creates and generatesAuthOption
instance capable of processing that challenge.
-
-
-
Method Detail
-
isAuthenticationRequested
public boolean isAuthenticationRequested(org.apache.http.HttpHost authhost, org.apache.http.HttpResponse response, org.apache.http.protocol.HttpContext context)
Description copied from interface:AuthenticationStrategy
Determines if the given HTTP response response represents an authentication challenge that was sent back as a result of authentication failure.- Specified by:
isAuthenticationRequested
in interfaceAuthenticationStrategy
- Parameters:
authhost
- authentication host.response
- HTTP response.context
- HTTP context.- Returns:
true
if user authentication is required,false
otherwise.
-
getChallenges
public java.util.Map<java.lang.String,org.apache.http.Header> getChallenges(org.apache.http.HttpHost authhost, org.apache.http.HttpResponse response, org.apache.http.protocol.HttpContext context) throws MalformedChallengeException
Generates a map of challenge auth-scheme => Header entries.- Specified by:
getChallenges
in interfaceAuthenticationStrategy
- Parameters:
authhost
- authentication host.response
- HTTP response.context
- HTTP context.- Returns:
- map: key=lower-cased auth-scheme name, value=Header that contains the challenge
- Throws:
MalformedChallengeException
- if one of the authentication challenges is not valid or malformed.
-
getPreferredAuthSchemes
abstract java.util.Collection<java.lang.String> getPreferredAuthSchemes(RequestConfig config)
-
select
public java.util.Queue<AuthOption> select(java.util.Map<java.lang.String,org.apache.http.Header> challenges, org.apache.http.HttpHost authhost, org.apache.http.HttpResponse response, org.apache.http.protocol.HttpContext context) throws MalformedChallengeException
Description copied from interface:AuthenticationStrategy
Selects one authentication challenge out of all available and creates and generatesAuthOption
instance capable of processing that challenge.- Specified by:
select
in interfaceAuthenticationStrategy
- Parameters:
challenges
- collection of challenges.authhost
- authentication host.response
- HTTP response.context
- HTTP context.- Returns:
- authentication auth schemes that can be used for authentication. Can be empty.
- Throws:
MalformedChallengeException
- if one of the authentication challenges is not valid or malformed.
-
authSucceeded
public void authSucceeded(org.apache.http.HttpHost authhost, AuthScheme authScheme, org.apache.http.protocol.HttpContext context)
Description copied from interface:AuthenticationStrategy
Callback invoked in case of successful authentication.- Specified by:
authSucceeded
in interfaceAuthenticationStrategy
- Parameters:
authhost
- authentication host.authScheme
- authentication scheme used.context
- HTTP context.
-
isCachable
protected boolean isCachable(AuthScheme authScheme)
-
authFailed
public void authFailed(org.apache.http.HttpHost authhost, AuthScheme authScheme, org.apache.http.protocol.HttpContext context)
Description copied from interface:AuthenticationStrategy
Callback invoked in case of unsuccessful authentication.- Specified by:
authFailed
in interfaceAuthenticationStrategy
- Parameters:
authhost
- authentication host.authScheme
- authentication scheme used.context
- HTTP context.
-
-