org.apache.oozie.command.wf

Class SuspendXCommand

java.lang.Object

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

org.apache.oozie.command.wf.WorkflowXCommand<java.lang.Void>

org.apache.oozie.command.wf.SuspendXCommand

All Implemented Interfaces:

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

public class SuspendXCommand
extends WorkflowXCommand<java.lang.Void>

Field Summary

Fields inherited from class org.apache.oozie.command.wf.WorkflowXCommand

INSTR_FAILED_JOBS_COUNTER_NAME, INSTR_KILLED_JOBS_COUNTER_NAME, INSTR_SUCCEEDED_JOBS_COUNTER_NAME, KEEP_WF_ACTION_DIR

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
SuspendXCommand(java.lang.String id)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	eagerLoadState() Load the necessary state to perform an eager precondition check.
protected void	eagerVerifyPrecondition() Verify the precondition for the command before obtaining a lock.
protected java.lang.Void	execute() Command execution body.
java.lang.String	getEntityKey() Return the entity key for the command.
java.lang.String	getKey() Get command key
protected boolean	isLockRequired() Indicate if the the command requires locking.
protected void	loadState() Load the necessary state to perform the precondition check and to execute the command.
protected void	setLogInfo() Set the thread local logInfo with the context of this command and reset log prefix.
static void	suspendJob(JPAService jpaService, WorkflowJobBean workflow, java.lang.String id, java.lang.String actionId, java.util.List<BatchQueryExecutor.UpdateEntry> updateList) Suspend the workflow job and pending flag to false for the actions that are START_RETRY or START_MANUAL or END_RETRY or END_MANUAL
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.wf.WorkflowXCommand

generateEvent, generateEvent, generateEvent, updateParentIfNecessary, updateParentIfNecessary

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

call, call, executeInterrupts, getCreatedTime, getInstrumentation, 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

SuspendXCommand

public SuspendXCommand(java.lang.String id)

Method Detail

setLogInfo

protected void setLogInfo()

Description copied from class: XCommand

Set the thread local logInfo with the context of this command and reset log prefix.

Overrides:

setLogInfo in class XCommand<java.lang.Void>

execute

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

suspendJob

public static void suspendJob(JPAService jpaService,
              WorkflowJobBean workflow,
              java.lang.String id,
              java.lang.String actionId,
              java.util.List<BatchQueryExecutor.UpdateEntry> updateList)
                       throws WorkflowException,
                              CommandException

Suspend the workflow job and pending flag to false for the actions that are START_RETRY or START_MANUAL or END_RETRY or END_MANUAL

Parameters:

jpaService - jpa service

workflow - workflow job

id - workflow job id

actionId - workflow action id

Throws:

WorkflowException - thrown if failed to suspend workflow instance

CommandException - thrown if unable set pending false for actions

eagerLoadState

protected void eagerLoadState()
                       throws CommandException

Description copied from class: XCommand

Load the necessary state to perform an eager precondition check.

This implementation does a NOP.

Subclasses should override this method and load the state needed to do an eager precondition check.

A trivial implementation is calling {link #loadState}.

Overrides:

eagerLoadState in class XCommand<java.lang.Void>

Throws:

CommandException

eagerVerifyPrecondition

protected void eagerVerifyPrecondition()
                                throws CommandException,
                                       PreconditionException

Description copied from class: XCommand

Verify the precondition for the command before obtaining a lock.

This implementation does a NOP.

A trivial implementation is calling {link #verifyPrecondition}.

Overrides:

eagerVerifyPrecondition in class XCommand<java.lang.Void>

Throws:

CommandException - thrown if the precondition is not met.

PreconditionException

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.

getKey

public java.lang.String getKey()

Description copied from class: XCommand

Get command key

Specified by:

getKey in interface XCallable<java.lang.Void>

Overrides:

getKey in class XCommand<java.lang.Void>

Returns:

command key

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

Returns:

true/false

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