Package net.officefloor.web.security.scheme

Class HttpAuthenticationImpl<C>

java.lang.Object

net.officefloor.web.security.scheme.HttpAuthenticationImpl<C>

All Implemented Interfaces:

HttpAuthentication<C>, AccessControlListener<HttpAccessControl>

public class HttpAuthenticationImpl<C>
extends Object
implements HttpAuthentication<C>, AccessControlListener<HttpAccessControl>

HttpAuthentication implementation.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
HttpAuthenticationImpl(AuthenticationContext<? extends HttpAccessControl,C> authenticationContext, Class<C> credentialsType)	Instantiate.

Method Summary

Modifier and Type	Method	Description
void	accessControlChange(HttpAccessControl accessControl, Throwable escalation)	Notified of a change to access control.
void	authenticate(C credentials, AuthenticateRequest authenticateRequest)	Triggers to undertake authentication.
HttpAccessControl	getAccessControl()	Obtains the HttpAccessControl.
Class<C>	getCredentialsType()	Obtains the type of credentials.
boolean	isAuthenticated()	Indicates if authenticated.
void	logout(LogoutRequest logoutRequest)	Undertakes logging out.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HttpAuthenticationImpl

public HttpAuthenticationImpl(AuthenticationContext<? extends HttpAccessControl,C> authenticationContext,
 Class<C> credentialsType)

Instantiate.

Parameters:

authenticationContext - AuthenticationContext.

credentialsType - Type of credentials.

Method Details

accessControlChange

public void accessControlChange(HttpAccessControl accessControl,
 Throwable escalation)

Description copied from interface: AccessControlListener

Notified of a change to access control.

Specified by:

accessControlChange in interface AccessControlListener<C>

Parameters:

accessControl - Access control. May be null if

• logging out
• failure in authenticating

escalation - Possible Escalation. Will be null if successfully obtain access control or logout.

isAuthenticated

public boolean isAuthenticated()
                        throws HttpException

Description copied from interface: HttpAuthentication

Indicates if authenticated.

Specified by:

isAuthenticated in interface HttpAuthentication<C>

Returns:

true if authenticated.

Throws:

HttpException - If authentication has been attempted but there were failures in undertaking authentication.

getCredentialsType

public Class<C> getCredentialsType()

Description copied from interface: HttpAuthentication

Obtains the type of credentials.

Specified by:

getCredentialsType in interface HttpAuthentication<C>

Returns:

Type of credentials.

authenticate

public void authenticate(C credentials,
 AuthenticateRequest authenticateRequest)

Description copied from interface: HttpAuthentication

Triggers to undertake authentication.

Specified by:

authenticate in interface HttpAuthentication<C>

Parameters:

credentials - Credentials. May be null if no credentials are required, or they are pulled from the HttpRequest.

authenticateRequest - AuthenticateRequest.

getAccessControl

public HttpAccessControl getAccessControl()
                                   throws AuthenticationRequiredException,
HttpException

Description copied from interface: HttpAuthentication

Obtains the HttpAccessControl.

Specified by:

getAccessControl in interface HttpAuthentication<C>

Returns:

HttpAccessControl.

Throws:

AuthenticationRequiredException - If not authenticated.

HttpException - If failure occurred in authentication.

logout

public void logout(LogoutRequest logoutRequest)

Description copied from interface: HttpAuthentication

Undertakes logging out.

Specified by:

logout in interface HttpAuthentication<C>

Parameters:

logoutRequest - LogoutRequest.