org.apache.oozie.command.coord

Class CoordActionsKillXCommand

java.lang.Object

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

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

org.apache.oozie.command.KillTransitionXCommand<CoordinatorActionInfo>

org.apache.oozie.command.coord.CoordActionsKillXCommand

All Implemented Interfaces:

Callable<CoordinatorActionInfo>, XCallable<CoordinatorActionInfo>

public class CoordActionsKillXCommand
extends KillTransitionXCommand<CoordinatorActionInfo>

Kill coordinator actions by a range of dates (nominal time) or action number.

The "range" can be set with RestConstants.JOB_COORD_SCOPE_DATE or RestConstants.JOB_COORD_SCOPE_ACTION.

Field Summary

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

ret

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
CoordActionsKillXCommand(String id, String rangeType, String scope)

Method Summary

Methods

Modifier and Type	Method and Description
String	getEntityKey() Return the entity key for the command.
protected boolean	isLockRequired() Indicate if the the command requires locking.
void	killChildren()
protected 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	performWrites() This will be used to perform atomically all the writes within this command.
void	transitToNext() Transit to the next status based on the result of the Job.
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.KillTransitionXCommand

execute

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

generateEvents, getJob, setJob

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CoordActionsKillXCommand

public CoordActionsKillXCommand(String id,
                        String rangeType,
                        String scope)

Method Detail

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<CoordinatorActionInfo>

Returns:

true/false

getEntityKey

public String getEntityKey()

Description copied from class: XCommand

Return the entity key for the command.

Specified by:

getEntityKey in interface XCallable<CoordinatorActionInfo>

Specified by:

getEntityKey in class XCommand<CoordinatorActionInfo>

Returns:

the entity key for the command.

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<CoordinatorActionInfo>

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<CoordinatorActionInfo>

Throws:

CommandException - thrown if the precondition is not met.

PreconditionException

transitToNext

public void transitToNext()

Description copied from class: TransitionXCommand

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

Overrides:

transitToNext in class KillTransitionXCommand<CoordinatorActionInfo>

killChildren

public void killChildren()
                  throws CommandException

Specified by:

killChildren in class KillTransitionXCommand<CoordinatorActionInfo>

Throws:

CommandException

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<CoordinatorActionInfo>

Throws:

CommandException

updateJob

public void updateJob()
               throws CommandException

Description copied from class: TransitionXCommand

Update the parent job.

Specified by:

updateJob in class TransitionXCommand<CoordinatorActionInfo>

Throws:

CommandException

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<CoordinatorActionInfo>

Throws:

CommandException