SshMachineLocation (Apache Brooklyn)

java.lang.Object
- brooklyn.basic.AbstractBrooklynObject
- - brooklyn.location.basic.AbstractLocation
  - - brooklyn.location.basic.SshMachineLocation

All Implemented Interfaces:

BrooklynObject, BrooklynObjectInternal, Rebindable, Configurable, Identifiable, AddressableLocation, LocationInternal, HasHostGeoInfo, Location, MachineLocation, PortSupplier, WithMutexes, HasNetworkAddresses, java.io.Closeable, java.io.Serializable, java.lang.AutoCloseable

Direct Known Subclasses:

JcloudsSshMachineLocation, LocalhostMachineProvisioningLocation.LocalhostMachine
```
public class SshMachineLocation
extends AbstractLocation
implements MachineLocation, PortSupplier, WithMutexes, java.io.Closeable
```
Operations on a machine that is accessible via ssh.
We expose two ways of running scripts. The execCommands method passes lines to bash and is lightweight but fragile. The execScript method creates a script on the remote machine. It is portable but heavier.
Additionally there are routines to copyTo, copyFrom; and installTo (which tries a curl, and falls back to copyTo in event the source is accessible by the caller only).

See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObject
  BrooklynObject.TagSupport
- Nested classes/interfaces inherited from interface brooklyn.entity.trait.Configurable
  Configurable.ConfigurationSupport
- Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObjectInternal
  BrooklynObjectInternal.ConfigurationSupportInternal

Field Summary

Fields
Modifier and Type	Field and Description
`static java.util.Set<java.lang.String>`	`ALL_SSH_CONFIG_KEY_NAMES`
`static java.util.Set<ConfigKey.HasConfigKey<?>>`	`ALL_SSH_CONFIG_KEYS`
`static ConfigKey<java.lang.Boolean>`	`ALLOCATE_PTY`
`static ConfigKey<java.lang.Boolean>`	`CLOSE_CONNECTION`
`static ConfigKey<java.lang.Boolean>`	`DETECT_MACHINE_DETAILS`
`static ConfigKey<java.lang.String>`	`LOCAL_TEMP_DIR`
`static org.slf4j.Logger`	`LOG` Deprecated. since 0.7.0 shouldn't be public
`static ConfigKey<java.lang.String>`	`LOG_PREFIX`
`static org.slf4j.Logger`	`logSsh` Deprecated. since 0.7.0 shouldn't be public
`static ConfigKey<MachineDetails>`	`MACHINE_DETAILS`
`static ConfigKey<java.lang.Boolean>`	`NO_STDERR_LOGGING`
`static ConfigKey<java.lang.Boolean>`	`NO_STDOUT_LOGGING`
`static ConfigKey<java.lang.String>`	`PASSWORD`
`static ConfigKey<java.lang.String>`	`PRIVATE_KEY_DATA`
`static ConfigKey<java.lang.String>`	`PRIVATE_KEY_FILE`
`static ConfigKey<java.lang.String>`	`PRIVATE_KEY_PASSPHRASE`
`static java.util.Set<ConfigKey<?>>`	`REUSABLE_SSH_PROPS` Specifies config keys where a change in the value does not require a new SshTool instance, i.e.
`static ConfigKey<java.lang.String>`	`SCP_EXECUTABLE`
`static ConfigKey<java.lang.String>`	`SCRIPT_DIR`
`static ConfigKey<Duration>`	`SSH_CACHE_EXPIRY_DURATION`
`static java.util.Set<ConfigKey<?>>`	`SSH_CONFIG_GIVEN_TO_PROPS` The set of config keys on this location which become default values for properties when invoking an SSH operation.
`static ConfigKey<java.util.Map<java.lang.String,java.lang.Object>>`	`SSH_ENV_MAP`
`static ConfigKey<java.lang.String>`	`SSH_EXECUTABLE`
`static ConfigKey<java.lang.String>`	`SSH_HOST`
`static ConfigKey<java.lang.Integer>`	`SSH_PORT`
`static ConfigKey<java.io.OutputStream>`	`STDERR`
`static ConfigKey<java.io.OutputStream>`	`STDOUT`
`static ConfigKey<java.lang.String>`	`UNIQUE_ID`

Fields inherited from class brooklyn.location.basic.AbstractLocation
PARENT_LOCATION, TEMPORARY_LOCATION

Fields inherited from interface brooklyn.location.basic.LocationInternal
FINAL_SPEC, NAMED_SPEC_NAME, ORIGINAL_SPEC

Constructor Summary

Constructors
Constructor and Description

SshMachineLocation()

SshMachineLocation(java.util.Map properties)

Constructors
Constructor and Description
`SshMachineLocation()`
`SshMachineLocation(java.util.Map properties)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`acquireMutex(java.lang.String mutexId, java.lang.String description)` acquires a mutex, if available, otherwise blocks on its becoming available; caller must release after use
`void`	`close()`
`SshMachineLocation`	`configure(java.util.Map<?,?> properties)` Will set fields from flags, and put the remaining ones into the 'leftovers' map.
`int`	`copyFrom(java.util.Map<java.lang.String,?> props, java.lang.String remote, java.lang.String local)`
`int`	`copyFrom(java.lang.String remote, java.lang.String local)`
`int`	`copyTo(java.io.File src, java.io.File destination)`
`int`	`copyTo(java.io.File src, java.lang.String destination)`
`int`	`copyTo(java.io.InputStream src, long filesize, java.lang.String destination)`
`int`	`copyTo(java.io.InputStream src, java.lang.String destination)`
`int`	`copyTo(java.util.Map<java.lang.String,?> props, java.io.File src, java.io.File destination)`
`int`	`copyTo(java.util.Map<java.lang.String,?> props, java.io.File src, java.lang.String destination)`
`int`	`copyTo(java.util.Map<java.lang.String,?> props, java.io.InputStream src, long filesize, java.lang.String destination)`
`int`	`copyTo(java.util.Map<java.lang.String,?> props, java.io.InputStream src, java.lang.String destination)`
`int`	`copyTo(java.util.Map<java.lang.String,?> props, java.io.Reader src, java.lang.String destination)`
`int`	`copyTo(java.io.Reader src, java.lang.String destination)`
`int`	`execCommands(java.util.Map<java.lang.String,?> props, java.lang.String summaryForLogging, java.util.List<java.lang.String> commands)`
`int`	`execCommands(java.util.Map<java.lang.String,?> props, java.lang.String summaryForLogging, java.util.List<java.lang.String> commands, java.util.Map<java.lang.String,?> env)`
`int`	`execCommands(java.lang.String summaryForLogging, java.util.List<java.lang.String> commands)` Executes a set of commands, directly on the target machine (no wrapping in script).
`int`	`execCommands(java.lang.String summaryForLogging, java.util.List<java.lang.String> commands, java.util.Map<java.lang.String,?> env)`
`int`	`execScript(java.util.Map<java.lang.String,?> props, java.lang.String summaryForLogging, java.util.List<java.lang.String> commands)`
`int`	`execScript(java.util.Map<java.lang.String,?> props, java.lang.String summaryForLogging, java.util.List<java.lang.String> commands, java.util.Map<java.lang.String,?> env)`
`int`	`execScript(java.lang.String summaryForLogging, java.util.List<java.lang.String> commands)` Executes a set of commands, wrapped as a script sent to the remote machine.
`int`	`execScript(java.lang.String summaryForLogging, java.util.List<java.lang.String> commands, java.util.Map<java.lang.String,?> env)`
`java.security.KeyPair`	`findKeyPair()` returns the un-passphrased key-pair info if a key is being used, or else null
`java.lang.String`	`findPassword()` returns the password being used to log in, if a password is being used, or else null
`java.net.InetAddress`	`getAddress()` Return the single most appropriate address for this location.
`java.lang.String`	`getHostname()` note
`MachineDetails`	`getMachineDetails()`
`OsDetails`	`getOsDetails()`
`int`	`getPort()` port for SSHing
`java.util.Set<java.lang.String>`	`getPrivateAddresses()` All private IP addresses.
`java.util.Set<java.lang.String>`	`getPublicAddresses()` All public IP addresses, potentially including shared ips.
`com.google.common.net.HostAndPort`	`getSshHostAndPort()`
`java.lang.String`	`getUser()`
`boolean`	`hasMutex(java.lang.String mutexId)` returns true if the calling thread has the mutex with the given ID
`int`	`installTo(java.util.Map<java.lang.String,?> props, java.lang.String url, java.lang.String destPath)`
`int`	`installTo(ResourceUtils utils, java.util.Map<java.lang.String,?> props, java.lang.String url, java.lang.String destPath)` Installs the given URL at the indicated destination path.
`int`	`installTo(ResourceUtils loader, java.lang.String url, java.lang.String destPath)`
`int`	`installTo(java.lang.String url, java.lang.String destPath)`
`boolean`	`isSshable()`
`int`	`obtainPort(PortRange range)` Reserve a port for your application, with a port number in a specific range.
`boolean`	`obtainSpecificPort(int portNumber)` Reserve a specific port for an application.
`void`	`releaseMutex(java.lang.String mutexId)` releases a mutex, triggering another thread to use it or cleaning it up if no one else is waiting; this should only be called by the mutex owner (thread)
`void`	`releasePort(int portNumber)` Release a previously reserved port.
`java.lang.String`	`toString()` Default String representation is simplified name of class, together with selected fields.
`java.lang.String`	`toVerboseString()`
`boolean`	`tryAcquireMutex(java.lang.String mutexId, java.lang.String description)` acquires a mutex and returns true, if available; otherwise immediately returns false; caller must release after use if this returns true

Methods inherited from class brooklyn.location.basic.AbstractLocation
addChild, addExtension, config, containsLocation, equals, getAllConfig, getAllConfigBag, getChildren, getConfig, getConfig, getDisplayName, getExtension, getHostGeoInfo, getLocalConfigBag, getParent, getRawLocalConfigBag, getRebindSupport, hasConfig, hasExtension, hashCode, isManaged, onManagementStarted, onManagementStopped, removeChild, setConfig, setDisplayName, setHostGeoInfo, setManagementContext, setName, setParent, setParent, toMetadataRecord

Methods inherited from class brooklyn.basic.AbstractBrooklynObject
getCatalogItemId, getId, getManagementContext, getTagSupport, init, rebind, setCatalogItemId, tags

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

Methods inherited from interface brooklyn.location.Location
containsLocation, getAllConfig, getChildren, getConfig, getConfig, getDisplayName, getExtension, getId, getParent, hasConfig, hasExtension, setParent

Methods inherited from interface brooklyn.basic.BrooklynObject
getCatalogItemId, getTagSupport, tags

Methods inherited from interface brooklyn.entity.trait.Configurable
config, setConfig

Methods inherited from interface brooklyn.location.basic.LocationInternal
getManagementContext

Methods inherited from interface brooklyn.basic.BrooklynObjectInternal
setCatalogItemId

- Field Detail
  - LOG
```
public static final org.slf4j.Logger LOG
```
    Deprecated. since 0.7.0 shouldn't be public
  - logSsh
```
public static final org.slf4j.Logger logSsh
```
    Deprecated. since 0.7.0 shouldn't be public
  - SSH_CACHE_EXPIRY_DURATION
```
public static final ConfigKey<Duration> SSH_CACHE_EXPIRY_DURATION
```
  - MACHINE_DETAILS
```
public static final ConfigKey<MachineDetails> MACHINE_DETAILS
```
  - DETECT_MACHINE_DETAILS
```
public static final ConfigKey<java.lang.Boolean> DETECT_MACHINE_DETAILS
```
  - SSH_HOST
```
public static final ConfigKey<java.lang.String> SSH_HOST
```
  - SSH_PORT
```
public static final ConfigKey<java.lang.Integer> SSH_PORT
```
  - SSH_EXECUTABLE
```
public static final ConfigKey<java.lang.String> SSH_EXECUTABLE
```
  - SCP_EXECUTABLE
```
public static final ConfigKey<java.lang.String> SCP_EXECUTABLE
```
  - PASSWORD
```
public static final ConfigKey<java.lang.String> PASSWORD
```
  - PRIVATE_KEY_FILE
```
public static final ConfigKey<java.lang.String> PRIVATE_KEY_FILE
```
  - PRIVATE_KEY_DATA
```
public static final ConfigKey<java.lang.String> PRIVATE_KEY_DATA
```
  - PRIVATE_KEY_PASSPHRASE
```
public static final ConfigKey<java.lang.String> PRIVATE_KEY_PASSPHRASE
```
  - SCRIPT_DIR
```
public static final ConfigKey<java.lang.String> SCRIPT_DIR
```
  - SSH_ENV_MAP
```
public static final ConfigKey<java.util.Map<java.lang.String,java.lang.Object>> SSH_ENV_MAP
```
  - ALLOCATE_PTY
```
public static final ConfigKey<java.lang.Boolean> ALLOCATE_PTY
```
  - STDOUT
```
public static final ConfigKey<java.io.OutputStream> STDOUT
```
  - STDERR
```
public static final ConfigKey<java.io.OutputStream> STDERR
```
  - NO_STDOUT_LOGGING
```
public static final ConfigKey<java.lang.Boolean> NO_STDOUT_LOGGING
```
  - NO_STDERR_LOGGING
```
public static final ConfigKey<java.lang.Boolean> NO_STDERR_LOGGING
```
  - LOG_PREFIX
```
public static final ConfigKey<java.lang.String> LOG_PREFIX
```
  - LOCAL_TEMP_DIR
```
public static final ConfigKey<java.lang.String> LOCAL_TEMP_DIR
```
  - CLOSE_CONNECTION
```
public static final ConfigKey<java.lang.Boolean> CLOSE_CONNECTION
```
  - UNIQUE_ID
```
public static final ConfigKey<java.lang.String> UNIQUE_ID
```
  - REUSABLE_SSH_PROPS
```
public static final java.util.Set<ConfigKey<?>> REUSABLE_SSH_PROPS
```
    Specifies config keys where a change in the value does not require a new SshTool instance, i.e. they can be specified per command on the tool
  - ALL_SSH_CONFIG_KEYS
```
public static final java.util.Set<ConfigKey.HasConfigKey<?>> ALL_SSH_CONFIG_KEYS
```
  - ALL_SSH_CONFIG_KEY_NAMES
```
public static final java.util.Set<java.lang.String> ALL_SSH_CONFIG_KEY_NAMES
```
  - SSH_CONFIG_GIVEN_TO_PROPS
```
@Beta
public static final java.util.Set<ConfigKey<?>> SSH_CONFIG_GIVEN_TO_PROPS
```
    The set of config keys on this location which become default values for properties when invoking an SSH operation.
- Constructor Detail
  - SshMachineLocation
```
public SshMachineLocation()
```
  - SshMachineLocation
```
public SshMachineLocation(java.util.Map properties)
```
- Method Detail
  - configure
```
public SshMachineLocation configure(java.util.Map<?,?> properties)
```
    Description copied from class: AbstractBrooklynObject
    
    Will set fields from flags, and put the remaining ones into the 'leftovers' map. For some types, you can find unused config via ConfigBag.getUnusedConfig().
    To be overridden by AbstractEntity, AbstractLoation, AbstractPolicy, AbstractEnricher, etc.
    But should not be overridden by specific entity types. If you do, the entity may break in subsequent releases. Also note that if you require fields to be initialized you must do that in this method. You must *not* rely on field initializers because they may not run until *after* this method (this method is invoked by the constructor in this class, so initializers in subclasses will not have run when this overridden method is invoked.)
    
    Overrides:
    
    configure in class AbstractLocation
  - close
```
public void close()
           throws java.io.IOException
```
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    java.io.IOException
  - getAddress
```
public java.net.InetAddress getAddress()
```
    Description copied from interface: AddressableLocation
    
    Return the single most appropriate address for this location. (An implementation or sub-interface definition may supply more information on the precise semantics of the address.) Should not return null, but in some "special cases" (e.g. CloudFoundryLocation it may return null if the location is not configured correctly). Users should expect a non-null result and treat null as a programming error or misconfiguration. Implementors of this interface should strive to not return null (and then we'll remove this caveat from the javadoc!).
    
    Specified by:
    
    getAddress in interface AddressableLocation
    
    Specified by:
    
    getAddress in interface MachineLocation
    
    Returns:
    the machine's network address.
  - getHostname
```
public java.lang.String getHostname()
```
    Description copied from interface: HasNetworkAddresses
    
    note
    hostname is something that is set in the operating system. This value may or may not be set in DNS.
    
    Specified by:
    
    getHostname in interface HasNetworkAddresses
    
    Returns:
    hostname of the node, or null if unknown
  - getPublicAddresses
```
public java.util.Set<java.lang.String> getPublicAddresses()
```
    Description copied from interface: HasNetworkAddresses
    
    All public IP addresses, potentially including shared ips.
    
    Specified by:
    
    getPublicAddresses in interface HasNetworkAddresses
  - getPrivateAddresses
```
public java.util.Set<java.lang.String> getPrivateAddresses()
```
    Description copied from interface: HasNetworkAddresses
    
    All private IP addresses.
    
    Specified by:
    
    getPrivateAddresses in interface HasNetworkAddresses
  - getSshHostAndPort
```
public com.google.common.net.HostAndPort getSshHostAndPort()
```
  - getUser
```
public java.lang.String getUser()
```
  - getPort
```
public int getPort()
```
    port for SSHing
  - execCommands
```
public int execCommands(java.lang.String summaryForLogging,
               java.util.List<java.lang.String> commands)
```
    Executes a set of commands, directly on the target machine (no wrapping in script). Joined using ; by default.
    Stdout and stderr will be logged automatically to brooklyn.SSH logger, unless the flags 'noStdoutLogging' and 'noStderrLogging' are set. To set a logging prefix, use the flag 'logPrefix'.
    Currently runs the commands in an interactive/login shell by passing each as a line to bash. To terminate early, use:
```
 foo || exit 1
 
```
    It may be desirable instead, in some situations, to wrap as:
```
 { line1 ; } && { line2 ; } ...
 
```
    and run as a single command (possibly not as an interacitve/login shell) causing the script to exit on the first command which fails.
    Currently this has to be done by the caller. (If desired we can add a flag exitIfAnyNonZero to support this mode, and/or commandPrepend and commandAppend similar to (currently supported in SshjTool) separator.)
  - execCommands
```
public int execCommands(java.util.Map<java.lang.String,?> props,
               java.lang.String summaryForLogging,
               java.util.List<java.lang.String> commands)
```
  - execCommands
```
public int execCommands(java.lang.String summaryForLogging,
               java.util.List<java.lang.String> commands,
               java.util.Map<java.lang.String,?> env)
```
  - execCommands
```
public int execCommands(java.util.Map<java.lang.String,?> props,
               java.lang.String summaryForLogging,
               java.util.List<java.lang.String> commands,
               java.util.Map<java.lang.String,?> env)
```
  - execScript
```
public int execScript(java.lang.String summaryForLogging,
             java.util.List<java.lang.String> commands)
```
    Executes a set of commands, wrapped as a script sent to the remote machine.
    Stdout and stderr will be logged automatically to brooklyn.SSH logger, unless the flags 'noStdoutLogging' and 'noStderrLogging' are set. To set a logging prefix, use the flag 'logPrefix'.
  - execScript
```
public int execScript(java.util.Map<java.lang.String,?> props,
             java.lang.String summaryForLogging,
             java.util.List<java.lang.String> commands)
```
  - execScript
```
public int execScript(java.lang.String summaryForLogging,
             java.util.List<java.lang.String> commands,
             java.util.Map<java.lang.String,?> env)
```
  - execScript
```
public int execScript(java.util.Map<java.lang.String,?> props,
             java.lang.String summaryForLogging,
             java.util.List<java.lang.String> commands,
             java.util.Map<java.lang.String,?> env)
```
  - copyTo
```
public int copyTo(java.io.File src,
         java.io.File destination)
```
  - copyTo
```
public int copyTo(java.util.Map<java.lang.String,?> props,
         java.io.File src,
         java.io.File destination)
```
  - copyTo
```
public int copyTo(java.io.File src,
         java.lang.String destination)
```
  - copyTo
```
public int copyTo(java.util.Map<java.lang.String,?> props,
         java.io.File src,
         java.lang.String destination)
```
  - copyTo
```
public int copyTo(java.io.Reader src,
         java.lang.String destination)
```
  - copyTo
```
public int copyTo(java.util.Map<java.lang.String,?> props,
         java.io.Reader src,
         java.lang.String destination)
```
  - copyTo
```
public int copyTo(java.io.InputStream src,
         java.lang.String destination)
```
  - copyTo
```
public int copyTo(java.io.InputStream src,
         long filesize,
         java.lang.String destination)
```
  - copyTo
```
public int copyTo(java.util.Map<java.lang.String,?> props,
         java.io.InputStream src,
         long filesize,
         java.lang.String destination)
```
  - copyTo
```
public int copyTo(java.util.Map<java.lang.String,?> props,
         java.io.InputStream src,
         java.lang.String destination)
```
  - copyFrom
```
public int copyFrom(java.lang.String remote,
           java.lang.String local)
```
  - copyFrom
```
public int copyFrom(java.util.Map<java.lang.String,?> props,
           java.lang.String remote,
           java.lang.String local)
```
  - installTo
```
public int installTo(java.lang.String url,
            java.lang.String destPath)
```
  - installTo
```
public int installTo(java.util.Map<java.lang.String,?> props,
            java.lang.String url,
            java.lang.String destPath)
```
  - installTo
```
public int installTo(ResourceUtils loader,
            java.lang.String url,
            java.lang.String destPath)
```
  - installTo
```
public int installTo(ResourceUtils utils,
            java.util.Map<java.lang.String,?> props,
            java.lang.String url,
            java.lang.String destPath)
```
    Installs the given URL at the indicated destination path.
    Attempts to curl the source URL on the remote machine, then if that fails, loads locally (from classpath or file) and transfers.
    Use ArchiveUtils to handle directories and their contents properly. TODO allow s3://bucket/file URIs for AWS S3 resources TODO use PAX-URL style URIs for maven artifacts TODO use subtasks here for greater visibility?; deprecate in favour of SshTasks.installFromUrl?
    
    Parameters:
    utils - A ResourceUtils that can resolve the source URLs
    url - The source URL to be installed
    destPath - The file to be created on the destination
    See Also:
    ArchiveUtils.deploy(String, SshMachineLocation, String), ArchiveUtils.deploy(String, SshMachineLocation, String, String), ResourceUtils.getResourceFromUrl(String)
  - toString
```
public java.lang.String toString()
```
    Description copied from class: AbstractLocation
    
    Default String representation is simplified name of class, together with selected fields.
    
    Overrides:
    
    toString in class AbstractLocation
  - toVerboseString
```
public java.lang.String toVerboseString()
```
    Specified by:
    
    toVerboseString in interface Location
    
    Overrides:
    
    toVerboseString in class AbstractLocation
    
    Returns:
    meta-data about the location (usually a long line, or a small number of lines).
  - obtainSpecificPort
```
public boolean obtainSpecificPort(int portNumber)
```
    Description copied from interface: PortSupplier
    
    Reserve a specific port for an application. If your application requires a specific port - for example, port 80 for a web server - you should reserve this port before starting your application. Using this method, you will be able to detect if another application has already claimed this port number.
    
    Specified by:
    
    obtainSpecificPort in interface PortSupplier
    
    Parameters:
    portNumber - the required port number.
    
    Returns:
    true if the port was successfully reserved; false if it has been previously reserved.
    See Also:
    obtainPort(PortRange), PortRanges.ANY_HIGH_PORT
  - obtainPort
```
public int obtainPort(PortRange range)
```
    Description copied from interface: PortSupplier
    
    Reserve a port for your application, with a port number in a specific range. If your application requires a port, but it does not mind exactly which port number - for example, a port for internal JMX monitoring - call this method.
    
    Specified by:
    
    obtainPort in interface PortSupplier
    
    Parameters:
    range - the range of acceptable port numbers.
    
    Returns:
    the port number that has been reserved, or -1 if there was no available port in the acceptable range.
  - releasePort
```
public void releasePort(int portNumber)
```
    Description copied from interface: PortSupplier
    
    Release a previously reserved port.
    
    Specified by:
    
    releasePort in interface PortSupplier
    
    Parameters:
    portNumber - the port number from a call to PortSupplier.obtainPort(PortRange) or PortSupplier.obtainSpecificPort(int)
  - isSshable
```
public boolean isSshable()
```
  - getOsDetails
```
public OsDetails getOsDetails()
```
    Specified by:
    
    getOsDetails in interface MachineLocation
  - getMachineDetails
```
public MachineDetails getMachineDetails()
```
    Specified by:
    
    getMachineDetails in interface MachineLocation
  - acquireMutex
```
public void acquireMutex(java.lang.String mutexId,
                java.lang.String description)
                  throws RuntimeInterruptedException
```
    Description copied from interface: WithMutexes
    
    acquires a mutex, if available, otherwise blocks on its becoming available; caller must release after use
    
    Specified by:
    
    acquireMutex in interface WithMutexes
    
    Throws:
    
    RuntimeInterruptedException
  - tryAcquireMutex
```
public boolean tryAcquireMutex(java.lang.String mutexId,
                      java.lang.String description)
```
    Description copied from interface: WithMutexes
    
    acquires a mutex and returns true, if available; otherwise immediately returns false; caller must release after use if this returns true
    
    Specified by:
    
    tryAcquireMutex in interface WithMutexes
  - releaseMutex
```
public void releaseMutex(java.lang.String mutexId)
```
    Description copied from interface: WithMutexes
    
    releases a mutex, triggering another thread to use it or cleaning it up if no one else is waiting; this should only be called by the mutex owner (thread)
    
    Specified by:
    
    releaseMutex in interface WithMutexes
  - hasMutex
```
public boolean hasMutex(java.lang.String mutexId)
```
    Description copied from interface: WithMutexes
    
    returns true if the calling thread has the mutex with the given ID
    
    Specified by:
    
    hasMutex in interface WithMutexes
  - findKeyPair
```
public java.security.KeyPair findKeyPair()
```
    returns the un-passphrased key-pair info if a key is being used, or else null
  - findPassword
```
public java.lang.String findPassword()
```
    returns the password being used to log in, if a password is being used, or else null

Class SshMachineLocation

Nested Class Summary

Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObject

Nested classes/interfaces inherited from interface brooklyn.entity.trait.Configurable

Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObjectInternal

Field Summary

Fields inherited from class brooklyn.location.basic.AbstractLocation

Fields inherited from interface brooklyn.location.basic.LocationInternal

Constructor Summary

Method Summary

Methods inherited from class brooklyn.location.basic.AbstractLocation

Methods inherited from class brooklyn.basic.AbstractBrooklynObject

Methods inherited from class java.lang.Object

Methods inherited from interface brooklyn.location.Location

Methods inherited from interface brooklyn.basic.BrooklynObject

Methods inherited from interface brooklyn.entity.trait.Configurable

Methods inherited from interface brooklyn.location.basic.LocationInternal

Methods inherited from interface brooklyn.basic.BrooklynObjectInternal

Field Detail

LOG

logSsh

SSH_CACHE_EXPIRY_DURATION

MACHINE_DETAILS

DETECT_MACHINE_DETAILS

SSH_HOST

SSH_PORT

SSH_EXECUTABLE

SCP_EXECUTABLE

PASSWORD

PRIVATE_KEY_FILE

PRIVATE_KEY_DATA

PRIVATE_KEY_PASSPHRASE

SCRIPT_DIR

SSH_ENV_MAP

ALLOCATE_PTY

STDOUT

STDERR

NO_STDOUT_LOGGING

NO_STDERR_LOGGING

LOG_PREFIX

LOCAL_TEMP_DIR

CLOSE_CONNECTION

UNIQUE_ID

REUSABLE_SSH_PROPS

ALL_SSH_CONFIG_KEYS

ALL_SSH_CONFIG_KEY_NAMES

SSH_CONFIG_GIVEN_TO_PROPS

Constructor Detail

SshMachineLocation

SshMachineLocation

Method Detail

configure

close

getAddress

getHostname

note

getPublicAddresses

getPrivateAddresses

getSshHostAndPort

getUser

getPort

execCommands

execCommands

execCommands

execCommands

execScript

execScript

execScript

execScript

copyTo

copyTo

copyTo

copyTo

copyTo

copyTo

copyTo

copyTo

copyTo

copyTo

copyFrom