public class ExternalIdXCommand extends WorkflowXCommand<String>
INSTR_FAILED_JOBS_COUNTER_NAME, INSTR_KILLED_JOBS_COUNTER_NAME, INSTR_SUCCEEDED_JOBS_COUNTER_NAME, KEEP_WF_ACTION_DIR
DEFAULT_LOCK_TIMEOUT, DEFAULT_REQUEUE_DELAY, dryrun, eventService, instrumentation, INSTRUMENTATION_GROUP, LOG
Constructor and Description |
---|
ExternalIdXCommand(String externalId) |
Modifier and Type | Method and Description |
---|---|
protected String |
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, generateEvent, updateParentIfNecessary, updateParentIfNecessary
call, eagerLoadState, eagerVerifyPrecondition, executeInterrupts, getCreatedTime, getInstrumentation, getKey, getLockTimeOut, getLog, getName, getPriority, getRequeueDelay, getType, inInterruptMode, isReQueueRequired, queue, queue, resetUsed, setInterruptMode, setLogInfo, toString
public ExternalIdXCommand(String externalId)
protected boolean isLockRequired()
XCommand
Subclasses should override this method if they require locking.
isLockRequired
in class XCommand<String>
true/false
public String getEntityKey()
XCommand
getEntityKey
in interface XCallable<String>
getEntityKey
in class XCommand<String>
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<String>
CommandException
protected void verifyPrecondition() throws CommandException, PreconditionException
XCommand
verifyPrecondition
in class XCommand<String>
CommandException
- thrown if the precondition is not met.PreconditionException
protected String 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<String>
CommandException
- thrown if the command execution failed.Copyright © 2018 Apache Software Foundation. All rights reserved.