org.apache.brooklyn.core.location

Class AbstractLocation

java.lang.Object

org.apache.brooklyn.core.objs.AbstractBrooklynObject

org.apache.brooklyn.core.location.AbstractLocation

All Implemented Interfaces:

Location, Rebindable, BrooklynObject, Configurable, Identifiable, HasHostGeoInfo, LocationInternal, BrooklynObjectInternal

Direct Known Subclasses:

AbstractCloudMachineProvisioningLocation, AbstractMachineLocation, AggregatingMachineProvisioningLocation, FixedListMachineProvisioningLocation, KubernetesLocation, MoreLocation, MultiLocation, PortForwardManagerImpl, ServerPoolLocation, SimpleLocation

public abstract class AbstractLocation
extends AbstractBrooklynObject
implements LocationInternal, HasHostGeoInfo, Configurable

A basic implementation of the Location interface. This provides an implementation which works according to the requirements of the interface documentation, and is ready to be extended to make more specialized locations. Override configure(Map) to add special initialization logic.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractLocation.BasicSubscriptionSupport

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

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigKey<Location>	PARENT_LOCATION
static ConfigKey<java.lang.Boolean>	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
AbstractLocation() Construct a new instance of an AbstractLocation.
AbstractLocation(java.util.Map<?,?> properties) Construct a new instance of an AbstractLocation.

Method Summary

Modifier and Type	Method and Description
void	addChild(Location child)
<T> void	addExtension(java.lang.Class<T> extensionType, T extension) Registers the given extension for the given type.
BrooklynObjectInternal.ConfigurationSupportInternal	config()
AbstractLocation	configure(java.util.Map<?,?> properties) Deprecated. since 0.7.0; only used for legacy brooklyn types where constructor is called directly; see overridden method for more info
boolean	containsLocation(Location potentialDescendent) Answers true if this location equals or is an ancestor of the given location.
boolean	equals(java.lang.Object o)
java.util.Collection<Location>	getChildren() Get the 'children' of this location.
<T> T	getConfig(ConfigKey.HasConfigKey<T> key) Convenience method for config().get(key)
<T> T	getConfig(ConfigKey<T> key) Convenience for calling Configurable.ConfigurationSupport.get(ConfigKey), via code like config().get(key).
java.lang.String	getDisplayName() A display name; recommended to be a concise single-line description.
<T> T	getExtension(java.lang.Class<T> extensionType) Returns an extension of the given type.
HostGeoInfo	getHostGeoInfo()
LocationDynamicType	getLocationTypeInternal()
Location	getParent() Get the 'parent' of this location.
RebindSupport<LocationMemento>	getRebindSupport() Users are strongly discouraged from calling or overriding this method.
boolean	hasExtension(java.lang.Class<?> extensionType) Whether this location has support for the given extension type.
int	hashCode()
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.
boolean	isManaged()
void	onManagementStarted()
void	onManagementStopped()
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.
BrooklynObjectInternal.RelationSupportInternal<Location>	relations() Relations specify a typed, directed connection between two entities.
boolean	removeChild(Location child)
void	setDisplayName(java.lang.String newName)
void	setHostGeoInfo(HostGeoInfo hostGeoInfo)
void	setManagementContext(ManagementContextInternal managementContext)
void	setParent(Location newParent) Set the 'parent' of this location.
void	setParent(Location newParent, boolean updateChildListParents)
AbstractLocation.BasicSubscriptionSupport	subscriptions() Subscriptions are the mechanism for receiving notifications of sensor-events (e.g.
java.util.Map<java.lang.String,java.lang.String>	toMetadataRecord() Get a record of the metadata of this location.
java.lang.String	toString() Default String representation is simplified name of class, together with selected fields.
java.lang.String	toVerboseString()

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.core.location.internal.LocationInternal

getManagementContext

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

addSearchPath, setCatalogItemId, setCatalogItemIdAndSearchPath, stackCatalogItemId

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

getId

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

getCatalogItemId, getCatalogItemIdSearchPath, tags

Field Detail

PARENT_LOCATION

public static final ConfigKey<Location> PARENT_LOCATION

TEMPORARY_LOCATION

public static final ConfigKey<java.lang.Boolean> TEMPORARY_LOCATION

Constructor Detail

AbstractLocation

public AbstractLocation()

Construct a new instance of an AbstractLocation.

AbstractLocation

public AbstractLocation(java.util.Map<?,?> properties)

Construct a new instance of an AbstractLocation. The properties map recognizes the following keys:

• name - a name for the location
• parentLocation - the parent Location

Other common properties (retrieved via get/findLocationProperty) include:

• latitude
• longitude
• displayName
• iso3166 - list of iso3166-2 code strings
• timeZone
• abbreviatedName

Method Detail

setManagementContext

public void setManagementContext(ManagementContextInternal managementContext)

Overrides:

setManagementContext in class AbstractBrooklynObject

configure

@Deprecated
public AbstractLocation configure(java.util.Map<?,?> properties)

Deprecated. since 0.7.0; only used for legacy brooklyn types where constructor is called directly; see overridden method for more info

Description copied from class: AbstractBrooklynObject

Will set fields from flags, and put the remaining ones into the 'leftovers' map. For some types, you can find unused config via ConfigBag.getUnusedConfig().

To be overridden by AbstractEntity, AbstractLoation, AbstractPolicy, AbstractEnricher, etc.

But should not be overridden by specific entity types. If you do, the entity may break in subsequent releases. Also note that if you require fields to be initialized you must do that in this method. You must *not* rely on field initializers because they may not run until *after* this method (this method is invoked by the constructor in this class, so initializers in subclasses will not have run when this overridden method is invoked.)

isManaged

public boolean isManaged()

onManagementStarted

public void onManagementStarted()

onManagementStopped

public void onManagementStopped()

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: BrooklynObject

A display name; recommended to be a concise single-line description.

Specified by:

getDisplayName in interface Location

Specified by:

getDisplayName in interface BrooklynObject

Returns:

the name assigned to the location.

getParent

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

Returns:

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

getChildren

public java.util.Collection<Location> getChildren()

Description copied from interface: Location

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.

Specified by:

getChildren in interface Location

Returns:

a collection containing the children of this location.

setParent

public void setParent(Location newParent)

Description copied from interface: Location

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

Specified by:

setParent in interface Location

Parameters:

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

setParent

public void setParent(Location newParent,
                      boolean updateChildListParents)

config

public BrooklynObjectInternal.ConfigurationSupportInternal config()

Specified by:

config in interface Configurable

Specified by:

config in interface BrooklynObjectInternal

subscriptions

public AbstractLocation.BasicSubscriptionSupport subscriptions()

Description copied from interface: BrooklynObject

Subscriptions are the mechanism for receiving notifications of sensor-events (e.g. attribute-changed) from other entities.

Specified by:

subscriptions in interface BrooklynObject

Specified by:

subscriptions in interface BrooklynObjectInternal

getConfig

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

Description copied from interface: Location

Convenience method for config().get(key)

Specified by:

getConfig in interface Location

See Also:

#getConfig(ConfigKey)}

getConfig

public <T> T getConfig(ConfigKey<T> key)

Description copied from interface: Configurable

Convenience for calling Configurable.ConfigurationSupport.get(ConfigKey), via code like config().get(key).

Specified by:

getConfig in interface Configurable

setDisplayName

public void setDisplayName(java.lang.String newName)

Specified by:

setDisplayName in class AbstractBrooklynObject

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

containsLocation

public boolean containsLocation(Location potentialDescendent)

Description copied from interface: Location

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

Specified by:

containsLocation in interface Location

addChild

public void addChild(Location child)

removeChild

public boolean removeChild(Location child)

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 AbstractBrooklynObject

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 AbstractBrooklynObject

toString

public java.lang.String toString()

Default String representation is simplified name of class, together with selected fields.

Overrides:

toString in class java.lang.Object

toVerboseString

public java.lang.String toVerboseString()

Specified by:

toVerboseString in interface Location

Returns:

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

getHostGeoInfo

public HostGeoInfo getHostGeoInfo()

Specified by:

getHostGeoInfo in interface HasHostGeoInfo

setHostGeoInfo

public void setHostGeoInfo(HostGeoInfo hostGeoInfo)

getRebindSupport

public RebindSupport<LocationMemento> getRebindSupport()

Description copied from interface: LocationInternal

Users are strongly discouraged from calling or overriding this method. It is for internal calls only, relating to persisting/rebinding entities. This method may change (or be removed) in a future release without notice.

Specified by:

getRebindSupport in interface Rebindable

Specified by:

getRebindSupport in interface LocationInternal

Specified by:

getRebindSupport in interface BrooklynObjectInternal

getLocationTypeInternal

public LocationDynamicType getLocationTypeInternal()

relations

public BrooklynObjectInternal.RelationSupportInternal<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 Location

Specified by:

relations in interface BrooklynObject

Specified by:

relations in interface LocationInternal

Specified by:

relations in interface BrooklynObjectInternal

Overrides:

relations in class AbstractBrooklynObject

hasExtension

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

Description copied from interface: Location

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

Specified by:

hasExtension in interface Location

getExtension

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

Description copied from interface: Location

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 Location.getParent().

Specified by:

getExtension in interface Location

addExtension

public <T> void addExtension(java.lang.Class<T> extensionType,
                             T extension)

Description copied from interface: LocationInternal

Registers the given extension for the given type. If an extension already existed for this type, then this will override it.

Specified by:

addExtension in interface LocationInternal

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

Returns: