AbstractEntity (Apache Brooklyn)

java.lang.Object
- brooklyn.basic.AbstractBrooklynObject
- - brooklyn.entity.basic.AbstractEntity

All Implemented Interfaces:

BrooklynObject, BrooklynObjectInternal, EntityInternal, EntityLocal, Entity, Rebindable, Configurable, Identifiable

Direct Known Subclasses:

AbstractApplication, AbstractGeoDnsServiceImpl, AbstractGroupImpl, AbstractNonProvisionedControllerImpl, BalanceableWorkerPoolImpl, BasicEntityImpl, BasicStartableImpl, BrooklynEntityMirrorImpl, BrooklynMetricsImpl, DataEntityImpl, DelegateEntityImpl, EffectorStartableImpl, FollowTheSunPoolImpl, JMSDestinationImpl, KafkaClusterImpl, KafkaTopic, MongoDBShardedDeploymentImpl, MoreEntityImpl, RabbitDestination, RedisClusterImpl, RedisShardImpl, SameServerEntityImpl, SimpleEntityImpl, SoftwareProcessImpl
```
public abstract class AbstractEntity
extends AbstractBrooklynObject
implements EntityLocal, EntityInternal
```
Default Entity implementation, which should be extended whenever implementing an entity.
Provides several common fields (displayName, AbstractBrooklynObject.id), and supports the core features of an entity such as configuration keys, attributes, subscriptions and effector invocation.
If a sub-class is creating other entities, this should be done in an overridden init() method.
Note that config is typically inherited by children, whereas the fields and attributes are not.
Though currently Groovy code, this is very likely to change to pure Java in a future release of Brooklyn so Groovy'isms should not be relied on.
Sub-classes should have a no-argument constructor. When brooklyn creates an entity, it will:
1. Construct the entity via the no-argument constructor
2. Call setDisplayName(String)
3. Call setManagementContext(ManagementContextInternal)
4. Call setProxy(Entity); the proxy should be used by everything else when referring to this entity (except for drivers/policies that are attached to the entity, which can be given a reference to this entity itself).
5. Call configure(Map) and then setConfig(ConfigKey, Object)
6. Call init()
7. Call addPolicy(Policy) (for any policies defined in the EntitySpec)
8. Call setParent(Entity), if a parent is specified in the EntitySpec
The legacy (pre 0.5) mechanism for creating entities is for others to call the constructor directly. This is now deprecated.

Nested Class Summary
- Nested classes/interfaces inherited from interface brooklyn.entity.basic.EntityInternal
  EntityInternal.FeedSupport
- Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObject
  BrooklynObject.TagSupport

Field Summary

Fields
Modifier and Type	Field and Description
`static BasicNotificationSensor<Entity>`	`CHILD_ADDED`
`static BasicNotificationSensor<Entity>`	`CHILD_REMOVED`
`static BasicNotificationSensor<java.lang.String>`	`EFFECTOR_ADDED`
`static BasicNotificationSensor<java.lang.String>`	`EFFECTOR_CHANGED`
`static BasicNotificationSensor<java.lang.String>`	`EFFECTOR_REMOVED`
`static BasicNotificationSensor<PolicyDescriptor>`	`POLICY_ADDED`
`static BasicNotificationSensor<PolicyDescriptor>`	`POLICY_REMOVED`
`static BasicNotificationSensor<Sensor>`	`SENSOR_ADDED`
`static BasicNotificationSensor<Sensor>`	`SENSOR_REMOVED`

Constructor Summary

Constructors
Constructor and Description
`AbstractEntity()`
`AbstractEntity(Entity parent)` Deprecated. since 0.5; instead use no-arg constructor with EntityManager().createEntity(spec)
`AbstractEntity(java.util.Map flags)` Deprecated. since 0.5; instead use no-arg constructor with EntityManager().createEntity(spec)
`AbstractEntity(java.util.Map flags, Entity parent)` Deprecated. since 0.5; instead use no-arg constructor with EntityManager().createEntity(spec)

Method Summary

Methods
Modifier and Type	Method and Description
`<T extends Entity> T`	`addChild(EntitySpec<T> spec)` Creates an entity using the given spec, and adds it as a child of this entity.
`<T extends Entity> T`	`addChild(T child)` Adds the given entity as a child of this parent and sets this entity as the parent of the child; returns argument passed in, for convenience.
`void`	`addEnricher(Enricher enricher)` Adds the given enricher to this entity.
`<T extends Enricher> T`	`addEnricher(EnricherSpec<T> spec)` Adds the given enricher to this entity.
`<T extends Feed> T`	`addFeed(T feed)` Convenience, which calls `EntityInternal.feeds()` and `FeedSupport#addFeed(Feed)`.
`void`	`addGroup(Group e)` Add this entity as a member of the given `Group`.
`void`	`addLocations(java.util.Collection<? extends Location> newLocations)`
`void`	`addPolicy(Policy policy)` Adds the given policy to this entity.
`<T extends Policy> T`	`addPolicy(PolicySpec<T> spec)` Adds the given policy to this entity.
`boolean`	`addTag(java.lang.Object tag)`
`void`	`clearLocations()`
`void`	`clearParent()` Clears the parent (i.e.
`<T> AbstractEntity`	`configure(ConfigKey.HasConfigKey<T> key, java.lang.String value)`
`<T> AbstractEntity`	`configure(ConfigKey.HasConfigKey<T> key, T value)`
`<T> AbstractEntity`	`configure(ConfigKey<T> key, java.lang.String value)`
`<T> AbstractEntity`	`configure(ConfigKey<T> key, T value)` Sets a config key value, and returns this Entity instance for use in fluent-API style coding.
`AbstractEntity`	`configure(java.util.Map flags)` Deprecated. since 0.7.0; only used for legacy brooklyn types where constructor is called directly
`boolean`	`containsTag(java.lang.Object tag)`
`void`	`destroy()` Should be invoked at end-of-life to clean up the item.
`<T> void`	`emit(Sensor<T> sensor, T val)` Emits a `SensorEvent` event on behalf of this entity (as though produced by this entity).
`<T> void`	`emitInternal(Sensor<T> sensor, T val)`
`boolean`	`equals(java.lang.Object o)`
`EntityInternal.FeedSupport`	`feeds()`
`Location`	`firstLocation()`
`java.util.Map<AttributeSensor,java.lang.Object>`	`getAllAttributes()`
`java.util.Map<ConfigKey<?>,java.lang.Object>`	`getAllConfig()`
`ConfigBag`	`getAllConfigBag()` Returns a read-only view of all the config key/value pairs on this entity, backed by a string-based map, including config names that did not match anything on this entity.
`Application`	`getApplication()` Returns the application, looking it up if not yet known (registering if necessary)
`java.lang.String`	`getApplicationId()`
`<T> T`	`getAttribute(AttributeSensor<T> attribute)` Gets the value of the given attribute on this entity, or null if has not been set.
`<T> T`	`getAttributeByNameParts(java.util.List<java.lang.String> nameParts)`
`java.util.Collection<Entity>`	`getChildren()` Return the entities that are children of (i.e.
`<T> T`	`getConfig(ConfigKey.HasConfigKey<T> key)`
`<T> T`	`getConfig(ConfigKey.HasConfigKey<T> key, T defaultValue)`
`<T> T`	`getConfig(ConfigKey<T> key)` Gets the given configuration value for this entity, in the following order of preference: value (including null) explicitly set on the entity value (including null) explicitly set on an ancestor (inherited) a default value (including null) on the best equivalent static key of the same name declared on the entity (where best equivalence is defined as preferring a config key which extends another, as computed in EntityDynamicType.getConfigKeys) a default value (including null) on the key itself null
`<T> T`	`getConfig(ConfigKey<T> key, T defaultValue)`
`EntityConfigMap`	`getConfigMap()`
`Maybe<java.lang.Object>`	`getConfigRaw(ConfigKey.HasConfigKey<?> key, boolean includeInherited)`
`Maybe<java.lang.Object>`	`getConfigRaw(ConfigKey<?> key, boolean includeInherited)` Returns the uncoerced value for this config key as set on this entity, if available, not following any inheritance chains and not taking any default.
`long`	`getCreationTime()` Returns the creation time for this entity, in UTC.
`java.lang.String`	`getDisplayName()` A display name; recommended to be a concise single-line description.
`Effector<?>`	`getEffector(java.lang.String effectorName)` Convenience for finding named effector in `EntityType.getEffectors()` `Map`.
`java.util.Collection<Enricher>`	`getEnrichers()`
`EntityType`	`getEntityType()` Information about the type of this entity; analogous to Java's object.getClass.
`ExecutionContext`	`getExecutionContext()` Returns the task execution context for the entity.
`EntityInternal.FeedSupport`	`getFeedSupport()` Deprecated.
`java.util.Collection<Group>`	`getGroups()` The `Collection` of `Group`s that this entity is a member of.
`java.lang.String`	`getIconUrl()` A URL pointing to an image which can be used to represent this entity.
`ConfigBag`	`getLocalConfigBag()` Returns a read-only view of the local (i.e.
`java.util.Collection<Location>`	`getLocations()` Return all the `Location`s this entity is deployed to.
`ManagementContext`	`getManagementContext()` Returns the management context for the entity.
`EntityManagementSupport`	`getManagementSupport()`
`EntityDynamicType`	`getMutableEntityType()` returns the dynamic type corresponding to the type of this entity instance
`Entity`	`getParent()` The parent of this entity, null if no parent.
`java.util.Collection<Policy>`	`getPolicies()`
`Entity`	`getProxy()`
`Entity`	`getProxyIfAvailable()` Returns the proxy, or if not available (because using legacy code) then returns the real entity.
`RebindSupport<EntityMemento>`	`getRebindSupport()` As described in `EntityInternal.getRebindSupport()`...
`SubscriptionContext`	`getSubscriptionContext()`
`java.util.Set<java.lang.Object>`	`getTags()`
`int`	`hashCode()`
`void`	`init()` Default entity initialization, just calls `initEnrichers()`.
`void`	`invalidateReferences()` For use by management plane, to invalidate all fields (e.g.
`<T> Task<T>`	`invoke(Effector<T> eff)` Invoke an `Effector` directly.
`<T> Task<T>`	`invoke(Effector<T> eff, java.util.Map<java.lang.String,?> parameters)` Additional form supplied for when the parameter map needs to be made explicit.
`<T> Task<T>`	`invoke(java.util.Map parameters, Effector<T> eff)`
`<T> T`	`modifyAttribute(AttributeSensor<T> attribute, com.google.common.base.Function<? super T,Maybe<T>> modifier)` Atomically modifies the `AttributeSensor`, ensuring that only one modification is done at a time.
`void`	`onManagementBecomingMaster()` Deprecated. since 0.4.0 override EntityManagementSupport.onManagementStarted if customization needed
`void`	`onManagementNoLongerMaster()` Deprecated. since 0.4.0 override EntityManagementSupport.onManagementStopped if customization needed
`void`	`onManagementStarted()` Invoked by `EntityManagementSupport` when this entity is fully managed and visible to other entities through the management context.
`void`	`onManagementStarting()` Invoked by `EntityManagementSupport` when this entity is becoming managed (i.e.
`void`	`onManagementStopped()` Invoked by `EntityManagementSupport` when this entity is fully unmanaged.
`void`	`refreshInheritedConfig()`
`boolean`	`removeAllEnrichers()` Removes all enricher from this entity.
`boolean`	`removeAllPolicies()` Removes all policy from this entity.
`void`	`removeAttribute(AttributeSensor<?> attribute)`
`boolean`	`removeChild(Entity child)` Removes the specified child `Entity`; its parent will be set to null.
`boolean`	`removeEnricher(Enricher enricher)` Removes the given enricher from this entity.
`void`	`removeGroup(Group e)` Removes this entity as a member of the given `Group`.
`void`	`removeLocations(java.util.Collection<? extends Location> removedLocations)`
`boolean`	`removePolicy(Policy policy)` Removes the given policy from this entity.
`boolean`	`removeTag(java.lang.Object tag)`
`void`	`requestPersist()` Can be called to request that the entity be persisted.
`void`	`resetProxy(Entity proxy)` internal use only
`<T> T`	`setAttribute(AttributeSensor<T> attribute, T val)` Sets the `AttributeSensor` data for the given attribute to the specified value.
`<T> T`	`setAttribute(AttributeSensorAndConfigKey<?,T> configuredSensor)` Deprecated. on interface since 0.5.0; use `ConfigToAttributes.apply(EntityLocal, AttributeSensorAndConfigKey)`
`<T> T`	`setAttributeWithoutPublishing(AttributeSensor<T> attribute, T val)` Like `EntityLocal.setAttribute(AttributeSensor, Object)`, except does not publish an attribute-change event.
`<T> T`	`setConfig(ConfigKey.HasConfigKey<T> key, DeferredSupplier val)`
`<T> T`	`setConfig(ConfigKey.HasConfigKey<T> key, T val)`
`<T> T`	`setConfig(ConfigKey.HasConfigKey<T> key, Task<T> val)`
`<T> T`	`setConfig(ConfigKey<T> key, DeferredSupplier val)`
`<T> T`	`setConfig(ConfigKey<T> key, T val)` Must be called before the entity is managed.
`<T> T`	`setConfig(ConfigKey<T> key, Task<T> val)`
`<T> T`	`setConfigEvenIfOwned(ConfigKey.HasConfigKey<T> key, T val)`
`<T> T`	`setConfigEvenIfOwned(ConfigKey<T> key, T val)`
`void`	`setDisplayName(java.lang.String newDisplayName)` Sets the entity's display name.
`void`	`setManagementContext(ManagementContextInternal managementContext)`
`AbstractEntity`	`setParent(Entity entity)` Adds this as a child of the given entity; registers with application if necessary.
`void`	`setProxy(Entity proxy)` internal use only
`<T> SubscriptionHandle`	`subscribe(Entity producer, Sensor<T> sensor, SensorEventListener<? super T> listener)` Allow us to subscribe to data from a `Sensor` on another entity.
`<T> SubscriptionHandle`	`subscribeToChildren(Entity parent, Sensor<T> sensor, SensorEventListener<? super T> listener)`
`<T> SubscriptionHandle`	`subscribeToMembers(Group group, Sensor<T> sensor, SensorEventListener<? super T> listener)`
`java.util.Map<java.lang.String,java.lang.String>`	`toMetadataRecord()`
`java.lang.String`	`toString()` Default String representation is simplified name of class, together with selected fields.
`boolean`	`unsubscribe(Entity producer)` Unsubscribes the given producer.
`boolean`	`unsubscribe(Entity producer, SubscriptionHandle handle)` Unsubscribes the given handle.

Methods inherited from class brooklyn.basic.AbstractBrooklynObject
getCatalogItemId, getId, getTagSupport, rebind, setCatalogItemId, tags

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface brooklyn.basic.BrooklynObjectInternal
setCatalogItemId

Methods inherited from interface brooklyn.entity.Entity
getId

Methods inherited from interface brooklyn.basic.BrooklynObject
getCatalogItemId, getTagSupport, tags

- Field Detail
  - SENSOR_ADDED
```
public static final BasicNotificationSensor<Sensor> SENSOR_ADDED
```
  - SENSOR_REMOVED
```
public static final BasicNotificationSensor<Sensor> SENSOR_REMOVED
```
  - EFFECTOR_ADDED
```
public static final BasicNotificationSensor<java.lang.String> EFFECTOR_ADDED
```
  - EFFECTOR_REMOVED
```
public static final BasicNotificationSensor<java.lang.String> EFFECTOR_REMOVED
```
  - EFFECTOR_CHANGED
```
public static final BasicNotificationSensor<java.lang.String> EFFECTOR_CHANGED
```
  - POLICY_ADDED
```
public static final BasicNotificationSensor<PolicyDescriptor> POLICY_ADDED
```
  - POLICY_REMOVED
```
public static final BasicNotificationSensor<PolicyDescriptor> POLICY_REMOVED
```
  - CHILD_ADDED
```
public static final BasicNotificationSensor<Entity> CHILD_ADDED
```
  - CHILD_REMOVED
```
public static final BasicNotificationSensor<Entity> CHILD_REMOVED
```
- Constructor Detail
  - AbstractEntity
```
public AbstractEntity()
```
  - AbstractEntity
```
@Deprecated
public AbstractEntity(java.util.Map flags)
```
    Deprecated. since 0.5; instead use no-arg constructor with EntityManager().createEntity(spec)
  - AbstractEntity
```
@Deprecated
public AbstractEntity(Entity parent)
```
    Deprecated. since 0.5; instead use no-arg constructor with EntityManager().createEntity(spec)
  - AbstractEntity
```
@Deprecated
public AbstractEntity(java.util.Map flags,
                         Entity parent)
```
    Deprecated. since 0.5; instead use no-arg constructor with EntityManager().createEntity(spec)
- Method Detail
  - configure
```
@Deprecated
public AbstractEntity configure(java.util.Map flags)
```
    Deprecated. since 0.7.0; only used for legacy brooklyn types where constructor is called directly
    
    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.)
    
    Specified by:
    
    configure in interface EntityInternal
    
    Returns:
    this entity (i.e. itself)
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - setProxy
```
@Beta
public void setProxy(Entity proxy)
```
    internal use only
  - resetProxy
```
@Beta
public void resetProxy(Entity proxy)
```
    internal use only
  - getProxy
```
public Entity getProxy()
```
  - getProxyIfAvailable
```
@Beta
public Entity getProxyIfAvailable()
```
    Returns the proxy, or if not available (because using legacy code) then returns the real entity. This method will be deleted in a future release; it will be kept while deprecated legacy code still exists that creates entities without setting the proxy.
  - configure
```
public <T> AbstractEntity configure(ConfigKey<T> key,
                           T value)
```
    Sets a config key value, and returns this Entity instance for use in fluent-API style coding.
  - configure
```
public <T> AbstractEntity configure(ConfigKey<T> key,
                           java.lang.String value)
```
  - configure
```
public <T> AbstractEntity configure(ConfigKey.HasConfigKey<T> key,
                           T value)
```
  - configure
```
public <T> AbstractEntity configure(ConfigKey.HasConfigKey<T> key,
                           java.lang.String value)
```
  - setManagementContext
```
public void setManagementContext(ManagementContextInternal managementContext)
```
    Overrides:
    
    setManagementContext in class AbstractBrooklynObject
  - toMetadataRecord
```
public java.util.Map<java.lang.String,java.lang.String> toMetadataRecord()
```
    Specified by:
    
    toMetadataRecord in interface EntityInternal
  - getCreationTime
```
public long getCreationTime()
```
    Description copied from interface: Entity
    
    Returns the creation time for this entity, in UTC.
    
    Specified by:
    
    getCreationTime in interface Entity
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Description copied from interface: Entity
    
    A display name; recommended to be a concise single-line description.
    
    Specified by:
    
    getDisplayName in interface BrooklynObject
    
    Specified by:
    
    getDisplayName in interface Entity
  - getIconUrl
```
public java.lang.String getIconUrl()
```
    Description copied from interface: Entity
    
    A URL pointing to an image which can be used to represent this entity.
    
    Specified by:
    
    getIconUrl in interface Entity
  - setDisplayName
```
public void setDisplayName(java.lang.String newDisplayName)
```
    Description copied from interface: EntityLocal
    
    Sets the entity's display name. Must be called before the entity is managed.
    
    Specified by:
    
    setDisplayName in interface EntityLocal
    
    Specified by:
    
    setDisplayName in class AbstractBrooklynObject
  - setParent
```
public AbstractEntity setParent(Entity entity)
```
    Adds this as a child of the given entity; registers with application if necessary.
    
    Specified by:
    
    setParent in interface Entity
    
    See Also:
    Entity.getParent(), Entity.clearParent()
  - clearParent
```
public void clearParent()
```
    Description copied from interface: Entity
    
    Clears the parent (i.e. "owner") of this entity. Also cleans up any references within its parent entity.
    
    Specified by:
    
    clearParent in interface Entity
    
    See Also:
    Entity.getParent(), Entity.setParent(brooklyn.entity.Entity)
  - addChild
```
public <T extends Entity> T addChild(T child)
```
    Adds the given entity as a child of this parent and sets this entity as the parent of the child; returns argument passed in, for convenience.
    The child is NOT managed, even if the parent is already managed at this point (e.g. the child is added *after* the parent's init() is invoked) and so will need an explicit getEntityManager().manage(childReturnedFromThis) call. These semantics are currently under review.
    
    Specified by:
    
    addChild in interface Entity
  - addChild
```
public <T extends Entity> T addChild(EntitySpec<T> spec)
```
    Creates an entity using the given spec, and adds it as a child of this entity.
    
    Specified by:
    
    addChild in interface Entity
    
    Throws:
    
    java.lang.IllegalArgumentException - If spec.getParent() is set and is different from this entity
    See Also:
    addChild(Entity), EntityManager.createEntity(EntitySpec)
  - removeChild
```
public boolean removeChild(Entity child)
```
    Description copied from interface: Entity
    
    Removes the specified child Entity; its parent will be set to null.
    
    Specified by:
    
    removeChild in interface Entity
    
    Returns:
    True if the given entity was contained in the set of children
  - addGroup
```
public void addGroup(Group e)
```
    Description copied from interface: Entity
    
    Add this entity as a member of the given Group. Called by framework.
    Users should call Group.addMember(Entity) instead; this method will then automatically be called. However, the reverse is not true (calling this method will not tell the group; this behaviour may change in a future release!)
    
    Specified by:
    
    addGroup in interface Entity
  - removeGroup
```
public void removeGroup(Group e)
```
    Description copied from interface: Entity
    
    Removes this entity as a member of the given Group. Called by framework.
    Users should call Group.removeMember(Entity) instead; this method will then automatically be called. However, the reverse is not true (calling this method will not tell the group; this behaviour may change in a future release!)
    
    Specified by:
    
    removeGroup in interface Entity
  - getParent
```
public Entity getParent()
```
    Description copied from interface: Entity
    
    The parent of this entity, null if no parent. The parent is normally the entity responsible for creating/destroying/managing this entity.
    
    Specified by:
    
    getParent in interface Entity
    
    See Also:
    Entity.setParent(Entity), Entity.clearParent()
  - getChildren
```
public java.util.Collection<Entity> getChildren()
```
    Description copied from interface: Entity
    
    Return the entities that are children of (i.e. "owned by") this entity
    
    Specified by:
    
    getChildren in interface Entity
  - getGroups
```
public java.util.Collection<Group> getGroups()
```
    Description copied from interface: Entity
    
    The Collection of Groups that this entity is a member of. Groupings can be used to allow easy management/monitoring of a group of entities.
    
    Specified by:
    
    getGroups in interface Entity
  - getApplication
```
public Application getApplication()
```
    Returns the application, looking it up if not yet known (registering if necessary)
    
    Specified by:
    
    getApplication in interface Entity
    
    Returns:
    the Application this entity is registered with, or null if not registered.
  - getApplicationId
```
public java.lang.String getApplicationId()
```
    Specified by:
    
    getApplicationId in interface Entity
    
    Returns:
    the id of the Application this entity is registered with, or null if not registered.
  - getManagementContext
```
public ManagementContext getManagementContext()
```
    Description copied from interface: EntityInternal
    
    Returns the management context for the entity. If the entity is not yet managed, some operations on the management context will fail. Do not cache this object; instead call getManagementContext() each time you need to use it.
    
    Specified by:
    
    getManagementContext in interface EntityInternal
    
    Overrides:
    
    getManagementContext in class AbstractBrooklynObject
  - getEntityType
```
public EntityType getEntityType()
```
    Description copied from interface: Entity
    
    Information about the type of this entity; analogous to Java's object.getClass.
    
    Specified by:
    
    getEntityType in interface Entity
  - getMutableEntityType
```
public EntityDynamicType getMutableEntityType()
```
    Description copied from interface: EntityInternal
    
    returns the dynamic type corresponding to the type of this entity instance
    
    Specified by:
    
    getMutableEntityType in interface EntityInternal
  - getLocations
```
public java.util.Collection<Location> getLocations()
```
    Description copied from interface: Entity
    
    Return all the Locations this entity is deployed to.
    
    Specified by:
    
    getLocations in interface Entity
  - addLocations
```
public void addLocations(java.util.Collection<? extends Location> newLocations)
```
    Specified by:
    
    addLocations in interface EntityInternal
  - removeLocations
```
public void removeLocations(java.util.Collection<? extends Location> removedLocations)
```
    Specified by:
    
    removeLocations in interface EntityInternal
  - clearLocations
```
public void clearLocations()
```
    Specified by:
    
    clearLocations in interface EntityInternal
  - firstLocation
```
public Location firstLocation()
```
  - destroy
```
public void destroy()
```
    Should be invoked at end-of-life to clean up the item.
    
    Specified by:
    
    destroy in interface EntityInternal
  - getAttribute
```
public <T> T getAttribute(AttributeSensor<T> attribute)
```
    Description copied from interface: Entity
    
    Gets the value of the given attribute on this entity, or null if has not been set. Attributes can be things like workrate and status information, as well as configuration (e.g. url/jmxHost/jmxPort), etc.
    
    Specified by:
    
    getAttribute in interface Entity
  - getAttributeByNameParts
```
public <T> T getAttributeByNameParts(java.util.List<java.lang.String> nameParts)
```
  - setAttribute
```
public <T> T setAttribute(AttributeSensor<T> attribute,
                 T val)
```
    Description copied from interface: EntityLocal
    
    Sets the AttributeSensor data for the given attribute to the specified value. This can be used to "enrich" the entity, such as adding aggregated information, rolling averages, etc.
    
    Specified by:
    
    setAttribute in interface EntityLocal
    
    Returns:
    the old value for the attribute (possibly null)
  - setAttributeWithoutPublishing
```
public <T> T setAttributeWithoutPublishing(AttributeSensor<T> attribute,
                                  T val)
```
    Description copied from interface: EntityInternal
    
    Like EntityLocal.setAttribute(AttributeSensor, Object), except does not publish an attribute-change event.
    
    Specified by:
    
    setAttributeWithoutPublishing in interface EntityInternal
  - modifyAttribute
```
@Beta
public <T> T modifyAttribute(AttributeSensor<T> attribute,
                         com.google.common.base.Function<? super T,Maybe<T>> modifier)
```
    Description copied from interface: EntityLocal
    
    Atomically modifies the AttributeSensor, ensuring that only one modification is done at a time. If the modifier returns Maybe.absent() then the attribute will be left unmodified, and the existing value will be returned. For details of the synchronization model used to achieve this, refer to the underlying attribute store (e.g. AttributeMap).
    
    Specified by:
    
    modifyAttribute in interface EntityLocal
    
    Returns:
    the old value for the attribute (possibly null)
  - removeAttribute
```
public void removeAttribute(AttributeSensor<?> attribute)
```
    Specified by:
    
    removeAttribute in interface EntityInternal
  - setAttribute
```
public <T> T setAttribute(AttributeSensorAndConfigKey<?,T> configuredSensor)
```
    Deprecated. on interface since 0.5.0; use ConfigToAttributes.apply(EntityLocal, AttributeSensorAndConfigKey)
    
    sets the value of the given attribute sensor from the config key value herein if the attribtue sensor is not-set or null
    returns old value
  - getConfig
```
public <T> T getConfig(ConfigKey<T> key)
```
    Description copied from interface: Entity
    
    Gets the given configuration value for this entity, in the following order of preference:
  - value (including null) explicitly set on the entity
  - value (including null) explicitly set on an ancestor (inherited)
  - a default value (including null) on the best equivalent static key of the same name declared on the entity (where best equivalence is defined as preferring a config key which extends another, as computed in EntityDynamicType.getConfigKeys)
  - a default value (including null) on the key itself
  - null

Specified by:: getConfig in interface Entity

getConfig

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

Specified by:: getConfig in interface Entity

getConfig

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

Specified by:: getConfig in interface EntityLocal

getConfig

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

Specified by:: getConfig in interface EntityLocal

getConfigRaw
```
public Maybe<java.lang.Object> getConfigRaw(ConfigKey<?> key,
                                   boolean includeInherited)
```
Description copied from interface: Entity

Returns the uncoerced value for this config key as set on this entity, if available, not following any inheritance chains and not taking any default.

Specified by:

getConfigRaw in interface Entity

getConfigRaw

public Maybe<java.lang.Object> getConfigRaw(ConfigKey.HasConfigKey<?> key,
                                   boolean includeInherited)

Specified by:: getConfigRaw in interface Entity

setConfig
```
public <T> T setConfig(ConfigKey<T> key,
              T val)
```
Description copied from interface: EntityLocal

Must be called before the entity is managed.

Specified by:

setConfig in interface EntityLocal

Specified by:

setConfig in interface Configurable

setConfig

public <T> T setConfig(ConfigKey<T> key,
              Task<T> val)

Specified by:: setConfig in interface EntityLocal

setConfig

public <T> T setConfig(ConfigKey<T> key,
              DeferredSupplier val)

setConfig

public <T> T setConfig(ConfigKey.HasConfigKey<T> key,
              T val)

Specified by:: setConfig in interface EntityLocal

setConfig

public <T> T setConfig(ConfigKey.HasConfigKey<T> key,
              Task<T> val)

Specified by:: setConfig in interface EntityLocal

setConfig

public <T> T setConfig(ConfigKey.HasConfigKey<T> key,
              DeferredSupplier val)

setConfigEvenIfOwned

public <T> T setConfigEvenIfOwned(ConfigKey<T> key,
                         T val)

setConfigEvenIfOwned

public <T> T setConfigEvenIfOwned(ConfigKey.HasConfigKey<T> key,
                         T val)

refreshInheritedConfig
```
public void refreshInheritedConfig()
```
Specified by:

refreshInheritedConfig in interface EntityInternal

getConfigMap
```
public EntityConfigMap getConfigMap()
```
Specified by:

getConfigMap in interface EntityInternal

getAllConfig
```
public java.util.Map<ConfigKey<?>,java.lang.Object> getAllConfig()
```
Specified by:

getAllConfig in interface EntityInternal

Returns:
a read-only copy of all the config key/value pairs on this entity.

getAllConfigBag
```
@Beta
public ConfigBag getAllConfigBag()
```
Description copied from interface: EntityInternal

Returns a read-only view of all the config key/value pairs on this entity, backed by a string-based map, including config names that did not match anything on this entity.

Specified by:

getAllConfigBag in interface EntityInternal

getLocalConfigBag
```
@Beta
public ConfigBag getLocalConfigBag()
```
Description copied from interface: EntityInternal

Returns a read-only view of the local (i.e. not inherited) config key/value pairs on this entity, backed by a string-based map, including config names that did not match anything on this entity.

Specified by:

getLocalConfigBag in interface EntityInternal

getAllAttributes

public java.util.Map<AttributeSensor,java.lang.Object> getAllAttributes()

Specified by:: getAllAttributes in interface EntityInternal

subscribe
```
public <T> SubscriptionHandle subscribe(Entity producer,
                               Sensor<T> sensor,
                               SensorEventListener<? super T> listener)
```
Description copied from interface: EntityLocal

Allow us to subscribe to data from a Sensor on another entity.

Specified by:

subscribe in interface EntityLocal

Returns:
a subscription id which can be used to unsubscribe
See Also:
EntityLocal.subscribe(brooklyn.entity.Entity, brooklyn.event.Sensor<T>, brooklyn.event.SensorEventListener<? super T>)

subscribeToChildren

public <T> SubscriptionHandle subscribeToChildren(Entity parent,
                                         Sensor<T> sensor,
                                         SensorEventListener<? super T> listener)

Specified by:: subscribeToChildren in interface EntityLocal
See Also:: EntityLocal.subscribeToChildren(brooklyn.entity.Entity, brooklyn.event.Sensor<T>, brooklyn.event.SensorEventListener<? super T>)

subscribeToMembers

public <T> SubscriptionHandle subscribeToMembers(Group group,
                                        Sensor<T> sensor,
                                        SensorEventListener<? super T> listener)

Specified by:: subscribeToMembers in interface EntityLocal
See Also:: EntityLocal.subscribeToMembers(brooklyn.entity.Group, brooklyn.event.Sensor<T>, brooklyn.event.SensorEventListener<? super T>)

unsubscribe
```
public boolean unsubscribe(Entity producer)
```
Unsubscribes the given producer.

Specified by:

unsubscribe in interface EntityLocal

See Also:
SubscriptionContext.unsubscribe(SubscriptionHandle)

unsubscribe
```
public boolean unsubscribe(Entity producer,
                  SubscriptionHandle handle)
```
Unsubscribes the given handle.

Specified by:

unsubscribe in interface EntityLocal

See Also:
SubscriptionContext.unsubscribe(SubscriptionHandle)

getSubscriptionContext
```
public SubscriptionContext getSubscriptionContext()
```
Specified by:

getSubscriptionContext in interface EntityInternal

getExecutionContext
```
public ExecutionContext getExecutionContext()
```
Description copied from interface: EntityInternal

Returns the task execution context for the entity. If the entity is not yet managed, some operations on the management context will fail. Do not cache this object; instead call getExecutionContext() each time you need to use it.

Specified by:

getExecutionContext in interface EntityInternal

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

init
```
public void init()
```
Default entity initialization, just calls initEnrichers().

Overrides:

init in class AbstractBrooklynObject

getPolicies
```
public java.util.Collection<Policy> getPolicies()
```
Specified by:

getPolicies in interface Entity

Returns:
an immutable thread-safe view of the policies.

addPolicy
```
public void addPolicy(Policy policy)
```
Description copied from interface: Entity

Adds the given policy to this entity. Also calls policy.setEntity if available.

Specified by:

addPolicy in interface Entity

addPolicy
```
public <T extends Policy> T addPolicy(PolicySpec<T> spec)
```
Description copied from interface: Entity

Adds the given policy to this entity. Also calls policy.setEntity if available.

Specified by:

addPolicy in interface Entity

addEnricher
```
public <T extends Enricher> T addEnricher(EnricherSpec<T> spec)
```
Description copied from interface: Entity

Adds the given enricher to this entity. Also calls enricher.setEntity if available.

Specified by:

addEnricher in interface Entity

removePolicy
```
public boolean removePolicy(Policy policy)
```
Description copied from interface: Entity

Removes the given policy from this entity.

Specified by:

removePolicy in interface Entity

Returns:
True if the policy existed at this entity; false otherwise

removeAllPolicies
```
public boolean removeAllPolicies()
```
Description copied from interface: EntityLocal

Removes all policy from this entity.

Specified by:

removeAllPolicies in interface EntityLocal

Returns:
True if any policies existed at this entity; false otherwise

getEnrichers
```
public java.util.Collection<Enricher> getEnrichers()
```
Specified by:

getEnrichers in interface Entity

Returns:
an immutable thread-safe view of the enrichers.

addEnricher
```
public void addEnricher(Enricher enricher)
```
Description copied from interface: Entity

Adds the given enricher to this entity. Also calls enricher.setEntity if available.

Specified by:

addEnricher in interface Entity

removeEnricher
```
public boolean removeEnricher(Enricher enricher)
```
Description copied from interface: Entity

Removes the given enricher from this entity.

Specified by:

removeEnricher in interface Entity

Returns:
True if the policy enricher at this entity; false otherwise

removeAllEnrichers
```
public boolean removeAllEnrichers()
```
Description copied from interface: EntityLocal

Removes all enricher from this entity. Use with caution as some entities automatically register enrichers; this will remove those enrichers as well.

Specified by:

removeAllEnrichers in interface EntityLocal

Returns:
True if any enrichers existed at this entity; false otherwise

addFeed
```
public <T extends Feed> T addFeed(T feed)
```
Convenience, which calls EntityInternal.feeds() and FeedSupport#addFeed(Feed).

Specified by:

addFeed in interface Entity

feeds
```
public EntityInternal.FeedSupport feeds()
```
Specified by:

feeds in interface EntityInternal

getFeedSupport
```
@Deprecated
public EntityInternal.FeedSupport getFeedSupport()
```
Deprecated.

Specified by:

getFeedSupport in interface EntityInternal

emit
```
public <T> void emit(Sensor<T> sensor,
            T val)
```
Description copied from interface: EntityLocal

Emits a SensorEvent event on behalf of this entity (as though produced by this entity).
Note that for attribute sensors it is nearly always recommended to use setAttribute, as this method will not update local values.

Specified by:

emit in interface EntityLocal

emitInternal

public <T> void emitInternal(Sensor<T> sensor,
                    T val)

getEffector
```
public Effector<?> getEffector(java.lang.String effectorName)
```
Convenience for finding named effector in EntityType.getEffectors() Map.

Specified by:

getEffector in interface EntityInternal

invoke

public <T> Task<T> invoke(Effector<T> eff)

Invoke an Effector directly.

invoke

public <T> Task<T> invoke(java.util.Map parameters,
                 Effector<T> eff)

invoke
```
public <T> Task<T> invoke(Effector<T> eff,
                 java.util.Map<java.lang.String,?> parameters)
```
Additional form supplied for when the parameter map needs to be made explicit.

Specified by:

invoke in interface Entity

See Also:
invoke(Effector)

onManagementStarting
```
public void onManagementStarting()
```
Invoked by EntityManagementSupport when this entity is becoming managed (i.e. it has a working management context, but before the entity is visible to other entities), including during a rebind.

onManagementStarted
```
public void onManagementStarted()
```
Invoked by EntityManagementSupport when this entity is fully managed and visible to other entities through the management context.

onManagementBecomingMaster
```
public void onManagementBecomingMaster()
```
Deprecated. since 0.4.0 override EntityManagementSupport.onManagementStarted if customization needed

Invoked by ManagementContext when this entity becomes managed at a particular management node, including the initial management started and subsequent management node master-change for this entity.

onManagementNoLongerMaster
```
public void onManagementNoLongerMaster()
```
Deprecated. since 0.4.0 override EntityManagementSupport.onManagementStopped if customization needed

Invoked by ManagementContext when this entity becomes mastered at a particular management node, including the final management end and subsequent management node master-change for this entity.

onManagementStopped
```
public void onManagementStopped()
```
Invoked by EntityManagementSupport when this entity is fully unmanaged.
Note that the activies possible here (when unmanaged) are limited, and that this event may be caused by either a brooklyn node itself being demoted (so the entity is managed elsewhere) or by a controlled shutdown.

invalidateReferences
```
public void invalidateReferences()
```
For use by management plane, to invalidate all fields (e.g. when an entity is changing to being proxied)

getManagementSupport
```
public EntityManagementSupport getManagementSupport()
```
Specified by:

getManagementSupport in interface EntityInternal

Returns:
Routings for accessing and inspecting the management context of the entity

requestPersist
```
public void requestPersist()
```
Description copied from interface: EntityInternal

Can be called to request that the entity be persisted. This persistence may happen asynchronously, or may not happen at all if persistence is disabled.

Specified by:

requestPersist in interface EntityInternal

getRebindSupport
```
@Beta
public RebindSupport<EntityMemento> getRebindSupport()
```
As described in EntityInternal.getRebindSupport()... Users are strongly discouraged to call or override 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 EntityInternal

Specified by:

getRebindSupport in interface Rebindable

getTags

public java.util.Set<java.lang.Object> getTags()

Specified by:: getTags in interface Entity

addTag

public boolean addTag(java.lang.Object tag)

Specified by:: addTag in interface Entity

removeTag

public boolean removeTag(java.lang.Object tag)

Specified by:: removeTag in interface Entity

containsTag
```
public boolean containsTag(java.lang.Object tag)
```
Specified by:

containsTag in interface Entity

Class AbstractEntity

Nested Class Summary

Nested classes/interfaces inherited from interface brooklyn.entity.basic.EntityInternal

Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class brooklyn.basic.AbstractBrooklynObject

Methods inherited from class java.lang.Object

Methods inherited from interface brooklyn.basic.BrooklynObjectInternal

Methods inherited from interface brooklyn.entity.Entity

Methods inherited from interface brooklyn.basic.BrooklynObject

Field Detail

SENSOR_ADDED

SENSOR_REMOVED

EFFECTOR_ADDED

EFFECTOR_REMOVED

EFFECTOR_CHANGED

POLICY_ADDED

POLICY_REMOVED

CHILD_ADDED

CHILD_REMOVED

Constructor Detail

AbstractEntity

AbstractEntity

AbstractEntity

AbstractEntity

Method Detail

configure

hashCode

equals

setProxy

resetProxy

getProxy

getProxyIfAvailable

configure

configure

configure

configure

setManagementContext

toMetadataRecord

getCreationTime

getDisplayName

getIconUrl

setDisplayName

setParent

clearParent

addChild

addChild

removeChild

addGroup

removeGroup

getParent

getChildren

getGroups

getApplication

getApplicationId

getManagementContext

getEntityType

getMutableEntityType

getLocations

addLocations

removeLocations

clearLocations

firstLocation

destroy

getAttribute

getAttributeByNameParts

setAttribute

setAttributeWithoutPublishing

modifyAttribute

removeAttribute

setAttribute

getConfig

getConfig

getConfig

getConfig

getConfigRaw

getConfigRaw

setConfig