Entity (Apache Brooklyn)

All Superinterfaces:

BrooklynObject, Configurable, Identifiable

All Known Subinterfaces:

AbstractController, AbstractGeoDnsService, AbstractGroup, AbstractMongoDBServer, AbstractNonProvisionedController, AbstractVanillaProcess, ActiveMQBroker, ActiveMQDestination, ActiveMQQueue, ActiveMQTopic, AmqpServer, AnsibleEntity, Application, BalanceableContainer<ItemType>, BalanceableWorkerPool, BaseTest, 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, EmptyWindowsProcess, EntityInternal, EntityLocal, Fabric, FollowTheSunPool, GeoscalingDnsService, Group, HazelcastCluster, HazelcastNode, InfrastructureDeploymentTestCase, ItemsInContainersGroup, JavaWebAppService, JavaWebAppService.CanDeployAndUndeploy, JavaWebAppSoftwareProcess, JBoss6Server, JBoss7Server, Jetty6Server, JMSBroker<Q,T>, JMSDestination, KafkaBroker, KafkaCluster, KafkaZooKeeper, KarafContainer, LoadBalancer, LoadBalancerCluster, LocalBrooklynNode, LoopOverGroupMembersTestCase, MachineEntity, MariaDbNode, MessageBroker, MongoDBClient, MongoDBConfigServer, MongoDBConfigServerCluster, MongoDBReplicaSet, MongoDBRouter, MongoDBRouterCluster, MongoDBServer, MongoDBShardCluster, MongoDBShardedDeployment, MonitNode, MoreEntity, Movable, MySqlCluster, MySqlNode, NginxController, NodeJsWebAppService, ParallelTestCase, PostgreSqlNode, QpidBroker, QpidDestination, QpidQueue, QpidTopic, QuarantineGroup, RabbitBroker, RedisCluster, RedisShard, RedisSlave, RedisStore, RiakCluster, RiakNode, RubyRepNode, SaltEntity, SameServerEntity, ServerPool, SimpleApplication, SimpleEntity, SimpleShellCommandTest, SoftwareProcess, SolrServer, StartableApplication, Storm, StormDeployment, TargetableTestComponent, TestCase, TestEffector, TestHttpCall, TestSensor, Tier, Tomcat8Server, TomcatServer, UrlMapping, VanillaJavaApp, VanillaSoftwareProcess, VanillaWindowsProcess, WebAppService, ZabbixServer, ZooKeeperEnsemble, ZooKeeperNode

All Known Implementing Classes:

AbstractApplication, AbstractControllerImpl, AbstractEntity, AbstractGeoDnsServiceImpl, AbstractGroupImpl, AbstractNonProvisionedControllerImpl, AbstractZooKeeperImpl, ActiveMQBrokerImpl, ActiveMQDestinationImpl, ActiveMQQueueImpl, ActiveMQTopicImpl, AnsibleEntityImpl, 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, DerbyDatabase, DerbySchema, DynamicClusterImpl, DynamicFabricImpl, DynamicGroupImpl, DynamicMultiGroupImpl, DynamicRegionsFabricImpl, DynamicWebAppClusterImpl, DynamicWebAppFabricImpl, EffectorStartableImpl, ElasticSearchClusterImpl, ElasticSearchNodeImpl, EmptySoftwareProcessImpl, EmptyWindowsProcessImpl, FollowTheSunPoolImpl, GeoscalingDnsServiceImpl, GlobalWebFabricExample, HazelcastClusterImpl, HazelcastNodeImpl, HighAvailabilityCassandraCluster, Infinispan5Server, InfrastructureDeploymentTestCaseImpl, ItemsInContainersGroupImpl, JavaWebAppSoftwareProcessImpl, JBoss6ServerImpl, JBoss7ServerImpl, Jetty6ServerImpl, JMSBrokerImpl, JMSDestinationImpl, KafkaBrokerImpl, KafkaClusterImpl, KafkaZooKeeperImpl, KarafContainerImpl, LoadBalancerClusterImpl, LocalBrooklynNodeImpl, LoopOverGroupMembersTestCaseImpl, MachineEntityImpl, MariaDbNodeImpl, MongoDBClientImpl, MongoDBConfigServerClusterImpl, MongoDBConfigServerImpl, MongoDBReplicaSetImpl, MongoDBRouterClusterImpl, MongoDBRouterImpl, MongoDBServerImpl, MongoDBShardClusterImpl, MongoDBShardedDeploymentImpl, MonitNodeImpl, MoreEntityImpl, MoreTemplate, MySqlClusterImpl, MySqlNodeImpl, NginxControllerImpl, NodeJsTodoApplication, NodeJsWebAppServiceImpl, ParallelTestCaseImpl, PostgreSqlNodeChefImplFromScratch, PostgreSqlNodeImpl, PostgreSqlNodeSaltImpl, QpidBrokerImpl, QpidDestinationImpl, QpidQueueImpl, QpidTopicImpl, QuarantineGroupImpl, RabbitBrokerImpl, RabbitDestination, RabbitQueue, RedisClusterImpl, RedisShardImpl, RedisSlaveImpl, RedisStoreImpl, ResilientMongoDbApp, RiakClusterExample, RiakClusterImpl, RiakNodeImpl, RubyRepNodeImpl, SaltEntityImpl, SameServerEntityImpl, ServerPoolImpl, SimpleApplicationImpl, SimpleCassandraCluster, SimpleEntityImpl, SimpleShellCommandTestImpl, SimulatedJBoss7ServerImpl, SimulatedMySqlNodeImpl, SimulatedNginxControllerImpl, SimulatedTheeTierApp, SingleWebServerExample, SoftwareProcessImpl, SolrServerImpl, StandaloneQpidBrokerExample, StormDeploymentImpl, StormImpl, StormSampleApp, TargetableTestComponentImpl, TestCaseImpl, TestEffectorImpl, TestHttpCallImpl, TestSensorImpl, Tomcat8ServerImpl, TomcatServerImpl, UrlMappingImpl, VanillaJavaAppImpl, VanillaSoftwareProcessImpl, VanillaWindowsProcessImpl, WebClusterDatabaseExample, WebClusterDatabaseExampleApp, WebClusterExample, WideAreaCassandraCluster, ZabbixServerImpl, 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
Modifier and Type	Interface and Description
`static interface`	`Entity.AdjunctSupport<T extends EntityAdjunct>`
`static interface`	`Entity.EnricherSupport`
`static interface`	`Entity.GroupSupport` For managing/querying the group membership of this entity.
`static interface`	`Entity.PolicySupport`
`static interface`	`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

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)` Deprecated. since 0.9.0; see `Entity.EnricherSupport.add(Enricher)`
`<T extends Enricher> T`	`addEnricher(EnricherSpec<T> enricher)` Deprecated. since 0.9.0; see `Entity.EnricherSupport.add(EnricherSpec)`
`<T extends Feed> T`	`addFeed(T feed)` Adds the given feed to this entity.
`void`	`addGroup(Group group)` Deprecated. since 0.9.0; see `GroupSupport#add()` and `groups()`
`void`	`addPolicy(Policy policy)` Deprecated. since 0.9.0; see `Entity.PolicySupport.add(Policy)`
`<T extends Policy> T`	`addPolicy(PolicySpec<T> policy)` Deprecated. since 0.9.0; see `Entity.PolicySupport.add(PolicySpec)`
`void`	`clearParent()` Clears the parent (i.e.
`Entity.EnricherSupport`	`enrichers()`
`Application`	`getApplication()`
`java.lang.String`	`getApplicationId()`
`<T> T`	`getAttribute(AttributeSensor<T> sensor)` 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)`
`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()` Deprecated. since 0.9.0; see `getEnrichers()`
`EntityType`	`getEntityType()` Information about the type of this entity; analogous to Java's object.getClass.
`java.util.Collection<Group>`	`getGroups()` Deprecated. since 0.9.0; see `getGroups()` and `groups()`
`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()` Deprecated. since 0.9.0; see `getPolicies()`
`Entity.GroupSupport`	`groups()`
`<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.
`Entity.PolicySupport`	`policies()`
`BrooklynObject.RelationSupport<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.
`boolean`	`removeEnricher(Enricher enricher)` Deprecated. since 0.9.0; see `Entity.EnricherSupport.remove(Enricher)`
`void`	`removeGroup(Group group)` Deprecated. since 0.9.0; see `GroupSupport#remove()` and `groups()`
`boolean`	`removePolicy(Policy policy)` Deprecated. since 0.9.0; see `Entity.PolicySupport.remove(Policy)`
`Entity.SensorSupport`	`sensors()`
`void`	`setDisplayName(java.lang.String displayName)` Sets the entity's display name.
`Entity`	`setParent(Entity parent)` Sets the parent (i.e.

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

Methods inherited from interface org.apache.brooklyn.api.objs.Configurable
config, getConfig, 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
  - setDisplayName
```
void setDisplayName(java.lang.String displayName)
```
    Sets the entity's display name.
  - 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
```
@Deprecated
java.util.Collection<Policy> getPolicies()
```
    Deprecated. since 0.9.0; see getPolicies()
    
    Returns:
    an immutable thread-safe view of the policies.
  - getEnrichers
```
@Deprecated
java.util.Collection<Enricher> getEnrichers()
```
    Deprecated. since 0.9.0; see getEnrichers()
    
    Returns:
    an immutable thread-safe view of the enrichers.
  - getGroups
```
@Deprecated
java.util.Collection<Group> getGroups()
```
    Deprecated. since 0.9.0; see getGroups() and groups()
    
    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
```
@Deprecated
void addGroup(Group group)
```
    Deprecated. since 0.9.0; see GroupSupport#add() and groups()
    
    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
```
@Deprecated
void removeGroup(Group group)
```
    Deprecated. since 0.9.0; see GroupSupport#remove() and groups()
    
    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.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
```
@Deprecated
void addPolicy(Policy policy)
```
    Deprecated. since 0.9.0; see Entity.PolicySupport.add(Policy)
    
    Adds the given policy to this entity. Also calls policy.setEntity if available.
  - addPolicy
```
@Deprecated
<T extends Policy> T addPolicy(PolicySpec<T> policy)
```
    Deprecated. since 0.9.0; see Entity.PolicySupport.add(PolicySpec)
    
    Adds the given policy to this entity. Also calls policy.setEntity if available.
  - removePolicy
```
@Deprecated
boolean removePolicy(Policy policy)
```
    Deprecated. since 0.9.0; see Entity.PolicySupport.remove(Policy)
    
    Removes the given policy from this entity.
    
    Returns:
    True if the policy existed at this entity; false otherwise
  - addEnricher
```
@Deprecated
void addEnricher(Enricher enricher)
```
    Deprecated. since 0.9.0; see Entity.EnricherSupport.add(Enricher)
    
    Adds the given enricher to this entity. Also calls enricher.setEntity if available.
  - addEnricher
```
@Deprecated
<T extends Enricher> T addEnricher(EnricherSpec<T> enricher)
```
    Deprecated. since 0.9.0; see Entity.EnricherSupport.add(EnricherSpec)
    
    Adds the given enricher to this entity. Also calls enricher.setEntity if available.
  - removeEnricher
```
@Deprecated
boolean removeEnricher(Enricher enricher)
```
    Deprecated. since 0.9.0; see Entity.EnricherSupport.remove(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()
```
  - policies
```
Entity.PolicySupport policies()
```
  - enrichers
```
Entity.EnricherSupport enrichers()
```
  - groups
```
Entity.GroupSupport groups()
```
  - relations
```
BrooklynObject.RelationSupport<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 BrooklynObject

Interface Entity

Nested Class Summary

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

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

Method Summary

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

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

Method Detail

getId

getCreationTime

getDisplayName

getIconUrl

getEntityType

getApplication

getApplicationId

getParent

getChildren

setDisplayName

setParent

clearParent

addChild

addChild

removeChild

getPolicies

getEnrichers

getGroups

addGroup

removeGroup

getLocations

getAttribute

getConfig

getConfigRaw

getConfigRaw

invoke

addPolicy

addPolicy

removePolicy

addEnricher

addEnricher

removeEnricher

addFeed

sensors

policies

enrichers

groups

relations