org.apache.oozie.command.wf
Class SubmitXCommand

java.lang.Object
  org.apache.oozie.command.XCommand<T>
      org.apache.oozie.command.wf.WorkflowXCommand<String>
          org.apache.oozie.command.wf.SubmitXCommand

All Implemented Interfaces:

Callable<String>, XCallable<String>

public class SubmitXCommand
extends WorkflowXCommand<String>

Field Summary

static String

CONFIG_DEFAULT

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

DEFAULT_LOCK_TIMEOUT, DEFAULT_REQUEUE_DELAY, dryrun, instrumentation, INSTRUMENTATION_GROUP, LOG, logInfo

Constructor Summary

SubmitXCommand(boolean dryrun, org.apache.hadoop.conf.Configuration conf, String authToken)
Constructor to create the workflow Submit Command.

SubmitXCommand(org.apache.hadoop.conf.Configuration conf, String authToken)
Constructor to create the workflow Submit Command.

Method Summary

static ELEvaluator	createELEvaluatorForGroup(org.apache.hadoop.conf.Configuration conf, String group) Create an EL evaluator for a given group.
protected String	execute() Command execution body.
String	getEntityKey() Return the entity key for the command.
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.
static String	resolveSla(org.jdom.Element eSla, ELEvaluator evalSla) Resolve variables in sla xml element.
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.XCommand

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

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_DEFAULT

public static final String CONFIG_DEFAULT

See Also:

Constant Field Values

Constructor Detail

SubmitXCommand

public SubmitXCommand(org.apache.hadoop.conf.Configuration conf,
                      String authToken)

Constructor to create the workflow Submit Command.

Parameters:

conf - : Configuration for workflow job

authToken - : To be used for authentication

SubmitXCommand

public SubmitXCommand(boolean dryrun,
                      org.apache.hadoop.conf.Configuration conf,
                      String authToken)

Constructor to create the workflow Submit Command.

Parameters:

dryrun - : if dryrun

conf - : Configuration for workflow job

authToken - : To be used for authentication

Method Detail

execute

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

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.

resolveSla

public static String resolveSla(org.jdom.Element eSla,
                                ELEvaluator evalSla)
                         throws CommandException

Resolve variables in sla xml element.

Parameters:

eSla - sla xml element

evalSla - sla evaluator

Returns:

sla xml string after evaluation

Throws:

CommandException

createELEvaluatorForGroup

public static ELEvaluator createELEvaluatorForGroup(org.apache.hadoop.conf.Configuration conf,
                                                    String group)

Create an EL evaluator for a given group.

Parameters:

conf - configuration variable

group - group variable

Returns:

the evaluator created for the group

getEntityKey

public String getEntityKey()

Description copied from class: XCommand

Return the entity key for the command.

Specified by:

getEntityKey in interface XCallable<String>

Specified by:

getEntityKey in class XCommand<String>

Returns:

the entity key for the command.

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

Returns:

true/false

loadState

protected void loadState()

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

verifyPrecondition

protected void verifyPrecondition()
                           throws CommandException

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

Throws:

CommandException - thrown if the precondition is not met.