com.asakusafw.yaess.jsch

Class SshCommandScriptHandler

java.lang.Object

com.asakusafw.yaess.core.ExecutionScriptHandlerBase

com.asakusafw.yaess.basic.ProcessCommandScriptHandler

com.asakusafw.yaess.jsch.SshCommandScriptHandler

All Implemented Interfaces:

CommandScriptHandler, ExecutionScriptHandler<CommandScript>, Service

public class SshCommandScriptHandler
extends ProcessCommandScriptHandler

Basic implementation of CommandScriptHandler using local processes.

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> = <this class name>
command.<profile-name>.command.<position> = $<prefix command token>
command.<profile-name>.ssh.user=asakusa
command.<profile-name>.ssh.host=localhost
command.<profile-name>.ssh.port=22
command.<profile-name>.ssh.privateKey=${HOME}/.ssh/id_dsa
command.<profile-name>.ssh.passPhrase=
command.<profile-name>.env.ASAKUSA_HOME = ${ASAKUSA_HOME}
command.<profile-name>.env.<key> = $<extra environment variables>

Since:

0.2.3

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
SshCommandScriptHandler()

Method Summary

Modifier and Type	Method and Description
protected void	configureExtension(ServiceProfile<?> profile) Configures this handler internally (extension point).
protected ProcessExecutor	getCommandExecutor() Returns command executor for this handler (extension point).

Methods inherited from class com.asakusafw.yaess.basic.ProcessCommandScriptHandler

cleanUp, doConfigure, execute, setUp

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

SshCommandScriptHandler

public SshCommandScriptHandler()

Method Detail

configureExtension

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

Description copied from class: ProcessCommandScriptHandler

Configures this handler internally (extension point).

Specified by:

configureExtension in class ProcessCommandScriptHandler

Parameters:

profile - the profile of this service

Throws:

InterruptedException - if interrupted in configuration

IOException - if failed to configure this service

getCommandExecutor

protected ProcessExecutor getCommandExecutor()

Description copied from class: ProcessCommandScriptHandler

Returns command executor for this handler (extension point).

Specified by:

getCommandExecutor in class ProcessCommandScriptHandler

Returns:

command executor