org.apache.oozie.command.coord

Class CoordActionInputCheckXCommand

java.lang.Object

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

org.apache.oozie.command.coord.CoordinatorXCommand<java.lang.Void>

org.apache.oozie.command.coord.CoordActionInputCheckXCommand

All Implemented Interfaces:

java.util.concurrent.Callable<java.lang.Void>, XCallable<java.lang.Void>

public class CoordActionInputCheckXCommand
extends CoordinatorXCommand<java.lang.Void>

The command to check if an action's data input paths exist in the file system.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONF_COORD_INPUT_CHECK_REQUEUE_INTERVAL Property name of command re-queue interval for coordinator action input check in milliseconds.
static java.lang.String	COORD_EXECUTION_NONE_TOLERANCE

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
CoordActionInputCheckXCommand(java.lang.String actionId, java.lang.String jobId)

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkInput(java.lang.StringBuilder actionXml, java.lang.StringBuilder existList, java.lang.StringBuilder nonExistList, org.apache.hadoop.conf.Configuration conf) To check the list of input paths if all of them exist
protected boolean	checkUnResolvedInput(java.lang.StringBuilder actionXml, org.apache.hadoop.conf.Configuration conf)
protected java.lang.Void	execute() Command execution body.
protected java.lang.String	getCoordActionErrorCode() getting the error code of the coord action.
protected java.lang.String	getCoordActionErrorMsg() getting the error message of the coord action.
long	getCoordInputCheckRequeueInterval() This function reads the value of re-queue interval for coordinator input check command from the Oozie configuration provided by Configuration Service.
java.lang.String	getEntityKey() Return the entity key for the command.
java.lang.String	getKey() Get command key
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 boolean	pathExists(java.lang.String sPath, org.apache.hadoop.conf.Configuration actionConf, java.lang.String user) Check if given path exists
protected void	setLogInfo() Set the thread local logInfo with the context of this command and reset log prefix.
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, 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

Field Detail

COORD_EXECUTION_NONE_TOLERANCE

public static final java.lang.String COORD_EXECUTION_NONE_TOLERANCE

See Also:

Constant Field Values

CONF_COORD_INPUT_CHECK_REQUEUE_INTERVAL

public static final java.lang.String CONF_COORD_INPUT_CHECK_REQUEUE_INTERVAL

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

See Also:

Constant Field Values

Constructor Detail

CoordActionInputCheckXCommand

public CoordActionInputCheckXCommand(java.lang.String actionId,
                             java.lang.String jobId)

Method Detail

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<java.lang.Void>

execute

protected java.lang.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<java.lang.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.

getCoordInputCheckRequeueInterval

public long getCoordInputCheckRequeueInterval()

This function reads the value of re-queue interval for coordinator input check command from the Oozie configuration provided by Configuration Service. If nothing defined in the configuration, it uses the code specified default value.

Returns:

re-queue interval in ms

checkInput

protected boolean checkInput(java.lang.StringBuilder actionXml,
                 java.lang.StringBuilder existList,
                 java.lang.StringBuilder nonExistList,
                 org.apache.hadoop.conf.Configuration conf)
                      throws java.lang.Exception

To check the list of input paths if all of them exist

Parameters:

actionXml - action xml

existList - the list of existed paths

nonExistList - the list of non existed paths

conf - action configuration

Returns:

true if all input paths are existed

Throws:

java.lang.Exception - thrown of unable to check input path

checkUnResolvedInput

protected boolean checkUnResolvedInput(java.lang.StringBuilder actionXml,
                           org.apache.hadoop.conf.Configuration conf)
                                throws java.lang.Exception

Throws:

java.lang.Exception

pathExists

protected boolean pathExists(java.lang.String sPath,
                 org.apache.hadoop.conf.Configuration actionConf,
                 java.lang.String user)
                      throws java.io.IOException

Check if given path exists

Parameters:

sPath - uri path

actionConf - action configuration

Returns:

true if path exists

Throws:

java.io.IOException - thrown if unable to access the path

getCoordActionErrorCode

protected java.lang.String getCoordActionErrorCode()

getting the error code of the coord action. (used mainly for unit testing)

getCoordActionErrorMsg

protected java.lang.String getCoordActionErrorMsg()

getting the error message of the coord action. (used mainly for unit testing)

getEntityKey

public java.lang.String getEntityKey()

Description copied from class: XCommand

Return the entity key for the command.

Specified by:

getEntityKey in interface XCallable<java.lang.Void>

Specified by:

getEntityKey in class XCommand<java.lang.Void>

Returns:

the entity key for the command.

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<java.lang.Void>

Returns:

true/false

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<java.lang.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<java.lang.Void>

Throws:

CommandException - thrown if the precondition is not met.

PreconditionException

getKey

public java.lang.String getKey()

Description copied from class: XCommand

Get command key

Specified by:

getKey in interface XCallable<java.lang.Void>

Overrides:

getKey in class XCommand<java.lang.Void>

Returns:

command key