net.officefloor.frame.impl.execute.asset

Class AssetMonitorImpl

java.lang.Object

net.officefloor.frame.impl.execute.linkedlistset.AbstractLinkedListSetEntry<AssetMonitor,AssetManager>

net.officefloor.frame.impl.execute.asset.AssetMonitorImpl

All Implemented Interfaces:

AssetMonitor, LinkedListSetEntry<AssetMonitor,AssetManager>

public class AssetMonitorImpl
extends AbstractLinkedListSetEntry<AssetMonitor,AssetManager>
implements AssetMonitor

Implementation of the AssetMonitor.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
AssetMonitorImpl(Asset asset, AssetManager assetManager) Initiate.

Method Summary

Modifier and Type	Method and Description
void	activateJobNodes(JobNodeActivateSet activateSet, boolean isPermanent) Adds all the JobNode instances waiting on the Asset to the input JobNodeActivateSet to be activated.
void	failJobNodes(JobNodeActivateSet activateSet, Throwable failure, boolean isPermanent) Adds all the JobNode instances waiting on this Asset to the input JobNodeActivateSet to be activated with the ThreadState receiving the input failure.
Asset	getAsset() Obtains the Asset for this AssetMonitor.
AssetManager	getLinkedListSetOwner() Obtains the owner of the LinkedListSet that this LinkedListSetEntry may be added.
boolean	waitOnAsset(JobNode jobNode, JobNodeActivateSet activateSet) Flags for the JobNode (and more specifically the ThreadState of the JobNode) to wait until the Asset activates it.

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

Constructor Detail

AssetMonitorImpl

public AssetMonitorImpl(Asset asset,
                        AssetManager assetManager)

Initiate.

Parameters:

asset - Asset to be managed.

assetManager - AssetManager for managing this.

Method Detail

getLinkedListSetOwner

public AssetManager 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<AssetMonitor,AssetManager>

Returns:

Owner of the LinkedListSet that may contain this LinkedListSetEntry.

getAsset

public Asset getAsset()

Description copied from interface: AssetMonitor

Obtains the Asset for this AssetMonitor.

Specified by:

getAsset in interface AssetMonitor

Returns:

Asset for this AssetMonitor.

waitOnAsset

public boolean waitOnAsset(JobNode jobNode,
                           JobNodeActivateSet activateSet)

Description copied from interface: AssetMonitor

Flags for the JobNode (and more specifically the ThreadState of the JobNode) to wait until the Asset activates it.

This is typically because the Asset is doing some processing that the JobNode requires completed before proceeding.

Specified by:

waitOnAsset in interface AssetMonitor

Parameters:

jobNode - JobNode to be activated when Asset processing is complete.

activateSet - JobNodeActivateSet that the JobNode is added to if the Asset has permanently activated this AssetMonitor. This may be null to activate via the OfficeManager however it is much more efficient to provide a JobNodeActivateSet.

Returns:

true if the JobNode is waiting on the Asset.

activateJobNodes

public void activateJobNodes(JobNodeActivateSet activateSet,
                             boolean isPermanent)

Description copied from interface: AssetMonitor

Adds all the JobNode instances waiting on the Asset to the input JobNodeActivateSet to be activated.

Specified by:

activateJobNodes in interface AssetMonitor

Parameters:

activateSet - JobNodeActivateSet that will later activate the JobNode instances waiting on the Asset. This may be null to activate via the OfficeManager however it is much more efficient to provide a JobNodeActivateSet.

isPermanent - true indicates that all JobNode instances added to the AssetMonitor from now on are activated immediately. It is useful to flag an AssetMonitor in this state when the Asset is no longer being used to stop a JobNode from waiting forever.

failJobNodes

public void failJobNodes(JobNodeActivateSet activateSet,
                         Throwable failure,
                         boolean isPermanent)

Description copied from interface: AssetMonitor

Adds all the JobNode instances waiting on this Asset to the input JobNodeActivateSet to be activated with the ThreadState receiving the input failure.

Specified by:

failJobNodes in interface AssetMonitor

Parameters:

activateSet - JobNodeActivateSet that will later activate the JobNode instances waiting on the Asset. This may be null to activate via the OfficeManager however it is much more efficient to provide a JobNodeActivateSet.

failure - Failure to propagate to the ThreadState of the JobNode instances waiting on the Asset.

isPermanent - true indicates that all JobNode instances added to the AssetMonitor from now on are activated immediately with the input failure. It is useful to flag an AssetMonitor in this state when the Asset is in a failed state that can not be recovered from.