SshCliTool (Apache Brooklyn)

java.lang.Object
- brooklyn.util.internal.ssh.ShellAbstractTool
- - brooklyn.util.internal.ssh.SshAbstractTool
  - - brooklyn.util.internal.ssh.cli.SshCliTool

All Implemented Interfaces:

ShellTool, SshTool
```
public class SshCliTool
extends SshAbstractTool
implements SshTool
```
For ssh and scp commands, delegating to system calls.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SshCliTool.Builder<T extends SshCliTool,B extends SshCliTool.Builder<T,B>>
- Nested classes/interfaces inherited from class brooklyn.util.internal.ssh.SshAbstractTool
  SshAbstractTool.AbstractSshToolBuilder<T extends SshTool,B extends SshAbstractTool.AbstractSshToolBuilder<T,B>>, SshAbstractTool.SshAction<T>

Nested Classes
Modifier and Type	Class and Description
`static class`	`SshCliTool.Builder<T extends SshCliTool,B extends SshCliTool.Builder<T,B>>`

Field Summary

Fields
Modifier and Type	Field and Description
`static ConfigKey<java.lang.String>`	`PROP_SCP_EXECUTABLE`
`static ConfigKey<java.lang.String>`	`PROP_SSH_EXECUTABLE`
`static ConfigKey<java.lang.String>`	`PROP_SSH_FLAGS`

Fields inherited from interface brooklyn.util.internal.ssh.SshTool
BROOKLYN_CONFIG_KEY_PREFIX, PROP_ALLOCATE_PTY, PROP_CONNECT_TIMEOUT, PROP_HOST, PROP_LAST_ACCESS_DATE, PROP_LAST_MODIFICATION_DATE, PROP_OWNER_UID, PROP_PASSWORD, PROP_PERMISSIONS, PROP_PORT, PROP_PRIVATE_KEY_DATA, PROP_PRIVATE_KEY_FILE, PROP_PRIVATE_KEY_PASSPHRASE, PROP_SESSION_TIMEOUT, PROP_SSH_RETRY_DELAY, PROP_SSH_TRIES, PROP_SSH_TRIES_TIMEOUT, PROP_STRICT_HOST_KEY_CHECKING, PROP_TOOL_CLASS, PROP_USER

Fields inherited from interface brooklyn.util.internal.ssh.ShellTool
PROP_DIRECT_HEADER, PROP_ERR_STREAM, PROP_EXEC_ASYNC, PROP_EXEC_ASYNC_POLLING_TIMEOUT, PROP_EXEC_TIMEOUT, PROP_LOCAL_TEMP_DIR, PROP_NO_DELETE_SCRIPT, PROP_NO_EXTRA_OUTPUT, PROP_OUT_STREAM, PROP_RUN_AS_ROOT, PROP_SCRIPT_DIR, PROP_SCRIPT_HEADER, PROP_SEPARATOR, PROP_SUMMARY

Constructor Summary

Constructors
Constructor and Description

SshCliTool(java.util.Map<java.lang.String,?> map)

Constructors
Constructor and Description
`SshCliTool(java.util.Map<java.lang.String,?> map)`

Method Summary

Methods
Modifier and Type	Method and Description
`static SshCliTool.Builder<SshCliTool,?>`	`builder()`
`void`	`connect()`
`void`	`connect(int maxAttempts)`
`int`	`copyFromServer(java.util.Map<java.lang.String,?> props, java.lang.String pathAndFileOnRemoteServer, java.io.File localFile)` Copies the file from the server at the given path.
`int`	`copyToServer(java.util.Map<java.lang.String,?> props, byte[] contents, java.lang.String pathAndFileOnRemoteServer)`
`int`	`copyToServer(java.util.Map<java.lang.String,?> props, java.io.File f, java.lang.String pathAndFileOnRemoteServer)` Copies the file to the server at the given path.
`int`	`copyToServer(java.util.Map<java.lang.String,?> props, java.io.InputStream contents, java.lang.String pathAndFileOnRemoteServer)` Closes the given input stream before returning.
`void`	`disconnect()`
`int`	`execCommands(java.util.Map<java.lang.String,?> props, java.util.List<java.lang.String> commands, java.util.Map<java.lang.String,?> env)` Executes the set of commands using ssh exec.
`int`	`execScript(java.util.Map<java.lang.String,?> props, java.util.List<java.lang.String> commands, java.util.Map<java.lang.String,?> env)` Executes the set of commands in a shell script.
`boolean`	`isConnected()`

Methods inherited from class brooklyn.util.internal.ssh.SshAbstractTool
getHostAddress, getUsername, toString

Methods inherited from class brooklyn.util.internal.ssh.ShellAbstractTool
execCommands, execScript, getOptionalVal

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface brooklyn.util.internal.ssh.SshTool
execCommands, execScript

- Field Detail
  - PROP_SSH_EXECUTABLE
```
public static final ConfigKey<java.lang.String> PROP_SSH_EXECUTABLE
```
  - PROP_SSH_FLAGS
```
public static final ConfigKey<java.lang.String> PROP_SSH_FLAGS
```
  - PROP_SCP_EXECUTABLE
```
public static final ConfigKey<java.lang.String> PROP_SCP_EXECUTABLE
```
- Constructor Detail
  - SshCliTool
```
public SshCliTool(java.util.Map<java.lang.String,?> map)
```
- Method Detail
  - builder
```
public static SshCliTool.Builder<SshCliTool,?> builder()
```
  - connect
```
public void connect()
```
    Specified by:
    
    connect in interface SshTool
  - connect
```
public void connect(int maxAttempts)
```
    Specified by:
    
    connect in interface SshTool
  - disconnect
```
public void disconnect()
```
    Specified by:
    
    disconnect in interface SshTool
  - isConnected
```
public boolean isConnected()
```
    Specified by:
    
    isConnected in interface SshTool
  - copyToServer
```
public int copyToServer(java.util.Map<java.lang.String,?> props,
               byte[] contents,
               java.lang.String pathAndFileOnRemoteServer)
```
    Specified by:
    
    copyToServer in interface SshTool
    
    See Also:
    SshTool.copyToServer(Map, File, String)
  - copyToServer
```
public int copyToServer(java.util.Map<java.lang.String,?> props,
               java.io.InputStream contents,
               java.lang.String pathAndFileOnRemoteServer)
```
    Description copied from interface: SshTool
    
    Closes the given input stream before returning. Consider using KnownSizeInputStream for efficiency when the size of the stream is known.
    
    Specified by:
    
    copyToServer in interface SshTool
    
    See Also:
    SshTool.copyToServer(Map, File, String)
  - copyToServer
```
public int copyToServer(java.util.Map<java.lang.String,?> props,
               java.io.File f,
               java.lang.String pathAndFileOnRemoteServer)
```
    Description copied from interface: SshTool
    Copies the file to the server at the given path. If path is null, empty, '.', '..', or ends with '/' then file name is used.
    The file will not preserve the permission of last _access_ date. Optional properties are:
    - 'permissions' (e.g. "0644") - see SshTool.PROP_PERMISSIONS
    - 'lastModificationDate' see SshTool.PROP_LAST_MODIFICATION_DATE; not supported by all SshTool implementations
    - 'lastAccessDate' see SshTool.PROP_LAST_ACCESS_DATE; not supported by all SshTool implementations
    Specified by:
    
    copyToServer in interface SshTool
    
    Returns:
    exit code (not supported by all SshTool implementations, usually throwing on error; sometimes possibly returning 0 even on error (?) )
  - copyFromServer
```
public int copyFromServer(java.util.Map<java.lang.String,?> props,
                 java.lang.String pathAndFileOnRemoteServer,
                 java.io.File localFile)
```
    Description copied from interface: SshTool
    
    Copies the file from the server at the given path.
    
    Specified by:
    
    copyFromServer in interface SshTool
    
    Returns:
    exit code (not supported by all SshTool implementations, usually throwing on error; sometimes possibly returning 0 even on error (?) )
  - execScript
```
public int execScript(java.util.Map<java.lang.String,?> props,
             java.util.List<java.lang.String> commands,
             java.util.Map<java.lang.String,?> env)
```
    Description copied from interface: ShellTool
    Executes the set of commands in a shell script. Blocks until completion.
    Optional properties are the same common ones as for ShellTool.execCommands(Map, List, Map) with the addition of:
    - ShellTool.PROP_RUN_AS_ROOT
    - ShellTool.PROP_SCRIPT_DIR
    Specified by:
    
    execScript in interface ShellTool
    
    Specified by:
    
    execScript in interface SshTool
    
    Returns:
    exit status of script
    See Also:
    #execScript(Map, List, Map)}
  - execCommands
```
public int execCommands(java.util.Map<java.lang.String,?> props,
               java.util.List<java.lang.String> commands,
               java.util.Map<java.lang.String,?> env)
```
    Description copied from interface: ShellTool
    Executes the set of commands using ssh exec. This is generally more efficient than ssh shell mode (cf ShellTool.execScript(Map, List, Map)), but is not suitable if you need env values which are only set on a fully-fledged shell, or if you want the entire block executed with root permission. Common optional properties (which also apply to ShellTool.execScript(Map, List, Map)) are:
    - ShellTool.PROP_OUT_STREAM
    - ShellTool.PROP_ERR_STREAM
    - ShellTool.PROP_SEPARATOR (for some modes)
    - ShellTool.PROP_NO_EXTRA_OUTPUT (often there is no extra output here)
    Note that ShellTool.PROP_RUN_AS_ROOT is not typically supported here. Prefer ShellTool.execScript(Map, List, Map)).
    Specified by:
    
    execCommands in interface ShellTool
    
    Specified by:
    
    execCommands in interface SshTool
    
    Returns:
    exit status of commands
    See Also:
    #execCommands(Map, List, Map)}

Class SshCliTool

Nested Class Summary

Nested classes/interfaces inherited from class brooklyn.util.internal.ssh.SshAbstractTool

Field Summary

Fields inherited from interface brooklyn.util.internal.ssh.SshTool

Fields inherited from interface brooklyn.util.internal.ssh.ShellTool

Constructor Summary

Method Summary

Methods inherited from class brooklyn.util.internal.ssh.SshAbstractTool

Methods inherited from class brooklyn.util.internal.ssh.ShellAbstractTool

Methods inherited from class java.lang.Object

Methods inherited from interface brooklyn.util.internal.ssh.SshTool

Field Detail

PROP_SSH_EXECUTABLE

PROP_SSH_FLAGS

PROP_SCP_EXECUTABLE

Constructor Detail

SshCliTool

Method Detail

builder

connect

connect

disconnect

isConnected

copyToServer

copyToServer

copyToServer

copyFromServer

execScript

execCommands