org.apache.oozie.command

Class StatusTransitXCommand

java.lang.Object

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

org.apache.oozie.command.StatusTransitXCommand

All Implemented Interfaces:

Callable<Void>, XCallable<Void>

Direct Known Subclasses:

BundleStatusTransitXCommand, CoordStatusTransitXCommand

public abstract class StatusTransitXCommand
extends XCommand<Void>

StatusTransitXCommand is super class for Status Transit Command, it defines layout for Status Transit Commands. It tries change job status change after acquiring lock with zero timeout. StatusTransit Commands are not requeued.

Field Summary

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
StatusTransitXCommand(String name, String type, int priority) Instantiates a new status transit x command.

Method Summary

Modifier and Type	Method and Description
protected Void	execute() Command execution body.
protected Job.Status	getJobStatus() Gets the job status.
protected long	getLockTimeOut() Return the time out when acquiring a lock.
protected abstract Job.Status	getPausedState() Gets the job pause state.
protected abstract Job.Status	getRunningState() Gets the job running state.
protected abstract Job.Status	getSuspendedStatus() Gets the suspended status.
protected abstract Job.Status	getTerminalStatus() Gets the job terminal status.
protected boolean	isLockRequired() Indicate if the the command requires locking.
protected abstract boolean	isPausedState() Checks if job is in paused state.
protected boolean	isReQueueRequired() Indicate if the the command requires to requeue itself if the lock is not acquired.
protected abstract boolean	isRunningState() Checks if job is in running state.
protected abstract boolean	isSuspendedState() Checks if is in suspended state.
protected abstract boolean	isTerminalState() Checks if job is in terminal state.
protected abstract void	updateJobStatus(Job.Status status) Update job status.

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

call, eagerLoadState, eagerVerifyPrecondition, executeInterrupts, getCreatedTime, getEntityKey, getInstrumentation, getKey, getLog, getName, getPriority, getRequeueDelay, getType, inInterruptMode, 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

StatusTransitXCommand

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

Instantiates a new status transit x command.

Parameters:

name - the name

type - the type

priority - the priority

Method Detail

getLockTimeOut

protected final long getLockTimeOut()

Description copied from class: XCommand

Return the time out when acquiring a lock.

The value is loaded from the Oozie configuration, the property {link #DEFAULT_LOCK_TIMEOUT}.

Subclasses should override this method if they want to use a different time out.

Overrides:

getLockTimeOut in class XCommand<Void>

Returns:

the lock time out in milliseconds.

isReQueueRequired

protected final boolean isReQueueRequired()

Description copied from class: XCommand

Indicate if the the command requires to requeue itself if the lock is not acquired.

Subclasses should override this method if they don't want to requeue.

Default is true.

Overrides:

isReQueueRequired in class XCommand<Void>

Returns:

true/false

isLockRequired

protected final 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

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.

getJobStatus

protected Job.Status getJobStatus()
                           throws CommandException

Gets the job status.

Returns:

the job status

Throws:

CommandException - the command exception

isTerminalState

protected abstract boolean isTerminalState()

Checks if job is in terminal state.

Returns:

true, if is terminal state

getTerminalStatus

protected abstract Job.Status getTerminalStatus()

Gets the job terminal status.

Returns:

the terminal status

isPausedState

protected abstract boolean isPausedState()

Checks if job is in paused state.

Returns:

true, if job is in paused state

getPausedState

protected abstract Job.Status getPausedState()

Gets the job pause state.

Returns:

the paused state

isSuspendedState

protected abstract boolean isSuspendedState()

Checks if is in suspended state.

Returns:

true, if job is in suspended state

getSuspendedStatus

protected abstract Job.Status getSuspendedStatus()

Gets the suspended status.

Returns:

the suspended status

isRunningState

protected abstract boolean isRunningState()

Checks if job is in running state.

Returns:

true, if job is in running state

getRunningState

protected abstract Job.Status getRunningState()

Gets the job running state.

Returns:

the running state

updateJobStatus

protected abstract void updateJobStatus(Job.Status status)
                                 throws JPAExecutorException,
                                        CommandException

Update job status.

Parameters:

status - the status

Throws:

JPAExecutorException - the JPA executor exception

CommandException - the command exception