Interface Authentication

All Superinterfaces:

Request.AuthenticationState

All Known Subinterfaces:

Authentication.Challenge, Authentication.Deferred, Authentication.Failure, Authentication.LoginAuthentication, Authentication.LogoutAuthentication, Authentication.NonAuthenticated, Authentication.ResponseSent, Authentication.SendSuccess, Authentication.User, Authentication.Wrapped

All Known Implementing Classes:

AbstractUserAuthentication, DeferredAuthentication, FormAuthenticator.FormAuthentication, LoggedOutAuthentication, OpenIdAuthenticator.OpenIdAuthentication, SessionAuthentication, UserAuthentication

public interface Authentication
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	Authentication.Challenge	An Authentication Challenge has been sent.
static interface	Authentication.Deferred	A deferred authentication with methods to progress the authentication process.
static class	Authentication.Failed
static interface	Authentication.Failure	An Authentication Failure has been sent.
static interface	Authentication.LoginAuthentication	An authentication that is capable of performing a programmatic login operation.
static interface	Authentication.LogoutAuthentication	An authentication that is capable of performing a programmatic logout operation.
static interface	Authentication.NonAuthenticated	After a logout, the authentication reverts to a state where it is possible to programmatically log in again.
static interface	Authentication.ResponseSent	Authentication Response sent state.
static interface	Authentication.SendSuccess
static interface	Authentication.User	A successful Authentication with User information.
static interface	Authentication.Wrapped	A wrapped authentication with methods provide the wrapped request/response for use by the application

Field Summary

Fields

Modifier and Type	Field	Description
static final Authentication	NOT_CHECKED	Authentication not checked
static final Authentication	SEND_CONTINUE	Authentication challenge sent.
static final Authentication	SEND_FAILURE	Authentication failure sent.
static final Authentication	SEND_SUCCESS
static final Authentication	UNAUTHENTICATED	Unauthenticated state.

Method Summary

Methods inherited from interface Request.AuthenticationState

getUserPrincipal

Field Details

UNAUTHENTICATED

static final Authentication UNAUTHENTICATED

Unauthenticated state.

This convenience instance is for non mandatory authentication where credentials have been presented and checked, but failed authentication.

NOT_CHECKED

static final Authentication NOT_CHECKED

Authentication not checked

This convenience instance us for non mandatory authentication when no credentials are present to be checked.

SEND_CONTINUE

static final Authentication SEND_CONTINUE

Authentication challenge sent.

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

SEND_FAILURE

static final Authentication SEND_FAILURE

Authentication failure sent.

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

SEND_SUCCESS

static final Authentication SEND_SUCCESS