net.officefloor.plugin.servlet.bridge

Class ServletBridgeManagedObjectSource

java.lang.Object

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

net.officefloor.frame.spi.managedobject.source.impl.AbstractManagedObjectSource<None,ServletBridgeManagedObjectSource.FlowKeys>

net.officefloor.plugin.servlet.bridge.ServletBridgeManagedObjectSource

All Implemented Interfaces:

ManagedObjectSource<None,ServletBridgeManagedObjectSource.FlowKeys>

public class ServletBridgeManagedObjectSource
extends AbstractManagedObjectSource<None,ServletBridgeManagedObjectSource.FlowKeys>

ManagedObjectSource to trigger a ProcessState to service a HttpServletRequest via providing a ServletBridge.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServletBridgeManagedObjectSource.CompleteAsyncContextTask Task to complete the AsyncContext.
static class	ServletBridgeManagedObjectSource.FlowKeys Flow keys for the ServletBridgeManagedObjectSource.

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[]	DEPENDENCY_ANNOTATION_TYPE_NAMES Type names for the dependency annotations.
static String	PROPERTY_INSTANCE_IDENTIFIER Name of property identifying the instance of the Servlet.
static String	PROPERTY_USE_ASYNC Name of property identifying whether to use AsyncContext servicing.

Constructor Summary

Constructors

Constructor and Description
ServletBridgeManagedObjectSource()

Method Summary

Modifier and Type	Method and Description
static <S> ServletServiceBridger<S>	createServletServiceBridger(Class<S> servletClass) Creates the ServletServiceBridger for the Servlet.
static <S> ServletServiceBridger<S>	createServletServiceBridger(Class<S> servletClass, AutoWireOfficeFloorSource source, String handlerSectionName, String handlerInputName) Convenience method to create a ServletServiceBridger and also configure into the AutoWireOfficeFloorSource.
protected ManagedObject	getManagedObject() Synchronously obtains the ManagedObject.
protected void	loadMetaData(AbstractAsyncManagedObjectSource.MetaDataContext<None,ServletBridgeManagedObjectSource.FlowKeys> context) Overridden to load meta-data.
protected void	loadSpecification(AbstractAsyncManagedObjectSource.SpecificationContext context) Overridden to load specifications.
void	start(ManagedObjectExecuteContext<ServletBridgeManagedObjectSource.FlowKeys> context) Called once after ManagedObjectSource.init(ManagedObjectSourceContext) to indicate this ManagedObjectSource should start execution.

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, stop

Methods inherited from class java.lang.Object

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

Field Detail

DEPENDENCY_ANNOTATION_TYPE_NAMES

public static final String[] DEPENDENCY_ANNOTATION_TYPE_NAMES

Type names for the dependency annotations. Using the qualified name rather than the class name as some dependencies such as EJBs may not have the annotation class available within the class path.

PROPERTY_INSTANCE_IDENTIFIER

public static final String PROPERTY_INSTANCE_IDENTIFIER

Name of property identifying the instance of the Servlet.

See Also:

Constant Field Values

PROPERTY_USE_ASYNC

public static final String PROPERTY_USE_ASYNC

Name of property identifying whether to use AsyncContext servicing.

See Also:

Constant Field Values

Constructor Detail

ServletBridgeManagedObjectSource

public ServletBridgeManagedObjectSource()

Method Detail

createServletServiceBridger

public static <S> ServletServiceBridger<S> createServletServiceBridger(Class<S> servletClass,
                                                                       AutoWireOfficeFloorSource source,
                                                                       String handlerSectionName,
                                                                       String handlerInputName)

Convenience method to create a ServletServiceBridger and also configure into the AutoWireOfficeFloorSource.

Type Parameters:

S - Servlet type.

Parameters:

servletClass - Servlet class.

source - AutoWireOfficeFloorSource.

handlerSectionName - Name of the section to handle the HTTP request.

handlerInputName - Name of the input on the section to handle the HTTP request.

Returns:

ServletServiceBridger.

createServletServiceBridger

public static <S> ServletServiceBridger<S> createServletServiceBridger(Class<S> servletClass)

Creates the ServletServiceBridger for the Servlet.

Type Parameters:

S - Servlet type.

Parameters:

servletClass - Class of the Servlet.

Returns:

ServletServiceBridger for the Servlet.

loadSpecification

protected void loadSpecification(AbstractAsyncManagedObjectSource.SpecificationContext context)

Description copied from class: AbstractAsyncManagedObjectSource

Overridden to load specifications.

Specified by:

loadSpecification in class AbstractAsyncManagedObjectSource<None,ServletBridgeManagedObjectSource.FlowKeys>

Parameters:

context - Specifications.

loadMetaData

protected void loadMetaData(AbstractAsyncManagedObjectSource.MetaDataContext<None,ServletBridgeManagedObjectSource.FlowKeys> context)
                     throws Exception

Description copied from class: AbstractAsyncManagedObjectSource

Overridden to load meta-data.

Specified by:

loadMetaData in class AbstractAsyncManagedObjectSource<None,ServletBridgeManagedObjectSource.FlowKeys>

Parameters:

context - Meta-data.

Throws:

Exception - If fails to load the meta-data.

start

public void start(ManagedObjectExecuteContext<ServletBridgeManagedObjectSource.FlowKeys> context)
           throws Exception

Description copied from interface: ManagedObjectSource

Called once after ManagedObjectSource.init(ManagedObjectSourceContext) to indicate this ManagedObjectSource should start execution.

On invocation of this method, ProcessState instances may be invoked via the ManagedObjectExecuteContext.

Specified by:

start in interface ManagedObjectSource<None,ServletBridgeManagedObjectSource.FlowKeys>

Overrides:

start in class AbstractAsyncManagedObjectSource<None,ServletBridgeManagedObjectSource.FlowKeys>

Parameters:

context - ManagedObjectExecuteContext to use in starting this ManagedObjectSource.

Throws:

Exception - Should the ManagedObjectSource fail to start execution.

getManagedObject

protected ManagedObject getManagedObject()
                                  throws Throwable

Description copied from class: AbstractManagedObjectSource

Synchronously obtains the ManagedObject.

Specified by:

getManagedObject in class AbstractManagedObjectSource<None,ServletBridgeManagedObjectSource.FlowKeys>

Returns:

ManagedObject.

Throws:

Throwable - If fails to obtain the ManagedObject.