net.officefloor.plugin.web.http.security

Class HttpAuthenticationManagedObject<S,C>

java.lang.Object

net.officefloor.plugin.web.http.security.HttpAuthenticationManagedObject<S,C>

All Implemented Interfaces:

AsynchronousManagedObject, CoordinatingManagedObject<HttpAuthenticationManagedObjectSource.Dependencies>, ManagedObject, HttpAuthentication<S,C>

public class HttpAuthenticationManagedObject<S,C>
extends Object
implements AsynchronousManagedObject, CoordinatingManagedObject<HttpAuthenticationManagedObjectSource.Dependencies>, HttpAuthentication<S,C>

HttpAuthentication ManagedObject.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
HttpAuthenticationManagedObject(HttpSecuritySource<S,C,?,?> httpSecuritySource, ManagedObjectExecuteContext<HttpAuthenticationManagedObjectSource.Flows> executeContext) Initiate.

Method Summary

Modifier and Type	Method and Description
void	authenticate(HttpAuthenticateRequest<C> authenticationRequest) Undertakes authentication.
S	getHttpSecurity() Obtains the HTTP security.
Object	getObject() Obtains the object being managed.
void	loadObjects(ObjectRegistry<HttpAuthenticationManagedObjectSource.Dependencies> registry) Loads the Objects of the ManagedObject instances to be referenced by this CoordinatingManagedObject.
void	logout(HttpLogoutRequest logoutRequest) Undertakes logging out.
void	registerAsynchronousCompletionListener(AsynchronousListener listener) Provides the AsynchronousListener to the AsynchronousManagedObject to enable call back to notify state and completion of asynchronous processing.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpAuthenticationManagedObject

public HttpAuthenticationManagedObject(HttpSecuritySource<S,C,?,?> httpSecuritySource,
                                       ManagedObjectExecuteContext<HttpAuthenticationManagedObjectSource.Flows> executeContext)

Initiate.

Parameters:

httpSecuritySource - HttpSecuritySource.

executeContext - ManagedObjectExecuteContext.

Method Detail

registerAsynchronousCompletionListener

public void registerAsynchronousCompletionListener(AsynchronousListener listener)

Description copied from interface: AsynchronousManagedObject

Provides the AsynchronousListener to the AsynchronousManagedObject to enable call back to notify state and completion of asynchronous processing.

Specified by:

registerAsynchronousCompletionListener in interface AsynchronousManagedObject

Parameters:

listener - AsynchronousListener.

loadObjects

public void loadObjects(ObjectRegistry<HttpAuthenticationManagedObjectSource.Dependencies> registry)
                 throws Throwable

Description copied from interface: CoordinatingManagedObject

Loads the Objects of the ManagedObject instances to be referenced by this CoordinatingManagedObject.

References to the loaded Objects must be released on recycling the ManagedObject.

Specified by:

loadObjects in interface CoordinatingManagedObject<HttpAuthenticationManagedObjectSource.Dependencies>

Parameters:

registry - Registry of the Objects for the ManagedObject instances.

Throws:

Throwable - Should this CoordinatingManagedObject fail to load the ManagedObject.

getObject

public Object getObject()
                 throws Throwable

Description copied from interface: ManagedObject

Obtains the object being managed.

Specified by:

getObject in interface ManagedObject

Returns:

Object being managed.

Throws:

Throwable - Indicating failed to obtain the object for use.

authenticate

public void authenticate(HttpAuthenticateRequest<C> authenticationRequest)

Description copied from interface: HttpAuthentication

Undertakes authentication.

Specified by:

authenticate in interface HttpAuthentication<S,C>

Parameters:

authenticationRequest - HttpAuthenticateRequest.

getHttpSecurity

public S getHttpSecurity()
                  throws IOException

Description copied from interface: HttpAuthentication

Obtains the HTTP security.

Specified by:

getHttpSecurity in interface HttpAuthentication<S,C>

Returns:

HTTP security or null if not authenticated.

Throws:

IOException - If authentication has been attempted but there were failures communicating to necessary security services.

logout

public void logout(HttpLogoutRequest logoutRequest)

Description copied from interface: HttpAuthentication

Undertakes logging out.

Specified by:

logout in interface HttpAuthentication<S,C>

Parameters:

logoutRequest - HttpLogoutRequest.