|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AuthenticationStrategy
/** A handler for determining if an HTTP response represents an authentication challenge that was sent back to the client as a result of authentication failure.
Implementations of this interface must be thread-safe. Access to shared data must be synchronized as methods of this interface may be executed from multiple threads.
Method Summary | |
---|---|
void |
authFailed(HttpHost authhost,
AuthScheme authScheme,
HttpContext context)
Callback invoked in case of unsuccessful authentication. |
void |
authSucceeded(HttpHost authhost,
AuthScheme authScheme,
HttpContext context)
Callback invoked in case of successful authentication. |
Map<String,Header> |
getChallenges(HttpHost authhost,
HttpResponse response,
HttpContext context)
Extracts from the given HTTP response a collection of authentication challenges, each of which represents an authentication scheme supported by the authentication host. |
boolean |
isAuthenticationRequested(HttpHost authhost,
HttpResponse response,
HttpContext context)
Determines if the given HTTP response response represents an authentication challenge that was sent back as a result of authentication failure. |
Queue<AuthOption> |
select(Map<String,Header> challenges,
HttpHost authhost,
HttpResponse response,
HttpContext context)
Selects one authentication challenge out of all available and creates and generates AuthOption instance capable of
processing that challenge. |
Method Detail |
---|
boolean isAuthenticationRequested(HttpHost authhost, HttpResponse response, HttpContext context)
authhost
- authentication host.response
- HTTP response.context
- HTTP context.
true
if user authentication is required,
false
otherwise.Map<String,Header> getChallenges(HttpHost authhost, HttpResponse response, HttpContext context) throws MalformedChallengeException
authhost
- authentication host.response
- HTTP response.context
- HTTP context.
MalformedChallengeException
- if one of the authentication
challenges is not valid or malformed.Queue<AuthOption> select(Map<String,Header> challenges, HttpHost authhost, HttpResponse response, HttpContext context) throws MalformedChallengeException
AuthOption
instance capable of
processing that challenge.
challenges
- collection of challenges.authhost
- authentication host.response
- HTTP response.context
- HTTP context.
MalformedChallengeException
- if one of the authentication
challenges is not valid or malformed.void authSucceeded(HttpHost authhost, AuthScheme authScheme, HttpContext context)
authhost
- authentication host.authScheme
- authentication scheme used.context
- HTTP context.void authFailed(HttpHost authhost, AuthScheme authScheme, HttpContext context)
authhost
- authentication host.authScheme
- authentication scheme used.context
- HTTP context.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |