org.apache.brooklyn.api.location

Interface Location

All Superinterfaces:

BrooklynObject, Configurable, Identifiable

All Known Subinterfaces:

AddressableLocation, JcloudsLocationPublic, JcloudsMachineLocation, JcloudsMachineLocationPublic, KubernetesMachineLocation, LocationInternal, MachineLocation, MachineManagementMixins.RichMachineProvisioningLocation<T>, MachineProvisioningLocation<T>, PaasLocation, PortForwardManager, ProvisioningLocation<T>

All Known Implementing Classes:

AbstractCloudMachineProvisioningLocation, AbstractJcloudsSubnetSshMachineLocation, AbstractLocation, AbstractMachineLocation, AggregatingMachineProvisioningLocation, DockerJcloudsLocation, FixedListMachineProvisioningLocation, JcloudsLocation, JcloudsSshMachineLocation, JcloudsWinRmMachineLocation, KubernetesEmptyMachineLocation, KubernetesLocation, KubernetesSshMachineLocation, LocalhostMachineProvisioningLocation, LocalhostMachineProvisioningLocation.LocalhostMachine, MoreLocation, MultiLocation, OpenShiftLocation, PortForwardManagerAuthority, PortForwardManagerClient, PortForwardManagerImpl, ServerPoolLocation, SimpleLocation, SingleMachineProvisioningLocation, SshMachineLocation, WinRmMachineLocation

public interface Location
extends BrooklynObject

A location that an entity can be in. Examples of locations include a single machine or a pool of machines, or a region within a given cloud.

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
boolean	containsLocation(Location potentialDescendent) Answers true if this location equals or is an ancestor of the given location.
java.util.Collection<Location>	getChildren() Get the 'children' of this location.
<T> T	getConfig(ConfigKey.HasConfigKey<T> key) Convenience method for config().get(key)
java.lang.String	getDisplayName() Get the name assigned to this location.
<T> T	getExtension(java.lang.Class<T> extensionType) Returns an extension of the given type.
java.lang.String	getId() A unique id for this location.
Location	getParent() Get the 'parent' of this location.
boolean	hasExtension(java.lang.Class<?> extensionType) Whether this location has support for the given extension type.
BrooklynObject.RelationSupport<Location>	relations() Relations specify a typed, directed connection between two entities.
void	setParent(Location newParent) Set the 'parent' of this location.
java.lang.String	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

Method Detail

getId

java.lang.String getId()

A unique id for this location.

Specified by:

getId in interface Identifiable

getDisplayName

java.lang.String getDisplayName()

Get the name assigned to this location.

Specified by:

getDisplayName in interface BrooklynObject

Returns:

the name assigned to the location.

Since:

0.6 (previously getName())

getParent

Location getParent()

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.

Returns:

a reference to the parent of this location, or null if this location is the tree root.

Since:

0.6 (previously getParentLocation())

getChildren

java.util.Collection<Location> getChildren()

Get the 'children' of this location. Locations are organized into a tree hierarchy, and this method will return a collection containing the children of this location. This collection is an unmodifiable view of the data.

Returns:

a collection containing the children of this location.

Since:

0.6 (previously getChildLocations())

setParent

void setParent(Location newParent)

Set the 'parent' of this location. If this location was previously a child of a different location, it is removed from the other location first. It is valid to pass in null to indicate that the location should be disconnected from its parent. Adds this location as a child of the new parent (see getChildLocations()).

Parameters:

newParent - the new parent location object, or null to clear the parent reference.

Since:

0.6 (previously setParentLocation(Location))

toVerboseString

java.lang.String toVerboseString()

Returns:

meta-data about the location (usually a long line, or a small number of lines).

Since:

0.6

containsLocation

boolean containsLocation(Location potentialDescendent)

Answers true if this location equals or is an ancestor of the given location.

getConfig

<T> T getConfig(ConfigKey.HasConfigKey<T> key)

Convenience method for config().get(key)

See Also:

#getConfig(ConfigKey)}

hasExtension

boolean hasExtension(java.lang.Class<?> extensionType)

Whether this location has support for the given extension type. See additional comments in getExtension(Class).

Throws:

java.lang.NullPointerException - if extensionType is null

getExtension

<T> T getExtension(java.lang.Class<T> extensionType)

Returns an extension of the given type. Note that the type must be an exact match for how the extension was registered (e.g. getExtension(Object.class) will not match anything, even though registered extension extend Object.

This will not look at extensions of getParent().

Throws:

java.lang.IllegalArgumentException - if this location does not support the given extension type

java.lang.NullPointerException - if extensionType is null

relations

BrooklynObject.RelationSupport<Location> relations()

Description copied from interface: BrooklynObject

Relations specify a typed, directed connection between two entities. Generic type is overridden in sub-interfaces.

Specified by:

relations in interface BrooklynObject