public class CoordJobXCommand extends CoordinatorXCommand<CoordinatorJobBean>
DEFAULT_LOCK_TIMEOUT, DEFAULT_REQUEUE_DELAY, dryrun, eventService, instrumentation, INSTRUMENTATION_GROUP, LOG
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
|
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.
|
generateEvent, generateEvent
call, eagerLoadState, eagerVerifyPrecondition, executeInterrupts, getCreatedTime, getInstrumentation, getKey, getLockTimeOut, getLog, getName, getPriority, getRequeueDelay, getType, inInterruptMode, isReQueueRequired, queue, queue, resetUsed, setInterruptMode, setLogInfo, toString
public CoordJobXCommand(String id)
id
- coord jobIdpublic CoordJobXCommand(String id, Map<Pair<String,CoordinatorEngine.FILTER_COMPARATORS>,List<Object>> filterMap, int offset, int length, boolean desc)
id
- coord jobIdfilterMap
- offset
- starting index in the list of actions belonging to the joblength
- number of actions to be returneddesc
- boolean for whether the actions returned are in descending orderpublic CoordJobXCommand(String id, boolean getActionInfo)
id
- coord jobIdgetActionInfo
- false to ignore loading actions for the jobprotected boolean isLockRequired()
XCommand
Subclasses should override this method if they require locking.
isLockRequired
in class XCommand<CoordinatorJobBean>
true/false
public String getEntityKey()
XCommand
getEntityKey
in interface XCallable<CoordinatorJobBean>
getEntityKey
in class XCommand<CoordinatorJobBean>
protected void loadState() throws CommandException
XCommand
Subclasses must implement this method and load the state needed to do the precondition check and execute the command.
loadState
in class XCommand<CoordinatorJobBean>
CommandException
protected void verifyPrecondition() throws CommandException, PreconditionException
XCommand
verifyPrecondition
in class XCommand<CoordinatorJobBean>
CommandException
- thrown if the precondition is not met.PreconditionException
protected CoordinatorJobBean execute() throws CommandException
XCommand
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.
execute
in class XCommand<CoordinatorJobBean>
CommandException
- thrown if the command execution failed.Copyright © 2018 Apache Software Foundation. All rights reserved.