Package net.officefloor.frame.util

Class ManagedObjectSourceStandAlone

java.lang.Object

net.officefloor.frame.util.ManagedObjectSourceStandAlone

public class ManagedObjectSourceStandAlone
extends Object

Loads ManagedObjectSource for stand-alone use.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field	Description
static final String	STAND_ALONE_MANAGING_OFFICE_NAME	Name of the Office managing the ManagedObjectSource being loaded.

Constructor Summary

Constructors

Constructor	Description
ManagedObjectSourceStandAlone()

Method Summary

Modifier and Type	Method	Description
void	addProfile(String profile)	Adds a profile.
void	addProperty(String name, String value)	Adds a property for the ManagedObjectSource.
ManagingOfficeBuilder<?>	getManagingOffice()	Obtains the ManagingOfficeBuilder.
<O extends Enum<O>, F extends Enum<F>, MS extends ManagedObjectSource<O, F>> MS	initManagedObjectSource(Class<MS> managedObjectSourceClass)	Instantiates and initialises the ManagedObjectSource.
<O extends Enum<O>, F extends Enum<F>, MS extends ManagedObjectSource<O, F>> MS	initManagedObjectSource(MS managedObjectSource)	Instantiates and initialises the ManagedObjectSource.
<O extends Enum<O>, F extends Enum<F>, MS extends ManagedObjectSource<O, F>> MS	loadManagedObjectSource(Class<MS> managedObjectSourceClass)	Loads (init and start) the ManagedObjectSource.
<O extends Enum<O>, F extends Enum<F>, MS extends ManagedObjectSource<O, F>> MS	loadManagedObjectSource(MS managedObjectSource)	Loads (init and start) the ManagedObjectSource.
void	registerExecutionStrategy(int strategyIndex, ThreadFactory[] threadFactories)	Registers an ExecutionStrategy.
void	registerInvokeProcessFunction(int processIndex, ManagedFunction<?,?> function, ManagedFunctionContext<?,?> functionContext)	Registers the initial ManagedFunction for the invoked ProcessState.
void	registerInvokeProcessFunction(Enum<?> processKey, ManagedFunction<?,?> function, ManagedFunctionContext<?,?> functionContext)	Registers the initial ManagedFunction for the invoked ProcessState.
void	registerInvokeProcessServicer(int processIndex, InvokedProcessServicer servicer)	Registers an InvokedProcessServicer for the invoked ProcessState.
void	registerInvokeProcessServicer(Enum<?> processKey, InvokedProcessServicer servicer)	Registers an InvokedProcessServicer for the invoked ProcessState.
void	setClockFactory(ClockFactory clockFactory)	Specifies the ClockFactory.
<O extends Enum<O>, F extends Enum<F>, MS extends ManagedObjectSource<O, F>> void	startManagedObjectSource(MS managedObjectSource)	Starts the ManagedObjectSource.

Methods inherited from class java.lang.Object

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

Field Details

STAND_ALONE_MANAGING_OFFICE_NAME

public static final String STAND_ALONE_MANAGING_OFFICE_NAME

Name of the Office managing the ManagedObjectSource being loaded.

See Also:

• Constant Field Values

Constructor Details

ManagedObjectSourceStandAlone

public ManagedObjectSourceStandAlone()

Method Details

addProfile

public void addProfile(String profile)

Adds a profile.

Parameters:

profile - Profile.

addProperty

public void addProperty(String name,
 String value)

Adds a property for the ManagedObjectSource.

Parameters:

name - Name of the property.

value - Value for the property.

setClockFactory

public void setClockFactory(ClockFactory clockFactory)

Specifies the ClockFactory.

Parameters:

clockFactory - ClockFactory.

getManagingOffice

public ManagingOfficeBuilder<?> getManagingOffice()

Obtains the ManagingOfficeBuilder.

Returns:

ManagingOfficeBuilder.

initManagedObjectSource

public <O extends Enum<O>,
F extends Enum<F>,
MS extends ManagedObjectSource<O,
F>>
MS initManagedObjectSource(Class<MS> managedObjectSourceClass)
                    throws Exception

Instantiates and initialises the ManagedObjectSource.

Type Parameters:

O - Dependency key type.

F - Flow key type.

MS - ManagedObjectSource type.

Parameters:

managedObjectSourceClass - Class of the ManagedObjectSource.

Returns:

Initialised ManagedObjectSource.

Throws:

Exception - If fails to initialise ManagedObjectSource.

initManagedObjectSource

public <O extends Enum<O>,
F extends Enum<F>,
MS extends ManagedObjectSource<O,
F>>
MS initManagedObjectSource(MS managedObjectSource)
                    throws Exception

Instantiates and initialises the ManagedObjectSource.

Type Parameters:

O - Dependency key type.

F - Flow key type.

MS - ManagedObjectSource type.

Parameters:

managedObjectSource - ManagedObjectSource instance.

Returns:

Initialised ManagedObjectSource.

Throws:

Exception - If fails to initialise ManagedObjectSource.

startManagedObjectSource

public <O extends Enum<O>,
F extends Enum<F>,
MS extends ManagedObjectSource<O,
F>>
void startManagedObjectSource(MS managedObjectSource)
                       throws Exception

Starts the ManagedObjectSource.

Type Parameters:

O - Dependency key type.

F - Flow key type.

MS - ManagedObjectSource type.

Parameters:

managedObjectSource - ManagedObjectSource.

Throws:

Exception - If fails to start the ManagedObjectSource.

loadManagedObjectSource

public <O extends Enum<O>,
F extends Enum<F>,
MS extends ManagedObjectSource<O,
F>>
MS loadManagedObjectSource(Class<MS> managedObjectSourceClass)
                    throws Exception

Loads (init and start) the ManagedObjectSource.

Type Parameters:

O - Dependency key type.

F - Flow key type.

MS - ManagedObjectSource type.

Parameters:

managedObjectSourceClass - ManagedObjectSource class.

Returns:

Loaded ManagedObjectSource.

Throws:

Exception - If fails to init and start the ManagedObjectSource.

loadManagedObjectSource

public <O extends Enum<O>,
F extends Enum<F>,
MS extends ManagedObjectSource<O,
F>>
MS loadManagedObjectSource(MS managedObjectSource)
                    throws Exception

Loads (init and start) the ManagedObjectSource.

Type Parameters:

O - Dependency key type.

F - Flow key type.

MS - ManagedObjectSource type.

Parameters:

managedObjectSource - ManagedObjectSource instance.

Returns:

Loaded ManagedObjectSource.

Throws:

Exception - If fails to init and start the ManagedObjectSource.

registerInvokeProcessFunction

public void registerInvokeProcessFunction(Enum<?> processKey,
 ManagedFunction<?,?> function,
 ManagedFunctionContext<?,?> functionContext)

Registers the initial ManagedFunction for the invoked ProcessState.

Parameters:

processKey - Key of the ProcessState.

function - Initial ManagedFunction for the ProcessState.

functionContext - ManagedFunctionContext for the ManagedFunction. Allows for mocking the ManagedFunctionContext to validate functionality for the ManagedFunction.

registerInvokeProcessFunction

public void registerInvokeProcessFunction(int processIndex,
 ManagedFunction<?,?> function,
 ManagedFunctionContext<?,?> functionContext)

Registers the initial ManagedFunction for the invoked ProcessState.

Parameters:

processIndex - Index of the ProcessState.

function - Initial ManagedFunction for the ProcessState.

functionContext - ManagedFunctionContext for the ManagedFunction. Allows for mocking the ManagedFunctionContext to validate functionality for the ManagedFunction.

registerInvokeProcessServicer

public void registerInvokeProcessServicer(Enum<?> processKey,
 InvokedProcessServicer servicer)

Registers an InvokedProcessServicer for the invoked ProcessState.

Parameters:

processKey - Key of the ProcessState.

servicer - InvokedProcessServicer.

registerInvokeProcessServicer

public void registerInvokeProcessServicer(int processIndex,
 InvokedProcessServicer servicer)

Registers an InvokedProcessServicer for the invoked ProcessState.

Parameters:

processIndex - Index of the ProcessState.

servicer - InvokedProcessServicer.

registerExecutionStrategy

public void registerExecutionStrategy(int strategyIndex,
 ThreadFactory[] threadFactories)

Registers an ExecutionStrategy.

Parameters:

strategyIndex - Index of the ExecutionStrategy.

threadFactories - ThreadFactory instances for the ExecutionStrategy.