This project has retired. For details please refer to its Attic page.

org.apache.oozie.command.bundle
Class BundleStartXCommand

java.lang.Object
  org.apache.oozie.command.XCommand<T>
      org.apache.oozie.command.TransitionXCommand<Void>
          org.apache.oozie.command.StartTransitionXCommand
              org.apache.oozie.command.bundle.BundleStartXCommand

All Implemented Interfaces:

Callable<Void>, XCallable<Void>

public class BundleStartXCommand
extends StartTransitionXCommand

The command to start Bundle job

Field Summary

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

job

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

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

Constructor Summary

BundleStartXCommand(String jobId)
The constructor for class BundleStartXCommand

BundleStartXCommand(String jobId, boolean dryrun)
The constructor for class BundleStartXCommand

Method Summary

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 String	getEntityKey() Return the entity key for the command.
org.apache.oozie.client.Job	getJob() Get the Job for the command.
protected boolean	isLockRequired() Indicate if the the command requires locking.
void	loadState() Load the necessary state to perform the precondition check and to execute the command.
void	notifyParent() This will be used to notify the parent about the status of that perticular job.
void	StartChildren() Start actions associated with the job
void	updateJob() Update the parent job.
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.StartTransitionXCommand

execute, transitToNext

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

setJob

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

call, getCreatedTime, getInstrumentation, getKey, getLockTimeOut, getLog, getName, getPriority, getRequeueDelay, getType, isReQueueRequired, queue, queue, resetUsed

Methods inherited from class java.lang.Object

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

Constructor Detail

BundleStartXCommand

public BundleStartXCommand(String jobId)

The constructor for class BundleStartXCommand

Parameters:

jobId - the bundle job id

BundleStartXCommand

public BundleStartXCommand(String jobId,
                           boolean dryrun)

The constructor for class BundleStartXCommand

Parameters:

jobId - the bundle job id

dryrun - true if dryrun is enable

Method Detail

getEntityKey

protected String getEntityKey()

Description copied from class: XCommand

Return the entity key for the command.

Specified by:

getEntityKey in class XCommand<Void>

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

Returns:

true/false

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

Throws:

CommandException - thrown if the precondition is not met.

PreconditionException

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

Throws:

CommandException - thrown if the precondition is not met.

PreconditionException

loadState

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

Throws:

CommandException

eagerLoadState

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

Throws:

CommandException

StartChildren

public void StartChildren()
                   throws CommandException

Description copied from class: StartTransitionXCommand

Start actions associated with the job

Specified by:

StartChildren in class StartTransitionXCommand

Throws:

CommandException - thrown if failed to start actions

notifyParent

public void notifyParent()

Description copied from class: TransitionXCommand

This will be used to notify the parent about the status of that perticular job.

Specified by:

notifyParent in class TransitionXCommand<Void>

getJob

public org.apache.oozie.client.Job getJob()

Description copied from class: TransitionXCommand

Get the Job for the command.

Overrides:

getJob in class TransitionXCommand<Void>

Returns:

the job

updateJob

public void updateJob()
               throws CommandException

Description copied from class: TransitionXCommand

Update the parent job.

Specified by:

updateJob in class TransitionXCommand<Void>

Throws:

CommandException