org.apache.accumulo.cluster

Class RemoteShellOptions

java.lang.Object

org.apache.accumulo.cluster.RemoteShellOptions

public class RemoteShellOptions
extends Object

Property-based configuration of options to control how SSH is performed. A properties file can be provided using SSH_PROPERTIES_FILE or using the normal system properties. Any relevant properties set in the system properties take precedence over the provided file.

Field Summary

Fields

Modifier and Type	Field and Description
protected Properties	properties
static String	SSH_COMMAND_DEFAULT
static String	SSH_COMMAND_KEY
static String	SSH_OPTIONS_DEFAULT
static String	SSH_OPTIONS_KEY
static String	SSH_PREFIX
static String	SSH_PROPERTIES_FILE
static String	SSH_USER_DEFAULT
static String	SSH_USER_KEY

Constructor Summary

Constructors

Constructor and Description
RemoteShellOptions()

Method Summary

Methods

Modifier and Type	Method and Description
String	getSshCommand() The explicit SSH executable to invoke
String	getSshOptions() Extra SSH options that can be provided
String	getUserName() Fetch the configured user to ssh as

Methods inherited from class java.lang.Object

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

Field Detail

SSH_PREFIX

public static final String SSH_PREFIX

See Also:

Constant Field Values

SSH_COMMAND_KEY

public static final String SSH_COMMAND_KEY

See Also:

Constant Field Values

SSH_COMMAND_DEFAULT

public static final String SSH_COMMAND_DEFAULT

See Also:

Constant Field Values

SSH_OPTIONS_KEY

public static final String SSH_OPTIONS_KEY

See Also:

Constant Field Values

SSH_OPTIONS_DEFAULT

public static final String SSH_OPTIONS_DEFAULT

See Also:

Constant Field Values

SSH_USER_KEY

public static final String SSH_USER_KEY

See Also:

Constant Field Values

SSH_USER_DEFAULT

public static final String SSH_USER_DEFAULT

See Also:

Constant Field Values

SSH_PROPERTIES_FILE

public static final String SSH_PROPERTIES_FILE

See Also:

Constant Field Values

properties

protected Properties properties

Constructor Detail

RemoteShellOptions

public RemoteShellOptions()

Method Detail

getUserName

public String getUserName()

Fetch the configured user to ssh as

Returns:

The user to SSH as, default SSH_USER_DEFAULT

getSshOptions

public String getSshOptions()

Extra SSH options that can be provided

Returns:

Any SSH options, default SSH_OPTIONS_DEFAULT

getSshCommand

public String getSshCommand()

The explicit SSH executable to invoke

Returns:

The configured SSH executable, default SSH_COMMAND_DEFAULT