public interface Authenticator
An Authenticator is responsible for checking requests and sending
response challenges in order to authenticate a request.
Various types of Authentication
are returned in order to
signal the next step in authentication.
Modifier and Type | Interface and Description |
---|---|
static interface |
Authenticator.AuthConfiguration
Authenticator Configuration
|
static interface |
Authenticator.Factory
Authenticator Factory
|
Modifier and Type | Method and Description |
---|---|
String |
getAuthMethod() |
void |
prepareRequest(ServletRequest request)
Called prior to validateRequest.
|
boolean |
secureResponse(ServletRequest request,
ServletResponse response,
boolean mandatory,
Authentication.User validatedUser) |
void |
setConfiguration(Authenticator.AuthConfiguration configuration)
Configure the Authenticator
|
Authentication |
validateRequest(ServletRequest request,
ServletResponse response,
boolean mandatory)
Validate a request
|
void setConfiguration(Authenticator.AuthConfiguration configuration)
configuration
- String getAuthMethod()
void prepareRequest(ServletRequest request)
request
- Authentication validateRequest(ServletRequest request, ServletResponse response, boolean mandatory) throws ServerAuthException
request
- The requestresponse
- The responsemandatory
- True if authentication is mandatory.Authentication.User
. If a response has
been sent by the Authenticator (which can be done for both successful and unsuccessful authentications), then the result will
implement Authentication.ResponseSent
. If Authentication is not manditory, then a
Authentication.Deferred
may be returned.ServerAuthException
boolean secureResponse(ServletRequest request, ServletResponse response, boolean mandatory, Authentication.User validatedUser) throws ServerAuthException
request
- response
- mandatory
- validatedUser
- ServerAuthException
Copyright © 1995-2015 Webtide. All Rights Reserved.