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

org.apache.oozie.command.wf
Class JobsXCommand

java.lang.Object
  org.apache.oozie.command.XCommand<T>
      org.apache.oozie.command.wf.WorkflowXCommand<WorkflowsInfo>
          org.apache.oozie.command.wf.JobsXCommand

All Implemented Interfaces:

Callable<WorkflowsInfo>, XCallable<WorkflowsInfo>

public class JobsXCommand
extends WorkflowXCommand<WorkflowsInfo>

Field Summary

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

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

Constructor Summary

JobsXCommand(Map<String,List<String>> filter, int start, int length)
Constructor taking the filter information

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

JobsXCommand

public JobsXCommand(Map<String,List<String>> filter,
                    int start,
                    int length)

Constructor taking the filter information

Parameters:

filter - Can be name, status, user, group and combination of these

start - starting from this index in the list of workflows matching the filter are returned

length - number of workflows to be returned from the list of workflows matching the filter and starting from index "start".

Method Detail

execute

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

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.

getEntityKey

public String getEntityKey()

Description copied from class: XCommand

Return the entity key for the command.

Specified by:

getEntityKey in interface XCallable<WorkflowsInfo>

Specified by:

getEntityKey in class XCommand<WorkflowsInfo>

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

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

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

Throws:

CommandException - thrown if the precondition is not met.

PreconditionException