net.officefloor.plugin.web.http.session

Class HttpSessionManagedObject

java.lang.Object

net.officefloor.plugin.web.http.session.HttpSessionManagedObject

All Implemented Interfaces:

AsynchronousManagedObject, CoordinatingManagedObject<Indexed>, ManagedObject

public class HttpSessionManagedObject
extends Object
implements CoordinatingManagedObject<Indexed>, AsynchronousManagedObject

ManagedObject for a HttpSession.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
HttpSessionManagedObject(String sessionIdCookieName, int serverHttpConnectionIndex, int httpSessionIdGeneratorIndex, HttpSessionIdGenerator httpSessionIdGenerator, int httpSessionStoreIndex, HttpSessionStore httpSessionStore) Initiate.

Method Summary

Modifier and Type	Method and Description
Object	getObject() Obtains the object being managed.
void	loadObjects(ObjectRegistry<Indexed> registry) Loads the Objects of the ManagedObject instances to be referenced by this CoordinatingManagedObject.
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

HttpSessionManagedObject

public HttpSessionManagedObject(String sessionIdCookieName,
                                int serverHttpConnectionIndex,
                                int httpSessionIdGeneratorIndex,
                                HttpSessionIdGenerator httpSessionIdGenerator,
                                int httpSessionStoreIndex,
                                HttpSessionStore httpSessionStore)

Initiate.

Parameters:

sessionIdCookieName - Name of the HttpCookie containing the Session Id.

serverHttpConnectionIndex - Index of the dependency ServerHttpConnection.

httpSessionIdGeneratorIndex - Index of the dependency HttpSessionIdGenerator.

httpSessionIdGenerator - HttpSessionIdGenerator. null to obtain via dependency.

httpSessionStoreIndex - Index of the dependency HttpSessionStore.

httpSessionStore - HttpSessionStore. null to obtain via dependency.

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<Indexed> 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<Indexed>

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.