org.apache.oozie.command.sla

Class SLAJobHistoryXCommand

java.lang.Object

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

org.apache.oozie.command.sla.SLAJobHistoryXCommand

All Implemented Interfaces:

Callable<Boolean>, XCallable<Boolean>

Direct Known Subclasses:

SLACoordActionJobHistoryXCommand, SLAWorkflowActionJobHistoryXCommand, SLAWorkflowJobHistoryXCommand

public abstract class SLAJobHistoryXCommand
extends XCommand<Boolean>

Field Summary

Fields

Modifier and Type	Field and Description
protected String	jobId

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
SLAJobHistoryXCommand(String jobId)

Method Summary

Methods

Modifier and Type	Method and Description
protected Boolean	execute() Command execution body.
String	getEntityKey() Return the entity key for the command.
protected long	getLockTimeOut() Return the time out when acquiring a lock.
protected abstract boolean	isJobEnded() Checks if is job ended.
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.
protected abstract void	updateSLASummary() Update SLASummary
protected void	updateSLASummary(String id, Date startTime, Date endTime, String status) Update sla summary.
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

Field Detail

jobId

protected String jobId

Constructor Detail

SLAJobHistoryXCommand

public SLAJobHistoryXCommand(String jobId)

Method Detail

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<Boolean>

Throws:

CommandException - thrown if the precondition is not met.

PreconditionException

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<Boolean>

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<Boolean>

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<Boolean>

Specified by:

getEntityKey in class XCommand<Boolean>

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<Boolean>

Returns:

the lock time out in milliseconds.

execute

protected Boolean 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<Boolean>

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.

isJobEnded

protected abstract boolean isJobEnded()

Checks if is job ended.

Returns:

true, if is job ended

updateSLASummary

protected abstract void updateSLASummary()
                                  throws CommandException,
                                         XException

Update SLASummary

Throws:

CommandException

XException

updateSLASummary

protected void updateSLASummary(String id,
                    Date startTime,
                    Date endTime,
                    String status)
                         throws JPAExecutorException

Update sla summary.

Parameters:

id - the id

startTime - the start time

endTime - the end time

status - the status

Throws:

JPAExecutorException - the JPA executor exception