com.asakusafw.windgate.hadoopfs.ssh

Class SshProfile

java.lang.Object

com.asakusafw.windgate.hadoopfs.ssh.SshProfile

public class SshProfile
extends Object

A structured profile for AbstractSshHadoopFsMirror.

Since:

0.2.2

Version:

0.7.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMAND_DELETE The remote 'delete' command path.
static String	COMMAND_GET The remote 'get' command path.
static String	COMMAND_PUT The remote 'put' command path.
static String	KEY_COMPRESSION The key of CompressionCodec class name.
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_TARGET The key of remote target installed path.
static String	KEY_USER The key of user name.
static String	PATH_BASE_TARGET The remote base target.
static String	PREFIX_ENV The key prefix of additional remote environment variables.

Constructor Summary

Constructors

Constructor and Description
SshProfile(String name, String target, String user, String host, int port, String privateKey, String passPhrase, org.apache.hadoop.io.compress.CompressionCodec compressionCodec, Map<String,String> env) Deprecated. Use SshProfile(String, String, String, String, int, String, String, Map) instead
SshProfile(String name, String target, String user, String host, int port, String privateKey, String passPhrase, Map<String,String> env) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
static SshProfile	convert(org.apache.hadoop.conf.Configuration configuration, ResourceProfile profile) Converts ResourceProfile into SshProfile.
org.apache.hadoop.io.compress.CompressionCodec	getCompressionCodec() Deprecated. from 0.7.0, WindGate does not use sequence files
String	getDeleteCommand() Returns the delete command.
Map<String,String>	getEnvironmentVariables() Returns the additional remote environment variables.
String	getGetCommand() Returns the get command.
String	getHost() Returns the target host name.
String	getPassPhrase() Returns the pass phrase of the getPrivateKey().
int	getPort() Return the target port.
String	getPrivateKey() Return the path to the private key file.
String	getPutCommand() Returns the put command.
String	getResourceName() Returns the resource name.
String	getTarget() Return the remote installation path.
String	getUser() Returns the user name.

Methods inherited from class java.lang.Object

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

Field Detail

PATH_BASE_TARGET

public static final String PATH_BASE_TARGET

The remote base target.

Since:

0.4.0

See Also:

Constant Field Values

COMMAND_GET

public static final String COMMAND_GET

The remote 'get' command path.

See Also:

Constant Field Values

COMMAND_PUT

public static final String COMMAND_PUT

The remote 'put' command path.

See Also:

Constant Field Values

COMMAND_DELETE

public static final String COMMAND_DELETE

The remote 'delete' command path.

See Also:

Constant Field Values

KEY_TARGET

public static final String KEY_TARGET

The key of remote target installed path.

See Also:

Constant Field Values

KEY_USER

public static final String KEY_USER

The key of user name.

See Also:

Constant Field Values

KEY_HOST

public static final String KEY_HOST

The key of host 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_COMPRESSION

public static final String KEY_COMPRESSION

The key of CompressionCodec class name.

See Also:

Constant Field Values

PREFIX_ENV

public static final String PREFIX_ENV

The key prefix of additional remote environment variables.

Since:

0.4.0

See Also:

Constant Field Values

Constructor Detail

SshProfile

@Deprecated
public SshProfile(String name,
                              String target,
                              String user,
                              String host,
                              int port,
                              String privateKey,
                              String passPhrase,
                              org.apache.hadoop.io.compress.CompressionCodec compressionCodec,
                              Map<String,String> env)

Deprecated. Use SshProfile(String, String, String, String, int, String, String, Map) instead

Creates a new instance.

Parameters:

name - the resource name

target - the remote target installed path

user - the connection user name

host - the connection target host

port - the connection target port

privateKey - the path to the private key file

passPhrase - the passphrase of target private key

compressionCodec - the compression codec, or null if does not compress

env - environment variables

Throws:

IllegalArgumentException - if any parameter is null

SshProfile

public SshProfile(String name,
                  String target,
                  String user,
                  String host,
                  int port,
                  String privateKey,
                  String passPhrase,
                  Map<String,String> env)

Creates a new instance.

Parameters:

name - the resource name

target - the remote target installed path

user - the connection user name

host - the connection target host

port - the connection target port

privateKey - the path to the private key file

passPhrase - the passphrase of target private key

env - environment variables

Throws:

IllegalArgumentException - if any parameter is null

Since:

0.7.0

Method Detail

convert

public static SshProfile convert(org.apache.hadoop.conf.Configuration configuration,
                                 ResourceProfile profile)

Converts ResourceProfile into SshProfile.

Parameters:

configuration - the current configuration

profile - target profile

Returns:

the converted profile

Throws:

IllegalArgumentException - if profile is not valid, or any parameter is null

getResourceName

public String getResourceName()

Returns the resource name.

Returns:

the resource name

getTarget

public String getTarget()

Return the remote installation path.

Returns:

the remote installation path

getGetCommand

public String getGetCommand()

Returns the get command.

Returns:

the get command

getPutCommand

public String getPutCommand()

Returns the put command.

Returns:

the put command

getDeleteCommand

public String getDeleteCommand()

Returns the delete command.

Returns:

the delete command

getUser

public String getUser()

Returns the user name.

Returns:

the user name

getHost

public String getHost()

Returns the target host name.

Returns:

the target host

getPort

public int getPort()

Return the target port.

Returns:

the target port

getPrivateKey

public String getPrivateKey()

Return the path to the private key file.

Returns:

the path to the private key file

getPassPhrase

public String getPassPhrase()

Returns the pass phrase of the getPrivateKey().

Returns:

the pass phrase

getEnvironmentVariables

public Map<String,String> getEnvironmentVariables()

Returns the additional remote environment variables.

Returns:

the remote environment variables

Since:

0.4.0

getCompressionCodec

@Deprecated
public org.apache.hadoop.io.compress.CompressionCodec getCompressionCodec()

Deprecated. from 0.7.0, WindGate does not use sequence files

Returns the compression codec of putting sequence files.

Returns:

the compression codec, or null if does not compress