|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
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 be stateful involving a series of challenge-response exchanges.
IMPORTANT: implementations of this interface MUST also implement ContextAwareAuthScheme
interface in order to remain API compatible with newer versions of HttpClient.
| Method Summary | |
|---|---|
Header |
authenticate(Credentials credentials,
HttpRequest request)
Deprecated. (4.1) Use ContextAwareAuthScheme.authenticate(Credentials, HttpRequest, org.apache.http.protocol.HttpContext) |
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(Header header)
Processes the given challenge token. |
| Method Detail |
|---|
void processChallenge(Header header)
throws MalformedChallengeException
header - the challenge header
MalformedChallengeExceptionString getSchemeName()
String getParameter(String name)
name - The name of the parameter to be returned
String getRealm()
null.
boolean isConnectionBased()
boolean isComplete()
@Deprecated
Header authenticate(Credentials credentials,
HttpRequest request)
throws AuthenticationException
ContextAwareAuthScheme.authenticate(Credentials, HttpRequest, org.apache.http.protocol.HttpContext)
Credentials.
credentials - The set of credentials to be used for athenticationrequest - The request being authenticated
AuthenticationException - if authorization string cannot
be generated due to an authentication failure
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||