This project has retired. For details please refer to its Attic page.

org.apache.oozie.command.wf
Class WfEndXCommand

java.lang.Object
  org.apache.oozie.command.XCommand<T>
      org.apache.oozie.command.wf.WorkflowXCommand<Void>
          org.apache.oozie.command.wf.WfEndXCommand

All Implemented Interfaces:

Callable<Void>, XCallable<Void>

public class WfEndXCommand
extends WorkflowXCommand<Void>

This Command is expected to be called when a Workflow moves to any terminal state ( such as SUCCEEDED, KILLED, FAILED). This class primarily removes the temporary directory created for specific workflow id

Field Summary

Fields inherited from class org.apache.oozie.command.XCommand

DEFAULT_LOCK_TIMEOUT, DEFAULT_REQUEUE_DELAY, dryrun, instrumentation, INSTRUMENTATION_GROUP, LOG, logInfo

Constructor Summary

WfEndXCommand(org.apache.oozie.client.WorkflowJob job)

Method Summary

protected Void	execute() Command execution body.
protected org.apache.hadoop.fs.FileSystem	getAppFileSystem(org.apache.oozie.client.WorkflowJob workflow)
protected String	getEntityKey() Return the entity key for the command.
protected boolean	isLockRequired() Indicate if the the command requires locking.
protected void	loadState() Load the necessary state to perform the precondition check and to execute the command.
protected void	verifyPrecondition() Verify the precondition for the command after a lock has been obtain, just before executing the command.

Methods inherited from class org.apache.oozie.command.XCommand

call, eagerLoadState, eagerVerifyPrecondition, getCreatedTime, getInstrumentation, getKey, getLockTimeOut, getLog, getName, getPriority, getRequeueDelay, getType, isReQueueRequired, queue, queue, resetUsed

Methods inherited from class java.lang.Object

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

Constructor Detail

WfEndXCommand

public WfEndXCommand(org.apache.oozie.client.WorkflowJob job)

Method Detail

execute

protected Void execute()
                throws CommandException

Description copied from class: XCommand

Command execution body.

This method will be invoked after the {link #loadState} and {link #verifyPrecondition} methods.

If the command requires locking, this method will be invoked ONLY if the lock has been acquired.

Specified by:

execute in class XCommand<Void>

Returns:

a return value from the execution of the command, only meaningful if the command is executed synchronously.

Throws:

CommandException - thrown if the command execution failed.

getAppFileSystem

protected org.apache.hadoop.fs.FileSystem getAppFileSystem(org.apache.oozie.client.WorkflowJob workflow)
                                                    throws HadoopAccessorException,
                                                           IOException,
                                                           URISyntaxException

Throws:

HadoopAccessorException

IOException

URISyntaxException

getEntityKey

protected String getEntityKey()

Description copied from class: XCommand

Return the entity key for the command.

Specified by:

getEntityKey in class XCommand<Void>

Returns:

the entity key for the command.

isLockRequired

protected boolean isLockRequired()

Description copied from class: XCommand

Indicate if the the command requires locking.

Subclasses should override this method if they require locking.

Specified by:

isLockRequired in class XCommand<Void>

Returns:

true/false

loadState

protected void loadState()
                  throws CommandException

Description copied from class: XCommand

Load the necessary state to perform the precondition check and to execute the command.

Subclasses must implement this method and load the state needed to do the precondition check and execute the command.

Specified by:

loadState in class XCommand<Void>

Throws:

CommandException

verifyPrecondition

protected void verifyPrecondition()
                           throws CommandException,
                                  PreconditionException

Description copied from class: XCommand

Verify the precondition for the command after a lock has been obtain, just before executing the command.

Specified by:

verifyPrecondition in class XCommand<Void>

Throws:

CommandException - thrown if the precondition is not met.

PreconditionException