Apache HttpClient 4.5.14 · org.apache.http.auth.AuthScheme

This interface represents an abstract challenge-response oriented authentication scheme.

An authentication scheme should be able to support the following functions:

Parse and process the challenge sent by the target server in response to request for a protected resource
Provide its textual designation
Provide its parameters, if available
Provide the realm this authentication scheme is applicable to, if available
Generate authorization string for the given set of credentials and the HTTP request in response to the authorization challenge.

Authentication schemes may be stateful involving a series of challenge-response exchanges.

Important Note

implementations of this interface MUST also implement ContextAwareAuthScheme interface in order to remain API compatible with newer versions of HttpClient.

Method Summary

Modifier and Type	Method and Description
public Header	Returns: the authorization string authenticate(Credentials The set of credentials to be used for athentication credentials, HttpRequest The request being authenticated request) Deprecated (4.1) Use `ContextAwareAuthScheme#authenticate(Credentials, HttpRequest, org.apache.http.protocol.HttpContext)` Produces an authorization string for the given set of `Credentials`.
public String	Returns: the parameter with the given name getParameter(final String The name of the parameter to be returned name) Returns authentication parameter with the given name, if available.
public String	Returns: the authentication realm getRealm() Returns authentication realm.
public String	Returns: the name of the given authentication scheme getSchemeName() Returns textual designation of the given authentication scheme.
public boolean	Returns: `true` if the authentication process has been completed, `false` otherwise. isComplete() Authentication process may involve a series of challenge-response exchanges.
public boolean	Returns: `true` if the scheme is connection based, `false` if the scheme is request based. isConnectionBased() Tests if the authentication scheme is provides authorization on a per connection basis instead of usual per request basis
public void	processChallenge(final Header the challenge header header) Processes the given challenge token.

Method Detail

authenticate back to summary

authenticate	back to summary
public Header authenticate(Credentials credentials, HttpRequest request) throws AuthenticationException Deprecated (4.1) Use `ContextAwareAuthScheme#authenticate(Credentials, HttpRequest, org.apache.http.protocol.HttpContext)` Produces an authorization string for the given set of `Credentials`. Parameters credentials:Credentials The set of credentials to be used for athentication request:HttpRequest The request being authenticated Returns:Header the authorization string Annotations @Deprecated Exceptions AuthenticationException: if authorization string cannot be generated due to an authentication failure

public Header authenticate(Credentials credentials, HttpRequest request) throws AuthenticationException

Deprecated

(4.1) Use ContextAwareAuthScheme#authenticate(Credentials, HttpRequest, org.apache.http.protocol.HttpContext)

Produces an authorization string for the given set of Credentials.

Parameters

credentials:Credentials: The set of credentials to be used for athentication
request:HttpRequest: The request being authenticated

Returns:Header

the authorization string

Annotations

@Deprecated

Exceptions

AuthenticationException:: if authorization string cannot be generated due to an authentication failure

getParameter	back to summary
public String getParameter(final String name) Returns authentication parameter with the given name, if available. Parameters name:String The name of the parameter to be returned Returns:String the parameter with the given name

getParameter

back to summary

public String getParameter(final String name)

Returns authentication parameter with the given name, if available.

Parameters

name:String: The name of the parameter to be returned

Returns:String

the parameter with the given name

getRealm back to summary

getRealm	back to summary
public String getRealm() Returns authentication realm. If the concept of an authentication realm is not applicable to the given authentication scheme, returns `null`. Returns:String the authentication realm

public String getRealm()

Returns authentication realm. If the concept of an authentication realm is not applicable to the given authentication scheme, returns null.

Returns:String: the authentication realm

getSchemeName	back to summary
public String getSchemeName() Returns textual designation of the given authentication scheme. Returns:String the name of the given authentication scheme

getSchemeName

back to summary

public String getSchemeName()

Returns textual designation of the given authentication scheme.

Returns:String: the name of the given authentication scheme

isComplete back to summary

isComplete	back to summary
public boolean isComplete() 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. Returns:boolean `true` if the authentication process has been completed, `false` otherwise.

public boolean isComplete()

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.

Returns:boolean: true if the authentication process has been completed, false otherwise.

isConnectionBased back to summary

isConnectionBased	back to summary
public boolean isConnectionBased() Tests if the authentication scheme is provides authorization on a per connection basis instead of usual per request basis Returns:boolean `true` if the scheme is connection based, `false` if the scheme is request based.

public boolean isConnectionBased()

Tests if the authentication scheme is provides authorization on a per connection basis instead of usual per request basis

Returns:boolean: true if the scheme is connection based, false if the scheme is request based.

processChallenge	back to summary
public void processChallenge(final Header header) throws MalformedChallengeException 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 Parameters header:Header the challenge header

processChallenge

back to summary

public void processChallenge(final Header header) throws MalformedChallengeException

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

Parameters

header:Header: the challenge header

public Interface AuthScheme

Method Summary

Method Detail