Brooklyn

brooklyn.util.internal.ssh.cli
[Java] Class SshCliTool

java.lang.Object
  brooklyn.util.internal.ssh.ShellAbstractTool
      brooklyn.util.internal.ssh.SshAbstractTool
          brooklyn.util.internal.ssh.cli.SshCliTool
All Implemented Interfaces:
SshTool

public class SshCliTool
extends SshAbstractTool

For ssh and scp commands, delegating to system calls.


Nested Class Summary
static class SshCliTool.Builder

 
Field Summary
static ConfigKey PROP_SCP_EXECUTABLE

static ConfigKey PROP_SSH_EXECUTABLE

static ConfigKey PROP_SSH_FLAGS

 
Fields inherited from class SshAbstractTool
allocatePTY, host, password, port, privateKeyData, privateKeyFile, privateKeyPassphrase, strictHostKeyChecking, toString, user
 
Fields inherited from class ShellAbstractTool
localTempDir
 
Method Summary
java.lang.Object SshCliTool(java.util.Map map)

static SshCliTool.Builder builder()

void connect()

void connect(int maxAttempts)

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

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

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

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

void disconnect()

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

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

boolean isConnected()

 
Methods inherited from class SshAbstractTool
SshAbstractTool, getHostAddress, getUsername, propagate, toString
 
Methods inherited from class ShellAbstractTool
asInt, buildRunScriptCommand, closeWhispering, closeWhispering, execCommands, execScript, getMandatoryVal, getMandatoryVal, getOptionalVal, getOptionalVal, getOptionalVal, hasVal, toCommandSequence, toScript, warnOnDeprecated, writeTempFile, writeTempFile, writeTempFile
 

Field Detail

PROP_SCP_EXECUTABLE

public static final ConfigKey PROP_SCP_EXECUTABLE


PROP_SSH_EXECUTABLE

public static final ConfigKey PROP_SSH_EXECUTABLE


PROP_SSH_FLAGS

public static final ConfigKey PROP_SSH_FLAGS


 
Method Detail

SshCliTool

public java.lang.Object SshCliTool(java.util.Map map)


builder

public static SshCliTool.Builder builder()


connect

public void connect() {
public void connect()


connect

// no-op
public void connect(int maxAttempts)


copyFromServer

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


copyToServer

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


copyToServer

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


copyToServer

if (hasVal(props, PROP_LAST_ACCESS_DATE)) {
public int copyToServer(java.util.Map props, java.io.File f, java.lang.String pathAndFileOnRemoteServer)


disconnect

// no-op
public void disconnect()


execCommands

return execScript(props2, commands, env);
public int execCommands(java.util.Map props, java.util.List commands, java.util.Map env)


execScript

Boolean noExtraOutput = getOptionalVal(props, PROP_NO_EXTRA_OUTPUT);
public int execScript(java.util.Map props, java.util.List commands, java.util.Map env)


isConnected

}
public boolean isConnected()


 

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