Interface Authenticator

All Known Implementing Classes:

Authenticator.NoOp, BasicAuthenticator, DigestAuthenticator, EthereumAuthenticator, FormAuthenticator, JaspiAuthenticator, JaspiAuthenticator, LoginAuthenticator, MultiAuthenticator, OpenIdAuthenticator, SPNEGOAuthenticator, SslClientCertAuthenticator

public interface Authenticator

Authenticator Interface

An Authenticator is responsible for checking requests and sending response challenges in order to authenticate a request. Various types of AuthenticationState are returned in order to signal the next step in authentication.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Authenticator.Configuration	Authenticator Configuration
static interface	Authenticator.Factory	Authenticator Factory
static class	Authenticator.NoOp

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASIC_AUTH
static final String	CERT_AUTH
static final String	CERT_AUTH2
static final String	DIGEST_AUTH
static final String	FORM_AUTH
static final String	MULTI_AUTH
static final String	NEGOTIATE_AUTH
static final String	OPENID_AUTH
static final String	SIWE_AUTH
static final String	SPNEGO_AUTH

Method Summary

Modifier and Type	Method	Description
String	getAuthenticationType()
default Constraint.Authorization	getConstraintAuthentication(String pathInContext, Constraint.Authorization existing, Function<Boolean,Session> getSession)	Get an Constraint.Authorization applicable to the path for this authenticator.
default Request	prepareRequest(Request request, AuthenticationState authenticationState)	Called after validateRequest(Request, Response, Callback) and before calling Request.Handler.handle(Request, Response, Callback) of the nested handler.
void	setConfiguration(Authenticator.Configuration configuration)	Configure the Authenticator
AuthenticationState	validateRequest(Request request, Response response, Callback callback)	Attempts to validate the authentication state of the given request.

Field Details

BASIC_AUTH

static final String BASIC_AUTH

See Also:

• Constant Field Values

FORM_AUTH

static final String FORM_AUTH

See Also:

• Constant Field Values

DIGEST_AUTH

static final String DIGEST_AUTH

See Also:

• Constant Field Values

CERT_AUTH

static final String CERT_AUTH

See Also:

• Constant Field Values

CERT_AUTH2

static final String CERT_AUTH2

See Also:

• Constant Field Values

SPNEGO_AUTH

static final String SPNEGO_AUTH

See Also:

• Constant Field Values

NEGOTIATE_AUTH

static final String NEGOTIATE_AUTH

See Also:

• Constant Field Values

OPENID_AUTH

static final String OPENID_AUTH

See Also:

• Constant Field Values

SIWE_AUTH

static final String SIWE_AUTH

See Also:

• Constant Field Values

MULTI_AUTH

static final String MULTI_AUTH

See Also:

• Constant Field Values

Method Details

setConfiguration

void setConfiguration(Authenticator.Configuration configuration)

Configure the Authenticator

Parameters:

configuration - the configuration

getAuthenticationType

String getAuthenticationType()

Returns:

The name of the authentication type

prepareRequest

default Request prepareRequest(Request request,
 AuthenticationState authenticationState)

Called after validateRequest(Request, Response, Callback) and before calling Request.Handler.handle(Request, Response, Callback) of the nested handler. This may be used by an Authenticator to restore method or content from a previous request that was challenged.

Parameters:

request - the request to prepare for handling

authenticationState - The authentication for the request

getConstraintAuthentication

default Constraint.Authorization getConstraintAuthentication(String pathInContext,
 Constraint.Authorization existing,
 Function<Boolean,Session> getSession)

Get an Constraint.Authorization applicable to the path for this authenticator. This is typically used to vary protection on special URIs known to a specific Authenticator (e.g. /j_security_check for the FormAuthenticator.

Parameters:

pathInContext - The pathInContext to potentially constrain.

existing - The existing authentication constraint for the pathInContext determined independently of Authenticator

getSession - Function to get or create a Session.

Returns:

The Constraint.Authorization to apply.

validateRequest

AuthenticationState validateRequest(Request request,
 Response response,
 Callback callback)
                             throws ServerAuthException

Attempts to validate the authentication state of the given request.

If authentication is successful, an AuthenticationState.Succeeded is returned. If the authenticator has already committed a response (for either success or failure), the returned value will implement AuthenticationState.ResponseSent, and the provided Callback will be eventually be completed, otherwise the caller is responsible for completing the Callback.

A null return value indicates that no authentication state could be established, possibly because the response has already been committed.

Parameters:

request - the request to validate.

response - the response associated with the request.

callback - the callback to use for writing a response.

Returns:

an AuthenticationState, or null if authentication could not be resolved.

Throws:

ServerAuthException - if unable to validate request.