Overview  Package   Class  Deprecated  Index  Help 
Brooklyn
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | METHOD DETAIL: FIELD | METHOD

brooklyn.util.internal.ssh
[Java] Interface SshTool

brooklyn.util.internal.ssh.ShellTool
  brooklyn.util.internal.ssh.SshTool
All Superinterfaces:
ShellTool
public interface SshTool
extends ShellTool

Defines the methods available on the various different implementations of SSH, and configuration options which are also generally available.

The config keys in this class can be supplied (or their string equivalents, where the flags/props take Map) to influence configuration, either for the tool/session itself or for individual commands.

To specify some of these properties on a global basis, use the variants of the keys here contained in ConfigKeys (which are generally {

value:
#BROOKLYN_CONFIG_KEY_PREFIX} prefixed to the names of keys here).

Field Summary
static java.lang.String BROOKLYN_CONFIG_KEY_PREFIX

Public-facing global config keys for Brooklyn are defined in ConfigKeys, and have this prefix pre-prended to the config keys in this class.
static ConfigKey PROP_ALLOCATE_PTY

static ConfigKey PROP_CONNECT_TIMEOUT

static ConfigKey PROP_HOST

static ConfigKey PROP_LAST_ACCESS_DATE

static ConfigKey PROP_LAST_MODIFICATION_DATE

static ConfigKey PROP_PASSWORD

static ConfigKey PROP_PERMISSIONS

static ConfigKey PROP_PORT

static ConfigKey PROP_PRIVATE_KEY_DATA

static ConfigKey PROP_PRIVATE_KEY_FILE

static ConfigKey PROP_PRIVATE_KEY_PASSPHRASE

static ConfigKey PROP_SESSION_TIMEOUT

static ConfigKey PROP_SSH_RETRY_DELAY

static ConfigKey PROP_SSH_TRIES

static ConfigKey PROP_SSH_TRIES_TIMEOUT

static ConfigKey PROP_STRICT_HOST_KEY_CHECKING

static ConfigKey PROP_TOOL_CLASS

static ConfigKey PROP_USER

 
Fields inherited from interface ShellTool
PROP_DIRECT_HEADER, PROP_ERR_STREAM, PROP_LOCAL_TEMP_DIR, PROP_NO_EXTRA_OUTPUT, PROP_OUT_STREAM, PROP_RUN_AS_ROOT, PROP_SCRIPT_DIR, PROP_SCRIPT_HEADER, PROP_SEPARATOR
 
Method Summary
void connect()

@throws SshException
void connect(int maxAttempts)

int copyFromServer(java.util.Map props, java.lang.String pathAndFileOnRemoteServer, java.io.File local)

// * Reads from the file at the given path on the remote server
int copyToServer(java.util.Map props, java.io.File localFile, java.lang.String pathAndFileOnRemoteServer)

int copyToServer(java.util.Map props, java.io.InputStream contents, java.lang.String pathAndFileOnRemoteServer)

@see #copyToServer(Map, File, String)
int copyToServer(java.util.Map props, byte[] contents, java.lang.String pathAndFileOnRemoteServer)

void disconnect()

int execCommands(java.util.Map properties, java.util.List commands, java.util.Map env)

@see #execCommands(Map, List, Map)
int execCommands(java.util.Map properties, java.util.List commands)

int execScript(java.util.Map props, java.util.List commands, java.util.Map env)

@see #execScript(Map, List, Map)
int execScript(java.util.Map props, java.util.List commands)

boolean isConnected()

 
Methods inherited from interface ShellTool
execCommands, execCommands, execScript, execScript
 

Field Detail

BROOKLYN_CONFIG_KEY_PREFIX

public static final java.lang.String BROOKLYN_CONFIG_KEY_PREFIX
Public-facing global config keys for Brooklyn are defined in ConfigKeys, and have this prefix pre-prended to the config keys in this class.

PROP_ALLOCATE_PTY

public static final ConfigKey PROP_ALLOCATE_PTY

PROP_CONNECT_TIMEOUT

public static final ConfigKey PROP_CONNECT_TIMEOUT

PROP_HOST

public static final ConfigKey PROP_HOST

PROP_LAST_ACCESS_DATE

public static final ConfigKey PROP_LAST_ACCESS_DATE

PROP_LAST_MODIFICATION_DATE

public static final ConfigKey PROP_LAST_MODIFICATION_DATE

PROP_PASSWORD

public static final ConfigKey PROP_PASSWORD

PROP_PERMISSIONS

public static final ConfigKey PROP_PERMISSIONS

PROP_PORT

public static final ConfigKey PROP_PORT

PROP_PRIVATE_KEY_DATA

public static final ConfigKey PROP_PRIVATE_KEY_DATA

PROP_PRIVATE_KEY_FILE

public static final ConfigKey PROP_PRIVATE_KEY_FILE

PROP_PRIVATE_KEY_PASSPHRASE

public static final ConfigKey PROP_PRIVATE_KEY_PASSPHRASE

PROP_SESSION_TIMEOUT

public static final ConfigKey PROP_SESSION_TIMEOUT

PROP_SSH_RETRY_DELAY

public static final ConfigKey PROP_SSH_RETRY_DELAY

PROP_SSH_TRIES

public static final ConfigKey PROP_SSH_TRIES

PROP_SSH_TRIES_TIMEOUT

public static final ConfigKey PROP_SSH_TRIES_TIMEOUT

PROP_STRICT_HOST_KEY_CHECKING

public static final ConfigKey PROP_STRICT_HOST_KEY_CHECKING

PROP_TOOL_CLASS

public static final ConfigKey PROP_TOOL_CLASS

PROP_USER

public static final ConfigKey PROP_USER

 
Method Detail

connect

public void connect()
throws:
SshException

connect

public void connect(int maxAttempts)

copyFromServer

public int copyFromServer(java.util.Map props, java.lang.String pathAndFileOnRemoteServer, java.io.File local)
// * Reads from the file at the given path on the remote server. //

copyToServer

public int copyToServer(java.util.Map props, java.io.File localFile, java.lang.String pathAndFileOnRemoteServer)

copyToServer

public int copyToServer(java.util.Map props, java.io.InputStream contents, java.lang.String pathAndFileOnRemoteServer)
See Also:
copyToServer(Map, File, String)

copyToServer

public int copyToServer(java.util.Map props, byte[] contents, java.lang.String pathAndFileOnRemoteServer)

disconnect

public void disconnect()

execCommands

@Override
public int execCommands(java.util.Map properties, java.util.List commands, java.util.Map env)
See Also:
execCommands(Map, List, Map)

execCommands

* 

public int execCommands(java.util.Map properties, java.util.List commands)

execScript

@Override
public int execScript(java.util.Map props, java.util.List commands, java.util.Map env)
See Also:
execScript(Map, List, Map)

execScript

*/
public int execScript(java.util.Map props, java.util.List commands)

isConnected

public boolean isConnected()

 

Brooklyn Multi-Cloud Application Management Platform
brooklyncentral.github.com. Apache License. © 2012.