com.asakusafw.yaess.core

Interface ExecutionScript

All Known Implementing Classes:

CommandScript, HadoopScript

public interface ExecutionScript

An base interface of execution script which represents each atomic execution in YAESS.

Since:

0.2.3

See Also:

ExecutionScriptHandler

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ExecutionScript.Kind Type of each ExecutionScript.
static class	ExecutionScript.PlaceholderResolver Resolves placeholders in script.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENV_ASAKUSA_HOME An environment variable name of Asakusa installation home.
static String	PLACEHOLDER_ARGUMENTS A placeholder name of the execution arguments.
static String	PLACEHOLDER_EXECUTION_ID A placeholder name of the execution ID.
static String	PLACEHOLDER_HOME A placeholder name of the Asakusa installed location.

Method Summary

Modifier and Type	Method and Description
Set<String>	getBlockerIds() Returns the IDs representing blockers of this script execution.
Map<String,String>	getEnvironmentVariables() Returns desired environment variables used in this execution.
String	getId() Returns the ID of this script execution.
ExecutionScript.Kind	getKind() Returns the kind of this script.
Set<String>	getSupportedExtensions() Returns the supported extension names.
boolean	isResolved() Returns whether this script is resolved.
ExecutionScript	resolve(ExecutionContext context, ExecutionScriptHandler<?> handler) Resolves placeholders defined in this script.

Field Detail

ENV_ASAKUSA_HOME

static final String ENV_ASAKUSA_HOME

An environment variable name of Asakusa installation home.

See Also:

Constant Field Values

PLACEHOLDER_HOME

static final String PLACEHOLDER_HOME

A placeholder name of the Asakusa installed location.

See Also:

Constant Field Values

PLACEHOLDER_EXECUTION_ID

static final String PLACEHOLDER_EXECUTION_ID

A placeholder name of the execution ID.

See Also:

Constant Field Values

PLACEHOLDER_ARGUMENTS

static final String PLACEHOLDER_ARGUMENTS

A placeholder name of the execution arguments.

See Also:

Constant Field Values

Method Detail

getKind

ExecutionScript.Kind getKind()

Returns the kind of this script.

Returns:

the kind of this script

getId

String getId()

Returns the ID of this script execution.

Returns:

the ID of this script execution

getBlockerIds

Set<String> getBlockerIds()

Returns the IDs representing blockers of this script execution.

Returns:

blockers' ID

getEnvironmentVariables

Map<String,String> getEnvironmentVariables()

Returns desired environment variables used in this execution.

Returns:

desired environment variables

getSupportedExtensions

Set<String> getSupportedExtensions()

Returns the supported extension names.

Returns:

the supported extension names

Since:

0.8.0

isResolved

boolean isResolved()

Returns whether this script is resolved.

Returns:

true for resolved instance, otherwise false

See Also:

resolve(ExecutionContext, ExecutionScriptHandler)

resolve

ExecutionScript resolve(ExecutionContext context,
                        ExecutionScriptHandler<?> handler)
                 throws InterruptedException,
                        IOException

Resolves placeholders defined in this script. This method does not change this object, but returns a resolved object.

Parameters:

context - current context

handler - target handler

Returns:

resolved object

Throws:

InterruptedException - if interrupted while resolving this object

IOException - if failed to resolve some entry

IllegalArgumentException - if some parameters were null

See Also:

isResolved()