Package net.officefloor.frame.impl.execute.thread

Class ThreadStateImpl

java.lang.Object

net.officefloor.frame.impl.execute.linkedlistset.AbstractLinkedListSetEntry<ThreadState,ProcessState>

net.officefloor.frame.impl.execute.thread.ThreadStateImpl

All Implemented Interfaces:

LinkedListSetEntry<ThreadState,ProcessState>, ThreadState

public class ThreadStateImpl
extends AbstractLinkedListSetEntry<ThreadState,ProcessState>
implements ThreadState

Implementation of the ThreadState.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field	Description
protected LinkedListSet<Flow,ThreadState>	activeFlows	Active Flow instances for this ThreadState.

Constructor Summary

Constructors

Constructor	Description
ThreadStateImpl(ThreadMetaData threadMetaData, FlowCallback callback, ThreadState callbackThreadState, ProcessState processState, ProcessProfiler processProfiler)	Initiate with ProcessState FlowCallback.
ThreadStateImpl(ThreadMetaData threadMetaData, FlowCompletion completion, boolean isEscalationHandlingThreadState, ProcessState processState, ProcessProfiler processProfiler)	Initiate.

Method Summary

Modifier and Type	Method	Description
static ThreadStateContext	attachThreadStateToThread(ThreadState threadState, boolean isThreadStateSafe)	Attaches the ThreadState to the Thread.
AvoidTeam	avoidTeam(FunctionState function, TeamManagement team)	Runs avoiding the specified Team.
Flow	createFlow(FlowCompletion flowCompletion, EscalationCompletion escalationCompletion)	Creates a Flow contained in this ThreadState.
static ProcessIdentifier	currentProcessIdentifier()	Obtains the current ProcessState ProcessIdentifier.
static ThreadStateContext	currentThreadContext(ThreadState fallbackThreadState)	Obtains the current ThreadStateContext.
static void	detachThreadStateFromThread()	Detaches the ThreadState from the Thread.
FunctionState	flowComplete(Flow flow, java.lang.Throwable threadEscalation, EscalationCompletion escalationCompletion)	Flags that the input Flow has completed.
GovernanceContainer<?>	getGovernanceContainer(int index)	Obtains the GovernanceContainer for the input index.
ProcessState	getLinkedListSetOwner()	Obtains the owner of the LinkedListSet that this LinkedListSetEntry may be added.
ManagedObjectContainer	getManagedObjectContainer(int index)	Obtains the ManagedObjectContainer for the input index.
int	getMaximumFunctionChainLength()	Obtains the maximum FunctionState chain length for this ThreadState.
ProcessState	getProcessState()	Obtains the ProcessState of the process containing this ThreadState.
FunctionState	handleEscalation(java.lang.Throwable escalation, EscalationCompletion escalationCompletion)	Handles the Escalation from a Flow of this ThreadState.
boolean	isAttachedToThread()	Indicates if this ThreadState is attached to the current Thread.
boolean	isGovernanceActive(int index)	Indicates if the Governance is active.
boolean	isThreadStateSafe()	Indicates if changes to the ThreadState are safe on the current Thread.
void	profile(ManagedFunctionLogicMetaData functionMetaData)	Profiles that ManagedObjectContainer is being executed.
FunctionState	registerThreadProfiler()	Obtains the FunctionState to register the ThreadProfiler.
<R,T extends java.lang.Throwable> R	runProcessSafeOperation(ProcessSafeOperation<R,T> operation)	Runs the ProcessSafeOperation.
<R,T extends java.lang.Throwable> R	runThreadSafeOperation(ThreadSafeOperation<R,T> operation)	Run the ThreadSafeOperation.
FunctionState	runWithin(FunctionState function)	Runs the FunctionState within this ThreadState.
FunctionState	then(FunctionState function, FunctionState thenFunction)	Creates FunctionState to execute the chain of the first FunctionState before moving onto execute the chain of the second FunctionState.

Methods inherited from class net.officefloor.frame.impl.execute.linkedlistset.AbstractLinkedListSetEntry

getNext, getPrev, setNext, setPrev

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.officefloor.frame.internal.structure.LinkedListSetEntry

getNext, getPrev, setNext, setPrev

Field Detail

activeFlows

protected final LinkedListSet<Flow,ThreadState> activeFlows

Active Flow instances for this ThreadState.

Constructor Detail

ThreadStateImpl

public ThreadStateImpl(ThreadMetaData threadMetaData,
                       FlowCallback callback,
                       ThreadState callbackThreadState,
                       ProcessState processState,
                       ProcessProfiler processProfiler)

Initiate with ProcessState FlowCallback.

Parameters:

threadMetaData - ThreadMetaData for this ThreadState.

callback - ProcessState FlowCallback.

callbackThreadState - FlowCallback ThreadState.

processState - ProcessState for this ThreadState.

processProfiler - ProcessProfiler. May be null.

ThreadStateImpl

public ThreadStateImpl(ThreadMetaData threadMetaData,
                       FlowCompletion completion,
                       boolean isEscalationHandlingThreadState,
                       ProcessState processState,
                       ProcessProfiler processProfiler)

Initiate.

Parameters:

threadMetaData - ThreadMetaData for this ThreadState.

completion - FlowCompletion for this ThreadState.

isEscalationHandlingThreadState - true if this ThreadState was spawned to handle an Escalation. false to indicate a ThreadState for normal execution.

processState - ProcessState for this ThreadState.

processProfiler - ProcessProfiler. May be null.

Method Detail

attachThreadStateToThread

public static ThreadStateContext attachThreadStateToThread(ThreadState threadState,
                                                           boolean isThreadStateSafe)

Attaches the ThreadState to the Thread.

Parameters:

threadState - ThreadState to attached to the Thread.

isThreadStateSafe - Indicates if the execution is ThreadState safe.

Returns:

ThreadStateContext for executing the ThreadState attached to the Thread.

detachThreadStateFromThread

public static void detachThreadStateFromThread()

Detaches the ThreadState from the Thread.

currentProcessIdentifier

public static ProcessIdentifier currentProcessIdentifier()

Obtains the current ProcessState ProcessIdentifier.

Returns:

Current ProcessState ProcessIdentifier or null if outside management.

currentThreadContext

public static ThreadStateContext currentThreadContext(ThreadState fallbackThreadState)

Obtains the current ThreadStateContext.

Parameters:

fallbackThreadState - Fall back ThreadState if no ThreadState bound to Thread.

Returns:

Current ThreadStateContext.

getLinkedListSetOwner

public ProcessState getLinkedListSetOwner()

Description copied from interface: LinkedListSetEntry

Obtains the owner of the LinkedListSet that this LinkedListSetEntry may be added.

LinkedListSetEntry instances may only be added to the LinkedListSet they were intended for and can not be shared between LinkedListSet instances. This constraint:

1. ensures the integrity of the FunctionState, Flow, ThreadState, ProcessState structure, and
2. improves uniqueness performance as LinkedListSetEntry.getNext() and LinkedListSetEntry.getPrev() both returning null indicates not added

Specified by:

getLinkedListSetOwner in interface LinkedListSetEntry<ThreadState,ProcessState>

Returns:

Owner of the LinkedListSet that may contain this LinkedListSetEntry.

isAttachedToThread

public boolean isAttachedToThread()

Description copied from interface: ThreadState

Indicates if this ThreadState is attached to the current Thread.

Specified by:

isAttachedToThread in interface ThreadState

Returns:

true if ThreadState is attached to the current Thread.

isThreadStateSafe

public boolean isThreadStateSafe()

Description copied from interface: ThreadState

Indicates if changes to the ThreadState are safe on the current Thread.

Specified by:

isThreadStateSafe in interface ThreadState

Returns:

true should changes to the ThreadState be safe on the current Thread.

then

public FunctionState then(FunctionState function,
                          FunctionState thenFunction)

Description copied from interface: ThreadState

Creates FunctionState to execute the chain of the first FunctionState before moving onto execute the chain of the second FunctionState.

Specified by:

then in interface ThreadState

Parameters:

function - Head of initial FunctionState chain to complete.

thenFunction - Head of the second FunctionState chain to then complete next.

Returns:

FunctionState to execute the chains one after another.

runWithin

public FunctionState runWithin(FunctionState function)

Description copied from interface: ThreadState

Runs the FunctionState within this ThreadState.

Specified by:

runWithin in interface ThreadState

Parameters:

function - FunctionState to run within this ThreadState.

Returns:

FunctionState running within this ThreadState.

avoidTeam

public AvoidTeam avoidTeam(FunctionState function,
                           TeamManagement team)

Description copied from interface: ThreadState

Runs avoiding the specified Team.

Specified by:

avoidTeam in interface ThreadState

Parameters:

function - FunctionState to avoid being executed by the specified Team.

team - TeamManagement of Team to avoid.

Returns:

AvoidTeam.

getMaximumFunctionChainLength

public int getMaximumFunctionChainLength()

Description copied from interface: ThreadState

Obtains the maximum FunctionState chain length for this ThreadState.

Once the FunctionState chain has reached this length, it will be broken. (spawned in another Thread). This avoids StackOverflowError issues in FunctionState chain being too large.

Specified by:

getMaximumFunctionChainLength in interface ThreadState

Returns:

Maximum FunctionState chain length for this ThreadState.

runThreadSafeOperation

public <R,T extends java.lang.Throwable> R runThreadSafeOperation(ThreadSafeOperation<R,T> operation)
                                                                 throws T extends java.lang.Throwable

Description copied from interface: ThreadState

Run the ThreadSafeOperation.

Initially locks are not taken to make the main ThreadState safe. This ensures the ThreadSafeOperation is run under critical section of this ThreadState.

Specified by:

runThreadSafeOperation in interface ThreadState

Type Parameters:

R - Return type from ThreadSafeOperation.

T - Possible Escalation from ThreadSafeOperation.

Parameters:

operation - ThreadSafeOperation.

Returns:

Optional return value from ThreadSafeOperation.

Throws:

T - Optional Throwable from ThreadSafeOperation.

T extends java.lang.Throwable

runProcessSafeOperation

public <R,T extends java.lang.Throwable> R runProcessSafeOperation(ProcessSafeOperation<R,T> operation)
                                                                  throws T extends java.lang.Throwable

Description copied from interface: ThreadState

Runs the ProcessSafeOperation.

Specified by:

runProcessSafeOperation in interface ThreadState

Type Parameters:

R - Return type from ProcessSafeOperation.

T - Possible Escalation from ProcessSafeOperation.

Parameters:

operation - ProcessSafeOperation.

Returns:

Optional return value from ProcessSafeOperation.

Throws:

T - Optional Throwable from ProcessSafeOperation.

T extends java.lang.Throwable

createFlow

public Flow createFlow(FlowCompletion flowCompletion,
                       EscalationCompletion escalationCompletion)

Description copied from interface: ThreadState

Creates a Flow contained in this ThreadState.

Specified by:

createFlow in interface ThreadState

Parameters:

flowCompletion - Optional FlowCompletion to handle completion of the Flow. May be null.

escalationCompletion - Optional EscalationCompletion to handle completion of Flow and notify Escalation handling complete. May be null.

Returns:

New Flow.

handleEscalation

public FunctionState handleEscalation(java.lang.Throwable escalation,
                                      EscalationCompletion escalationCompletion)

Description copied from interface: ThreadState

Handles the Escalation from a Flow of this ThreadState.

Specified by:

handleEscalation in interface ThreadState

Parameters:

escalation - Escalation.

escalationCompletion - Optional EscalationCompletion to be notified of completion of Escalation handling.

Returns:

FunctionState to handle the Escalation.

flowComplete

public FunctionState flowComplete(Flow flow,
                                  java.lang.Throwable threadEscalation,
                                  EscalationCompletion escalationCompletion)

Description copied from interface: ThreadState

Flags that the input Flow has completed.

Specified by:

flowComplete in interface ThreadState

Parameters:

flow - Flow that has completed.

threadEscalation - Possible Escalation from the Flow. May be null.

escalationCompletion - EscalationCompletion. May be null.

Returns:

Optional FunctionState to complete the Flow.

getProcessState

public ProcessState getProcessState()

Description copied from interface: ThreadState

Obtains the ProcessState of the process containing this ThreadState.

Specified by:

getProcessState in interface ThreadState

Returns:

ProcessState of the process containing this ThreadState.

getManagedObjectContainer

public ManagedObjectContainer getManagedObjectContainer(int index)

Description copied from interface: ThreadState

Obtains the ManagedObjectContainer for the input index.

Specified by:

getManagedObjectContainer in interface ThreadState

Parameters:

index - Index of the ManagedObjectContainer to be returned.

Returns:

ManagedObjectContainer for the index.

getGovernanceContainer

public GovernanceContainer<?> getGovernanceContainer(int index)

Description copied from interface: ThreadState

Obtains the GovernanceContainer for the input index.

Specified by:

getGovernanceContainer in interface ThreadState

Parameters:

index - Index of the GovernanceContainer to be returned.

Returns:

GovernanceContainer for the index only if active. If not active will return null.

isGovernanceActive

public boolean isGovernanceActive(int index)

Description copied from interface: ThreadState

Indicates if the Governance is active.

This provides a quick check and avoids creation of the GovernanceContainer.

Specified by:

isGovernanceActive in interface ThreadState

Parameters:

index - Index of the Governance to check active.

Returns:

true if the Governance is active.

registerThreadProfiler

public FunctionState registerThreadProfiler()

Description copied from interface: ThreadState

Obtains the FunctionState to register the ThreadProfiler.

Specified by:

registerThreadProfiler in interface ThreadState

Returns:

FunctionState to register the ThreadProfiler. May be null if no ThreadProfiler required.

profile

public void profile(ManagedFunctionLogicMetaData functionMetaData)

Description copied from interface: ThreadState

Profiles that ManagedObjectContainer is being executed.

Specified by:

profile in interface ThreadState

Parameters:

functionMetaData - ManagedFunctionLogicMetaData of the ManagedFunctionContainer being executed.