Apache HttpClient 4.5.14 · org.apache.http.impl.client.AuthenticationStrategyImpl

Modifier and Type	Field and Description
private final int	challengeCode
private static final List<String>	DEFAULT_SCHEME_PRIORITY
private final String	headerName
private final Log	log

Access	Constructor and Description
pack-priv	AuthenticationStrategyImpl(final int for example SC_PROXY_AUTHENTICATION_REQUIRED or SC_UNAUTHORIZED challengeCode, final String for example "Proxy-Authenticate" or "WWW-Authenticate" headerName)

Method Summary

Modifier and Type	Method and Description
public void	authFailed(final HttpHost authentication host. authhost, final AuthScheme authentication scheme used. authScheme, final HttpContext HTTP context. context) Implements org.apache.http.client.AuthenticationStrategy.authFailed. Callback invoked in case of unsuccessful authentication.
public void	authSucceeded(final HttpHost authentication host. authhost, final AuthScheme authentication scheme used. authScheme, final HttpContext HTTP context. context) Implements org.apache.http.client.AuthenticationStrategy.authSucceeded. Callback invoked in case of successful authentication.
public Map<String, Header>	Returns: map: key=lower-cased auth-scheme name, value=Header that contains the challenge getChallenges(final HttpHost authentication host. authhost, final HttpResponse HTTP response. response, final HttpContext HTTP context. context) Implements org.apache.http.client.AuthenticationStrategy.getChallenges. Generates a map of challenge auth-scheme => Header entries.
pack-priv abstract Collection<String>	getPreferredAuthSchemes(RequestConfig config)
public boolean	isAuthenticationRequested(final HttpHost authentication host. authhost, final HttpResponse HTTP response. response, final HttpContext HTTP context. context) Implements org.apache.http.client.AuthenticationStrategy.isAuthenticationRequested. Determines if the given HTTP response response represents an authentication challenge that was sent back as a result of authentication failure.
protected boolean	isCachable(final AuthScheme authScheme)
public Queue<AuthOption>	select(final Map<String, Header> collection of challenges. challenges, final HttpHost authentication host. authhost, final HttpResponse HTTP response. response, final HttpContext HTTP context. context) Implements org.apache.http.client.AuthenticationStrategy.select. Selects one authentication challenge out of all available and creates and generates `AuthOption` instance capable of processing that challenge.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

challengeCode	back to summary
private final int challengeCode

DEFAULT_SCHEME_PRIORITY	back to summary
private static final List<String> DEFAULT_SCHEME_PRIORITY

headerName	back to summary
private final String headerName

log	back to summary
private final Log log

AuthenticationStrategyImpl	back to summary
pack-priv AuthenticationStrategyImpl(final int challengeCode, final String headerName) Parameters challengeCode:int for example SC_PROXY_AUTHENTICATION_REQUIRED or SC_UNAUTHORIZED headerName:String for example "Proxy-Authenticate" or "WWW-Authenticate"

Method Detail

authFailed	back to summary
public void authFailed(final HttpHost authhost, final AuthScheme authScheme, final HttpContext context) Implements org.apache.http.client.AuthenticationStrategy.authFailed. Doc from org.apache.http.client.AuthenticationStrategy.authFailed. Callback invoked in case of unsuccessful authentication. Parameters authhost:HttpHost authentication host. authScheme:AuthScheme authentication scheme used. context:HttpContext HTTP context. Annotations @Override

authFailed

back to summary

public void authFailed(final HttpHost authhost, final AuthScheme authScheme, final HttpContext context)

Implements org.apache.http.client.AuthenticationStrategy.authFailed.

Doc from org.apache.http.client.AuthenticationStrategy.authFailed.

Callback invoked in case of unsuccessful authentication.

Parameters

authhost:HttpHost: authentication host.
authScheme:AuthScheme: authentication scheme used.
context:HttpContext: HTTP context.

Annotations

@Override

authSucceeded	back to summary
public void authSucceeded(final HttpHost authhost, final AuthScheme authScheme, final HttpContext context) Implements org.apache.http.client.AuthenticationStrategy.authSucceeded. Doc from org.apache.http.client.AuthenticationStrategy.authSucceeded. Callback invoked in case of successful authentication. Parameters authhost:HttpHost authentication host. authScheme:AuthScheme authentication scheme used. context:HttpContext HTTP context. Annotations @Override

authSucceeded

back to summary

public void authSucceeded(final HttpHost authhost, final AuthScheme authScheme, final HttpContext context)

Implements org.apache.http.client.AuthenticationStrategy.authSucceeded.

Doc from org.apache.http.client.AuthenticationStrategy.authSucceeded.

Callback invoked in case of successful authentication.

Parameters

authhost:HttpHost: authentication host.
authScheme:AuthScheme: authentication scheme used.
context:HttpContext: HTTP context.

Annotations

@Override

getChallenges	back to summary
public Map<String, Header> getChallenges(final HttpHost authhost, final HttpResponse response, final HttpContext context) throws MalformedChallengeException Implements org.apache.http.client.AuthenticationStrategy.getChallenges. Generates a map of challenge auth-scheme => Header entries. Parameters authhost:HttpHost Doc from org.apache.http.client.AuthenticationStrategy.getChallenges. authentication host. response:HttpResponse Doc from org.apache.http.client.AuthenticationStrategy.getChallenges. HTTP response. context:HttpContext Doc from org.apache.http.client.AuthenticationStrategy.getChallenges. HTTP context. Returns:Map<String, Header> map: key=lower-cased auth-scheme name, value=Header that contains the challenge Annotations @Override Exceptions MalformedChallengeException: Doc from org.apache.http.client.AuthenticationStrategy.getChallenges. if one of the authentication challenges is not valid or malformed.

getChallenges

back to summary

public Map<String, Header> getChallenges(final HttpHost authhost, final HttpResponse response, final HttpContext context) throws MalformedChallengeException

Implements org.apache.http.client.AuthenticationStrategy.getChallenges.

Generates a map of challenge auth-scheme => Header entries.

Parameters

authhost:HttpHost

Doc from org.apache.http.client.AuthenticationStrategy.getChallenges.

authentication host.

response:HttpResponse

Doc from org.apache.http.client.AuthenticationStrategy.getChallenges.

HTTP response.

context:HttpContext

Doc from org.apache.http.client.AuthenticationStrategy.getChallenges.

HTTP context.

Returns:Map<String, Header>

map: key=lower-cased auth-scheme name, value=Header that contains the challenge

Annotations

@Override

Exceptions

MalformedChallengeException:

Doc from org.apache.http.client.AuthenticationStrategy.getChallenges.

if one of the authentication challenges is not valid or malformed.

getPreferredAuthSchemes	back to summary
pack-priv abstract Collection<String> getPreferredAuthSchemes(RequestConfig config)

isAuthenticationRequested back to summary

isAuthenticationRequested	back to summary
public boolean isAuthenticationRequested(final HttpHost authhost, final HttpResponse response, final HttpContext context) Implements org.apache.http.client.AuthenticationStrategy.isAuthenticationRequested. Doc from org.apache.http.client.AuthenticationStrategy.isAuthenticationRequested. Determines if the given HTTP response response represents an authentication challenge that was sent back as a result of authentication failure. Parameters authhost:HttpHost authentication host. response:HttpResponse HTTP response. context:HttpContext HTTP context. Returns:boolean `true` if user authentication is required, `false` otherwise. Annotations @Override

public boolean isAuthenticationRequested(final HttpHost authhost, final HttpResponse response, final HttpContext context)

Implements org.apache.http.client.AuthenticationStrategy.isAuthenticationRequested.

Doc from org.apache.http.client.AuthenticationStrategy.isAuthenticationRequested.

Determines if the given HTTP response response represents an authentication challenge that was sent back as a result of authentication failure.

Parameters

authhost:HttpHost: authentication host.
response:HttpResponse: HTTP response.
context:HttpContext: HTTP context.

Returns:boolean

true if user authentication is required, false otherwise.

Annotations

@Override

isCachable	back to summary
protected boolean isCachable(final AuthScheme authScheme)

select back to summary

select	back to summary
public Queue<AuthOption> select(final Map<String, Header> challenges, final HttpHost authhost, final HttpResponse response, final HttpContext context) throws MalformedChallengeException Implements org.apache.http.client.AuthenticationStrategy.select. Doc from org.apache.http.client.AuthenticationStrategy.select. Selects one authentication challenge out of all available and creates and generates `AuthOption` instance capable of processing that challenge. Parameters challenges:Map<String, Header> collection of challenges. authhost:HttpHost authentication host. response:HttpResponse HTTP response. context:HttpContext HTTP context. Returns:Queue<AuthOption> authentication auth schemes that can be used for authentication. Can be empty. Annotations @Override Exceptions MalformedChallengeException: if one of the authentication challenges is not valid or malformed.