net.officefloor.plugin.servlet.context.source

Class OfficeServletContextManagedObjectSource

java.lang.Object

net.officefloor.frame.spi.managedobject.source.impl.AbstractAsyncManagedObjectSource<D,F>

net.officefloor.frame.spi.managedobject.source.impl.AbstractManagedObjectSource<OfficeServletContextManagedObjectSource.DependencyKeys,None>

net.officefloor.plugin.servlet.context.source.OfficeServletContextManagedObjectSource

All Implemented Interfaces:

CoordinatingManagedObject<OfficeServletContextManagedObjectSource.DependencyKeys>, ManagedObject, ManagedObjectSource<OfficeServletContextManagedObjectSource.DependencyKeys,None>

public class OfficeServletContextManagedObjectSource
extends AbstractManagedObjectSource<OfficeServletContextManagedObjectSource.DependencyKeys,None>
implements CoordinatingManagedObject<OfficeServletContextManagedObjectSource.DependencyKeys>

ManagedObjectSource for the OfficeServletContext.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OfficeServletContextManagedObjectSource.DependencyKeys Dependency keys for the OfficeServletContextManagedObjectSource.

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

AbstractAsyncManagedObjectSource.DependencyLabeller, AbstractAsyncManagedObjectSource.Labeller, AbstractAsyncManagedObjectSource.MetaDataContext<D extends Enum<D>,F extends Enum<F>>, AbstractAsyncManagedObjectSource.SpecificationContext

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_FILTER_INSTANCE_INIT_PREFIX Prefix on property name to obtain Init Parameter name and its corresponding value.
static String	PROPERTY_FILTER_INSTANCE_NAME_PREFIX Prefix on property name to obtain the Filter name and its corresponding Filter Class name.
static String	PROPERTY_FILTER_MAPPING_INDEX_PREFIX Prefix on property name to obtain the FilterMapping index and its corresponding Filter name.
static String	PROPERTY_FILTER_MAPPING_SERVLET_PREFIX Prefix on property name to obtain the FilterMapping Servlet name.
static String	PROPERTY_FILTER_MAPPING_TYPE_PREFIX Prefix on property name to obtain the FilterMapping MappingType.
static String	PROPERTY_FILTER_MAPPING_URL_PREFIX Prefix on property name to obtain the FilterMapping URL pattern.
static String	PROPERTY_PREFIX_FILE_EXTENSION_TO_MIME_TYPE Property prefix to file extension to MIME type mapping.
static String	PROPERTY_PREFIX_INIT_PARAMETER Property prefix to an init parameter.
static String	PROPERTY_SERVLET_CONTEXT_NAME Property name to specify the ServletContext name.

Constructor Summary

Constructors

Constructor and Description
OfficeServletContextManagedObjectSource()

Method Summary

Modifier and Type	Method and Description
protected ManagedObject	getManagedObject() Synchronously obtains the ManagedObject.
Object	getObject() Obtains the object being managed.
Map<String,String>	loadMappings(String prefix, ManagedObjectSourceContext<None> context, Map<String,String> mappings) Extracts the mapping from the ManagedObjectSourceContext.
protected void	loadMetaData(AbstractAsyncManagedObjectSource.MetaDataContext<OfficeServletContextManagedObjectSource.DependencyKeys,None> context) Overridden to load meta-data.
void	loadObjects(ObjectRegistry<OfficeServletContextManagedObjectSource.DependencyKeys> registry) Loads the Objects of the ManagedObject instances to be referenced by this CoordinatingManagedObject.
protected void	loadSpecification(AbstractAsyncManagedObjectSource.SpecificationContext context) Overridden to load specifications.

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

sourceManagedObject

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

getMetaData, getSpecification, init, start, stop

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_SERVLET_CONTEXT_NAME

public static final String PROPERTY_SERVLET_CONTEXT_NAME

Property name to specify the ServletContext name.

See Also:

Constant Field Values

PROPERTY_PREFIX_INIT_PARAMETER

public static final String PROPERTY_PREFIX_INIT_PARAMETER

Property prefix to an init parameter.

See Also:

Constant Field Values

PROPERTY_PREFIX_FILE_EXTENSION_TO_MIME_TYPE

public static final String PROPERTY_PREFIX_FILE_EXTENSION_TO_MIME_TYPE

Property prefix to file extension to MIME type mapping.

See Also:

Constant Field Values

PROPERTY_FILTER_INSTANCE_NAME_PREFIX

public static final String PROPERTY_FILTER_INSTANCE_NAME_PREFIX

Prefix on property name to obtain the Filter name and its corresponding Filter Class name.

See Also:

Constant Field Values

PROPERTY_FILTER_INSTANCE_INIT_PREFIX

public static final String PROPERTY_FILTER_INSTANCE_INIT_PREFIX

Prefix on property name to obtain Init Parameter name and its corresponding value.

See Also:

Constant Field Values

PROPERTY_FILTER_MAPPING_INDEX_PREFIX

public static final String PROPERTY_FILTER_MAPPING_INDEX_PREFIX

Prefix on property name to obtain the FilterMapping index and its corresponding Filter name.

See Also:

Constant Field Values

PROPERTY_FILTER_MAPPING_URL_PREFIX

public static final String PROPERTY_FILTER_MAPPING_URL_PREFIX

Prefix on property name to obtain the FilterMapping URL pattern.

See Also:

Constant Field Values

PROPERTY_FILTER_MAPPING_SERVLET_PREFIX

public static final String PROPERTY_FILTER_MAPPING_SERVLET_PREFIX

Prefix on property name to obtain the FilterMapping Servlet name.

See Also:

Constant Field Values

PROPERTY_FILTER_MAPPING_TYPE_PREFIX

public static final String PROPERTY_FILTER_MAPPING_TYPE_PREFIX

Prefix on property name to obtain the FilterMapping MappingType.

See Also:

Constant Field Values

Constructor Detail

OfficeServletContextManagedObjectSource

public OfficeServletContextManagedObjectSource()

Method Detail

loadMappings

public Map<String,String> loadMappings(String prefix,
                                       ManagedObjectSourceContext<None> context,
                                       Map<String,String> mappings)

Extracts the mapping from the ManagedObjectSourceContext.

Parameters:

prefix - Prefix of properties with remaining being the key.

context - ManagedObjectSourceContext.

mappings - Mappings to be loaded..

Returns:

Mapping.

loadSpecification

protected void loadSpecification(AbstractAsyncManagedObjectSource.SpecificationContext context)

Description copied from class: AbstractAsyncManagedObjectSource

Overridden to load specifications.

Specified by:

loadSpecification in class AbstractAsyncManagedObjectSource<OfficeServletContextManagedObjectSource.DependencyKeys,None>

Parameters:

context - Specifications.

loadMetaData

protected void loadMetaData(AbstractAsyncManagedObjectSource.MetaDataContext<OfficeServletContextManagedObjectSource.DependencyKeys,None> context)
                     throws Exception

Description copied from class: AbstractAsyncManagedObjectSource

Overridden to load meta-data.

Specified by:

loadMetaData in class AbstractAsyncManagedObjectSource<OfficeServletContextManagedObjectSource.DependencyKeys,None>

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<OfficeServletContextManagedObjectSource.DependencyKeys,None>

Returns:

ManagedObject.

Throws:

Throwable - If fails to obtain the ManagedObject.

loadObjects

public void loadObjects(ObjectRegistry<OfficeServletContextManagedObjectSource.DependencyKeys> 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<OfficeServletContextManagedObjectSource.DependencyKeys>

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.