com.asakusafw.runtime.stage

Class BaseStageClient

java.lang.Object

org.apache.hadoop.conf.Configured

com.asakusafw.runtime.stage.BaseStageClient

All Implemented Interfaces:

org.apache.hadoop.conf.Configurable, org.apache.hadoop.util.Tool

Direct Known Subclasses:

AbstractCleanupStageClient, AbstractStageClient

public abstract class BaseStageClient
extends org.apache.hadoop.conf.Configured
implements org.apache.hadoop.util.Tool

A skeletal implementation of stage clients.

Since:

0.2.6

Field Summary

Fields

Modifier and Type	Field and Description
static String	METHOD_BATCH_ID The method name of getBatchId().
static String	METHOD_FLOW_ID The method name of getFlowId().
static String	METHOD_STAGE_ID The method name of getStageId().

Constructor Summary

Constructors

Constructor and Description
BaseStageClient()

Method Summary

Modifier and Type	Method and Description
protected abstract int	execute(String[] args) Performs stage execution.
protected abstract String	getBatchId() Returns the batch ID.
protected String	getDefinitionId() Returns the qualified stage ID {@literal (a.k.a.
protected String	getExecutionId() Returns the execution ID of the current jobflow.
protected abstract String	getFlowId() Returns the flow ID.
protected String	getOperationId() Returns the job operation ID which this client will invoke.
protected abstract String	getStageId() Returns the stage ID.
protected String	getUser() Returns the current user name.
int	run(String[] args)

Methods inherited from class org.apache.hadoop.conf.Configured

getConf, setConf

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.conf.Configurable

getConf, setConf

Field Detail

METHOD_BATCH_ID

public static final String METHOD_BATCH_ID

The method name of getBatchId().

See Also:

Constant Field Values

METHOD_FLOW_ID

public static final String METHOD_FLOW_ID

The method name of getFlowId().

See Also:

Constant Field Values

METHOD_STAGE_ID

public static final String METHOD_STAGE_ID

The method name of getStageId().

See Also:

Constant Field Values

Constructor Detail

BaseStageClient

public BaseStageClient()

Method Detail

getUser

protected String getUser()

Returns the current user name.

Returns:

the current user name

getExecutionId

protected String getExecutionId()

Returns the execution ID of the current jobflow.

Returns:

the execution ID

getBatchId

protected abstract String getBatchId()

Returns the batch ID.

Returns:

the batch ID

getFlowId

protected abstract String getFlowId()

Returns the flow ID.

Returns:

the flow ID

getStageId

protected abstract String getStageId()

Returns the stage ID.

Returns:

the stage ID

getDefinitionId

protected String getDefinitionId()

Returns the qualified stage ID (a.k.a. stage definition ID).

Returns:

the qualified stage ID

getOperationId

protected String getOperationId()

Returns the job operation ID which this client will invoke.

Returns:

the job operation ID

Since:

0.5.0

run

public final int run(String[] args)
              throws Exception

Specified by:

run in interface org.apache.hadoop.util.Tool

Throws:

Exception

execute

protected abstract int execute(String[] args)
                        throws Exception

Performs stage execution.

Parameters:

args - arguments

Returns:

exit code of the execution

Throws:

Exception - if failed to execute