com.asakusafw.yaess.core

Interface ExecutionScriptHandler<T extends ExecutionScript>

Type Parameters:

T - the type of script

All Superinterfaces:

Service

All Known Subinterfaces:

CommandScriptHandler, HadoopScriptHandler

All Known Implementing Classes:

BasicCommandScriptHandler, BasicHadoopScriptHandler, CommandScriptHandlerDispatcher, ExecutionScriptHandlerDispatcher, HadoopScriptHandlerDispatcher, ProcessCommandScriptHandler, ProcessHadoopScriptHandler, QueueHadoopScriptHandler, SshCommandScriptHandler, SshHadoopScriptHandler

public interface ExecutionScriptHandler<T extends ExecutionScript>
extends Service

An abstract super interface of ExecutionScript handler. An implementation of this will be handles ExecutionScript, and then execute some commands on the suitable environment. Clients must not implement this interface directly, extend ExecutionScriptHandlerBase and implement HadoopScriptHandler or CommandScriptHandler instead.

Since:

0.2.3

Version:

0.8.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_RESOURCE_ID The default value of resource ID.
static String	ENV_EXTENSION_PREFIX The prefix of environment variable names for each extension Blobs.
static String	KEY_ENV_PREFIX The configuration key prefix of environment variables.
static String	KEY_PROP_PREFIX The configuration key prefix of system or hadoop properties.
static String	KEY_RESOURCE The configuration key name of resource ID.

Method Summary

Modifier and Type	Method and Description
void	cleanUp(ExecutionMonitor monitor, ExecutionContext context) Cleanup the target environment.
void	execute(ExecutionMonitor monitor, ExecutionContext context, T script) Executes the specified script.
Map<String,String>	getEnvironmentVariables(ExecutionContext context, ExecutionScript script) Returns desired environment variables to execute scripts using this handler.
String	getHandlerId() Returns the ID of this handler.
Map<String,String>	getProperties(ExecutionContext context, ExecutionScript script) Returns desired system/hadoop properties to execute scripts using this handler.
String	getResourceId(ExecutionContext context, ExecutionScript script) Returns the ID of a resource which is used for executing this handler.
void	setUp(ExecutionMonitor monitor, ExecutionContext context) Setup the target environment.

Methods inherited from interface com.asakusafw.yaess.core.Service

configure

Field Detail

KEY_ENV_PREFIX

static final String KEY_ENV_PREFIX

The configuration key prefix of environment variables. This value can includes local environment variables in form of ${VARIABLE-NAME}.

See Also:

Constant Field Values

KEY_PROP_PREFIX

static final String KEY_PROP_PREFIX

The configuration key prefix of system or hadoop properties. This value can includes local environment variables in form of ${VARIABLE-NAME}.

Since:

0.2.6

See Also:

Constant Field Values

KEY_RESOURCE

static final String KEY_RESOURCE

The configuration key name of resource ID.

See Also:

Constant Field Values

DEFAULT_RESOURCE_ID

static final String DEFAULT_RESOURCE_ID

The default value of resource ID.

See Also:

Constant Field Values

ENV_EXTENSION_PREFIX

static final String ENV_EXTENSION_PREFIX

The prefix of environment variable names for each extension Blobs.

Since:

0.8.0

See Also:

Constant Field Values

Method Detail

getHandlerId

String getHandlerId()

Returns the ID of this handler.

Returns:

the ID

getResourceId

String getResourceId(ExecutionContext context,
                     ExecutionScript script)
              throws InterruptedException,
                     IOException

Returns the ID of a resource which is used for executing this handler.

Parameters:

context - the current execution context

script - the target script (nullable)

Returns:

the required resource ID

Throws:

InterruptedException - if this operation is interrupted

IOException - if failed to setup the target environment

getProperties

Map<String,String> getProperties(ExecutionContext context,
                                 ExecutionScript script)
                          throws InterruptedException,
                                 IOException

Returns desired system/hadoop properties to execute scripts using this handler.

Parameters:

context - the current execution context

script - the target script (nullable)

Returns:

desired system or hadoop properties

Throws:

InterruptedException - if this operation is interrupted

IOException - if failed to setup the target environment

Since:

0.2.6

getEnvironmentVariables

Map<String,String> getEnvironmentVariables(ExecutionContext context,
                                           ExecutionScript script)
                                    throws InterruptedException,
                                           IOException

Returns desired environment variables to execute scripts using this handler.

Parameters:

context - the current execution context

script - the target script (nullable)

Returns:

desired environment variables

Throws:

InterruptedException - if this operation is interrupted

IOException - if failed to setup the target environment

setUp

void setUp(ExecutionMonitor monitor,
           ExecutionContext context)
    throws InterruptedException,
           IOException

Setup the target environment.

Parameters:

monitor - the progress monitor of the operation

context - the current execution context

Throws:

InterruptedException - if this operation is interrupted

IOException - if failed to setup the target environment

execute

void execute(ExecutionMonitor monitor,
             ExecutionContext context,
             T script)
      throws InterruptedException,
             IOException

Executes the specified script.

Parameters:

monitor - the progress monitor of the execution

context - current execution context

script - target script

Throws:

InterruptedException - if the execution was interrupted

IOException - if execution was failed

cleanUp

void cleanUp(ExecutionMonitor monitor,
             ExecutionContext context)
      throws InterruptedException,
             IOException

Cleanup the target environment.

Parameters:

monitor - the progress monitor of the operation

context - the current execution context

Throws:

InterruptedException - if this operation is interrupted

IOException - if failed to setup the target environment