net.officefloor.frame.impl.execute.job

Class AbstractJobContainer<W extends Work,N extends JobMetaData>

java.lang.Object

net.officefloor.frame.impl.execute.linkedlistset.AbstractLinkedListSetEntry<JobNode,JobSequence>

net.officefloor.frame.impl.execute.job.AbstractJobContainer<W,N>

All Implemented Interfaces:

JobExecuteContext, ContainerContext, JobNode, LinkedListSetEntry<JobNode,JobSequence>, Job

Direct Known Subclasses:

DutyJob, GovernanceJob, TaskJob

public abstract class AbstractJobContainer<W extends Work,N extends JobMetaData>
extends AbstractLinkedListSetEntry<JobNode,JobSequence>
implements Job, JobNode, JobExecuteContext, ContainerContext

Abstract implementation of the Job that provides the additional JobNode functionality.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field and Description
static TeamIdentifier	ASYNCHRONOUS_FLOW_TEAM_IDENTIFIER TeamIdentifier for decoupling current Team from invoking the asynchronous flow.
protected JobSequence	flow JobSequence.
protected N	nodeMetaData JobMetaData.
protected WorkContainer<W>	workContainer WorkContainer.

Constructor Summary

Constructors

Constructor and Description
AbstractJobContainer(JobSequence flow, WorkContainer<W> workContainer, N nodeMetaData, JobNode parallelOwner, ManagedObjectIndex[] requiredManagedObjects, boolean[] requiredGovernance, GovernanceDeactivationStrategy governanceDeactivationStrategy) Initiate.

Method Summary

Modifier and Type	Method and Description
void	activateJob(TeamIdentifier currentTeam) Activates the Job for this JobNode.
void	addGovernanceActivity(GovernanceActivity<?,?> activity) Adds a GovernanceActivity to be executed before the current JobNode.
void	addSetupTask(TaskMetaData<?,?,?> taskMetaData, Object parameter) Adds a setup Task to be executed before the current JobNode.
void	cancelJob(Exception cause) Triggers to cancel the Job.
void	clearNodes(JobNodeActivateSet activateSet, TeamIdentifier currentTeam) Clears the JobNode instances linked to this JobNode.
FlowFuture	doFlow(FlowMetaData<?> flowMetaData, Object parameter) Invokes the JobSequence for the input FlowMetaData.
boolean	doJob(JobContext jobContext) Executes the Job.
protected abstract Object	executeJob(JobExecuteContext context, JobContext jobContext, JobNodeActivateSet activateSet) Overridden by specific container to execute the Job.
void	flagJobToWait() Flags for the JobNode to wait and be activated at a later time once a dependency is ready.
EscalationProcedure	getEscalationProcedure() Obtains the EscalationProcedure for this JobNode.
JobSequence	getJobSequence() Obtains the JobSequence containing this JobNode.
JobSequence	getLinkedListSetOwner() Obtains the owner of the LinkedListSet that this LinkedListSetEntry may be added.
Job	getNextJob() Obtains the next Job.
JobNode	getNextNode() Obtains the next JobNode in the JobSequence to execute after the current JobNode has completed.
JobNode	getParallelNode() Obtains the parallel JobNode to the current JobNode.
JobNode	getParallelOwner() Obtains the parallel owner of this JobNode.
Object	getProcessIdentifier() Obtains the identifier for the ProcessState containing this Job.
boolean	isJobNodeComplete() Indicates if this JobNode is completed.
void	joinFlow(FlowFuture flowFuture, long timeout, Object token) Joins on the JobSequence for the FlowFuture.
protected abstract void	loadJobName(StringBuilder message) Loads the Job name to the message.
void	setJobComplete(boolean isComplete) Specifies whether the job is complete.
void	setNextJob(Job task) Specifies the next Job.
void	setNextNode(JobNode jobNode) Specifies the next JobNode in the JobSequence to execute after the current JobNode is completed.
void	setParallelNode(JobNode jobNode) Specifies the parallel JobNode to the current JobNode.
void	setParallelOwner(JobNode jobNode) Specifies the parallel owner of this JobNode.

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

flow

protected final JobSequence flow

JobSequence.

workContainer

protected final WorkContainer<W extends Work> workContainer

WorkContainer.

nodeMetaData

protected final N extends JobMetaData nodeMetaData

JobMetaData.

ASYNCHRONOUS_FLOW_TEAM_IDENTIFIER

public static TeamIdentifier ASYNCHRONOUS_FLOW_TEAM_IDENTIFIER

TeamIdentifier for decoupling current Team from invoking the asynchronous flow.

Note that asynchronous flows should be queued and not executed immediately by the current Team. Should execution be required immediately please use parallel flow.

Constructor Detail

AbstractJobContainer

public AbstractJobContainer(JobSequence flow,
                            WorkContainer<W> workContainer,
                            N nodeMetaData,
                            JobNode parallelOwner,
                            ManagedObjectIndex[] requiredManagedObjects,
                            boolean[] requiredGovernance,
                            GovernanceDeactivationStrategy governanceDeactivationStrategy)

Initiate.

Parameters:

flow - JobSequence containing this Job.

workContainer - WorkContainer of the Work for this Task.

nodeMetaData - JobMetaData for this node.

parallelOwner - If this is invoked as or a parallel Task or from a parallel Task this will be the invoker. If not parallel then will be null.

requiredManagedObjects - Work ManagedObjectIndex instances to the ManagedObject instances that must be loaded before the Task may be executed.

requiredGovernance - Identifies the required activation state of the Governance for this Job.

governanceDeactivationStrategy - GovernanceDeactivationStrategy for ActiveGovernance.

Method Detail

loadJobName

protected abstract void loadJobName(StringBuilder message)

Loads the Job name to the message.

Parameters:

message - Message to receive the Job name.

executeJob

protected abstract Object executeJob(JobExecuteContext context,
                                     JobContext jobContext,
                                     JobNodeActivateSet activateSet)
                              throws Throwable

Overridden by specific container to execute the Job.

Parameters:

context - JobExecuteContext.

jobContext - JobContext.

activateSet - JobNodeActivateSet.

Returns:

Parameter for the next Job.

Throws:

Throwable - If failure in executing the Job.

getLinkedListSetOwner

public JobSequence 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 JobNode, JobSequence, 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<JobNode,JobSequence>

Returns:

Owner of the LinkedListSet that may contain this LinkedListSetEntry.

flagJobToWait

public void flagJobToWait()

Description copied from interface: ContainerContext

Flags for the JobNode to wait and be activated at a later time once a dependency is ready.

Specified by:

flagJobToWait in interface ContainerContext

addSetupTask

public void addSetupTask(TaskMetaData<?,?,?> taskMetaData,
                         Object parameter)

Description copied from interface: ContainerContext

Adds a setup Task to be executed before the current JobNode.

This is available to ManagedObject and Duty setup. Note that if it is added during Task execution it will be executed after the Task.

Specified by:

addSetupTask in interface ContainerContext

Parameters:

taskMetaData - TaskMetaData for the setup Task.

parameter - Parameter for the Task.

addGovernanceActivity

public void addGovernanceActivity(GovernanceActivity<?,?> activity)

Description copied from interface: ContainerContext

Adds a GovernanceActivity to be executed before the current JobNode.

This is available to ManagedObject and Duty setup. Note that if it is added during Task execution it will be executed after the Task.

Specified by:

addGovernanceActivity in interface ContainerContext

Parameters:

activity - GovernanceActivity.

setNextJob

public final void setNextJob(Job task)

Description copied from interface: Job

Specifies the next Job. This provides ability to create a linked list of Job instances.

Note there is no thread-safety guaranteed on this method.

Specified by:

setNextJob in interface Job

Parameters:

task - Job that is next in the list to this Job.

See Also:

Job.getNextJob()

getNextJob

public final Job getNextJob()

Description copied from interface: Job

Obtains the next Job. This provides ability to create a linked list of Job instances.

Note there is no thread-safety guaranteed on this method.

Specified by:

getNextJob in interface Job

Returns:

Next Job after this in the list.

See Also:

Job.setNextJob(Job)

getProcessIdentifier

public Object getProcessIdentifier()

Description copied from interface: Job

Obtains the identifier for the ProcessState containing this Job.

This allows the Team executing the Job to be aware of the ProcessState context in which the Job is to be executed.

An example use would be embedding OfficeFloor within an Application Server and using this identifier and a ProcessContextListener to know the invoking Thread for interaction with JNDI.

Specified by:

getProcessIdentifier in interface Job

Returns:

Identifier for the ProcessState containing this Job

See Also:

ProcessContextListener

cancelJob

public void cancelJob(Exception cause)

Description copied from interface: Job

Triggers to cancel the Job.

Specified by:

cancelJob in interface Job

Parameters:

cause - Cause providing reason for cancelling the Job.s

doJob

public final boolean doJob(JobContext jobContext)

Description copied from interface: Job

Executes the Job.

The return indicates if the Job has been completed and may be released. Returning false indicates this method must be executed again (and possibly again and again) until it returns true.

Specified by:

doJob in interface Job

Parameters:

jobContext - Context for execution.

Returns:

true if the Job has completed.

setJobComplete

public final void setJobComplete(boolean isComplete)

Description copied from interface: JobExecuteContext

Specifies whether the job is complete.

Specified by:

setJobComplete in interface JobExecuteContext

Parameters:

isComplete - true if complete.

joinFlow

public final void joinFlow(FlowFuture flowFuture,
                           long timeout,
                           Object token)

Description copied from interface: JobExecuteContext

Joins on the JobSequence for the FlowFuture.

Specified by:

joinFlow in interface JobExecuteContext

Parameters:

flowFuture - FlowFuture of the JobSequence to join.

timeout - Timeout in milliseconds for the JobSequence join.

token - JobSequence join token.

doFlow

public final FlowFuture doFlow(FlowMetaData<?> flowMetaData,
                               Object parameter)

Description copied from interface: JobExecuteContext

Invokes the JobSequence for the input FlowMetaData.

Specified by:

doFlow in interface JobExecuteContext

Parameters:

flowMetaData - FlowMetaData.

parameter - Parameter for the JobSequence.

Returns:

FlowFuture of the JobSequence.

activateJob

public final void activateJob(TeamIdentifier currentTeam)

Description copied from interface: JobNode

Activates the Job for this JobNode.

Specified by:

activateJob in interface JobNode

Parameters:

currentTeam - Current TeamIdentifier that is activating the JobNode. This enables continuing execution with the current Thread should it be the same Team.

isJobNodeComplete

public boolean isJobNodeComplete()

Description copied from interface: JobNode

Indicates if this JobNode is completed.

Specified by:

isJobNodeComplete in interface JobNode

Returns:

true if this JobNode is completed.

getJobSequence

public JobSequence getJobSequence()

Description copied from interface: JobNode

Obtains the JobSequence containing this JobNode. The returned JobSequence provides access to the ThreadState and subsequent ProcessState that this JobNode is involved in.

Specified by:

getJobSequence in interface JobNode

Returns:

JobSequence containing this JobNode.

getEscalationProcedure

public EscalationProcedure getEscalationProcedure()

Description copied from interface: JobNode

Obtains the EscalationProcedure for this JobNode.

Specified by:

getEscalationProcedure in interface JobNode

Returns:

EscalationProcedure for this JobNode.

setParallelOwner

public final void setParallelOwner(JobNode jobNode)

Description copied from interface: JobNode

Specifies the parallel owner of this JobNode.

The input JobNode is executed once the current JobSequence that this JobNode is involved with is complete.

Specified by:

setParallelOwner in interface JobNode

Parameters:

jobNode - Parallel owner of this JobNode.

getParallelOwner

public final JobNode getParallelOwner()

Description copied from interface: JobNode

Obtains the parallel owner of this JobNode.

Specified by:

getParallelOwner in interface JobNode

Returns:

Parallel owner of this JobNode.

setParallelNode

public final void setParallelNode(JobNode jobNode)

Description copied from interface: JobNode

Specifies the parallel JobNode to the current JobNode. The current JobNode will not complete until the input parallel JobNode is complete.

Specified by:

setParallelNode in interface JobNode

Parameters:

jobNode - Parallel JobNode.

getParallelNode

public final JobNode getParallelNode()

Description copied from interface: JobNode

Obtains the parallel JobNode to the current JobNode.

Specified by:

getParallelNode in interface JobNode

Returns:

Parallel JobNode to the current JobNode.

setNextNode

public final void setNextNode(JobNode jobNode)

Description copied from interface: JobNode

Specifies the next JobNode in the JobSequence to execute after the current JobNode is completed.

Specified by:

setNextNode in interface JobNode

Parameters:

jobNode - Next JobNode.

getNextNode

public final JobNode getNextNode()

Description copied from interface: JobNode

Obtains the next JobNode in the JobSequence to execute after the current JobNode has completed.

Specified by:

getNextNode in interface JobNode

Returns:

Next JobNode.

clearNodes

public final void clearNodes(JobNodeActivateSet activateSet,
                             TeamIdentifier currentTeam)

Description copied from interface: JobNode

Clears the JobNode instances linked to this JobNode.

Specified by:

clearNodes in interface JobNode

Parameters:

activateSet - JobNodeActivateSet.

currentTeam - TeamIdentifier of the current Team clearing the JobNode instances.