com.asakusafw.yaess.basic

Class ProcessCommandScriptHandler

java.lang.Object

com.asakusafw.yaess.core.ExecutionScriptHandlerBase

com.asakusafw.yaess.basic.ProcessCommandScriptHandler

All Implemented Interfaces:

CommandScriptHandler, ExecutionScriptHandler<CommandScript>, Service

Direct Known Subclasses:

BasicCommandScriptHandler, SshCommandScriptHandler

public abstract class ProcessCommandScriptHandler
extends ExecutionScriptHandlerBase
implements CommandScriptHandler

An abstract implementation of process-based CommandScriptHandler.

Profile format

# <position> = 0, 1, 2, ...
# <prefix command token> can contain "@[position],"
# this will be replaced as original command tokens (0-origin position)
command.<profile-name> = <subclass class name>
command.<profile-name>.env.ASAKUSA_HOME = ${ASAKUSA_HOME}
command.<profile-name>.command.<position> = $<prefix command token>
command.<profile-name>.env.<key> = $<extra environment variables>

Since:

0.2.3

Version:

0.2.6

Field Summary

Fields inherited from interface com.asakusafw.yaess.core.CommandScriptHandler

PROFILE_WILDCARD

Fields inherited from interface com.asakusafw.yaess.core.ExecutionScriptHandler

DEFAULT_RESOURCE_ID, ENV_EXTENSION_PREFIX, KEY_ENV_PREFIX, KEY_PROP_PREFIX, KEY_RESOURCE

Constructor Summary

Constructors

Constructor and Description
ProcessCommandScriptHandler()

Method Summary

Modifier and Type	Method and Description
void	cleanUp(ExecutionMonitor monitor, ExecutionContext context) Cleanup the target environment.
protected abstract void	configureExtension(ServiceProfile<?> profile) Configures this handler internally (extension point).
protected void	doConfigure(ServiceProfile<?> profile, Map<String,String> desiredProperties, Map<String,String> desiredEnvironmentVariables) Configures this handler internally (extention point).
void	execute(ExecutionMonitor monitor, ExecutionContext context, CommandScript script) Executes the specified script.
protected abstract ProcessExecutor	getCommandExecutor() Returns command executor for this handler (extension point).
void	setUp(ExecutionMonitor monitor, ExecutionContext context) Setup the target environment.

Methods inherited from class com.asakusafw.yaess.core.ExecutionScriptHandlerBase

configure, getEnvironmentVariables, getHandlerId, getProperties, getResourceId, voidCleanUp, voidSetUp

Methods inherited from class java.lang.Object

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

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

getEnvironmentVariables, getHandlerId, getProperties, getResourceId

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

configure

Constructor Detail

ProcessCommandScriptHandler

public ProcessCommandScriptHandler()

Method Detail

doConfigure

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

Description copied from class: ExecutionScriptHandlerBase

Configures this handler internally (extention point).

Specified by:

doConfigure in class ExecutionScriptHandlerBase

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

configureExtension

protected abstract void configureExtension(ServiceProfile<?> profile)
                                    throws InterruptedException,
                                           IOException

Configures this handler internally (extension point).

Parameters:

profile - the profile of this service

Throws:

InterruptedException - if interrupted in configuration

IOException - if failed to configure this service

getCommandExecutor

protected abstract ProcessExecutor getCommandExecutor()

Returns command executor for this handler (extension point).

Returns:

command executor

execute

public final void execute(ExecutionMonitor monitor,
                          ExecutionContext context,
                          CommandScript script)
                   throws InterruptedException,
                          IOException

Description copied from interface: ExecutionScriptHandler

Executes the specified script.

Specified by:

execute in interface ExecutionScriptHandler<CommandScript>

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

setUp

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

Description copied from class: ExecutionScriptHandlerBase

Setup the target environment.

Specified by:

setUp in interface ExecutionScriptHandler<CommandScript>

Overrides:

setUp in class ExecutionScriptHandlerBase

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

Description copied from class: ExecutionScriptHandlerBase

Cleanup the target environment.

Specified by:

cleanUp in interface ExecutionScriptHandler<CommandScript>

Overrides:

cleanUp in class ExecutionScriptHandlerBase

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