brooklyn.location
[Java] Interface AddressableLocation
brooklyn.location.AddressableLocation
brooklyn.location.Location
brooklyn.entity.rebind.Rebindable
- All Superinterfaces:
- Location, Rebindable
public interface AddressableLocation
extends Location
A location that has an IP address.
This IP address may be a machine (usually the MachineLocation sub-interface),
or often an entry point for a service.
|
Method Summary |
java.net.InetAddress
|
getAddress()
Return the single most appropriate address for this location.
|
|
Methods inherited from interface Location
|
|---|
| containsLocation, findLocationProperty, getAllConfig, getChildLocations, getConfig, getId, getLocationProperty, getName, getParentLocation, getRebindSupport, hasConfig, hasLocationProperty, setParentLocation |
getAddress
public java.net.InetAddress getAddress()
- 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!).
Brooklyn Multi-Cloud Application Management Platform
brooklyncentral.github.com. Apache License. © 2012.