org.apache.commons.httpclient.auth
public interface AuthScheme
This interface represents an abstract challenge-response oriented authentication scheme.
An authentication scheme should be able to support the following functions:
Authentication schemes may ignore method name and URI parameters if they are not relevant for the given authentication mechanism
Authentication schemes may be stateful involving a series of challenge-response exchanges
Since: 2.0beta1
Method Summary | |
---|---|
String | authenticate(Credentials credentials, String method, String uri) |
String | authenticate(Credentials credentials, HttpMethod method)
Produces an authorization string for the given set of {@link Credentials}.
|
String | getID()
Returns a String identifying the authentication challenge. |
String | getParameter(String name)
Returns authentication parameter with the given name, if available.
|
String | getRealm()
Returns authentication realm. |
String | getSchemeName()
Returns textual designation of the given authentication scheme.
|
boolean | isComplete()
Authentication process may involve a series of challenge-response exchanges.
|
boolean | isConnectionBased()
Tests if the authentication scheme is provides authorization on a per
connection basis instead of usual per request basis
|
void | processChallenge(String challenge)
Processes the given challenge token. |
Deprecated: Use {@link #authenticate(Credentials, HttpMethod)} Produces an authorization string for the given set of {@link Credentials}, method name and URI using the given authentication scheme in response to the actual authorization challenge.
Parameters: credentials The set of credentials to be used for athentication method The name of the method that requires authorization. This parameter may be ignored, if it is irrelevant or not applicable to the given authentication scheme uri The URI for which authorization is needed. This parameter may be ignored, if it is irrelevant or not applicable to the given authentication scheme
Returns: the authorization string
Throws: AuthenticationException if authorization string cannot be generated due to an authentication failure
Parameters: credentials The set of credentials to be used for athentication method The method being authenticated
Returns: the authorization string
Throws: AuthenticationException if authorization string cannot be generated due to an authentication failure
Since: 3.0
Deprecated: no longer used
Returns a String identifying the authentication challenge. This is used, in combination with the host and port to determine if authorization has already been attempted or not. Schemes which require multiple requests to complete the authentication should return a different value for each stage in the request.Additionally, the ID should take into account any changes to the authentication challenge and return a different value when appropriate. For example when the realm changes in basic authentication it should be considered a different authentication attempt and a different value should be returned.
Returns: String a String identifying the authentication challenge. The returned value may be null.
Parameters: name The name of the parameter to be returned
Returns: the parameter with the given name
null
.
Returns: the authentication realm
Returns: the name of the given authentication scheme
Returns: true if the authentication process has been completed, false otherwise.
Since: 3.0
Returns: true if the scheme is connection based, false if the scheme is request based.
Since: 3.0
Parameters: challenge the challenge string
Since: 3.0