org.apache.oozie.command

Class SubmitTransitionXCommand

java.lang.Object

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

org.apache.oozie.command.TransitionXCommand<java.lang.String>

org.apache.oozie.command.SubmitTransitionXCommand

All Implemented Interfaces:

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

Direct Known Subclasses:

BundleSubmitXCommand, CoordSubmitXCommand

public abstract class SubmitTransitionXCommand
extends TransitionXCommand<java.lang.String>

Base class for submit transition command. The derived class has to override these following functions:

loadState() : load the job's and/or actions' state submit() : submit the job notifyParent() : update the status to upstream if any

Field Summary

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

insertList, job, updateList

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
SubmitTransitionXCommand(java.lang.String name, java.lang.String type, int priority) The constructor for abstract class SubmitTransitionXCommand
SubmitTransitionXCommand(java.lang.String name, java.lang.String type, int priority, boolean dryrun) The constructor for abstract class SubmitTransitionXCommand

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	execute() Command execution body.
protected abstract java.lang.String	submit() Submit the job
void	transitToNext() Transit to the next status based on the result of the Job.

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

generateEvents, getJob, notifyParent, performWrites, setJob, updateJob

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

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

SubmitTransitionXCommand

public SubmitTransitionXCommand(java.lang.String name,
                        java.lang.String type,
                        int priority)

The constructor for abstract class SubmitTransitionXCommand

Parameters:

name - the command name

type - the command type

priority - the command priority

SubmitTransitionXCommand

public SubmitTransitionXCommand(java.lang.String name,
                        java.lang.String type,
                        int priority,
                        boolean dryrun)

The constructor for abstract class SubmitTransitionXCommand

Parameters:

name - the command name

type - the command type

priority - the command priority

dryrun - true if dryrun is enable

Method Detail

submit

protected abstract java.lang.String submit()
                                    throws CommandException

Submit the job

Returns:

the id

Throws:

CommandException - thrown if unable to submit

transitToNext

public void transitToNext()

Description copied from class: TransitionXCommand

Transit to the next status based on the result of the Job.

Specified by:

transitToNext in class TransitionXCommand<java.lang.String>

execute

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

Overrides:

execute in class TransitionXCommand<java.lang.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.