This project has retired. For details please refer to its Attic page.

org.apache.oozie.command.coord
Class CoordPushDependencyCheckXCommand

java.lang.Object
  org.apache.oozie.command.XCommand<T>
      org.apache.oozie.command.coord.CoordinatorXCommand<Void>
          org.apache.oozie.command.coord.CoordPushDependencyCheckXCommand

All Implemented Interfaces:

Callable<Void>, XCallable<Void>

Direct Known Subclasses:

CoordActionUpdatePushMissingDependency

public class CoordPushDependencyCheckXCommand
extends CoordinatorXCommand<Void>

Field Summary

protected String	actionId
static String	CONF_COORD_PUSH_CHECK_REQUEUE_INTERVAL Property name of command re-queue interval for coordinator push check in milliseconds.
protected CoordinatorActionBean	coordAction
protected CoordinatorJobBean	coordJob
protected JPAService	jpaService

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

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

Constructor Summary

	CoordPushDependencyCheckXCommand(String actionId)
	CoordPushDependencyCheckXCommand(String actionId, boolean registerForNotification)
	CoordPushDependencyCheckXCommand(String actionId, boolean registerForNotification, boolean removeAvailDependencies)
protected	CoordPushDependencyCheckXCommand(String actionName, String actionId)

Method Summary

protected void	eagerLoadState() Load the necessary state to perform an eager precondition check.
protected void	eagerVerifyPrecondition() Verify the precondition for the command before obtaining a lock.
protected Void	execute() Command execution body.
long	getCoordPushCheckRequeueInterval() Return the re-queue interval for coord push dependency check
String	getEntityKey() Return the entity key for the command.
String	getKey() Get command key
protected boolean	isLockRequired() Indicate if the the command requires locking.
protected boolean	isTimeout() Returns true if timeout period has been reached
protected void	loadState() Load the necessary state to perform the precondition check and to execute the command.
protected void	onAllPushDependenciesAvailable()
static void	unregisterMissingDependencies(List<String> missingDeps, String actionId)
protected void	updateCoordAction(CoordinatorActionBean coordAction, boolean isChangeInDependency)
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.coord.CoordinatorXCommand

generateEvent, generateEvent

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

call, executeInterrupts, getCreatedTime, getInstrumentation, getLockTimeOut, getLog, getName, getPriority, getRequeueDelay, getType, inInterruptMode, isReQueueRequired, queue, queue, resetUsed, setInterruptMode

Methods inherited from class java.lang.Object

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

Field Detail

actionId

protected String actionId

jpaService

protected JPAService jpaService

coordAction

protected CoordinatorActionBean coordAction

coordJob

protected CoordinatorJobBean coordJob

CONF_COORD_PUSH_CHECK_REQUEUE_INTERVAL

public static final String CONF_COORD_PUSH_CHECK_REQUEUE_INTERVAL

Property name of command re-queue interval for coordinator push check in milliseconds.

See Also:

Constant Field Values

Constructor Detail

CoordPushDependencyCheckXCommand

public CoordPushDependencyCheckXCommand(String actionId)

CoordPushDependencyCheckXCommand

public CoordPushDependencyCheckXCommand(String actionId,
                                        boolean registerForNotification)

CoordPushDependencyCheckXCommand

public CoordPushDependencyCheckXCommand(String actionId,
                                        boolean registerForNotification,
                                        boolean removeAvailDependencies)

CoordPushDependencyCheckXCommand

protected CoordPushDependencyCheckXCommand(String actionName,
                                           String actionId)

Method Detail

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.

getCoordPushCheckRequeueInterval

public long getCoordPushCheckRequeueInterval()

Return the re-queue interval for coord push dependency check

Returns:

isTimeout

protected boolean isTimeout()

Returns true if timeout period has been reached

Returns:

true if it is time for timeout else false

onAllPushDependenciesAvailable

protected void onAllPushDependenciesAvailable()
                                       throws CommandException

Throws:

CommandException

updateCoordAction

protected void updateCoordAction(CoordinatorActionBean coordAction,
                                 boolean isChangeInDependency)
                          throws CommandException

Throws:

CommandException

unregisterMissingDependencies

public static void unregisterMissingDependencies(List<String> missingDeps,
                                                 String actionId)

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.

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

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

eagerLoadState

protected void eagerLoadState()
                       throws CommandException

Description copied from class: XCommand

Load the necessary state to perform an eager precondition check.

This implementation does a NOP.

Subclasses should override this method and load the state needed to do an eager precondition check.

A trivial implementation is calling {link #loadState}.

Overrides:

eagerLoadState in class XCommand<Void>

Throws:

CommandException

eagerVerifyPrecondition

protected void eagerVerifyPrecondition()
                                throws CommandException,
                                       PreconditionException

Description copied from class: XCommand

Verify the precondition for the command before obtaining a lock.

This implementation does a NOP.

A trivial implementation is calling {link #verifyPrecondition}.

Overrides:

eagerVerifyPrecondition in class XCommand<Void>

Throws:

CommandException - thrown if the precondition is not met.

PreconditionException

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