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

brooklyn.util.internal.ssh
[Java] Class SshAbstractTool

java.lang.Object
  brooklyn.util.internal.ssh.SshAbstractTool
All Implemented Interfaces:
SshTool
public abstract class SshAbstractTool
Nested Class Summary
static class SshAbstractTool.AbstractToolBuilder

static interface SshAbstractTool.SshAction

 
Field Summary
protected boolean allocatePTY

protected java.lang.String host

protected java.io.File localTempDir

protected java.lang.String password

protected int port

protected java.lang.String privateKeyData

protected java.io.File privateKeyFile

protected java.lang.String privateKeyPassphrase

protected boolean strictHostKeyChecking

protected java.lang.String toString

protected java.lang.String user

 
Method Summary
protected java.lang.Object SshAbstractTool(SshAbstractTool.AbstractToolBuilder builder)

protected void closeWhispering(java.io.Closeable closeable, java.lang.Object context)

Similar to Guava's Closeables.closeQuitely, except logs exception at debug with context in message.
java.lang.String getHostAddress()

protected static java.lang.Object getMandatoryVal(java.util.Map map, ConfigKey keyC)

protected static java.lang.Object getMandatoryVal(java.util.Map map, java.lang.String key, java.lang.Class clazz)

@deprecated since 0.5.0 use ConfigKey variant
protected static java.lang.Object getOptionalVal(java.util.Map map, ConfigKey keyC)

protected static java.lang.Object getOptionalVal(java.util.Map map, ConfigKey keyC, java.lang.Object defaultValue)

returns the value of the key if specified, otherwise defaultValue
protected static java.lang.Object getOptionalVal(java.util.Map map, java.lang.String key, java.lang.Class clazz, java.lang.Object defaultVal)

@deprecated since 0.5.0 use ConfigKey variant
java.lang.String getUsername()

protected static java.lang.Boolean hasVal(java.util.Map map, ConfigKey keyC)

protected SshException propagate(java.lang.Exception e, java.lang.String message)

protected java.util.List toCommandSequence(java.util.List commands, java.util.Map env)

Merges the commands and env, into a single set of commands.

protected java.lang.String toScript(java.util.Map props, java.util.List commands, java.util.Map env)

java.lang.String toString()

protected static void warnOnDeprecated(java.util.Map props, java.lang.String deprecatedKey, java.lang.String correctKey)

protected java.io.File writeTempFile(java.io.InputStream contents)

protected java.io.File writeTempFile(java.lang.String contents)

protected java.io.File writeTempFile(byte[] contents)

 
Methods inherited from class java.lang.Object
java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()
 

Field Detail

allocatePTY

protected boolean allocatePTY

host

protected final java.lang.String host

localTempDir

protected java.io.File localTempDir

password

protected final java.lang.String password

port

protected final int port

privateKeyData

protected java.lang.String privateKeyData

privateKeyFile

protected java.io.File privateKeyFile

privateKeyPassphrase

protected java.lang.String privateKeyPassphrase

strictHostKeyChecking

protected boolean strictHostKeyChecking

toString

protected final java.lang.String toString

user

protected final java.lang.String user

 
Method Detail

SshAbstractTool

protected java.lang.Object SshAbstractTool(SshAbstractTool.AbstractToolBuilder builder)

closeWhispering

protected void closeWhispering(java.io.Closeable closeable, java.lang.Object context)
Similar to Guava's Closeables.closeQuitely, except logs exception at debug with context in message.

getHostAddress

public java.lang.String getHostAddress()

getMandatoryVal

protected static java.lang.Object getMandatoryVal(java.util.Map map, ConfigKey keyC)

getMandatoryVal

@Deprecated
protected static java.lang.Object getMandatoryVal(java.util.Map map, java.lang.String key, java.lang.Class clazz)
deprecated:
since 0.5.0 use ConfigKey variant

getOptionalVal

protected static java.lang.Object getOptionalVal(java.util.Map map, ConfigKey keyC)

getOptionalVal

protected static java.lang.Object getOptionalVal(java.util.Map map, ConfigKey keyC, java.lang.Object defaultValue)
returns the value of the key if specified, otherwise defaultValue

getOptionalVal

@Deprecated
protected static java.lang.Object getOptionalVal(java.util.Map map, java.lang.String key, java.lang.Class clazz, java.lang.Object defaultVal)
deprecated:
since 0.5.0 use ConfigKey variant

getUsername

public java.lang.String getUsername()

hasVal

protected static java.lang.Boolean hasVal(java.util.Map map, ConfigKey keyC)

propagate

protected SshException propagate(java.lang.Exception e, java.lang.String message)

toCommandSequence

protected java.util.List toCommandSequence(java.util.List commands, java.util.Map env)
Merges the commands and env, into a single set of commands. Also escapes the commands as required. Not all ssh servers handle "env", so instead convert env into exported variables

toScript

protected java.lang.String toScript(java.util.Map props, java.util.List commands, java.util.Map env)

toString

@Override
public java.lang.String toString()

warnOnDeprecated

protected static void warnOnDeprecated(java.util.Map props, java.lang.String deprecatedKey, java.lang.String correctKey)

writeTempFile

protected java.io.File writeTempFile(java.io.InputStream contents)

writeTempFile

protected java.io.File writeTempFile(java.lang.String contents)

writeTempFile

protected java.io.File writeTempFile(byte[] contents)

 

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