Package net.officefloor.compile.spi.officefloor

Interface DeployedOfficeInput

All Superinterfaces:

OfficeFloorFlowSinkNode

All Known Subinterfaces:

SectionInputNode

All Known Implementing Classes:

SectionInputNodeImpl

public interface DeployedOfficeInput
extends OfficeFloorFlowSinkNode

Input into a DeployedOffice.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
<O,M extends ManagedObject> ExternalServiceInput<O,M>	addExternalServiceInput(java.lang.Class<O> objectType, java.lang.Class<? extends M> managedObjectType, ExternalServiceCleanupEscalationHandler<? super M> cleanupEscalationHandler)	Adds an ExternalServiceInput to externally trigger this DeployedOfficeInput.
DeployedOffice	getDeployedOffice()	Obtains the DeployedOffice containing this DeployedOfficeInput.
java.lang.String	getDeployedOfficeInputName()	Obtains the name of the DeployedOfficeInput.
FunctionManager	getFunctionManager()	Obtains the FunctionManager to externally trigger this DeployedOfficeInput.

Method Detail

getDeployedOfficeInputName

java.lang.String getDeployedOfficeInputName()

Obtains the name of the DeployedOfficeInput.

Returns:

Name of the DeployedOfficeInput.

getDeployedOffice

DeployedOffice getDeployedOffice()

Obtains the DeployedOffice containing this DeployedOfficeInput.

Returns:

DeployedOffice containing this DeployedOfficeInput.

getFunctionManager

FunctionManager getFunctionManager()

Obtains the FunctionManager to externally trigger this DeployedOfficeInput.

This allows OfficeFloorExtensionService instances to obtain the FunctionManager for external triggering of service handling.

Returns:

FunctionManager to externally trigger this DeployedOfficeInput.

addExternalServiceInput

<O,M extends ManagedObject> ExternalServiceInput<O,M> addExternalServiceInput(java.lang.Class<O> objectType,
                                                                                          java.lang.Class<? extends M> managedObjectType,
                                                                                          ExternalServiceCleanupEscalationHandler<? super M> cleanupEscalationHandler)

Adds an ExternalServiceInput to externally trigger this DeployedOfficeInput.

This allows OfficeFloorExtensionService instances to run external services (running within their own Thread) to use OfficeFloor to service.

Should the external service require running within the OfficeFloor open/close life-cycle, add an OfficeFloorListener to the OfficeFloorDeployer.

An example use case is running OfficeFloor within a JEE server and having OfficeFloor service the Servlet requests.

Note should more complex interaction be required with OfficeFloor, consider creating a ManagedObjectSource and invoking services through the ManagedObjectExecuteContext.

Type Parameters:

O - Object type.

M - ManagedObject type.

Parameters:

objectType - Type of object provided to the ExternalServiceInput.

managedObjectType - Type of the ManagedObject to the ExternalServiceInput.

cleanupEscalationHandler - ExternalServiceCleanupEscalationHandler.

Returns:

ExternalServiceInput.