org.apache.oozie.action.oozie

Class SubWorkflowActionExecutor

java.lang.Object

org.apache.oozie.action.ActionExecutor

org.apache.oozie.action.oozie.SubWorkflowActionExecutor

public class SubWorkflowActionExecutor
extends ActionExecutor

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.oozie.action.ActionExecutor

ActionExecutor.Context, ActionExecutor.RETRYPOLICY

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_TYPE
static java.lang.String	LOCAL
XLog	LOG
static java.lang.String	PARENT_ID
static java.lang.String	SUBWORKFLOW_DEPTH
static java.lang.String	SUBWORKFLOW_MAX_DEPTH
static java.lang.String	SUBWORKFLOW_RERUN
static java.lang.String	SUPER_PARENT_ID

Fields inherited from class org.apache.oozie.action.ActionExecutor

ACTION_RETRY_INTERVAL, ACTION_RETRY_POLICY, CONF_PREFIX, ERROR_OTHER, MAX_RETRIES, OOZIE_ACTION_YARN_TAG, RETRY_INTERVAL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SubWorkflowActionExecutor()

Method Summary

Methods

Modifier and Type	Method and Description
void	check(ActionExecutor.Context context, org.apache.oozie.client.WorkflowAction action) Check if an action has completed.
protected java.lang.String	checkIfRunning(org.apache.oozie.client.OozieClient oozieClient, java.lang.String extId)
void	end(ActionExecutor.Context context, org.apache.oozie.client.WorkflowAction action) End an action after it has executed.
protected org.apache.oozie.client.OozieClient	getWorkflowClient(ActionExecutor.Context context, java.lang.String oozieUri)
void	initActionType() Invoked once at system initialization time.
protected void	injectCallback(ActionExecutor.Context context, org.apache.hadoop.conf.Configuration conf)
protected void	injectInline(org.jdom.Element eConf, org.apache.hadoop.conf.Configuration subWorkflowConf)
protected void	injectParent(java.lang.String parentId, org.apache.hadoop.conf.Configuration conf)
protected void	injectRecovery(java.lang.String externalId, org.apache.hadoop.conf.Configuration conf)
protected void	injectSuperParent(org.apache.oozie.client.WorkflowJob parentWorkflow, org.apache.hadoop.conf.Configuration parentConf, org.apache.hadoop.conf.Configuration conf)
boolean	isCompleted(java.lang.String externalStatus) Return if the external status indicates that the action has completed.
void	kill(ActionExecutor.Context context, org.apache.oozie.client.WorkflowAction action) Kill an action.
void	start(ActionExecutor.Context context, org.apache.oozie.client.WorkflowAction action) Start an action.
boolean	supportsConfigurationJobXML() Returns true if this action type supports a Configuration and JobXML.
protected void	verifyAndInjectSubworkflowDepth(org.apache.hadoop.conf.Configuration parentConf, org.apache.hadoop.conf.Configuration conf)

Methods inherited from class org.apache.oozie.action.ActionExecutor

convertException, disableInit, enableInit, getActionDir, getActionDirPath, getActionSignal, getActionYarnTag, getMaxRetries, getOozieConf, getOozieRuntimeDir, getOozieSystemId, getRetryInterval, getRetryPolicy, getType, registerError, requiresNameNodeJobTracker, resetInitInfo, setMaxRetries, setRetryInterval, setRetryPolicy

Methods inherited from class java.lang.Object

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

Field Detail

ACTION_TYPE

public static final java.lang.String ACTION_TYPE

See Also:

Constant Field Values

LOCAL

public static final java.lang.String LOCAL

See Also:

Constant Field Values

PARENT_ID

public static final java.lang.String PARENT_ID

See Also:

Constant Field Values

SUPER_PARENT_ID

public static final java.lang.String SUPER_PARENT_ID

See Also:

Constant Field Values

SUBWORKFLOW_MAX_DEPTH

public static final java.lang.String SUBWORKFLOW_MAX_DEPTH

See Also:

Constant Field Values

SUBWORKFLOW_DEPTH

public static final java.lang.String SUBWORKFLOW_DEPTH

See Also:

Constant Field Values

SUBWORKFLOW_RERUN

public static final java.lang.String SUBWORKFLOW_RERUN

See Also:

Constant Field Values

LOG

public XLog LOG

Constructor Detail

SubWorkflowActionExecutor

protected SubWorkflowActionExecutor()

Method Detail

initActionType

public void initActionType()

Description copied from class: ActionExecutor

Invoked once at system initialization time.

It can be used to register error information for the expected exceptions. Exceptions should be register from subclasses to superclasses to ensure proper detection, same thing that it is done in a normal catch.

This method should invoke the ActionExecutor.registerError(java.lang.String, org.apache.oozie.action.ActionExecutorException.ErrorType, java.lang.String) method to register all its possible errors.

Subclasses overriding must invoke super.

Overrides:

initActionType in class ActionExecutor

getWorkflowClient

protected org.apache.oozie.client.OozieClient getWorkflowClient(ActionExecutor.Context context,
                                                    java.lang.String oozieUri)

injectInline

protected void injectInline(org.jdom.Element eConf,
                org.apache.hadoop.conf.Configuration subWorkflowConf)
                     throws java.io.IOException,
                            ActionExecutorException

Throws:

java.io.IOException

ActionExecutorException

injectCallback

protected void injectCallback(ActionExecutor.Context context,
                  org.apache.hadoop.conf.Configuration conf)

injectRecovery

protected void injectRecovery(java.lang.String externalId,
                  org.apache.hadoop.conf.Configuration conf)

injectParent

protected void injectParent(java.lang.String parentId,
                org.apache.hadoop.conf.Configuration conf)

injectSuperParent

protected void injectSuperParent(org.apache.oozie.client.WorkflowJob parentWorkflow,
                     org.apache.hadoop.conf.Configuration parentConf,
                     org.apache.hadoop.conf.Configuration conf)

verifyAndInjectSubworkflowDepth

protected void verifyAndInjectSubworkflowDepth(org.apache.hadoop.conf.Configuration parentConf,
                                   org.apache.hadoop.conf.Configuration conf)
                                        throws ActionExecutorException

Throws:

ActionExecutorException

checkIfRunning

protected java.lang.String checkIfRunning(org.apache.oozie.client.OozieClient oozieClient,
                              java.lang.String extId)
                                   throws org.apache.oozie.client.OozieClientException

Throws:

org.apache.oozie.client.OozieClientException

start

public void start(ActionExecutor.Context context,
         org.apache.oozie.client.WorkflowAction action)
           throws ActionExecutorException

Description copied from class: ActionExecutor

Start an action.

The ActionExecutor.Context.setStartData(java.lang.String, java.lang.String, java.lang.String) method must be called within this method.

If the action has completed, the ActionExecutor.Context.setExecutionData(java.lang.String, java.util.Properties) method must be called within this method.

Specified by:

start in class ActionExecutor

Parameters:

context - executor context.

action - the action to start.

Throws:

ActionExecutorException - thrown if the action could not start.

end

public void end(ActionExecutor.Context context,
       org.apache.oozie.client.WorkflowAction action)
         throws ActionExecutorException

Description copied from class: ActionExecutor

End an action after it has executed.

The ActionExecutor.Context.setEndData(org.apache.oozie.client.WorkflowAction.Status, java.lang.String) method must be called within this method.

Specified by:

end in class ActionExecutor

Parameters:

context - executor context.

action - the action to end.

Throws:

ActionExecutorException - thrown if the action could not end.

check

public void check(ActionExecutor.Context context,
         org.apache.oozie.client.WorkflowAction action)
           throws ActionExecutorException

Description copied from class: ActionExecutor

Check if an action has completed. This method must be implemented by Async Action Executors.

If the action has completed, the ActionExecutor.Context.setExecutionData(java.lang.String, java.util.Properties) method must be called within this method.

If the action has not completed, the ActionExecutor.Context.setExternalStatus(java.lang.String) method must be called within this method.

Specified by:

check in class ActionExecutor

Parameters:

context - executor context.

action - the action to end.

Throws:

ActionExecutorException - thrown if the action could not be checked.

kill

public void kill(ActionExecutor.Context context,
        org.apache.oozie.client.WorkflowAction action)
          throws ActionExecutorException

Description copied from class: ActionExecutor

Kill an action.

The ActionExecutor.Context.setEndData(org.apache.oozie.client.WorkflowAction.Status, java.lang.String) method must be called within this method.

Specified by:

kill in class ActionExecutor

Parameters:

context - executor context.

action - the action to kill.

Throws:

ActionExecutorException - thrown if the action could not be killed.

isCompleted

public boolean isCompleted(java.lang.String externalStatus)

Description copied from class: ActionExecutor

Return if the external status indicates that the action has completed.

Specified by:

isCompleted in class ActionExecutor

Parameters:

externalStatus - external status to check.

Returns:

if the external status indicates that the action has completed.

supportsConfigurationJobXML

public boolean supportsConfigurationJobXML()

Description copied from class: ActionExecutor

Returns true if this action type supports a Configuration and JobXML. In this case, Oozie will include the <configuration> and <job-xml> elements from the global section (if provided) with the action. If false, Oozie won't add these.

Overrides:

supportsConfigurationJobXML in class ActionExecutor

Returns:

true if the global section's Configuration and JobXML should be given; false if not