org.apache.brooklyn.location.jclouds

Class JcloudsSshMachineLocation

java.lang.Object

org.apache.brooklyn.core.objs.AbstractBrooklynObject

org.apache.brooklyn.core.location.AbstractLocation

org.apache.brooklyn.core.location.AbstractMachineLocation

org.apache.brooklyn.location.ssh.SshMachineLocation

org.apache.brooklyn.location.jclouds.JcloudsSshMachineLocation

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractJcloudsSubnetSshMachineLocation

public class JcloudsSshMachineLocation
extends SshMachineLocation
implements JcloudsMachineLocation

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.brooklyn.core.location.AbstractLocation

AbstractLocation.BasicSubscriptionSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

BrooklynObject.RelationSupport<T extends BrooklynObject>, BrooklynObject.SubscriptionSupport, BrooklynObject.TagSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.Configurable

Configurable.ConfigurationSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

BrooklynObjectInternal.ConfigurationSupportInternal, BrooklynObjectInternal.RelationSupportInternal<T extends BrooklynObject>, BrooklynObjectInternal.SubscriptionSupportInternal

Field Summary

Fields inherited from class org.apache.brooklyn.location.ssh.SshMachineLocation

ALL_SSH_CONFIG_KEY_NAMES, ALL_SSH_CONFIG_KEYS, ALLOCATE_PTY, CLOSE_CONNECTION, LOCAL_TEMP_DIR, LOG_PREFIX, NO_STDERR_LOGGING, NO_STDOUT_LOGGING, PASSWORD, PRIVATE_ADDRESSES, 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, SSH_TOOL_CLASS, SSH_TOOL_CLASS_PROPERTIES_PREFIX, STDERR, STDOUT, TCP_PORT_MAPPINGS, UNIQUE_ID

Fields inherited from class org.apache.brooklyn.core.location.AbstractMachineLocation

DETECT_MACHINE_DETAILS, MACHINE_DETAILS

Fields inherited from class org.apache.brooklyn.core.location.AbstractLocation

PARENT_LOCATION, TEMPORARY_LOCATION

Fields inherited from interface org.apache.brooklyn.core.location.internal.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

Modifier and Type	Method and Description
java.lang.String	getHostname() note
java.lang.String	getJcloudsId() Returns the node ID as known at the cloud provider.
org.jclouds.compute.domain.NodeMetadata	getNode() Deprecated. since 0.9.0
<any>	getOptionalNode()
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() In clouds like AWS, the public hostname is the only way to ensure VMs in different zones can access each other.
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
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.
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() Deprecated. since 0.9.0; use the machine to execute commands, so no need to extract the password

Methods inherited from class org.apache.brooklyn.location.ssh.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, getPort, getSshHostAndPort, getUser, hasMutex, installTo, installTo, installTo, installTo, isSshable, obtainPort, obtainSpecificPort, releaseMutex, releasePort, resolveOnBoxDirFor, toString, tryAcquireMutex

Methods inherited from class org.apache.brooklyn.core.location.AbstractMachineLocation

getMachineDetails, getOsDetails, mutexes

Methods inherited from class org.apache.brooklyn.core.location.AbstractLocation

addChild, addExtension, config, containsLocation, equals, getChildren, getConfig, getConfig, getDisplayName, getExtension, getHostGeoInfo, getLocationTypeInternal, getRebindSupport, hasExtension, hashCode, isManaged, onManagementStarted, onManagementStopped, relations, removeChild, setDisplayName, setHostGeoInfo, setManagementContext, setParent, setParent, subscriptions

Methods inherited from class org.apache.brooklyn.core.objs.AbstractBrooklynObject

addSearchPath, getCatalogItemId, getCatalogItemIdSearchPath, getId, getManagementContext, setCatalogItemId, setCatalogItemIdAndSearchPath, stackCatalogItemId, tags

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.brooklyn.location.jclouds.api.JcloudsMachineLocationPublic

getPort, getUser

Methods inherited from interface org.apache.brooklyn.api.location.MachineLocation

getAddress, getMachineDetails, getOsDetails

Methods inherited from interface org.apache.brooklyn.api.location.Location

containsLocation, getChildren, getConfig, getDisplayName, getExtension, getId, hasExtension, relations, setParent

Methods inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

getCatalogItemId, getCatalogItemIdSearchPath, subscriptions, tags

Methods inherited from interface org.apache.brooklyn.api.objs.Configurable

config, getConfig

Methods inherited from interface org.apache.brooklyn.core.location.internal.LocationInternal

getManagementContext

Methods inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

addSearchPath, setCatalogItemId, setCatalogItemIdAndSearchPath, stackCatalogItemId

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 SshMachineLocation

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 AbstractLocation

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

getOptionalNode

public <any> getOptionalNode()

Specified by:

getOptionalNode in interface JcloudsMachineLocation

getNode

@Deprecated
public org.jclouds.compute.domain.NodeMetadata getNode()

Deprecated. since 0.9.0

Specified by:

getNode 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 Location

Specified by:

getParent in interface JcloudsMachineLocationPublic

Specified by:

getParent in interface JcloudsMachineLocation

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()

In clouds like AWS, the public hostname is the only way to ensure VMs in different zones can access each other.

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()

Description copied from interface: JcloudsMachineLocationPublic

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 JcloudsMachineLocationPublic

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()

Description copied from interface: JcloudsMachineLocationPublic

Returns the node ID as known at the cloud provider.

Specified by:

getJcloudsId in interface JcloudsMachineLocationPublic

waitForPassword

@Deprecated
public java.lang.String waitForPassword()

Deprecated. since 0.9.0; use the machine to execute commands, so no need to extract the password

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: