brooklyn.location.basic
[Java] Class AbstractLocation

java.lang.Object
  brooklyn.location.basic.AbstractLocation

All Implemented Interfaces:

Configurable, HasHostGeoInfo, LocationInternal

public abstract class AbstractLocation

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.

LOG

public static final Logger LOG

PARENT_LOCATION

public static final ConfigKey PARENT_LOCATION

hostGeoInfo

protected HostGeoInfo hostGeoInfo

name

protected java.lang.String name

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

addChild

protected java.lang.Object addChild(LocationSpec spec)

addChild

public void addChild(Location child)

addChildLocation

// instances.
public void addChildLocation(Location child)

addExtension

public void addExtension(java.lang.Class extensionType, java.lang.Object extension)

assertNotYetManaged

protected void assertNotYetManaged()

configure

public void configure(java.util.Map properties)

Will set fields from flags. The unused configuration can be found via the {

linkplain:

ConfigBag#getUnusedConfig()}. This can be overridden for custom initialization but note the following.

For new-style locations (i.e. not calling constructor directly, this will be invoked automatically by brooklyn-core post-construction).

For legacy location use, this will be invoked by the constructor in this class. Therefore if over-riding 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.) If you require fields to be initialized you must do that in this method with a guard (as in FixedListMachineProvisioningLocation).

containsLocation

public boolean containsLocation(Location potentialDescendent)

equals

while (loc != null) {
public boolean equals(java.lang.Object o)

findLocationProperty

return Objects.toStringHelper(getClass()).add("id", id).add("name", name);
}
public java.lang.Object findLocationProperty(java.lang.String key)

override this, adding to the returned value, to supply additional fields to include in the toString

getAllConfig

/** @deprecated since 0.6.0 use {@link #getRawLocalConfigBag()} */
public java.util.Map getAllConfig()

getAllConfig

public ConfigBag getRawLocalConfigBag() {
public java.util.Map getAllConfig(boolean includeInherited)

deprecated:

since 0.6.0 use getRawLocalConfigBag()

getChildLocations

@Override
@Deprecated
public java.util.Collection getChildLocations()

getChildren

}
public java.util.Collection getChildren()

getConfig

}
public java.lang.Object getConfig(ConfigKey key)

getConfigBag

public ConfigBag getConfigBag()

getDisplayName

return parentLocation;
public java.lang.String getDisplayName()

getExtension

public java.lang.Object getExtension(java.lang.Class extensionType)

getHostGeoInfo

public HostGeoInfo getHostGeoInfo()

getId

return getDisplayName();
public java.lang.String getId()

Since:

0.6.0 (?) - use getDisplayName

getLocationProperty

}

public java.lang.Object getLocationProperty(java.lang.String key)

getManagementContext

protected ManagementContext getManagementContext()

getName

synchronized (childLocations) {
return ImmutableList.copyOf(childLocations);
        }
public java.lang.String getName()

getParent

if (parent == this) {
public Location getParent()

getParentLocation

@Override
public  T getConfig(ConfigKey key) {
public Location getParentLocation()

getRawLocalConfigBag

public ConfigBag getRawLocalConfigBag()

getRebindSupport

builder.put("id", getId());
public RebindSupport getRebindSupport()

hasConfig

}
@Override
public boolean hasConfig(ConfigKey key)

hasConfig

Location p = getParent();
public boolean hasConfig(ConfigKey key, boolean includeInherited)

hasExtension

public boolean hasExtension(java.lang.Class extensionType)

hasLocationProperty

@Override
public boolean hasLocationProperty(java.lang.String key)

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

hashCode

*/
public int hashCode()

init

public void init()

isLegacyConstruction

protected boolean isLegacyConstruction()

isManaged

public boolean isManaged()

onManagementStarted

public void onManagementStarted()

onManagementStopped

public void onManagementStopped()

removeChild

protected boolean removeChild(Location child)

removeChildLocation

protected boolean removeChildLocation(Location child)

deprecated:

since 0.6

See Also:

removeChild(Location)

setConfig

public java.lang.Object setConfig(ConfigKey key, java.lang.Object value)

setHostGeoInfo

public void setHostGeoInfo(HostGeoInfo hostGeoInfo)

setManagementContext

public void setManagementContext(ManagementContext managementContext)

setName

public void setName(java.lang.String name)

setParent

}
public void setParent(Location parent)

setParentLocation

public boolean hasConfig(ConfigKey key, boolean includeInherited) {
boolean locally = getRawLocalConfigBag().containsKey(key);
public void setParentLocation(Location parent)

string

protected ToStringHelper string()

toMetadataRecord

public java.util.Map toMetadataRecord()

toString

public java.lang.String toString()

toVerboseString

public java.lang.String toVerboseString()

Brooklyn Multi-Cloud Application Management Platform
brooklyncentral.github.com. Apache License. © 2012.