Method Detail

• addLocations

  void addLocations(java.util.Collection<? extends Location> locations)

• removeLocations

  void removeLocations(java.util.Collection<? extends Location> locations)

• clearLocations

  void clearLocations()

• setAttributeWithoutPublishing

  <T> T setAttributeWithoutPublishing(AttributeSensor<T> sensor,
                                    T val)

  Deprecated. since 0.8.0; use EntityInternal.SensorSupportInternal.setWithoutPublishing(AttributeSensor, Object) via code like sensors().setWithoutPublishing(attribute, val).

• getConfigMap

  @Deprecated
  EntityConfigMap getConfigMap()

  Deprecated. since 0.7.0; instead just use methods on BrooklynObjectInternal.ConfigurationSupportInternal returned by BrooklynObjectInternal.config()

• getAllConfig

  @Deprecated
  @Beta
  java.util.Map<ConfigKey<?>,java.lang.Object> getAllConfig()

  Deprecated. since 0.7.0; instead just use methods on BrooklynObjectInternal.ConfigurationSupportInternal returned by BrooklynObjectInternal.config(), e.g. getBag().getAllConfigAsConfigKeyMap().

  Returns:

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

• getAllConfigBag

  @Deprecated
  ConfigBag getAllConfigBag()

  Deprecated. since 0.7.0; use BrooklynObjectInternal.config(), such as entity.config().getBag()
  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.

• getLocalConfigBag

  @Deprecated
  ConfigBag getLocalConfigBag()

  Deprecated. since 0.7.0; use BrooklynObjectInternal.config(), such as entity.config().getLocalBag()
  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.

• getAllAttributes

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

  Deprecated. since 0.8.0; use EntityInternal.SensorSupportInternal.getAll() via code like sensors().getAll().

• removeAttribute

  @Beta
  void removeAttribute(AttributeSensor<?> attribute)

  Deprecated. since 0.8.0; use EntityInternal.SensorSupportInternal.remove(AttributeSensor) via code like sensors().remove(attribute).

• refreshInheritedConfig

  @Deprecated
  void refreshInheritedConfig()

  Deprecated. since 0.7.0; use BrooklynObjectInternal.config(), such as entity.config().refreshInheritedConfig()

• configure

  @Beta
  EntityInternal configure(java.util.Map flags)

  Must be called before the entity is started.

  Returns:

  this entity (i.e. itself)

• getManagementSupport

  EntityManagementSupport getManagementSupport()

  Returns:

  Routings for accessing and inspecting the management context of the entity

• destroy

  @Beta
  void destroy()

  Should be invoked at end-of-life to clean up the item.

• getManagementContext

  ManagementContext getManagementContext()

  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.

• getExecutionContext

  ExecutionContext getExecutionContext()

  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.

• getSubscriptionContext

  SubscriptionContext getSubscriptionContext()

• getMutableEntityType

  @Beta
  EntityDynamicType getMutableEntityType()

  returns the dynamic type corresponding to the type of this entity instance

• getEffector

  @Beta
  Effector<?> getEffector(java.lang.String effectorName)

  returns the effector registered against a given name

• feeds

  EntityInternal.FeedSupport feeds()

• getFeedSupport

  @Deprecated
  EntityInternal.FeedSupport getFeedSupport()

  Deprecated. since 0.7.0-M2; use feeds()

  Since:

  0.7.0-M2

• toMetadataRecord

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

• getRebindSupport

  @Beta
  RebindSupport<EntityMemento> 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

• requestPersist

  void requestPersist()

  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.

• sensors

  EntityInternal.SensorSupportInternal sensors()

  Specified by:

  sensors in interface Entity