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

org.apache.oozie.command.bundle
Class BundleJobSuspendXCommand

java.lang.Object
  org.apache.oozie.command.XCommand<T>
      org.apache.oozie.command.TransitionXCommand<Void>
          org.apache.oozie.command.SuspendTransitionXCommand
              org.apache.oozie.command.bundle.BundleJobSuspendXCommand

All Implemented Interfaces:

Callable<Void>, XCallable<Void>

public class BundleJobSuspendXCommand
extends SuspendTransitionXCommand

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

BundleJobSuspendXCommand(String id)

Method Summary

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.
protected 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	setJob(org.apache.oozie.client.Job job) Set the Job for the command.
void	suspendChildren() Suspend all children of 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.SuspendTransitionXCommand

execute, transitToNext

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

call, eagerLoadState, eagerVerifyPrecondition, 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

BundleJobSuspendXCommand

public BundleJobSuspendXCommand(String id)

Method Detail

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

notifyParent

public void notifyParent()
                  throws CommandException

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>

Throws:

CommandException

setJob

public void setJob(org.apache.oozie.client.Job job)

Description copied from class: TransitionXCommand

Set the Job for the command.

Overrides:

setJob in class TransitionXCommand<Void>

Parameters:

job - the job

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

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

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

Throws:

CommandException - thrown if the precondition is not met.

PreconditionException

updateJob

public void updateJob()
               throws CommandException

Description copied from class: TransitionXCommand

Update the parent job.

Specified by:

updateJob in class TransitionXCommand<Void>

Throws:

CommandException

suspendChildren

public void suspendChildren()
                     throws CommandException

Description copied from class: SuspendTransitionXCommand

Suspend all children of the job

Specified by:

suspendChildren in class SuspendTransitionXCommand

Throws:

CommandException