org.apache.oozie.command

Class NotificationXCommand

java.lang.Object

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

org.apache.oozie.command.NotificationXCommand

All Implemented Interfaces:

Callable<Void>, XCallable<Void>

Direct Known Subclasses:

CoordActionNotificationXCommand, WorkflowNotificationXCommand

public abstract class NotificationXCommand
extends XCommand<Void>

Field Summary

Fields

Modifier and Type	Field and Description
protected String	jobId
static String	NOTIFICATION_PROXY_KEY
static String	NOTIFICATION_URL_CONNECTION_TIMEOUT_KEY
protected String	proxyConf
protected int	retries
protected String	url

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
NotificationXCommand(String name, String type, int priority)

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 Proxy	getProxy(String proxyConf)
protected void	handleRetry()
protected boolean	isLockRequired() Indicate if the the command requires locking.
protected void	sendNotification()
protected void	setLogInfo() Set the thread local logInfo with the context of this command and reset log prefix.
void	setRetry(int retries)
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, call, eagerLoadState, eagerVerifyPrecondition, executeInterrupts, getCreatedTime, getInstrumentation, getKey, getLockTimeOut, getLog, getName, getPriority, getRequeueDelay, getType, inInterruptMode, isReQueueRequired, loadState, queue, queue, resetUsed, setInterruptMode, toString

Methods inherited from class java.lang.Object

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

Field Detail

NOTIFICATION_URL_CONNECTION_TIMEOUT_KEY

public static final String NOTIFICATION_URL_CONNECTION_TIMEOUT_KEY

See Also:

Constant Field Values

NOTIFICATION_PROXY_KEY

public static final String NOTIFICATION_PROXY_KEY

See Also:

Constant Field Values

retries

protected int retries

jobId

protected String jobId

url

protected String url

proxyConf

protected String proxyConf

Constructor Detail

NotificationXCommand

public NotificationXCommand(String name,
                    String type,
                    int priority)

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

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.

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>

getProxy

protected Proxy getProxy(String proxyConf)

handleRetry

protected void handleRetry()

sendNotification

protected void sendNotification()

setRetry

public void setRetry(int retries)