Package net.officefloor.web.session.object

Class HttpSessionObjectManagedObject

java.lang.Object

net.officefloor.web.session.object.HttpSessionObjectManagedObject

All Implemented Interfaces:

ContextAwareManagedObject, CoordinatingManagedObject<HttpSessionObjectManagedObject.Dependencies>, ManagedObject

public class HttpSessionObjectManagedObject
extends java.lang.Object
implements ContextAwareManagedObject, CoordinatingManagedObject<HttpSessionObjectManagedObject.Dependencies>

ManagedObject to cache creation of an Object within the HttpSession.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpSessionObjectManagedObject.Dependencies	Dependency keys for the HttpSessionObjectManagedObject.

Constructor Summary

Constructors

Constructor	Description
HttpSessionObjectManagedObject(java.lang.Class<?> objectClass, java.lang.String bindName)	Initiate.

Method Summary

Modifier and Type	Method	Description
java.lang.Object	getObject()	Obtains the object being managed.
void	loadObjects(ObjectRegistry<HttpSessionObjectManagedObject.Dependencies> registry)	Loads the Objects of the ManagedObject instances to be referenced by this CoordinatingManagedObject.
void	setManagedObjectContext(ManagedObjectContext context)	Provides the ManagedObjectContext to the ManagedObject.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpSessionObjectManagedObject

public HttpSessionObjectManagedObject(java.lang.Class<?> objectClass,
                                      java.lang.String bindName)

Initiate.

Parameters:

objectClass - Class of the object.

bindName - Specific name to bind the object into the HttpSession.

Method Detail

setManagedObjectContext

public void setManagedObjectContext(ManagedObjectContext context)

Description copied from interface: ContextAwareManagedObject

Provides the ManagedObjectContext to the ManagedObject.

Specified by:

setManagedObjectContext in interface ContextAwareManagedObject

Parameters:

context - ManagedObjectContext.

loadObjects

public void loadObjects(ObjectRegistry<HttpSessionObjectManagedObject.Dependencies> registry)
                 throws java.lang.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<HttpSessionObjectManagedObject.Dependencies>

Parameters:

registry - Registry of the Objects for the ManagedObject instances.

Throws:

java.lang.Throwable - Should this CoordinatingManagedObject fail to load the ManagedObject.

getObject

public java.lang.Object getObject()
                           throws java.lang.Throwable

Description copied from interface: ManagedObject

Obtains the object being managed.

Specified by:

getObject in interface ManagedObject

Returns:

Object being managed.

Throws:

java.lang.Throwable - Indicating failed to obtain the object for use.