org.apache.oozie.command.coord

Class CoordJobXCommand

java.lang.Object

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

org.apache.oozie.command.coord.CoordinatorXCommand<CoordinatorJobBean>

org.apache.oozie.command.coord.CoordJobXCommand

All Implemented Interfaces:

Callable<CoordinatorJobBean>, XCallable<CoordinatorJobBean>

public class CoordJobXCommand
extends CoordinatorXCommand<CoordinatorJobBean>

Command for loading a coordinator job information

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
CoordJobXCommand(String id) Constructor for loading a coordinator job information
CoordJobXCommand(String id, boolean getActionInfo) Constructor for loading a coordinator job information
CoordJobXCommand(String id, Map<Pair<String,CoordinatorEngine.FILTER_COMPARATORS>,List<Object>> filterMap, int offset, int length, boolean desc) Constructor for loading a coordinator job information

Method Summary

Methods

Modifier and Type	Method and Description
protected CoordinatorJobBean	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.
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.coord.CoordinatorXCommand

generateEvent, generateEvent

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CoordJobXCommand

public CoordJobXCommand(String id)

Constructor for loading a coordinator job information

Parameters:

id - coord jobId

CoordJobXCommand

public CoordJobXCommand(String id,
                Map<Pair<String,CoordinatorEngine.FILTER_COMPARATORS>,List<Object>> filterMap,
                int offset,
                int length,
                boolean desc)

Constructor for loading a coordinator job information

Parameters:

id - coord jobId

filterMap -

offset - starting index in the list of actions belonging to the job

length - number of actions to be returned

desc - boolean for whether the actions returned are in descending order

CoordJobXCommand

public CoordJobXCommand(String id,
                boolean getActionInfo)

Constructor for loading a coordinator job information

Parameters:

id - coord jobId

getActionInfo - false to ignore loading actions for the job

Method Detail

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

Returns:

true/false

getEntityKey

public String getEntityKey()

Description copied from class: XCommand

Return the entity key for the command.

Specified by:

getEntityKey in interface XCallable<CoordinatorJobBean>

Specified by:

getEntityKey in class XCommand<CoordinatorJobBean>

Returns:

the entity key for the command.

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

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

Throws:

CommandException - thrown if the precondition is not met.

PreconditionException

execute

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

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.