org.apache.brooklyn.api.location

Interface MachineLocation

All Superinterfaces:

AddressableLocation, BrooklynObject, Configurable, HasNetworkAddresses, Identifiable, Location

All Known Subinterfaces:

JcloudsMachineLocation, JcloudsMachineLocationPublic, KubernetesMachineLocation

All Known Implementing Classes:

AbstractJcloudsSubnetSshMachineLocation, AbstractMachineLocation, JcloudsSshMachineLocation, JcloudsWinRmMachineLocation, KubernetesEmptyMachineLocation, KubernetesSshMachineLocation, LocalhostMachineProvisioningLocation.LocalhostMachine, SshMachineLocation, WinRmMachineLocation

public interface MachineLocation
extends AddressableLocation, HasNetworkAddresses

A location that is a machine. This interface marks a Location being a network node with an IP address, and supports appropriate operations on the node.

Nested Class Summary

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

Method Summary

Modifier and Type	Method and Description
java.net.InetAddress	getAddress() Return the single most appropriate address for this location.
MachineDetails	getMachineDetails()
OsDetails	getOsDetails() Deprecated. since 0.7.0. Use getMachineDetails().getOsDetails() instead.

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

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

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.util.net.HasNetworkAddresses

getHostname, getPrivateAddresses, getPublicAddresses

Method Detail

getAddress

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

Returns:

the machine's network address.

getOsDetails

@Deprecated
OsDetails getOsDetails()

Deprecated. since 0.7.0. Use getMachineDetails().getOsDetails() instead.

getMachineDetails

MachineDetails getMachineDetails()