Method Detail

• getId

  java.lang.String getId()

  The unique identifier for this entity.

  Specified by:

  getId in interface Identifiable

• getCreationTime

  long getCreationTime()

  Returns the creation time for this entity, in UTC.

• getDisplayName

  java.lang.String getDisplayName()

  A display name; recommended to be a concise single-line description.

  Specified by:

  getDisplayName in interface BrooklynObject

• getIconUrl

  @Nullable
  java.lang.String getIconUrl()

  A URL pointing to an image which can be used to represent this entity.

• getEntityType

  EntityType getEntityType()

  Information about the type of this entity; analogous to Java's object.getClass.

• getApplication

  Application getApplication()

  Returns:

  the Application this entity is registered with, or null if not registered.

• getApplicationId

  java.lang.String getApplicationId()

  Returns:

  the id of the Application this entity is registered with, or null if not registered.

• getParent

  Entity getParent()

  The parent of this entity, null if no parent. The parent is normally the entity responsible for creating/destroying/managing this entity.

  See Also:

  setParent(Entity), clearParent()

• getChildren

  java.util.Collection<Entity> getChildren()

  Return the entities that are children of (i.e. "owned by") this entity

• setParent

  Entity setParent(Entity parent)

  Sets the parent (i.e. "owner") of this entity. Returns this entity, for convenience.

  See Also:

  getParent(), clearParent()

• clearParent

  void clearParent()

  Clears the parent (i.e. "owner") of this entity. Also cleans up any references within its parent entity.

  See Also:

  getParent(), setParent(org.apache.brooklyn.api.entity.Entity)

• addChild

  <T extends Entity> T addChild(T child)

  Add a child Entity, and set this entity as its parent, returning the added child.

  As with addChild(EntitySpec) the child is not brought under management as part of this call. It should not be managed prior to this call either.

• addChild

  <T extends Entity> T addChild(EntitySpec<T> spec)

  Creates an Entity from the given spec and adds it, setting this entity as the parent, returning the added child.

  The added child is not managed as part of this call, even if the parent is managed, so if adding post-management an explicit call to manage the child will be needed; see the convenience method Entities.manage(...).

• removeChild

  boolean removeChild(Entity child)

  Removes the specified child Entity; its parent will be set to null.

  Returns:

  True if the given entity was contained in the set of children

• getPolicies

  java.util.Collection<Policy> getPolicies()

  Returns:

  an immutable thread-safe view of the policies.

• getEnrichers

  java.util.Collection<Enricher> getEnrichers()

  Returns:

  an immutable thread-safe view of the enrichers.

• getGroups

  java.util.Collection<Group> getGroups()

  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.

• addGroup

  void addGroup(Group group)

  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!)

• removeGroup

  void removeGroup(Group group)

  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!)

• getLocations

  java.util.Collection<Location> getLocations()

  Return all the Locations this entity is deployed to.

• getAttribute

  <T> T getAttribute(AttributeSensor<T> sensor)

  Convenience for calling Entity.SensorSupport.get(AttributeSensor), via code like sensors().get(key).

• getConfig

  <T> T getConfig(ConfigKey<T> key)

  Convenience for calling Configurable.ConfigurationSupport.get(ConfigKey), via code like config().get(key).

• getConfig

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

  See Also:

  getConfig(ConfigKey)}

• getConfigRaw

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

  Deprecated. since 0.7.0; use ((EntityInternal)entity).config().getRaw() or ((EntityInternal)entity).config().getLocalRaw()
  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.

• getConfigRaw

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

  Deprecated. since 0.7.0

  See Also:

  #getConfigRaw(ConfigKey, boolean)}.

• invoke

  <T> Task<T> invoke(Effector<T> eff,
                   java.util.Map<java.lang.String,?> parameters)

  Invokes the given effector, with the given parameters to that effector.

• addPolicy

  void addPolicy(Policy policy)

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

• addPolicy

  <T extends Policy> T addPolicy(PolicySpec<T> enricher)

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

• removePolicy

  boolean removePolicy(Policy policy)

  Removes the given policy from this entity.

  Returns:

  True if the policy existed at this entity; false otherwise

• addEnricher

  void addEnricher(Enricher enricher)

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

• addEnricher

  <T extends Enricher> T addEnricher(EnricherSpec<T> enricher)

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

• removeEnricher

  boolean removeEnricher(Enricher enricher)

  Removes the given enricher from this entity.

  Returns:

  True if the policy enricher at this entity; false otherwise

• addFeed

  <T extends Feed> T addFeed(T feed)

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

• sensors

  Entity.SensorSupport sensors()