JcloudsSshMachineLocation (Apache Brooklyn)

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractJcloudsSubnetSshMachineLocation
```
public class JcloudsSshMachineLocation
extends SshMachineLocation
implements JcloudsMachineLocation
```
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 inherited from class brooklyn.location.basic.SshMachineLocation
  ALL_SSH_CONFIG_KEY_NAMES, ALL_SSH_CONFIG_KEYS, ALLOCATE_PTY, CLOSE_CONNECTION, DETECT_MACHINE_DETAILS, LOCAL_TEMP_DIR, LOG_PREFIX, logSsh, MACHINE_DETAILS, NO_STDERR_LOGGING, NO_STDOUT_LOGGING, PASSWORD, PRIVATE_KEY_DATA, PRIVATE_KEY_FILE, PRIVATE_KEY_PASSPHRASE, REUSABLE_SSH_PROPS, SCP_EXECUTABLE, SCRIPT_DIR, SSH_CACHE_EXPIRY_DURATION, SSH_CONFIG_GIVEN_TO_PROPS, SSH_ENV_MAP, SSH_EXECUTABLE, SSH_HOST, SSH_PORT, STDERR, STDOUT, 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
`JcloudsSshMachineLocation()`
`JcloudsSshMachineLocation(java.util.Map<?,?> flags, JcloudsLocation jcloudsParent, org.jclouds.compute.domain.NodeMetadata node)` Deprecated. since 0.6; use LocationSpec (which calls no-arg constructor)

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`execRemoteScript(java.lang.String... commands)` uses submitRunScript to execute the commands, and throws error if it fails or returns non-zero
`java.lang.String`	`getHostname()` note
`java.lang.String`	`getJcloudsId()`
`org.jclouds.compute.domain.NodeMetadata`	`getNode()`
`JcloudsLocation`	`getParent()` Get the 'parent' of this location.
`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.
`java.lang.String`	`getSubnetHostname()` In most clouds, the public hostname is the only way to ensure VMs in different zones can access each other.
`java.lang.String`	`getSubnetIp()` returns an IP for use internally within a subnet / VPC
`org.jclouds.compute.domain.Template`	`getTemplate()`
`void`	`init()` Called by framework (in new-style instances where spec was used) after configuring etc, but before a reference to this instance is shared.
`void`	`rebind()` Called by framework on rebind (in new-style instances): after configuring, but before the instance is managed, and before adjuncts are attached to entities, and before a reference to an object is shared.
`com.google.common.util.concurrent.ListenableFuture<org.jclouds.compute.domain.ExecResponse>`	`submitRunScript(org.jclouds.scriptbuilder.domain.Statement script)`
`com.google.common.util.concurrent.ListenableFuture<org.jclouds.compute.domain.ExecResponse>`	`submitRunScript(org.jclouds.scriptbuilder.domain.Statement script, org.jclouds.compute.options.RunScriptOptions options)`
`com.google.common.util.concurrent.ListenableFuture<org.jclouds.compute.domain.ExecResponse>`	`submitRunScript(java.lang.String... statements)` executes the given statements on the server using jclouds ScriptBuilder, wrapping in a script which is polled periodically.
`java.util.Map<java.lang.String,java.lang.String>`	`toMetadataRecord()` Get a record of the metadata of this location.
`java.lang.String`	`toVerboseString()`
`java.lang.String`	`waitForPassword()` Retrieves the password for this VM, if one exists.

Methods inherited from class brooklyn.location.basic.SshMachineLocation
acquireMutex, close, configure, copyFrom, copyFrom, copyTo, copyTo, copyTo, copyTo, copyTo, copyTo, copyTo, copyTo, copyTo, copyTo, execCommands, execCommands, execCommands, execCommands, execScript, execScript, execScript, execScript, findKeyPair, findPassword, getAddress, getMachineDetails, getOsDetails, getPort, getSshHostAndPort, getUser, hasMutex, installTo, installTo, installTo, installTo, isSshable, obtainPort, obtainSpecificPort, releaseMutex, releasePort, toString, tryAcquireMutex

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

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

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

Methods inherited from interface brooklyn.location.jclouds.JcloudsMachineLocation
getPort, getUser

Methods inherited from interface brooklyn.location.MachineLocation
getAddress, getMachineDetails, getOsDetails

Methods inherited from interface brooklyn.location.Location
containsLocation, getAllConfig, getChildren, getConfig, getConfig, getDisplayName, getExtension, getId, 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

- Constructor Detail
  - JcloudsSshMachineLocation
```
public JcloudsSshMachineLocation()
```
  - JcloudsSshMachineLocation
```
@Deprecated
public JcloudsSshMachineLocation(java.util.Map<?,?> flags,
                                    JcloudsLocation jcloudsParent,
                                    org.jclouds.compute.domain.NodeMetadata node)
```
    Deprecated. since 0.6; use LocationSpec (which calls no-arg constructor)
- Method Detail
  - init
```
public void init()
```
    Description copied from class: AbstractBrooklynObject
    Called by framework (in new-style instances where spec was used) after configuring etc, but before a reference to this instance is shared.
    To preserve backwards compatibility for if the instance is constructed directly, one can call the code below, but that means it will be called after references to this policy have been shared with other entities.
```
 if (isLegacyConstruction()) {
     init();
 }
 
 
```
    Overrides:
    
    init in class AbstractBrooklynObject
  - rebind
```
public void rebind()
```
    Description copied from class: AbstractBrooklynObject
    Called by framework on rebind (in new-style instances):
    - after configuring, but
    - before the instance is managed, and
    - before adjuncts are attached to entities, and
    - before a reference to an object is shared.
    Note that AbstractBrooklynObject.init() will not be called on rebind.
    If you need to intercept behaviour after adjuncts are attached, consider AbstractEntity.onManagementStarting() (but probably worth raising a discussion on the mailing list!)
    Overrides:
    
    rebind in class AbstractBrooklynObject
  - toVerboseString
```
public java.lang.String toVerboseString()
```
    Specified by:
    
    toVerboseString in interface Location
    
    Overrides:
    
    toVerboseString in class SshMachineLocation
    
    Returns:
    meta-data about the location (usually a long line, or a small number of lines).
  - getNode
```
public org.jclouds.compute.domain.NodeMetadata getNode()
```
    Specified by:
    
    getNode in interface JcloudsMachineLocation
  - getTemplate
```
public org.jclouds.compute.domain.Template getTemplate()
```
    Specified by:
    
    getTemplate in interface JcloudsMachineLocation
  - getParent
```
public JcloudsLocation getParent()
```
    Description copied from interface: Location
    
    Get the 'parent' of this location. Locations are organized into a tree hierarchy, and this method will return a reference to the parent of this location, or null if this location is the tree root.
    
    Specified by:
    
    getParent in interface JcloudsMachineLocation
    
    Specified by:
    
    getParent in interface Location
    
    Overrides:
    
    getParent in class AbstractLocation
    
    Returns:
    a reference to the parent of this location, or null if this location is the tree root.
  - 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
    
    Overrides:
    
    getHostname in class SshMachineLocation
    
    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
    
    Overrides:
    
    getPublicAddresses in class SshMachineLocation
  - getPrivateAddresses
```
public java.util.Set<java.lang.String> getPrivateAddresses()
```
    Description copied from interface: HasNetworkAddresses
    
    All private IP addresses.
    
    Specified by:
    
    getPrivateAddresses in interface HasNetworkAddresses
    
    Overrides:
    
    getPrivateAddresses in class SshMachineLocation
  - getSubnetHostname
```
public java.lang.String getSubnetHostname()
```
    In most clouds, the public hostname is the only way to ensure VMs in different zones can access each other.
    
    Specified by:
    
    getSubnetHostname in interface HasSubnetHostname
    
    Specified by:
    
    getSubnetHostname in interface JcloudsMachineLocation
  - getSubnetIp
```
public java.lang.String getSubnetIp()
```
    Description copied from interface: HasSubnetHostname
    
    returns an IP for use internally within a subnet / VPC
    
    Specified by:
    
    getSubnetIp in interface HasSubnetHostname
  - getJcloudsId
```
public java.lang.String getJcloudsId()
```
    Specified by:
    
    getJcloudsId in interface JcloudsMachineLocation
  - submitRunScript
```
public com.google.common.util.concurrent.ListenableFuture<org.jclouds.compute.domain.ExecResponse> submitRunScript(java.lang.String... statements)
```
    executes the given statements on the server using jclouds ScriptBuilder, wrapping in a script which is polled periodically. the output is returned once the script completes (disadvantage compared to other methods) but the process is nohupped and the SSH session is not kept, so very useful for long-running processes
  - submitRunScript
```
public com.google.common.util.concurrent.ListenableFuture<org.jclouds.compute.domain.ExecResponse> submitRunScript(org.jclouds.scriptbuilder.domain.Statement script)
```
  - submitRunScript
```
public com.google.common.util.concurrent.ListenableFuture<org.jclouds.compute.domain.ExecResponse> submitRunScript(org.jclouds.scriptbuilder.domain.Statement script,
                                                                                                          org.jclouds.compute.options.RunScriptOptions options)
```
  - execRemoteScript
```
public void execRemoteScript(java.lang.String... commands)
```
    uses submitRunScript to execute the commands, and throws error if it fails or returns non-zero
  - waitForPassword
```
public java.lang.String waitForPassword()
```
    Retrieves the password for this VM, if one exists. The behaviour/implementation is different for different clouds. e.g. on Rackspace, the password for a windows VM is available immediately; on AWS-EC2, for a Windows VM you need to poll repeatedly until the password is available which can take up to 15 minutes.
  - toMetadataRecord
```
public java.util.Map<java.lang.String,java.lang.String> toMetadataRecord()
```
    Description copied from interface: LocationInternal
    
    Get a record of the metadata of this location.
    
    Metadata records are used to record an audit trail of events relating to location usage (for billing purposes, for example). Implementations (and subclasses) should override this method to return information useful for this purpose.
    
    Specified by:
    
    toMetadataRecord in interface LocationInternal
    
    Overrides:
    
    toMetadataRecord in class AbstractLocation
    
    Returns:

Class JcloudsSshMachineLocation

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.SshMachineLocation

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.SshMachineLocation

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.jclouds.JcloudsMachineLocation

Methods inherited from interface brooklyn.location.MachineLocation

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

Constructor Detail

JcloudsSshMachineLocation

JcloudsSshMachineLocation

Method Detail

init

rebind

toVerboseString

getNode

getTemplate

getParent

getHostname

note

getPublicAddresses

getPrivateAddresses

getSubnetHostname

getSubnetIp

getJcloudsId

submitRunScript

submitRunScript

submitRunScript

execRemoteScript

waitForPassword

toMetadataRecord