com.asakusafw.yaess.jsch

Class JschProcessExecutor

java.lang.Object

com.asakusafw.yaess.jsch.JschProcessExecutor

All Implemented Interfaces:

ProcessExecutor

public class JschProcessExecutor
extends Object
implements ProcessExecutor

An implementation of ProcessExecutor using JSch.

Since:

0.2.3

Version:

0.8.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_TEMPORARY_BLOB_PREFIX The default value of KEY_TEMPORARY_BLOB_PREFIX.
static String	KEY_HOST The key of host name.
static String	KEY_PASS_PHRASE The key of passphrase.
static String	KEY_PORT The key of port number.
static String	KEY_PRIVATE_KEY The key of path to the private key.
static String	KEY_TEMPORARY_BLOB_PREFIX The key of BLOB storage path prefix.
static String	KEY_USER The key of user name.

Constructor Summary

Constructors

Constructor and Description
JschProcessExecutor(String user, String host, Integer portOrNull, String privateKeyPath, String passPhraseOrNull) Creates a new instance.
JschProcessExecutor(String user, String host, Integer portOrNull, String privateKeyPath, String passPhraseOrNull, String temporaryBlobPrefix) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
int	execute(ExecutionContext context, List<String> commandLineTokens, Map<String,String> environmentVariables, Map<String,Blob> extensions, OutputStream output) Executes a process.
static JschProcessExecutor	extract(String servicePrefix, Map<String,String> configuration, VariableResolver variables) Extracts SSH profiles from configuration and returns a related executor.
String	getHost() Returns the remote host name.
String	getPassPhrase() Returns a pass phrase for private key.
Integer	getPort() Returns the remote port number.
String	getPrivateKey() Returns the path to the private key file.
String	getTemporaryBlobPrefix() Returns the BLOB storage remote path prefix.
String	getUser() Returns the remote user name.

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.basic.ProcessExecutor

execute, execute

Field Detail

KEY_USER

public static final String KEY_USER

The key of user name. This value can includes environment variables in form of ${VARIABLE-NAME}.

See Also:

Constant Field Values

KEY_HOST

public static final String KEY_HOST

The key of host name. This value can includes environment variables in form of ${VARIABLE-NAME}.

See Also:

Constant Field Values

KEY_PORT

public static final String KEY_PORT

The key of port number.

See Also:

Constant Field Values

KEY_PRIVATE_KEY

public static final String KEY_PRIVATE_KEY

The key of path to the private key. This value can includes environment variables in form of ${VARIABLE-NAME}.

See Also:

Constant Field Values

KEY_PASS_PHRASE

public static final String KEY_PASS_PHRASE

The key of passphrase.

See Also:

Constant Field Values

KEY_TEMPORARY_BLOB_PREFIX

public static final String KEY_TEMPORARY_BLOB_PREFIX

The key of BLOB storage path prefix.

Since:

0.8.0

See Also:

Constant Field Values

DEFAULT_TEMPORARY_BLOB_PREFIX

public static final String DEFAULT_TEMPORARY_BLOB_PREFIX

The default value of KEY_TEMPORARY_BLOB_PREFIX.

Since:

0.8.0

See Also:

Constant Field Values

Constructor Detail

JschProcessExecutor

public JschProcessExecutor(String user,
                           String host,
                           Integer portOrNull,
                           String privateKeyPath,
                           String passPhraseOrNull)
                    throws com.jcraft.jsch.JSchException

Creates a new instance.

Parameters:

user - remote user name

host - remote host name

portOrNull - remote port number (nullable)

privateKeyPath - path to private key file

passPhraseOrNull - passphrase for the private key (nullable)

Throws:

com.jcraft.jsch.JSchException - if failed to initialize SSH client

IllegalArgumentException - if some parameters were null

JschProcessExecutor

public JschProcessExecutor(String user,
                           String host,
                           Integer portOrNull,
                           String privateKeyPath,
                           String passPhraseOrNull,
                           String temporaryBlobPrefix)
                    throws com.jcraft.jsch.JSchException

Creates a new instance.

Parameters:

user - remote user name

host - remote host name

portOrNull - remote port number (nullable)

privateKeyPath - path to private key file

passPhraseOrNull - passphrase for the private key (nullable)

temporaryBlobPrefix - the temporary BLOB storage path prefix

Throws:

com.jcraft.jsch.JSchException - if failed to initialize SSH client

IllegalArgumentException - if some parameters were null

Since:

0.8.0

Method Detail

getUser

public String getUser()

Returns the remote user name.

Returns:

the user name

getHost

public String getHost()

Returns the remote host name.

Returns:

the host name

getPort

public Integer getPort()

Returns the remote port number.

Returns:

the port number, or null if is not specified

getPrivateKey

public String getPrivateKey()

Returns the path to the private key file.

Returns:

the path to the private key

getPassPhrase

public String getPassPhrase()

Returns a pass phrase for private key.

Returns:

the pass phrase, or null if is not specified

getTemporaryBlobPrefix

public String getTemporaryBlobPrefix()

Returns the BLOB storage remote path prefix.

Returns:

the BLOB storage remote path prefix

extract

public static JschProcessExecutor extract(String servicePrefix,
                                          Map<String,String> configuration,
                                          VariableResolver variables)
                                   throws com.jcraft.jsch.JSchException

Extracts SSH profiles from configuration and returns a related executor. This operation extracts following entries from configuration:

• remote user name
• remote host name
• remote port number (can omit)
• private key path
• KEY_PASS_PHRASE (can omit)

Parameters:

servicePrefix - prefix of configuration keys

configuration - target configuration

variables - variable resolver

Returns:

the created executor

Throws:

com.jcraft.jsch.JSchException - if failed to initialize SSH client

IllegalArgumentException - if configuration is invalid

execute

public int execute(ExecutionContext context,
                   List<String> commandLineTokens,
                   Map<String,String> environmentVariables,
                   Map<String,Blob> extensions,
                   OutputStream output)
            throws InterruptedException,
                   IOException

Description copied from interface: ProcessExecutor

Executes a process.

Specified by:

execute in interface ProcessExecutor

Parameters:

context - current execution context

commandLineTokens - target command

environmentVariables - environment variables

extensions - the extension BLOBs

output - information output

Returns:

exit code

Throws:

InterruptedException - if interrupted while waiting process exit

IOException - if failed to execute the command