org.apache.oozie.command

Class PauseTransitionXCommand

java.lang.Object

org.apache.oozie.command.XCommand<T>

org.apache.oozie.command.TransitionXCommand<Void>

org.apache.oozie.command.PauseTransitionXCommand

All Implemented Interfaces:

Callable<Void>, XCallable<Void>

Direct Known Subclasses:

BundlePauseXCommand, CoordPauseXCommand

public abstract class PauseTransitionXCommand
extends TransitionXCommand<Void>

Transition command for pause the job. The derived class has to override these following functions:

updateJob() : update job status and attributes pauseChildren() : submit or queue commands to pause children notifyParent() : update the status to upstream if any

Field Summary

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

insertList, job, updateList

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

DEFAULT_LOCK_TIMEOUT, DEFAULT_REQUEUE_DELAY, dryrun, eventService, instrumentation, INSTRUMENTATION_GROUP, LOG

Constructor Summary

Constructors

Constructor and Description
PauseTransitionXCommand(String name, String type, int priority) The constructor for abstract class PauseTransitionXCommand

Method Summary

Methods

Modifier and Type	Method and Description
protected Void	execute() Command execution body.
abstract void	pauseChildren() pause actions associated with the job
void	transitToNext() Transit to the next status based on the result of the Job.

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

generateEvents, getJob, notifyParent, performWrites, setJob, updateJob

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

call, eagerLoadState, eagerVerifyPrecondition, executeInterrupts, getCreatedTime, getEntityKey, getInstrumentation, getKey, getLockTimeOut, getLog, getName, getPriority, getRequeueDelay, getType, inInterruptMode, isLockRequired, isReQueueRequired, loadState, queue, queue, resetUsed, setInterruptMode, setLogInfo, toString, verifyPrecondition

Methods inherited from class java.lang.Object

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

Constructor Detail

PauseTransitionXCommand

public PauseTransitionXCommand(String name,
                       String type,
                       int priority)

The constructor for abstract class PauseTransitionXCommand

Parameters:

name - the command name

type - the command type

priority - the command priority

Method Detail

pauseChildren

public abstract void pauseChildren()
                            throws CommandException

pause actions associated with the job

Throws:

CommandException - thrown if failed to pause actions

transitToNext

public final void transitToNext()
                         throws CommandException

Description copied from class: TransitionXCommand

Transit to the next status based on the result of the Job.

Specified by:

transitToNext in class TransitionXCommand<Void>

Throws:

CommandException

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.

Overrides:

execute in class TransitionXCommand<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.