Interface DeployedOfficeInput
-
- All Superinterfaces:
OfficeFloorFlowSinkNode
- All Known Subinterfaces:
SectionInputNode
- All Known Implementing Classes:
SectionInputNodeImpl
public interface DeployedOfficeInput extends OfficeFloorFlowSinkNode
Input into aDeployedOffice
.- Author:
- Daniel Sagenschneider
-
-
Method Summary
All Methods Instance Methods Abstract Methods 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 anExternalServiceInput
to externally trigger thisDeployedOfficeInput
.DeployedOffice
getDeployedOffice()
Obtains theDeployedOffice
containing thisDeployedOfficeInput
.java.lang.String
getDeployedOfficeInputName()
Obtains the name of theDeployedOfficeInput
.FunctionManager
getFunctionManager()
Obtains theFunctionManager
to externally trigger thisDeployedOfficeInput
.
-
-
-
Method Detail
-
getDeployedOfficeInputName
java.lang.String getDeployedOfficeInputName()
Obtains the name of theDeployedOfficeInput
.- Returns:
- Name of the
DeployedOfficeInput
.
-
getDeployedOffice
DeployedOffice getDeployedOffice()
Obtains theDeployedOffice
containing thisDeployedOfficeInput
.- Returns:
DeployedOffice
containing thisDeployedOfficeInput
.
-
getFunctionManager
FunctionManager getFunctionManager()
Obtains the
FunctionManager
to externally trigger thisDeployedOfficeInput
.This allows
OfficeFloorExtensionService
instances to obtain theFunctionManager
for external triggering of service handling.- Returns:
FunctionManager
to externally trigger thisDeployedOfficeInput
.
-
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 thisDeployedOfficeInput
.This allows
OfficeFloorExtensionService
instances to run external services (running within their ownThread
) to useOfficeFloor
to service.Should the external service require running within the
OfficeFloor
open/close life-cycle, add anOfficeFloorListener
to theOfficeFloorDeployer
.An example use case is running
OfficeFloor
within a JEE server and havingOfficeFloor
service the Servlet requests.Note should more complex interaction be required with
OfficeFloor
, consider creating aManagedObjectSource
and invoking services through theManagedObjectExecuteContext
.- Type Parameters:
O
- Object type.M
-ManagedObject
type.- Parameters:
objectType
- Type of object provided to theExternalServiceInput
.managedObjectType
- Type of theManagedObject
to theExternalServiceInput
.cleanupEscalationHandler
-ExternalServiceCleanupEscalationHandler
.- Returns:
ExternalServiceInput
.
-
-