This project has retired. For details please refer to its
Attic page .
ActionKillXCommand (Apache Oozie Core 3.3.2 API)
org.apache.oozie.command.wf
Class ActionKillXCommand
java.lang.Object
org.apache.oozie.command.XCommand <T>
org.apache.oozie.command.wf.WorkflowXCommand <Void >
org.apache.oozie.command.wf.ActionXCommand <Void >
org.apache.oozie.command.wf.ActionKillXCommand
All Implemented Interfaces: Callable <Void >, XCallable <Void >
public class ActionKillXCommand extends ActionXCommand <Void >
Kill workflow action and invoke action executor to kill the underlying context.
Method Summary
protected Void
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
ActionKillXCommand
public ActionKillXCommand (String actionId,
String type)
ActionKillXCommand
public ActionKillXCommand (String actionId)
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
public String getEntityKey ()
Description copied from class: XCommand
Return the entity key for the command.
Specified by: getEntityKey
in interface XCallable <Void >
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.
Copyright © 2013 Apache Software Foundation . All Rights Reserved.