net.officefloor.frame.internal.structure

Interface CleanupSequence

All Known Implementing Classes:

CleanupSequenceImpl

public interface CleanupSequence

Sequence of JobNode instances to undertake clean-up.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
CleanupEscalation[]	getCleanupEscalations() Obtains the registered CleanupEscalation instances.
void	registerCleanupEscalation(Class<?> objectType, Throwable escalation) Registers a Throwable from attempting to cleanup the ManagedObject of the object type.
void	registerCleanUpJob(JobNode cleanupJob, TeamIdentifier teamIdentifier) Registers the JobNode that undertakes clean-up.

Method Detail

registerCleanUpJob

void registerCleanUpJob(JobNode cleanupJob,
                        TeamIdentifier teamIdentifier)

Registers the JobNode that undertakes clean-up.

JobNode instances are executed in the order they are registered.

Parameters:

cleanupJob - Clean up JobNode. Each JobNode is to be created within its own ProcessState. This is necessary as ProcessCompletionListener are registered to undertake the next clean up JobNode. Note: JobNode instances may invoke other JobNode instances for clean up, so the whole ProcessState must complete before the next JobNode may be started (typically because there may be dependencies between JobNode instances that must be respected in sequential clean up).

teamIdentifier - TeamIdentifier of the current Team executing.

getCleanupEscalations

CleanupEscalation[] getCleanupEscalations()

Obtains the registered CleanupEscalation instances.

Returns:

CleanupEscalation instances.

registerCleanupEscalation

void registerCleanupEscalation(Class<?> objectType,
                               Throwable escalation)

Registers a Throwable from attempting to cleanup the ManagedObject of the object type.

Parameters:

objectType - Object type of the ManagedObject.

escalation - Escalation.