Package se.curity.identityserver.sdk.authentication

Interface AuthenticatorRequestHandler<RequestModel>

All Superinterfaces:

HasValidatableRequestModel<RequestModel>, RequestHandler<RequestModel>

public interface AuthenticatorRequestHandler<RequestModel>
extends RequestHandler<RequestModel>

The authentication request handler.

The role of this handler is to provide the means for the server to authenticate users.

On successful authentication, an instance of AuthenticationResult should be returned by the request handler. On failure, an Exception should be thrown indicating the error that occurred.

Returning an empty result indicates that the authentication has not yet completed.

Since:

2.1.0

See Also:

• RequestHandler

Method Summary

Modifier and Type	Method	Description
Optional<AuthenticationResult>	get(RequestModel requestModel, Response response)	Handle a GET HTTP Request.
Optional<AuthenticationResult>	post(RequestModel requestModel, Response response)	Handle a POST HTTP Request.

Methods inherited from interface se.curity.identityserver.sdk.web.validation.HasValidatableRequestModel

onRequestModelValidationFailure, preProcess

Method Details

get

Optional<AuthenticationResult> get(RequestModel requestModel,
 Response response)

Handle a GET HTTP Request.

Specified by:

get in interface RequestHandler<RequestModel>

Parameters:

requestModel - the validated request model

response - the response

Returns:

the successful authentication result, or an empty Optional if the authentication was not completed.

See Also:

• ContainsSensitiveData

post

Optional<AuthenticationResult> post(RequestModel requestModel,
 Response response)

Handle a POST HTTP Request.

Specified by:

post in interface RequestHandler<RequestModel>

Parameters:

requestModel - the validated request model

response - the response

Returns:

the successful authentication result, or an empty Optional if the authentication was not completed.

See Also:

• ContainsSensitiveData