brooklyn.location
Interface MachineLocation

All Superinterfaces:

AddressableLocation, Identifiable, Location, Rebindable, Serializable

public interface MachineLocation
extends AddressableLocation

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.

Method Summary

InetAddress	getAddress() Return the single most appropriate address for this location.
OsDetails	getOsDetails()

Methods inherited from interface brooklyn.location.Location

containsLocation, findLocationProperty, getAllConfig, getAllConfig, getChildLocations, getChildren, getConfig, getDisplayName, getExtension, getId, getLocationProperty, getName, getParent, getParentLocation, getRebindSupport, hasConfig, hasConfig, hasExtension, hasLocationProperty, setParent, setParentLocation, toVerboseString

Method Detail

getAddress

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

OsDetails getOsDetails()