AbstractEntity (Apache Brooklyn)

java.lang.Object
- org.apache.brooklyn.core.objs.AbstractBrooklynObject
- - org.apache.brooklyn.core.entity.AbstractEntity

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractApplication, AbstractGeoDnsServiceImpl, AbstractGroupImpl, AbstractNonProvisionedControllerImpl, BalanceableWorkerPoolImpl, BasicEntityImpl, BasicStartableImpl, BrooklynEntityMirrorImpl, BrooklynMetricsImpl, DataEntityImpl, DelegateEntityImpl, DerbySchema, EffectorStartableImpl, FollowTheSunPoolImpl, JMSDestinationImpl, KafkaClusterImpl, MongoDBShardedDeploymentImpl, MoreEntityImpl, RabbitDestination, RedisClusterImpl, RedisShardImpl, SameServerEntityImpl, SequenceEntityImpl, SimpleEntityImpl, SimulatedExternalMonitorImpl, SoftwareProcessImpl, TargetableTestComponentImpl, ZabbixServerImpl
```
public abstract class AbstractEntity
extends AbstractBrooklynObject
implements 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.
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
Modifier and Type	Class and Description
`class`	`AbstractEntity.BasicConfigurationSupport` Direct use of this class is strongly discouraged.
`class`	`AbstractEntity.BasicEnricherSupport` Direct use of this class is strongly discouraged.
`class`	`AbstractEntity.BasicGroupSupport` Direct use of this class is strongly discouraged.
`class`	`AbstractEntity.BasicPolicySupport` Direct use of this class is strongly discouraged.
`class`	`AbstractEntity.BasicSensorSupport` Direct use of this class is strongly discouraged.
`class`	`AbstractEntity.BasicSubscriptionSupport` Direct use of this class is strongly discouraged.

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.entity.EntityInternal
EntityInternal.EnricherSupportInternal, EntityInternal.EntitySubscriptionSupportInternal, EntityInternal.FeedSupport, EntityInternal.GroupSupportInternal, EntityInternal.PolicySupportInternal, EntityInternal.SensorSupportInternal

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.entity.Entity
Entity.AdjunctSupport<T extends EntityAdjunct>, Entity.EnricherSupport, Entity.GroupSupport, Entity.PolicySupport, Entity.SensorSupport

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 AttributeSensor<java.lang.String>`	`APPLICATION_ID`
`static AttributeSensor<java.lang.String>`	`CATALOG_ID`
`static BasicNotificationSensor<Entity>`	`CHILD_ADDED`
`static BasicNotificationSensor<Entity>`	`CHILD_REMOVED`
`static BasicNotificationSensor<ConfigKey>`	`CONFIG_KEY_ADDED`
`static BasicNotificationSensor<ConfigKey>`	`CONFIG_KEY_REMOVED`
`static ConfigKey<java.lang.String>`	`DEFAULT_DISPLAY_NAME` The default name to use for this entity, if not explicitly overridden.
`static BasicNotificationSensor<java.lang.String>`	`EFFECTOR_ADDED`
`static BasicNotificationSensor<java.lang.String>`	`EFFECTOR_CHANGED`
`static BasicNotificationSensor<java.lang.String>`	`EFFECTOR_REMOVED`
`static AttributeSensor<java.lang.String>`	`ENTITY_ID`
`static BasicNotificationSensor<Group>`	`GROUP_ADDED`
`static BasicNotificationSensor<Group>`	`GROUP_REMOVED`
`static BasicNotificationSensor<Location>`	`LOCATION_ADDED`
`static BasicNotificationSensor<Location>`	`LOCATION_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

All Methods Instance Methods Concrete Methods Deprecated 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.
`<T extends Feed> T`	`addFeed(T feed)` Convenience, which calls `EntityInternal.feeds()` and `FeedSupport#addFeed(Feed)`.
`void`	`addLocations(java.util.Collection<? extends Location> newLocations)`
`void`	`addLocationsWithoutPublishing(java.util.Collection<? extends Location> newLocations)` Adds the given locations to this entity, but without emitting `LOCATION_ADDED` events, and without auto-managing the locations.
`void`	`clearLocations()`
`void`	`clearParent()` Clears the parent (i.e.
`AbstractEntity.BasicConfigurationSupport`	`config()`
`void`	`configure(java.lang.Iterable<ConfigKey<?>> configKeys)` Adds the config keys to the entity dynamic type
`AbstractEntity`	`configure(java.util.Map flags)` Deprecated. since 0.7.0; only used for legacy brooklyn types where constructor is called directly
`void`	`destroy()` Should be invoked at end-of-life to clean up the item.
`AbstractEntity.BasicEnricherSupport`	`enrichers()`
`boolean`	`equals(java.lang.Object o)`
`EntityInternal.FeedSupport`	`feeds()`
`Location`	`firstLocation()`
`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)` Convenience for calling `Entity.SensorSupport.get(AttributeSensor)`, via code like `sensors().get(key)`.
`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<T> key)` Convenience for calling `Configurable.ConfigurationSupport.get(ConfigKey)`, via code like `config().get(key)`.
`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`.
`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.
`java.lang.String`	`getIconUrl()` Deprecated.
`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.
`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()`...
`AbstractEntity.BasicGroupSupport`	`groups()`
`int`	`hashCode()`
`void`	`init()` Default entity initialization sets ID sensors and 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)`
`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.
`AbstractEntity.BasicPolicySupport`	`policies()`
`BrooklynObjectInternal.RelationSupportInternal<Entity>`	`relations()` Relations specify a typed, directed connection between two entities.
`boolean`	`removeChild(Entity child)` Removes the specified child `Entity`; its parent will be set to null.
`void`	`removeLocations(java.util.Collection<? extends Location> removedLocations)`
`void`	`requestPersist()` Can be called to request that the entity be persisted.
`void`	`resetProxy(Entity proxy)` internal use only
`AbstractEntity.BasicSensorSupport`	`sensors()`
`<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
`AbstractEntity.BasicSubscriptionSupport`	`subscriptions()` Subscriptions are the mechanism for receiving notifications of sensor-events (e.g.
`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.

Methods inherited from class org.apache.brooklyn.core.objs.AbstractBrooklynObject
addSearchPath, getCatalogItemId, getCatalogItemIdSearchPath, getId, rebind, 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.objs.BrooklynObjectInternal
addSearchPath, setCatalogItemId, setCatalogItemIdAndSearchPath, stackCatalogItemId

Methods inherited from interface org.apache.brooklyn.api.entity.Entity
getId

Methods inherited from interface org.apache.brooklyn.api.objs.BrooklynObject
getCatalogItemId, getCatalogItemIdSearchPath, tags

- Field Detail
  - DEFAULT_DISPLAY_NAME
```
public static final ConfigKey<java.lang.String> DEFAULT_DISPLAY_NAME
```
    The default name to use for this entity, if not explicitly overridden.
  - LOCATION_ADDED
```
public static final BasicNotificationSensor<Location> LOCATION_ADDED
```
  - LOCATION_REMOVED
```
public static final BasicNotificationSensor<Location> LOCATION_REMOVED
```
  - 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
```
  - CONFIG_KEY_ADDED
```
public static final BasicNotificationSensor<ConfigKey> CONFIG_KEY_ADDED
```
  - CONFIG_KEY_REMOVED
```
public static final BasicNotificationSensor<ConfigKey> CONFIG_KEY_REMOVED
```
  - 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
```
  - GROUP_ADDED
```
public static final BasicNotificationSensor<Group> GROUP_ADDED
```
  - GROUP_REMOVED
```
public static final BasicNotificationSensor<Group> GROUP_REMOVED
```
  - ENTITY_ID
```
public static final AttributeSensor<java.lang.String> ENTITY_ID
```
  - APPLICATION_ID
```
public static final AttributeSensor<java.lang.String> APPLICATION_ID
```
  - CATALOG_ID
```
public static final AttributeSensor<java.lang.String> CATALOG_ID
```
- 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)
  - configure
```
public void configure(java.lang.Iterable<ConfigKey<?>> configKeys)
```
    Adds the config keys to the entity dynamic type
    
    Since:
    
    0.9.0
  - 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
```
public void setProxy(Entity proxy)
```
    internal use only
  - resetProxy
```
public void resetProxy(Entity proxy)
```
    internal use only
  - getProxy
```
public Entity getProxy()
```
  - getProxyIfAvailable
```
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.
  - 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: BrooklynObject
    
    A display name; recommended to be a concise single-line description.
    
    Specified by:
    
    getDisplayName in interface Entity
    
    Specified by:
    
    getDisplayName in interface BrooklynObject
  - getIconUrl
```
@Deprecated
public java.lang.String getIconUrl()
```
    Deprecated.
    
    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: Entity
    
    Sets the entity's display name.
    
    Specified by:
    
    setDisplayName in interface Entity
    
    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(org.apache.brooklyn.api.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
  - groups
```
public AbstractEntity.BasicGroupSupport groups()
```
    Specified by:
    
    groups in interface Entity
    
    Specified by:
    
    groups in interface EntityInternal
  - 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
  - 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
    
    Specified by:
    
    getManagementContext in interface BrooklynObjectInternal
    
    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
  - addLocationsWithoutPublishing
```
public void addLocationsWithoutPublishing(java.util.Collection<? extends Location> newLocations)
```
    Description copied from interface: EntityInternal
    
    Adds the given locations to this entity, but without emitting LOCATION_ADDED events, and without auto-managing the locations. This is for internal purposes only; it is primarily intended for use during rebind.
    
    Specified by:
    
    addLocationsWithoutPublishing 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
    
    Convenience for calling Entity.SensorSupport.get(AttributeSensor), via code like sensors().get(key).
    
    Specified by:
    
    getAttribute in interface Entity
  - config
```
public AbstractEntity.BasicConfigurationSupport config()
```
    Specified by:
    
    config in interface Configurable
    
    Specified by:
    
    config in interface BrooklynObjectInternal
  - sensors
```
public AbstractEntity.BasicSensorSupport sensors()
```
    Specified by:
    
    sensors in interface Entity
    
    Specified by:
    
    sensors in interface EntityInternal
  - 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
  - getConfig
```
public <T> T getConfig(ConfigKey.HasConfigKey<T> key)
```
    Specified by:
    
    getConfig in interface Entity
    
    See Also:
    
    #getConfig(ConfigKey)}
  - setConfigEvenIfOwned
```
public <T> T setConfigEvenIfOwned(ConfigKey<T> key,
                                  T val)
```
  - setConfigEvenIfOwned
```
public <T> T setConfigEvenIfOwned(ConfigKey.HasConfigKey<T> key,
                                  T val)
```
  - subscriptions
```
public AbstractEntity.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 EntityInternal
    
    Specified by:
    
    subscriptions in interface BrooklynObjectInternal
  - 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 sets ID sensors and calls initEnrichers().
    
    Overrides:
    
    init in class AbstractBrooklynObject
  - policies
```
public AbstractEntity.BasicPolicySupport policies()
```
    Specified by:
    
    policies in interface Entity
    
    Specified by:
    
    policies in interface EntityInternal
  - enrichers
```
public AbstractEntity.BasicEnricherSupport enrichers()
```
    Specified by:
    
    enrichers in interface Entity
    
    Specified by:
    
    enrichers in interface EntityInternal
  - 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
  - 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
```
@Deprecated
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
```
@Deprecated
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
```
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 Rebindable
    
    Specified by:
    
    getRebindSupport in interface EntityInternal
    
    Specified by:
    
    getRebindSupport in interface BrooklynObjectInternal
  - relations
```
public BrooklynObjectInternal.RelationSupportInternal<Entity> 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 Entity
    
    Specified by:
    
    relations in interface BrooklynObject
    
    Specified by:
    
    relations in interface EntityInternal
    
    Specified by:
    
    relations in interface BrooklynObjectInternal
    
    Overrides:
    
    relations in class AbstractBrooklynObject

Class AbstractEntity

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.entity.EntityInternal

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

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.entity.Entity

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.Configurable

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.brooklyn.core.objs.AbstractBrooklynObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.brooklyn.api.entity.Entity

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

Field Detail

DEFAULT_DISPLAY_NAME

LOCATION_ADDED

LOCATION_REMOVED

SENSOR_ADDED

SENSOR_REMOVED

EFFECTOR_ADDED

EFFECTOR_REMOVED

EFFECTOR_CHANGED

CONFIG_KEY_ADDED

CONFIG_KEY_REMOVED

POLICY_ADDED

POLICY_REMOVED

CHILD_ADDED

CHILD_REMOVED

GROUP_ADDED

GROUP_REMOVED

ENTITY_ID

APPLICATION_ID

CATALOG_ID

Constructor Detail

AbstractEntity

AbstractEntity

AbstractEntity

AbstractEntity

Method Detail

configure

configure

hashCode

equals

setProxy

resetProxy

getProxy

getProxyIfAvailable

setManagementContext

toMetadataRecord

getCreationTime

getDisplayName

getIconUrl

setDisplayName

setParent

clearParent

addChild

addChild

removeChild

groups

getParent

getChildren

getApplication

getApplicationId

getManagementContext

getEntityType

getMutableEntityType

getLocations

addLocations

addLocationsWithoutPublishing

removeLocations

clearLocations

firstLocation

destroy

getAttribute

config

sensors

getConfig

getConfig