org.apache.oozie.command

Class SLAAlertsXCommand

java.lang.Object

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

org.apache.oozie.command.SLAAlertsXCommand

All Implemented Interfaces:

Callable<Void>, XCallable<Void>

Direct Known Subclasses:

BundleSLAAlertsXCommand, CoordSLAAlertsXCommand

public abstract class SLAAlertsXCommand
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
SLAAlertsXCommand(String jobId, String name, String type)

Method Summary

Modifier and Type	Method and Description
protected Void	execute() Command execution body.
protected abstract boolean	executeSlaCommand() Execute sla command.
String	getEntityKey() Return the entity key for the command.
String	getJobId()
String	getKey() Get command key
protected abstract boolean	isJobRequest()
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	setLogInfo() Set the thread local logInfo with the context of this command and reset log prefix.
protected abstract void	updateJob() Update job.
protected void	validateSLAChangeParam(Map<String,String> slaParams)
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, getLockTimeOut, getLog, getName, getPriority, getRequeueDelay, getType, inInterruptMode, isReQueueRequired, queue, queue, resetUsed, setInterruptMode, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SLAAlertsXCommand

public SLAAlertsXCommand(String jobId,
                         String name,
                         String type)

Method Detail

isLockRequired

protected final 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 final 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.

getJobId

public final String getJobId()

setLogInfo

protected void setLogInfo()

Description copied from class: XCommand

Set the thread local logInfo with the context of this command and reset log prefix.

Overrides:

setLogInfo in class XCommand<Void>

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.

getKey

public String getKey()

Description copied from class: XCommand

Get command key

Specified by:

getKey in interface XCallable<Void>

Overrides:

getKey in class XCommand<Void>

Returns:

command key

validateSLAChangeParam

protected void validateSLAChangeParam(Map<String,String> slaParams)
                               throws CommandException,
                                      PreconditionException

Throws:

CommandException

PreconditionException

executeSlaCommand

protected abstract boolean executeSlaCommand()
                                      throws ServiceException,
                                             CommandException

Execute sla command.

Returns:

true, if successful

Throws:

ServiceException - the service exception

CommandException - the command exception

updateJob

protected abstract void updateJob()
                           throws CommandException

Update job.

Throws:

CommandException - the command exception

isJobRequest

protected abstract boolean isJobRequest()
                                 throws CommandException

Throws:

CommandException