net.officefloor.plugin.web.http.session.attribute

Class HttpSessionAttributeManagedObject

java.lang.Object

net.officefloor.plugin.web.http.session.attribute.HttpSessionAttributeManagedObject

All Implemented Interfaces:

CoordinatingManagedObject<HttpSessionAttributeManagedObjectSource.HttpSessionAttributeDependencies>, ManagedObject, NameAwareManagedObject, HttpSessionAttribute<Serializable>

public class HttpSessionAttributeManagedObject
extends Object
implements NameAwareManagedObject, CoordinatingManagedObject<HttpSessionAttributeManagedObjectSource.HttpSessionAttributeDependencies>, HttpSessionAttribute<Serializable>

ManagedObject for the HttpSessionAttribute.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
HttpSessionAttributeManagedObject()

Method Summary

Modifier and Type	Method and Description
Object	getObject() Obtains the object being managed.
Serializable	getSessionObject() Obtains the Object from the HttpSession.
void	loadObjects(ObjectRegistry<HttpSessionAttributeManagedObjectSource.HttpSessionAttributeDependencies> registry) Loads the Objects of the ManagedObject instances to be referenced by this CoordinatingManagedObject.
void	setBoundManagedObjectName(String boundManagedObjectName) Provides the ManagedObject its bound name.
void	setSessionObject(Serializable sessionObject) Sets the Object into the HttpSession.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpSessionAttributeManagedObject

public HttpSessionAttributeManagedObject()

Method Detail

setBoundManagedObjectName

public void setBoundManagedObjectName(String boundManagedObjectName)

Description copied from interface: NameAwareManagedObject

Provides the ManagedObject its bound name.

Specified by:

setBoundManagedObjectName in interface NameAwareManagedObject

Parameters:

boundManagedObjectName - Bound name for the ManagedObject.

loadObjects

public void loadObjects(ObjectRegistry<HttpSessionAttributeManagedObjectSource.HttpSessionAttributeDependencies> 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<HttpSessionAttributeManagedObjectSource.HttpSessionAttributeDependencies>

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.

getSessionObject

public Serializable getSessionObject()

Description copied from interface: HttpSessionAttribute

Obtains the Object from the HttpSession.

Specified by:

getSessionObject in interface HttpSessionAttribute<Serializable>

Returns:

Object from the HttpSession. May be null if not within the HttpSession.

setSessionObject

public void setSessionObject(Serializable sessionObject)

Description copied from interface: HttpSessionAttribute

Sets the Object into the HttpSession.

Specified by:

setSessionObject in interface HttpSessionAttribute<Serializable>

Parameters:

sessionObject - HttpSession Object.