org.apache.brooklyn.core.location.internal

Interface LocationInternal

All Superinterfaces:

BrooklynObject, BrooklynObjectInternal, Configurable, Identifiable, Location, Rebindable

All Known Implementing Classes:

AbstractCloudMachineProvisioningLocation, AbstractJcloudsSubnetSshMachineLocation, AbstractLocation, AggregatingMachineProvisioningLocation, FixedListMachineProvisioningLocation, JcloudsLocation, JcloudsSshMachineLocation, JcloudsWinRmMachineLocation, LocalhostMachineProvisioningLocation, LocalhostMachineProvisioningLocation.LocalhostMachine, MoreLocation, MultiLocation, PortForwardManagerAuthority, PortForwardManagerImpl, ServerPoolLocation, SimpleLocation, SingleMachineProvisioningLocation, SshMachineLocation, WinRmMachineLocation

public interface LocationInternal
extends BrooklynObjectInternal, Location

Information about locations private to Brooklyn.

Nested Class Summary

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<java.lang.String>	FINAL_SPEC
static ConfigKey<java.lang.String>	NAMED_SPEC_NAME
static ConfigKey<java.lang.String>	ORIGINAL_SPEC

Method Summary

Modifier and Type	Method and Description
<T> void	addExtension(java.lang.Class<T> extensionType, T extension) Registers the given extension for the given type.
ConfigBag	getAllConfigBag() Deprecated. since 0.7.0; use BrooklynObjectInternal.config(), such as ((LocationInternal)location).config().getBag()
ConfigBag	getLocalConfigBag() Deprecated. since 0.7.0; use BrooklynObjectInternal.config(), such as ((LocationInternal)location).config().getLocalBag()
ManagementContext	getManagementContext()
RebindSupport<LocationMemento>	getRebindSupport() Users are strongly discouraged from calling or overriding this method.
BrooklynObjectInternal.RelationSupportInternal<Location>	relations() Relations specify a typed, directed connection between two entities.
java.util.Map<java.lang.String,java.lang.String>	toMetadataRecord() Get a record of the metadata of this location.

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

config, setCatalogItemId, subscriptions

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

containsLocation, getAllConfig, getChildren, getConfig, getDisplayName, getExtension, getId, getParent, hasConfig, hasExtension, setParent, toVerboseString

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

getCatalogItemId, tags

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

getConfig, setConfig

Field Detail

ORIGINAL_SPEC

static final ConfigKey<java.lang.String> ORIGINAL_SPEC

FINAL_SPEC

static final ConfigKey<java.lang.String> FINAL_SPEC

NAMED_SPEC_NAME

static final ConfigKey<java.lang.String> NAMED_SPEC_NAME

Method Detail

addExtension

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

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

Throws:

java.lang.NullPointerException - if extensionType or extension are null

java.lang.IllegalArgumentException - if extension does not implement extensionType

toMetadataRecord

java.util.Map<java.lang.String,java.lang.String> toMetadataRecord()

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.

Returns:

getLocalConfigBag

@Deprecated
ConfigBag getLocalConfigBag()

Deprecated. since 0.7.0; use BrooklynObjectInternal.config(), such as ((LocationInternal)location).config().getLocalBag()

getAllConfigBag

@Deprecated
ConfigBag getAllConfigBag()

Deprecated. since 0.7.0; use BrooklynObjectInternal.config(), such as ((LocationInternal)location).config().getBag()

Returns all config, including that inherited from parents. This method does not respect ConfigInheritance and so usage is discouraged.

getRebindSupport

@Beta
RebindSupport<LocationMemento> getRebindSupport()

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 BrooklynObjectInternal

Specified by:

getRebindSupport in interface Rebindable

relations

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 BrooklynObject

Specified by:

relations in interface BrooklynObjectInternal

Specified by:

relations in interface Location

getManagementContext

ManagementContext getManagementContext()