Package net.officefloor.web.session

Class HttpSessionManagedObjectSource

java.lang.Object

net.officefloor.frame.api.managedobject.source.impl.AbstractAsyncManagedObjectSource<O,F>

net.officefloor.frame.api.managedobject.source.impl.AbstractManagedObjectSource<Indexed,Indexed>

net.officefloor.web.session.HttpSessionManagedObjectSource

All Implemented Interfaces:

ManagedObjectSource<Indexed,Indexed>

@PrivateSource
public class HttpSessionManagedObjectSource
extends AbstractManagedObjectSource<Indexed,Indexed>

ManagedObjectSource for a HttpSession.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested classes/interfaces inherited from class net.officefloor.frame.api.managedobject.source.impl.AbstractAsyncManagedObjectSource

AbstractAsyncManagedObjectSource.DependencyLabeller<K extends Enum<K>>, AbstractAsyncManagedObjectSource.ExecutionLabeller, AbstractAsyncManagedObjectSource.Labeller<K extends Enum<K>>, AbstractAsyncManagedObjectSource.MetaDataContext<O extends Enum<O>,F extends Enum<F>>, AbstractAsyncManagedObjectSource.SpecificationContext

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_SESSION_ID_COOKIE_NAME	Keep default consistent with JEE to aid in special processing of session identifiers by such things as search engines.
static final String	PROPERTY_MAX_IDLE_TIME	Property name to obtain the default maximum idle times for HttpSession instances.
static final String	PROPERTY_SESSION_ID_COOKIE_NAME	Property name to obtain the HttpCookie name of the Session Id.
static final String	PROPERTY_USE_DEPENDENCY_SESSION_ID_GENERATOR	Property name specifying whether to use an external HttpSessionIdGenerator.
static final String	PROPERTY_USE_DEPENDENCY_SESSION_STORE	Property name specifying whether to use an external HttpSessionStore.

Constructor Summary

Constructors

Constructor	Description
HttpSessionManagedObjectSource()

Method Summary

Modifier and Type	Method	Description
protected ManagedObject	getManagedObject()	Synchronously obtains the ManagedObject.
protected void	loadMetaData(AbstractAsyncManagedObjectSource.MetaDataContext<Indexed,Indexed> context)	Overridden to load meta-data.
protected void	loadSpecification(AbstractAsyncManagedObjectSource.SpecificationContext context)	Overridden to load specifications.

Methods inherited from class net.officefloor.frame.api.managedobject.source.impl.AbstractManagedObjectSource

sourceManagedObject

Methods inherited from class net.officefloor.frame.api.managedobject.source.impl.AbstractAsyncManagedObjectSource

getSpecification, init, start, stop

Methods inherited from class java.lang.Object

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

Field Details

PROPERTY_SESSION_ID_COOKIE_NAME

public static final String PROPERTY_SESSION_ID_COOKIE_NAME

Property name to obtain the HttpCookie name of the Session Id.

See Also:

• Constant Field Values

PROPERTY_USE_DEPENDENCY_SESSION_ID_GENERATOR

public static final String PROPERTY_USE_DEPENDENCY_SESSION_ID_GENERATOR

Property name specifying whether to use an external HttpSessionIdGenerator. Value of true indicates to link as dependency. A default HttpSessionIdGenerator is used otherwise.

See Also:

• Constant Field Values

PROPERTY_USE_DEPENDENCY_SESSION_STORE

public static final String PROPERTY_USE_DEPENDENCY_SESSION_STORE

Property name specifying whether to use an external HttpSessionStore. Value of true indicates to link as dependency. A default HttpSessionStore is used otherwise.

See Also:

• Constant Field Values

PROPERTY_MAX_IDLE_TIME

public static final String PROPERTY_MAX_IDLE_TIME

Property name to obtain the default maximum idle times for HttpSession instances.

See Also:

• Constant Field Values

DEFAULT_SESSION_ID_COOKIE_NAME

public static final String DEFAULT_SESSION_ID_COOKIE_NAME

Keep default consistent with JEE to aid in special processing of session identifiers by such things as search engines.

See Also:

• Constant Field Values

Constructor Details

HttpSessionManagedObjectSource

public HttpSessionManagedObjectSource()

Method Details

loadSpecification

protected void loadSpecification(AbstractAsyncManagedObjectSource.SpecificationContext context)

Description copied from class: AbstractAsyncManagedObjectSource

Overridden to load specifications.

Specified by:

loadSpecification in class AbstractAsyncManagedObjectSource<Indexed,Indexed>

Parameters:

context - Specifications.

loadMetaData

protected void loadMetaData(AbstractAsyncManagedObjectSource.MetaDataContext<Indexed,Indexed> context)
                     throws Exception

Description copied from class: AbstractAsyncManagedObjectSource

Overridden to load meta-data.

Specified by:

loadMetaData in class AbstractAsyncManagedObjectSource<Indexed,Indexed>

Parameters:

context - Meta-data.

Throws:

Exception - If fails to load the meta-data.

getManagedObject

protected ManagedObject getManagedObject()
                                  throws Throwable

Description copied from class: AbstractManagedObjectSource

Synchronously obtains the ManagedObject.

Specified by:

getManagedObject in class AbstractManagedObjectSource<Indexed,Indexed>

Returns:

ManagedObject.

Throws:

Throwable - If fails to obtain the ManagedObject.