org.apache.oozie.command.sla

Class SLAJobEventXCommand

java.lang.Object

org.apache.oozie.command.XCommand<Void>

org.apache.oozie.command.sla.SLAJobEventXCommand

All Implemented Interfaces:

Callable<Void>, XCallable<Void>

Direct Known Subclasses:

SLACoordActionJobEventXCommand, SLAWorkflowActionJobEventXCommand, SLAWorkflowJobEventXCommand

public abstract class SLAJobEventXCommand
extends XCommand<Void>

Field Summary

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

DEFAULT_LOCK_TIMEOUT, DEFAULT_REQUEUE_DELAY, dryrun, eventService, instrumentation, INSTRUMENTATION_GROUP, LOG

Constructor Summary

Constructors

Constructor and Description
SLAJobEventXCommand(SLACalcStatus slaCalc, long lockTimeOut)

Method Summary

Methods

Modifier and Type	Method and Description
protected Void	execute() Command execution body.
String	getEntityKey() Return the entity key for the command.
protected long	getLockTimeOut() Return the time out when acquiring a lock.
boolean	isEnded()
boolean	isEndMiss()
protected boolean	isLockRequired() Indicate if the the command requires locking.
protected boolean	isReQueueRequired() Indicate if the the command requires to requeue itself if the lock is not acquired.
void	setEnded(boolean isEnded)
void	setEndMiss(boolean isEndMiss)
protected abstract void	updateJobInfo() Verify job.
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, getLog, getName, getPriority, getRequeueDelay, getType, inInterruptMode, loadState, queue, queue, resetUsed, setInterruptMode, setLogInfo, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SLAJobEventXCommand

public SLAJobEventXCommand(SLACalcStatus slaCalc,
                   long lockTimeOut)

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

isReQueueRequired

protected boolean isReQueueRequired()

Description copied from class: XCommand

Indicate if the the command requires to requeue itself if the lock is not acquired.

Subclasses should override this method if they don't want to requeue.

Default is true.

Overrides:

isReQueueRequired 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.

getLockTimeOut

protected long getLockTimeOut()

Description copied from class: XCommand

Return the time out when acquiring a lock.

The value is loaded from the Oozie configuration, the property {link #DEFAULT_LOCK_TIMEOUT}.

Subclasses should override this method if they want to use a different time out.

Overrides:

getLockTimeOut in class XCommand<Void>

Returns:

the lock time out in milliseconds.

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.

updateJobInfo

protected abstract void updateJobInfo()

Verify job.

isEnded

public boolean isEnded()

setEnded

public void setEnded(boolean isEnded)

isEndMiss

public boolean isEndMiss()

setEndMiss

public void setEndMiss(boolean isEndMiss)