Entity (Apache Brooklyn)

All Superinterfaces:

BrooklynObject, Configurable, Identifiable

All Known Subinterfaces:

AbstractController, AbstractGeoDnsService, AbstractGroup, AbstractMongoDBServer, AbstractNonProvisionedController, AbstractVanillaProcess, ActiveMQBroker, ActiveMQDestination, ActiveMQQueue, ActiveMQTopic, AmqpServer, Application, BalanceableContainer<ItemType>, BalanceableWorkerPool, BasicApplication, BasicEntity, BasicGroup, BasicStartable, BindDnsServer, BrooklynCluster, BrooklynEntityMirror, BrooklynMetrics, BrooklynNode, CassandraCluster, CassandraDatacenter, CassandraFabric, CassandraNode, ChefEntity, Cluster, CoLocatedMongoDBRouter, ControlledDynamicWebAppCluster, CouchbaseCluster, CouchbaseNode, CouchbaseSyncGateway, CouchDBCluster, CouchDBNode, CrateNode, DatabaseNode, DataEntity, DatastoreMixins.DatastoreCommon, DelegateEntity, DriverDependentEntity<D>, DynamicCluster, DynamicFabric, DynamicGroup, DynamicMultiGroup, DynamicRegionsFabric, DynamicWebAppCluster, DynamicWebAppFabric, ElasticJavaWebAppService, ElasticSearchCluster, ElasticSearchNode, EmptySoftwareProcess, EntityInternal, EntityLocal, Fabric, FollowTheSunPool, GeoscalingDnsService, Group, ItemsInContainersGroup, JavaWebAppService, JavaWebAppService.CanDeployAndUndeploy, JavaWebAppSoftwareProcess, JBoss6Server, JBoss7Server, Jetty6Server, JMSBroker<Q,T>, JMSDestination, KafkaBroker, KafkaCluster, KafkaZooKeeper, KarafContainer, LoadBalancer, LoadBalancerCluster, LocalBrooklynNode, MachineEntity, MariaDbNode, MessageBroker, MongoDBClient, MongoDBConfigServer, MongoDBConfigServerCluster, MongoDBReplicaSet, MongoDBRouter, MongoDBRouterCluster, MongoDBServer, MongoDBShardCluster, MongoDBShardedDeployment, MonitNode, MoreEntity, Movable, MySqlNode, NginxController, NodeJsWebAppService, PostgreSqlNode, QpidBroker, QpidDestination, QpidQueue, QpidTopic, QuarantineGroup, RabbitBroker, RedisCluster, RedisShard, RedisSlave, RedisStore, RiakCluster, RiakNode, RubyRepNode, SameServerEntity, ServerPool, SimpleApplication, SimpleEntity, SoftwareProcess, SolrServer, StartableApplication, Storm, StormDeployment, Tier, Tomcat8Server, TomcatServer, UrlMapping, VanillaJavaApp, VanillaSoftwareProcess, VanillaWindowsProcess, WebAppService, ZooKeeperEnsemble, ZooKeeperNode

All Known Implementing Classes:

AbstractApplication, AbstractControllerImpl, AbstractEntity, AbstractGeoDnsServiceImpl, AbstractGroupImpl, AbstractNonProvisionedControllerImpl, AbstractZooKeeperImpl, ActiveMQBrokerImpl, ActiveMQDestinationImpl, ActiveMQQueueImpl, ActiveMQTopicImpl, BalanceableWorkerPoolImpl, BasicApplicationImpl, BasicEntityImpl, BasicGroupImpl, BasicStartableImpl, BindDnsServerImpl, BrooklynClusterImpl, BrooklynEntityMirrorImpl, BrooklynMetricsImpl, BrooklynNodeImpl, CassandraClusterImpl, CassandraDatacenterImpl, CassandraFabricImpl, CassandraNodeImpl, ChefEntityImpl, CoLocatedMongoDBRouterImpl, ControlledDynamicWebAppClusterImpl, CouchbaseClusterImpl, CouchbaseNodeImpl, CouchbaseSyncGatewayImpl, CouchDBClusterImpl, CouchDBNodeImpl, CrateNodeImpl, CumulusRDFApplication, DataEntityImpl, DelegateEntityImpl, DynamicClusterImpl, DynamicFabricImpl, DynamicGroupImpl, DynamicMultiGroupImpl, DynamicRegionsFabricImpl, DynamicWebAppClusterImpl, DynamicWebAppFabricImpl, EffectorStartableImpl, ElasticSearchClusterImpl, ElasticSearchNodeImpl, EmptySoftwareProcessImpl, FollowTheSunPoolImpl, GeoscalingDnsServiceImpl, GlobalWebFabricExample, HighAvailabilityCassandraCluster, ItemsInContainersGroupImpl, JavaWebAppSoftwareProcessImpl, JBoss6ServerImpl, JBoss7ServerImpl, Jetty6ServerImpl, JMSBrokerImpl, JMSDestinationImpl, KafkaBrokerImpl, KafkaClusterImpl, KafkaTopic, KafkaZooKeeperImpl, KarafContainerImpl, LoadBalancerClusterImpl, LocalBrooklynNodeImpl, MachineEntityImpl, MariaDbNodeImpl, MongoDBClientImpl, MongoDBConfigServerClusterImpl, MongoDBConfigServerImpl, MongoDBReplicaSetImpl, MongoDBRouterClusterImpl, MongoDBRouterImpl, MongoDBServerImpl, MongoDBShardClusterImpl, MongoDBShardedDeploymentImpl, MonitNodeImpl, MoreEntityImpl, MoreTemplate, MySqlNodeImpl, NginxControllerImpl, NodeJsTodoApplication, NodeJsWebAppServiceImpl, PostgreSqlNodeChefImplFromScratch, PostgreSqlNodeImpl, QpidBrokerImpl, QpidDestinationImpl, QpidQueueImpl, QpidTopicImpl, QuarantineGroupImpl, RabbitBrokerImpl, RabbitDestination, RabbitQueue, RedisClusterImpl, RedisShardImpl, RedisSlaveImpl, RedisStoreImpl, ResilientMongoDbApp, RiakClusterExample, RiakClusterImpl, RiakNodeImpl, RubyRepNodeImpl, SameServerEntityImpl, ServerPoolImpl, SimpleApplicationImpl, SimpleCassandraCluster, SimpleEntityImpl, SimulatedJBoss7ServerImpl, SimulatedMySqlNodeImpl, SimulatedNginxControllerImpl, SimulatedTheeTierApp, SingleWebServerExample, SoftwareProcessImpl, SolrServerImpl, StandaloneQpidBrokerExample, StormDeploymentImpl, StormImpl, StormSampleApp, Tomcat8ServerImpl, TomcatServerImpl, UrlMappingImpl, VanillaJavaAppImpl, VanillaSoftwareProcessImpl, VanillaWindowsProcessImpl, WebClusterDatabaseExample, WebClusterDatabaseExampleApp, WebClusterExample, WideAreaCassandraCluster, ZooKeeperEnsembleImpl, ZooKeeperNodeImpl
```
public interface Entity
extends BrooklynObject
```
The basic interface for a Brooklyn entity.
Implementors of entities are strongly encouraged to extend AbstractEntity.
To instantiate an entity, see managementContext.getEntityManager().createEntity(entitySpec). Also see ApplicationBuilder, AbstractEntity.addChild(EntitySpec), and EntitySpec.

See Also:
AbstractEntity

Nested Class Summary
- Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObject
  BrooklynObject.TagSupport
- Nested classes/interfaces inherited from interface brooklyn.entity.trait.Configurable
  Configurable.ConfigurationSupport

Method Summary

Methods
Modifier and Type	Method and Description
`<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.
`<T extends Entity> T`	`addChild(T child)` Add a child `Entity`, and set this entity as its parent, returning the added child.
`void`	`addEnricher(Enricher enricher)` Adds the given enricher to this entity.
`<T extends Enricher> T`	`addEnricher(EnricherSpec<T> enricher)` Adds the given enricher to this entity.
`<T extends Feed> T`	`addFeed(T feed)` Adds the given feed to this entity.
`void`	`addGroup(Group group)` Add this entity as a member of the given `Group`.
`void`	`addPolicy(Policy policy)` Adds the given policy to this entity.
`<T extends Policy> T`	`addPolicy(PolicySpec<T> enricher)` Adds the given policy to this entity.
`boolean`	`addTag(java.lang.Object tag)` Deprecated. since 0.7; see `BrooklynObject.tags()`
`void`	`clearParent()` Clears the parent (i.e.
`boolean`	`containsTag(java.lang.Object tag)` Deprecated. since 0.7; see `BrooklynObject.tags()`
`Application`	`getApplication()`
`java.lang.String`	`getApplicationId()`
`<T> T`	`getAttribute(AttributeSensor<T> sensor)` Gets the value of the given attribute on this entity, or null if has not been set.
`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 `ConfigurationSupport#getConfig(ConfigKey)`, via code like `config().get(key)`.
`Maybe<java.lang.Object>`	`getConfigRaw(ConfigKey.HasConfigKey<?> key, boolean includeInherited)` Deprecated. since 0.7.0
`Maybe<java.lang.Object>`	`getConfigRaw(ConfigKey<?> key, boolean includeInherited)` Deprecated. since 0.7.0; use `((EntityInternal)entity).config().getRaw()` or `((EntityInternal)entity).config().getLocalRaw()`
`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.
`java.util.Collection<Enricher>`	`getEnrichers()`
`EntityType`	`getEntityType()` Information about the type of this entity; analogous to Java's object.getClass.
`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.
`java.lang.String`	`getId()` The unique identifier for this entity.
`java.util.Collection<Location>`	`getLocations()` Return all the `Location`s this entity is deployed to.
`Entity`	`getParent()` The parent of this entity, null if no parent.
`java.util.Collection<Policy>`	`getPolicies()`
`java.util.Set<java.lang.Object>`	`getTags()` Deprecated. since 0.7; see `BrooklynObject.tags()`
`<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.
`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 group)` Removes this entity as a member of the given `Group`.
`boolean`	`removePolicy(Policy policy)` Removes the given policy from this entity.
`boolean`	`removeTag(java.lang.Object tag)` Deprecated. since 0.7; see `BrooklynObject.tags()`
`Entity`	`setParent(Entity parent)` Sets the parent (i.e.

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

Methods inherited from interface brooklyn.entity.trait.Configurable
config, setConfig

- 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(brooklyn.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)
```
    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.
  - getConfig
```
<T> T getConfig(ConfigKey<T> key)
```
    Convenience for calling ConfigurationSupport#getConfig(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.
  - getTags
```
@Deprecated
java.util.Set<java.lang.Object> getTags()
```
    Deprecated. since 0.7; see BrooklynObject.tags()
    
    Since:
    
    0.7
  - addTag
```
@Deprecated
boolean addTag(@Nonnull
                        java.lang.Object tag)
```
    Deprecated. since 0.7; see BrooklynObject.tags()
    
    Since:
    
    0.7
  - removeTag
```
@Deprecated
boolean removeTag(@Nonnull
                           java.lang.Object tag)
```
    Deprecated. since 0.7; see BrooklynObject.tags()
    
    Since:
    
    0.7
  - containsTag
```
@Deprecated
boolean containsTag(@Nonnull
                             java.lang.Object tag)
```
    Deprecated. since 0.7; see BrooklynObject.tags()
    
    Since:
    
    0.7

Interface Entity

Nested Class Summary

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

Nested classes/interfaces inherited from interface brooklyn.entity.trait.Configurable

Method Summary

Methods inherited from interface brooklyn.basic.BrooklynObject

Methods inherited from interface brooklyn.entity.trait.Configurable

Method Detail

getId

getCreationTime

getDisplayName

getIconUrl

getEntityType

getApplication

getApplicationId

getParent

getChildren

setParent

clearParent

addChild

addChild

removeChild

getPolicies

getEnrichers

getGroups

addGroup

removeGroup

getLocations

getAttribute

getConfig

getConfig

getConfigRaw

getConfigRaw

invoke

addPolicy

addPolicy

removePolicy

addEnricher

addEnricher

removeEnricher

addFeed

getTags

addTag

removeTag

containsTag