org.apache.oozie.command.coord

Class CoordPauseXCommand

java.lang.Object

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

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

org.apache.oozie.command.PauseTransitionXCommand

org.apache.oozie.command.coord.CoordPauseXCommand

All Implemented Interfaces:

Callable<Void>, XCallable<Void>

public class CoordPauseXCommand
extends PauseTransitionXCommand

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, logInfo

Constructor Summary

Constructors

Constructor and Description
CoordPauseXCommand(CoordinatorJobBean coordJob)

Method Summary

Methods

Modifier and Type	Method and Description
String	getEntityKey() Return the entity key for the command.
org.apache.oozie.client.Job	getJob() Get the Job for the command.
protected boolean	isLockRequired() Indicate if the the command requires locking.
void	loadState() Load the necessary state to perform the precondition check and to execute the command.
void	notifyParent() This will be used to notify the parent about the status of that perticular job.
void	pauseChildren() pause actions associated with the job
void	performWrites() This will be used to perform atomically all the writes within this command.
void	updateJob() Update the parent job.
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.PauseTransitionXCommand

execute, transitToNext

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

generateEvents, setJob

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CoordPauseXCommand

public CoordPauseXCommand(CoordinatorJobBean coordJob)

Method Detail

getEntityKey

public String getEntityKey()

Description copied from class: XCommand

Return the entity key for the command.

Specified by:

getEntityKey in interface XCallable<Void>

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

public 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

notifyParent

public void notifyParent()
                  throws CommandException

Description copied from class: TransitionXCommand

This will be used to notify the parent about the status of that perticular job.

Specified by:

notifyParent in class TransitionXCommand<Void>

Throws:

CommandException

getJob

public org.apache.oozie.client.Job getJob()

Description copied from class: TransitionXCommand

Get the Job for the command.

Overrides:

getJob in class TransitionXCommand<Void>

Returns:

the job

updateJob

public void updateJob()
               throws CommandException

Description copied from class: TransitionXCommand

Update the parent job.

Specified by:

updateJob in class TransitionXCommand<Void>

Throws:

CommandException

pauseChildren

public void pauseChildren()
                   throws CommandException

Description copied from class: PauseTransitionXCommand

pause actions associated with the job

Specified by:

pauseChildren in class PauseTransitionXCommand

Throws:

CommandException - thrown if failed to pause actions

performWrites

public void performWrites()
                   throws CommandException

Description copied from class: TransitionXCommand

This will be used to perform atomically all the writes within this command.

Specified by:

performWrites in class TransitionXCommand<Void>

Throws:

CommandException