Interface AuthenticationState

All Superinterfaces:

Request.AuthenticationState

All Known Subinterfaces:

AuthenticationState.Deferred, AuthenticationState.ResponseSent, AuthenticationState.Succeeded

All Known Implementing Classes:

AuthenticationState.ServeAs, LoginAuthenticator.LoggedOutAuthentication, LoginAuthenticator.UserAuthenticationSent, LoginAuthenticator.UserAuthenticationSucceeded, SessionAuthentication

public interface AuthenticationState
extends Request.AuthenticationState

The Authentication state of a request.

The Authentication state can be one of several sub-types that reflects where the request is in the many different authentication cycles. Authentication might not yet be checked or it might be checked and failed, checked and deferred or succeeded.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	AuthenticationState.Deferred	Authentication is Deferred, either so that credentials can later be passed with login(String, String, Request, Response); or that existing credentials on the request may be validated with AuthenticationState.Deferred.authenticate(Request); or an authentication dialog can be advanced with AuthenticationState.Deferred.authenticate(Request, Response, Callback).
static interface	AuthenticationState.ResponseSent	Authentication Response sent state.
static class	AuthenticationState.ServeAs	The SecurityHandler will use this to wrap the Request.
static interface	AuthenticationState.Succeeded	A successful Authentication with User information.

Field Summary

Fields

Modifier and Type	Field	Description
static final AuthenticationState	CHALLENGE	Authentication challenge sent.
static final AuthenticationState	SEND_FAILURE	Authentication failure sent.
static final AuthenticationState	SEND_SUCCESS	Authentication success sent.

Method Summary

Static Methods

Modifier and Type	Method	Description
static AuthenticationState.Succeeded	authenticate(Request request)	Get successful authentication for a request.
static AuthenticationState.Succeeded	authenticate(Request request, Response response, Callback callback)	Get successful authentication for a request.
static AuthenticationState.Deferred	defer(LoginAuthenticator loginAuthenticator)
static AuthenticationState	getAuthenticationState(Request request)	Get the authentication state of a request.
static AuthenticationState	getUndeferredAuthenticationState(Request request)	Get the authentication state of a request resolving any AuthenticationState.Deferred authentication.
static Principal	getUserPrincipal(Request request)	Get the UserPrincipal of an authenticated request.
static AuthenticationState.Succeeded	login(String username, String password, Request request, Response response)	Attempt to login a request using the passed credentials.
static boolean	logout(Request request, Response response)
static void	setAuthenticationState(Request request, AuthenticationState authenticationState)	Set the authentication state of a request.
static AuthenticationState	writeError(Request request, Response response, Callback callback, int code)

Methods inherited from interface Request.AuthenticationState

getUserPrincipal

Field Details

CHALLENGE

static final AuthenticationState CHALLENGE

Authentication challenge sent.

This convenience instance is for when an authentication challenge has been sent.

SEND_FAILURE

static final AuthenticationState SEND_FAILURE

Authentication failure sent.

This convenience instance is for when an authentication failure has been sent.

SEND_SUCCESS

static final AuthenticationState SEND_SUCCESS

Authentication success sent.

This convenience instance is for when an authentication success has been sent.

Method Details

getAuthenticationState

static AuthenticationState getAuthenticationState(Request request)

Get the authentication state of a request.

Parameters:

request - The request to query.

Returns:

The authentication state of the request or null if none.

getUndeferredAuthenticationState

static AuthenticationState getUndeferredAuthenticationState(Request request)

Get the authentication state of a request resolving any AuthenticationState.Deferred authentication.

Parameters:

request - The request to query.

Returns:

The authentication state of the request or null if none or AuthenticationState.Deferred authentication could not be resolved.

setAuthenticationState

static void setAuthenticationState(Request request,
 AuthenticationState authenticationState)

Set the authentication state of a request.

Parameters:

request - The request to update

authenticationState - the state to set on the request.

getUserPrincipal

static Principal getUserPrincipal(Request request)

Get the UserPrincipal of an authenticated request. If the AuthenticationState is AuthenticationState.Deferred, then an attempt to validate is made and the AuthenticationState of the request is updated.

Parameters:

request - The request to query

Returns:

The UserPrincipal of any AuthenticationState.Succeeded authentication state, potential after validating a AuthenticationState.Deferred state.

See Also:

• authenticate(Request)

authenticate

static AuthenticationState.Succeeded authenticate(Request request)

Get successful authentication for a request. If the AuthenticationState is AuthenticationState.Deferred, then an attempt to authenticate, but without sending a challenge.

Parameters:

request - The request to query.

Returns:

A AuthenticationState.Succeeded authentiction or null

See Also:

• AuthenticationState.Deferred.authenticate(Request)
• if an authentication challenge should be sent.

authenticate

static AuthenticationState.Succeeded authenticate(Request request,
 Response response,
 Callback callback)

Get successful authentication for a request. If the AuthenticationState is AuthenticationState.Deferred, then an attempt to authenticate, possibly sending a challenge. If authentication is not successful, then a HttpStatus.FORBIDDEN_403 response is sent.

Parameters:

request - The request to query.

response - The response to use for a challenge or error

callback - The collback to complete if a challenge or error is sent.

Returns:

A AuthenticationState.Succeeded authentication or null. If null is returned, then the callback will be completed.

See Also:

• AuthenticationState.Deferred.authenticate(Request, Response, Callback)
• if an authentication challenge should not be sent.

login

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

Attempt to login a request using the passed credentials. The current AuthenticationState must be AuthenticationState.Deferred.

Parameters:

request - The request to query.

Returns:

A AuthenticationState.Succeeded authentiction or null

See Also:

• login(String, String, Request, Response)

logout

static boolean logout(Request request,
 Response response)

writeError

static AuthenticationState writeError(Request request,
 Response response,
 Callback callback,
 int code)

defer

static AuthenticationState.Deferred defer(LoginAuthenticator loginAuthenticator)