org.apache.oozie.command.wf
Class SignalXCommand

java.lang.Object
  extended by org.apache.oozie.command.XCommand<T>
      extended by org.apache.oozie.command.wf.WorkflowXCommand<Void>
          extended by org.apache.oozie.command.wf.SignalXCommand
All Implemented Interfaces:
Callable<Void>, XCallable<Void>
Direct Known Subclasses:
StartXCommand

public class SignalXCommand
extends WorkflowXCommand<Void>


Field Summary
protected static String INSTR_SUCCEEDED_JOBS_COUNTER_NAME
           
 
Fields inherited from class org.apache.oozie.command.XCommand
DEFAULT_LOCK_TIMEOUT, DEFAULT_REQUEUE_DELAY, dryrun, instrumentation, INSTRUMENTATION_GROUP, LOG, logInfo
 
Constructor Summary
SignalXCommand(String name, int priority, String jobId)
           
SignalXCommand(String jobId, String actionId)
           
 
Method Summary
static ELEvaluator createELEvaluatorForGroup(org.apache.hadoop.conf.Configuration conf, String group)
           
protected  Void execute()
          Command execution body.
protected  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, 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
 

Field Detail

INSTR_SUCCEEDED_JOBS_COUNTER_NAME

protected static final String INSTR_SUCCEEDED_JOBS_COUNTER_NAME
See Also:
Constant Field Values
Constructor Detail

SignalXCommand

public SignalXCommand(String name,
                      int priority,
                      String jobId)

SignalXCommand

public SignalXCommand(String jobId,
                      String actionId)
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<Void>
Returns:
true/false

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.

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

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.

Specified by:
execute in class XCommand<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.

createELEvaluatorForGroup

public static ELEvaluator createELEvaluatorForGroup(org.apache.hadoop.conf.Configuration conf,
                                                    String group)


Copyright © 2012 Apache Software Foundation. All Rights Reserved.