org.apache.oozie.command
Class StartTransitionXCommand

java.lang.Object
  extended by org.apache.oozie.command.XCommand<T>
      extended by org.apache.oozie.command.TransitionXCommand<Void>
          extended by org.apache.oozie.command.StartTransitionXCommand
All Implemented Interfaces:
Callable<Void>, XCallable<Void>
Direct Known Subclasses:
BundleStartXCommand

public abstract class StartTransitionXCommand
extends TransitionXCommand<Void>

Transition command for start the job. The derived class has to override these following functions:

loadState() : load the job's and/or actions' state updateJob() : update job status and attributes StartChildren() : submit or queue commands to start children 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, logInfo
 
Constructor Summary
StartTransitionXCommand(String name, String type, int priority)
          The constructor for abstract class StartTransitionXCommand
StartTransitionXCommand(String name, String type, int priority, boolean dryrun)
          The constructor for abstract class StartTransitionXCommand
 
Method Summary
protected  Void execute()
          Command execution body.
abstract  void StartChildren()
          Start actions associated with 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, eagerLoadState, eagerVerifyPrecondition, executeInterrupts, getCreatedTime, getEntityKey, getInstrumentation, getKey, getLockTimeOut, getLog, getName, getPriority, getRequeueDelay, getType, inInterruptMode, isLockRequired, isReQueueRequired, loadState, queue, queue, resetUsed, setInterruptMode, verifyPrecondition
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StartTransitionXCommand

public StartTransitionXCommand(String name,
                               String type,
                               int priority)
The constructor for abstract class StartTransitionXCommand

Parameters:
name - the command name
type - the command type
priority - the command priority

StartTransitionXCommand

public StartTransitionXCommand(String name,
                               String type,
                               int priority,
                               boolean dryrun)
The constructor for abstract class StartTransitionXCommand

Parameters:
name - the command name
type - the command type
priority - the command priority
dryrun - true if dryrun is enable
Method Detail

StartChildren

public abstract void StartChildren()
                            throws CommandException
Start actions associated with the job

Throws:
CommandException - thrown if failed to start actions

transitToNext

public final 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<Void>

execute

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

Overrides:
execute in class TransitionXCommand<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.


Copyright © 2013 Apache Software Foundation. All Rights Reserved.