org.apache.oozie.command.coord

Class CoordStatusTransitXCommand

java.lang.Object

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

org.apache.oozie.command.StatusTransitXCommand

org.apache.oozie.command.coord.CoordStatusTransitXCommand

All Implemented Interfaces:

java.util.concurrent.Callable<java.lang.Void>, XCallable<java.lang.Void>

public class CoordStatusTransitXCommand
extends StatusTransitXCommand

CoordStatusTransitXCommand update coord job's status according to its child actions' status. If all child actions' pending flag equals 0 (job done), we reset the job's pending flag to 0. If all child actions are succeeded, we set the job's status to SUCCEEDED.

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
CoordStatusTransitXCommand(java.lang.String jobId)

Method Summary

Methods

Modifier and Type	Method and Description
protected org.apache.oozie.client.Job.Status	getBottomUpSuspendedState() Bottom up look for children to check the parent's status only if materialization is done and all actions are non-pending.
java.lang.String	getEntityKey() Return the entity key for the command.
protected org.apache.oozie.client.Job.Status	getJobStatus() Gets the job status.
protected org.apache.oozie.client.Job.Status	getPausedState() Gets the job pause state.
protected org.apache.oozie.client.Job.Status	getRunningState() Gets the job running state.
protected org.apache.oozie.client.Job.Status	getSuspendedStatus() Gets the suspended status.
protected org.apache.oozie.client.Job.Status	getTerminalStatus() Gets the job terminal status.
protected boolean	isPausedState() Checks if job is in paused state.
protected boolean	isRunningState() Checks if job is in running state.
protected boolean	isSuspendedState() Checks if is in suspended state.
protected boolean	isTerminalState() Checks if job is in terminal state.
protected void	loadState() Load the necessary state to perform the precondition check and to execute the command.
protected void	updateJobStatus(org.apache.oozie.client.Job.Status coordStatus) Update job status.
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.StatusTransitXCommand

execute, getLockTimeOut, isLockRequired, isReQueueRequired

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

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

CoordStatusTransitXCommand

public CoordStatusTransitXCommand(java.lang.String jobId)

Method Detail

getEntityKey

public java.lang.String getEntityKey()

Description copied from class: XCommand

Return the entity key for the command.

Specified by:

getEntityKey in interface XCallable<java.lang.Void>

Specified by:

getEntityKey in class XCommand<java.lang.Void>

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<java.lang.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<java.lang.Void>

Throws:

CommandException - thrown if the precondition is not met.

PreconditionException

getJobStatus

protected org.apache.oozie.client.Job.Status getJobStatus()
                                                   throws CommandException

Description copied from class: StatusTransitXCommand

Gets the job status.

Overrides:

getJobStatus in class StatusTransitXCommand

Returns:

the job status

Throws:

CommandException - the command exception

isTerminalState

protected boolean isTerminalState()

Description copied from class: StatusTransitXCommand

Checks if job is in terminal state.

Specified by:

isTerminalState in class StatusTransitXCommand

Returns:

true, if is terminal state

getTerminalStatus

protected org.apache.oozie.client.Job.Status getTerminalStatus()

Description copied from class: StatusTransitXCommand

Gets the job terminal status.

Specified by:

getTerminalStatus in class StatusTransitXCommand

Returns:

the terminal status

isPausedState

protected boolean isPausedState()

Description copied from class: StatusTransitXCommand

Checks if job is in paused state.

Specified by:

isPausedState in class StatusTransitXCommand

Returns:

true, if job is in paused state

getPausedState

protected org.apache.oozie.client.Job.Status getPausedState()

Description copied from class: StatusTransitXCommand

Gets the job pause state.

Specified by:

getPausedState in class StatusTransitXCommand

Returns:

the paused state

isSuspendedState

protected boolean isSuspendedState()

Description copied from class: StatusTransitXCommand

Checks if is in suspended state.

Specified by:

isSuspendedState in class StatusTransitXCommand

Returns:

true, if job is in suspended state

getSuspendedStatus

protected org.apache.oozie.client.Job.Status getSuspendedStatus()

Description copied from class: StatusTransitXCommand

Gets the suspended status.

Specified by:

getSuspendedStatus in class StatusTransitXCommand

Returns:

the suspended status

isRunningState

protected boolean isRunningState()

Description copied from class: StatusTransitXCommand

Checks if job is in running state.

Specified by:

isRunningState in class StatusTransitXCommand

Returns:

true, if job is in running state

getRunningState

protected org.apache.oozie.client.Job.Status getRunningState()

Description copied from class: StatusTransitXCommand

Gets the job running state.

Specified by:

getRunningState in class StatusTransitXCommand

Returns:

the running state

updateJobStatus

protected void updateJobStatus(org.apache.oozie.client.Job.Status coordStatus)
                        throws JPAExecutorException,
                               CommandException

Description copied from class: StatusTransitXCommand

Update job status.

Specified by:

updateJobStatus in class StatusTransitXCommand

Parameters:

coordStatus - the status

Throws:

JPAExecutorException - the JPA executor exception

CommandException - the command exception

getBottomUpSuspendedState

protected org.apache.oozie.client.Job.Status getBottomUpSuspendedState()

Bottom up look for children to check the parent's status only if materialization is done and all actions are non-pending.

Returns:

the bottom up suspended state