Interface AuthenticationState.Deferred

All Superinterfaces:

AuthenticationState, Request.AuthenticationState

All Known Implementing Classes:

LoginAuthenticator.LoggedOutAuthentication

Enclosing interface:

AuthenticationState

public static interface AuthenticationState.Deferred
extends AuthenticationState

Authentication is Deferred, either so that credentials can later be passed with AuthenticationState.login(String, String, Request, Response); or that existing credentials on the request may be validated with authenticate(Request); or an authentication dialog can be advanced with authenticate(Request, Response, Callback).

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	AuthenticationState.Deferred.DeferredResponse	A tag interface used to identify a Response that might be passed to Authenticator.validateRequest(Request, Response, Callback) while doing deferred authentication when a challenge cannot be sent.

Nested classes/interfaces inherited from interface AuthenticationState

AuthenticationState.Deferred, AuthenticationState.ResponseSent, AuthenticationState.ServeAs, AuthenticationState.Succeeded

Field Summary

Fields inherited from interface AuthenticationState

CHALLENGE, SEND_FAILURE, SEND_SUCCESS

Method Summary

Modifier and Type	Method	Description
AuthenticationState.Succeeded	authenticate(Request request)	Authenticate the request using any credentials already associated with the request.
AuthenticationState	authenticate(Request request, Response response, Callback callback)	Authenticate the request using any credentials already associated with the request or challenging if necessary.
IdentityService.Association	getAssociation()
static boolean	isDeferred(Response response)
AuthenticationState.Succeeded	login(String username, Object password, Request request, Response response)	Authenticate the request with the passed credentials
void	logout(Request request, Response response)	Logout the authenticated user.

Methods inherited from interface Request.AuthenticationState

getUserPrincipal

Method Details

isDeferred

static boolean isDeferred(Response response)

Parameters:

response - the response

Returns:

true if this response is from a deferred call to authenticate(Request)

authenticate

AuthenticationState.Succeeded authenticate(Request request)

Authenticate the request using any credentials already associated with the request. No challenge can be sent. If the login is successful, then the IdentityService.associate(UserIdentity, RunAsToken) method is used and the returned IdentityService.Association is made available via getAssociation().

Parameters:

request - The request to authenticate

Returns:

A AuthenticationState.Succeeded authentication or null

See Also:

• getAssociation()

authenticate

AuthenticationState authenticate(Request request,
 Response response,
 Callback callback)

Authenticate the request using any credentials already associated with the request or challenging if necessary. If the login is successful, then the IdentityService.associate(UserIdentity, RunAsToken) method is used and the returned IdentityService.Association is made available via getAssociation().

Parameters:

request - The request to authenticate

response - The response to use for a challenge.

callback - The callback to complete if a challenge is sent

Returns:

The next AuthenticationState, if it is AuthenticationState.ResponseSent, then the callback will be completed.

See Also:

• getAssociation()

login

AuthenticationState.Succeeded login(String username,
 Object password,
 Request request,
 Response response)

Authenticate the request with the passed credentials

Parameters:

username - The username to validate

password - The credential to validate

request - The request to authenticate

response - The response, which may be updated if the session ID is changed.

Returns:

A AuthenticationState.Succeeded authentication or null

logout

void logout(Request request,
 Response response)

Logout the authenticated user.

Parameters:

request - The authenticated request

response - The associated response, which may be updated to clear a session ID.

getAssociation

IdentityService.Association getAssociation()

Returns:

Any IdentityService.Association created during deferred authentication.

See Also:

• authenticate(Request, Response, Callback)
• authenticate(Request)