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 ShellAbstractTool

java.lang.Object
  brooklyn.util.internal.ssh.ShellAbstractTool
All Implemented Interfaces:
ShellTool
public abstract class ShellAbstractTool
Field Summary
protected java.io.File localTempDir

 
Constructor Summary
ShellAbstractTool(java.io.File localTempDir)

ShellAbstractTool()

 
Method Summary
protected static int asInt(java.lang.Integer input, int valueIfInputNull)

protected java.util.List buildRunScriptCommand(java.lang.String scriptPath, java.lang.Boolean noExtraOutput, java.lang.Boolean runAsRoot)

builds the command to run the given script; note that some modes require \$RESULT passed in order to access a variable, whereas most just need $
protected void closeWhispering(java.io.Closeable closeable, java.lang.Object context)

protected static void closeWhispering(java.io.Closeable closeable, java.lang.Object context1, java.lang.Object context2)

Similar to Guava's Closeables.closeQuitely, except logs exception at debug with context in message.
int execCommands(java.util.Map props, java.util.List commands)

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

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
protected static java.lang.Boolean hasVal(java.util.Map map, ConfigKey keyC)

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)

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

localTempDir

protected final java.io.File localTempDir

 
Constructor Detail

ShellAbstractTool

public ShellAbstractTool(java.io.File localTempDir)

ShellAbstractTool

public ShellAbstractTool()

 
Method Detail

asInt

protected static int asInt(java.lang.Integer input, int valueIfInputNull)

buildRunScriptCommand

protected java.util.List buildRunScriptCommand(java.lang.String scriptPath, java.lang.Boolean noExtraOutput, java.lang.Boolean runAsRoot)
builds the command to run the given script; note that some modes require \$RESULT passed in order to access a variable, whereas most just need $

closeWhispering

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

closeWhispering

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

execCommands

return input != null ? input : valueIfInputNull;
public int execCommands(java.util.Map props, java.util.List commands)

execScript

public int execCommands(Map props, List commands) {
public int execScript(java.util.Map props, java.util.List commands)

getMandatoryVal

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

getMandatoryVal

protected static  T getMandatoryVal(Map map, String key, Class clazz) {
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

protected static  T getOptionalVal(Map map, String key, Class clazz, T defaultVal) {
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

hasVal

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

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)

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.