com.asakusafw.yaess.core

Class ExecutionScriptHandlerBase

java.lang.Object

com.asakusafw.yaess.core.ExecutionScriptHandlerBase

All Implemented Interfaces:

Service

Direct Known Subclasses:

ProcessCommandScriptHandler, ProcessHadoopScriptHandler, QueueHadoopScriptHandler

public abstract class ExecutionScriptHandlerBase
extends Object
implements Service

A skeletal implementation of ExecutionScriptHandler. Note that this class does not implement ExecutionScriptHandler, so that subclasses must implement HadoopScriptHandler or CommandScriptHandler.

Since:

0.2.3

Version:

0.2.6

Constructor Summary

Constructors

Constructor and Description
ExecutionScriptHandlerBase()

Method Summary

Modifier and Type	Method and Description
void	cleanUp(ExecutionMonitor monitor, ExecutionContext context) Cleanup the target environment.
void	configure(ServiceProfile<?> profile) Configures this service.
protected abstract void	doConfigure(ServiceProfile<?> profile, Map<String,String> desiredProperties, Map<String,String> desiredEnvironmentVariables) Configures this handler internally (extention point).
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.
protected void	voidCleanUp(ExecutionContext context) Performs as cleanUp(ExecutionMonitor, ExecutionContext) that does nothing.
protected void	voidSetUp(ExecutionContext context) Performs as setUp(ExecutionMonitor, ExecutionContext) that does nothing.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutionScriptHandlerBase

public ExecutionScriptHandlerBase()

Method Detail

configure

public final void configure(ServiceProfile<?> profile)
                     throws InterruptedException,
                            IOException

Description copied from interface: Service

Configures this service. This method will be invoked only once when this instance is created from the profile.

Specified by:

configure in interface Service

Parameters:

profile - the profile of this service

Throws:

InterruptedException - if interrupted in configuration

IOException - if failed to configure this service

getHandlerId

public final String getHandlerId()

Returns the ID of this handler.

Returns:

the ID

doConfigure

protected abstract void doConfigure(ServiceProfile<?> profile,
                                    Map<String,String> desiredProperties,
                                    Map<String,String> desiredEnvironmentVariables)
                             throws InterruptedException,
                                    IOException

Configures this handler internally (extention point).

Parameters:

profile - the profile of this service

desiredProperties - the current desired system/hadoop properties (configurable)

desiredEnvironmentVariables - the current desired environment variables (configurable)

Throws:

InterruptedException - if interrupted in configuration

IOException - if failed to configure this service

getResourceId

public final 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

public 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

getEnvironmentVariables

public 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

public 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

cleanUp

public 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

voidSetUp

protected final void voidSetUp(ExecutionContext context)

Performs as setUp(ExecutionMonitor, ExecutionContext) that does nothing.

Parameters:

context - current context

Since:

0.4.0

voidCleanUp

protected final void voidCleanUp(ExecutionContext context)

Performs as cleanUp(ExecutionMonitor, ExecutionContext) that does nothing.

Parameters:

context - current context

Since:

0.4.0