org.apache.oozie.command.wf

Class ActionStartXCommand

java.lang.Object

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

org.apache.oozie.command.wf.WorkflowXCommand<T>

org.apache.oozie.command.wf.ActionXCommand<ActionXCommand.ActionExecutorContext>

org.apache.oozie.command.wf.ActionStartXCommand

All Implemented Interfaces:

Callable<ActionXCommand.ActionExecutorContext>, XCallable<ActionXCommand.ActionExecutorContext>

Direct Known Subclasses:

ForkedActionStartXCommand

public class ActionStartXCommand
extends ActionXCommand<ActionXCommand.ActionExecutorContext>

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.oozie.command.wf.ActionXCommand

ActionXCommand.ActionExecutorContext, ActionXCommand.ForkedActionExecutorContext

Field Summary

Fields

Modifier and Type	Field and Description
protected String	actionId
protected ActionXCommand.ActionExecutorContext	context
static String	COULD_NOT_START
static String	EL_ERROR
static String	EL_EVAL_ERROR
static String	EXEC_DATA_MISSING
static String	START_DATA_MISSING
protected WorkflowActionBean	wfAction
protected WorkflowJobBean	wfJob

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

RECOVERY_ID_SEPARATOR

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

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

DEFAULT_LOCK_TIMEOUT, DEFAULT_REQUEUE_DELAY, dryrun, eventService, instrumentation, LOG

Constructor Summary

Constructors

Constructor and Description
ActionStartXCommand(String actionId, String type)
ActionStartXCommand(WorkflowJobBean job, String actionId, String type)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	callActionEnd()
protected void	endWF()
protected ActionXCommand.ActionExecutorContext	execute() Command execution body.
protected ActionXCommand.ActionExecutorContext	getContext(boolean isRetry, boolean isUserRetry) Get action executor context
String	getEntityKey() Return the entity key for the command.
String	getKey() Get command key
protected void	handleError(ActionXCommand.ActionExecutorContext context, WorkflowJobBean workflow, WorkflowActionBean action)
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	queue(XCommand<?> command, long msDelay) Queue a command for delayed execution after the current command execution completes.
protected void	queueCommandForTransientFailure(long retryDelayMillis)
protected void	setLogInfo() Set the thread local logInfo with the context of this command and reset log prefix.
protected void	updateJobLastModified()
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.ActionXCommand

addActionCron, failJob, failJob, handleError, handleNonTransient, handleTransient, handleUserRetry, incrActionCounter

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, eagerLoadState, eagerVerifyPrecondition, executeInterrupts, getCreatedTime, getInstrumentation, getLockTimeOut, getLog, getName, getPriority, getRequeueDelay, getType, inInterruptMode, isReQueueRequired, queue, resetUsed, setInterruptMode, toString

Methods inherited from class java.lang.Object

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

Field Detail

EL_ERROR

public static final String EL_ERROR

See Also:

Constant Field Values

EL_EVAL_ERROR

public static final String EL_EVAL_ERROR

See Also:

Constant Field Values

COULD_NOT_START

public static final String COULD_NOT_START

See Also:

Constant Field Values

START_DATA_MISSING

public static final String START_DATA_MISSING

See Also:

Constant Field Values

EXEC_DATA_MISSING

public static final String EXEC_DATA_MISSING

See Also:

Constant Field Values

actionId

protected String actionId

wfJob

protected WorkflowJobBean wfJob

wfAction

protected WorkflowActionBean wfAction

context

protected ActionXCommand.ActionExecutorContext context

Constructor Detail

ActionStartXCommand

public ActionStartXCommand(String actionId,
                   String type)

ActionStartXCommand

public ActionStartXCommand(WorkflowJobBean job,
                   String actionId,
                   String type)

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<ActionXCommand.ActionExecutorContext>

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<ActionXCommand.ActionExecutorContext>

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<ActionXCommand.ActionExecutorContext>

Specified by:

getEntityKey in class XCommand<ActionXCommand.ActionExecutorContext>

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<ActionXCommand.ActionExecutorContext>

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<ActionXCommand.ActionExecutorContext>

Throws:

CommandException - thrown if the precondition is not met.

PreconditionException

execute

protected ActionXCommand.ActionExecutorContext 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<ActionXCommand.ActionExecutorContext>

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.

callActionEnd

protected void callActionEnd()
                      throws CommandException

Throws:

CommandException

getContext

protected ActionXCommand.ActionExecutorContext getContext(boolean isRetry,
                                              boolean isUserRetry)

Get action executor context

Parameters:

isRetry -

isUserRetry -

Returns:

updateJobLastModified

protected void updateJobLastModified()

endWF

protected void endWF()
              throws CommandException

Throws:

CommandException

handleError

protected void handleError(ActionXCommand.ActionExecutorContext context,
               WorkflowJobBean workflow,
               WorkflowActionBean action)
                    throws CommandException

Throws:

CommandException

getKey

public String getKey()

Description copied from class: XCommand

Get command key

Specified by:

getKey in interface XCallable<ActionXCommand.ActionExecutorContext>

Overrides:

getKey in class XCommand<ActionXCommand.ActionExecutorContext>

Returns:

command key

queueCommandForTransientFailure

protected void queueCommandForTransientFailure(long retryDelayMillis)

Overrides:

queueCommandForTransientFailure in class ActionXCommand<ActionXCommand.ActionExecutorContext>

queue

protected void queue(XCommand<?> command,
         long msDelay)

Description copied from class: XCommand

Queue a command for delayed execution after the current command execution completes.

All commands queued during the execution of the current command with the same delay will be queued for a single serial execution.

If the command execution throws an exception, no command will be effectively queued.

Overrides:

queue in class XCommand<ActionXCommand.ActionExecutorContext>

Parameters:

command - command to queue.

msDelay - delay in milliseconds.