|
||||||||||
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 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
Method Summary | |
---|---|
org.apache.http.Header |
authenticate(Credentials credentials,
org.apache.http.HttpRequest request)
Produces an authorization string for the given set of Credentials . |
java.lang.String |
getParameter(java.lang.String name)
Returns authentication parameter with the given name, if available. |
java.lang.String |
getRealm()
Returns authentication realm. |
java.lang.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(org.apache.http.Header header)
Processes the given challenge token. |
Method Detail |
---|
void processChallenge(org.apache.http.Header header) throws MalformedChallengeException
header
- the challenge header
MalformedChallengeException
java.lang.String getSchemeName()
java.lang.String getParameter(java.lang.String name)
name
- The name of the parameter to be returned
java.lang.String getRealm()
null
.
boolean isConnectionBased()
boolean isComplete()
org.apache.http.Header authenticate(Credentials credentials, org.apache.http.HttpRequest request) throws AuthenticationException
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 |