org.apache.brooklyn.api.entity

Interface Entity

All Superinterfaces:

BrooklynObject, Configurable, Identifiable

All Known Subinterfaces:

AbstractController, AbstractGeoDnsService, AbstractGroup, AbstractMongoDBServer, AbstractNonProvisionedController, AbstractVanillaProcess, ActiveMQBroker, ActiveMQDestination, ActiveMQQueue, ActiveMQTopic, AmqpServer, AnsibleEntity, Application, AsyncApplication, BalanceableContainer<ItemType>, BalanceableWorkerPool, BaseTest, BasicApplication, BasicEntity, BasicGroup, BasicStartable, BindDnsServer, BrooklynCluster, BrooklynEntityMirror, BrooklynMetrics, BrooklynNode, CassandraCluster, CassandraDatacenter, CassandraFabric, CassandraNode, ChefEntity, Cluster, CoLocatedMongoDBRouter, ConditionalEntity, ControlledDynamicWebAppCluster, CouchbaseCluster, CouchbaseNode, CouchbaseSyncGateway, CouchDBCluster, CouchDBNode, CrateNode, DatabaseNode, DataEntity, DatastoreMixins.DatastoreCommon, DelegateEntity, DockerContainer, DriverDependentEntity<D>, DynamicCluster, DynamicFabric, DynamicGroup, DynamicMultiGroup, DynamicRegionsFabric, DynamicWebAppCluster, DynamicWebAppFabric, 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, KubernetesPod, KubernetesResource, LoadBalancer, LoadBalancerCluster, LocalBrooklynNode, LocationEntity, LoopOverGroupMembersTestCase, MachineEntity, MariaDbNode, MessageBroker, MongoDBClient, MongoDBConfigServer, MongoDBConfigServerCluster, MongoDBReplicaSet, MongoDBRouter, MongoDBRouterCluster, MongoDBServer, MongoDBShardCluster, MongoDBShardedDeployment, MonitNode, MoreEntity, Movable, MySqlCluster, MySqlNode, NginxController, NodeJsWebAppService, OpenShiftPod, OpenShiftResource, ParallelTestCase, PostgreSqlNode, QpidBroker, QpidDestination, QpidQueue, QpidTopic, QuarantineGroup, RabbitBroker, RedisCluster, RedisShard, RedisSlave, RedisStore, RelativeEntityTestCase, RiakCluster, RiakNode, RubyRepNode, SaltEntity, SameServerEntity, SequenceEntity, SequenceGroup, ServerPool, SimpleApplication, SimpleEntity, SimpleShellCommandTest, SimulatedExternalMonitor, SoftwareProcess, SolrServer, StartableApplication, Storm, StormDeployment, TargetableTestComponent, TestCase, TestEffector, TestEndpointReachable, TestHttpCall, TestSensor, TestSshCommand, TestWinrmCommand, 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, AsyncApplicationImpl, BalanceableWorkerPoolImpl, BasicApplicationImpl, BasicEntityImpl, BasicGroupImpl, BasicStartableImpl, BindDnsServerImpl, BrooklynClusterImpl, BrooklynEntityMirrorImpl, BrooklynMetricsImpl, BrooklynNodeImpl, CassandraClusterImpl, CassandraDatacenterImpl, CassandraFabricImpl, CassandraNodeImpl, ChefEntityImpl, CoLocatedMongoDBRouterImpl, ConditionalEntityImpl, ControlledDynamicWebAppClusterImpl, CouchbaseClusterImpl, CouchbaseNodeImpl, CouchbaseSyncGatewayImpl, CouchDBClusterImpl, CouchDBNodeImpl, CrateNodeImpl, DataEntityImpl, DelegateEntityImpl, DerbyDatabase, DerbySchema, DockerContainerImpl, DynamicClusterImpl, DynamicFabricImpl, DynamicGroupImpl, DynamicMultiGroupImpl, DynamicRegionsFabricImpl, DynamicWebAppClusterImpl, DynamicWebAppFabricImpl, EffectorStartableImpl, ElasticSearchClusterImpl, ElasticSearchNodeImpl, EmptySoftwareProcessImpl, EmptyWindowsProcessImpl, FollowTheSunPoolImpl, GeoscalingDnsServiceImpl, HazelcastClusterImpl, HazelcastNodeImpl, Infinispan5Server, InfrastructureDeploymentTestCaseImpl, ItemsInContainersGroupImpl, JavaWebAppSoftwareProcessImpl, JBoss6ServerImpl, JBoss7ServerImpl, Jetty6ServerImpl, JMSBrokerImpl, JMSDestinationImpl, KafkaBrokerImpl, KafkaClusterImpl, KafkaZooKeeperImpl, KarafContainerImpl, KubernetesPodImpl, KubernetesResourceImpl, LoadBalancerClusterImpl, LocalBrooklynNodeImpl, LocationEntityImpl, LoopOverGroupMembersTestCaseImpl, MachineEntityImpl, MariaDbNodeImpl, MongoDBClientImpl, MongoDBConfigServerClusterImpl, MongoDBConfigServerImpl, MongoDBReplicaSetImpl, MongoDBRouterClusterImpl, MongoDBRouterImpl, MongoDBServerImpl, MongoDBShardClusterImpl, MongoDBShardedDeploymentImpl, MonitNodeImpl, MoreEntityImpl, MoreTemplate, MySqlClusterImpl, MySqlNodeImpl, NginxControllerImpl, NodeJsTodoApplication, NodeJsWebAppServiceImpl, OpenShiftPodImpl, OpenShiftResourceImpl, ParallelTestCaseImpl, PostgreSqlNodeChefImplFromScratch, PostgreSqlNodeImpl, PostgreSqlNodeSaltImpl, QpidBrokerImpl, QpidDestinationImpl, QpidQueueImpl, QpidTopicImpl, QuarantineGroupImpl, RabbitBrokerImpl, RabbitDestination, RabbitQueue, RedisClusterImpl, RedisShardImpl, RedisSlaveImpl, RedisStoreImpl, RelativeEntityTestCaseImpl, RiakClusterImpl, RiakNodeImpl, RubyRepNodeImpl, SaltEntityImpl, SameServerEntityImpl, SequenceEntityImpl, SequenceGroupImpl, ServerPoolImpl, SimpleApplicationImpl, SimpleEntityImpl, SimpleShellCommandTestImpl, SimulatedExternalMonitorImpl, SimulatedJBoss7ServerImpl, SimulatedMySqlNodeImpl, SimulatedNginxControllerImpl, SimulatedTheeTierApp, SimulatedVanillaSoftwareProcessImpl, SingleWebServerExample, SoftwareProcessImpl, SolrServerImpl, StormDeploymentImpl, StormImpl, TargetableTestComponentImpl, TestCaseImpl, TestEffectorImpl, TestEndpointReachableImpl, TestHttpCallImpl, TestSensorImpl, TestSshCommandImpl, TestWinrmCommandImpl, Tomcat8ServerImpl, TomcatServerImpl, UrlMappingImpl, VanillaJavaAppImpl, VanillaSoftwareProcessImpl, VanillaWindowsProcessImpl, WebClusterDatabaseExample, WebClusterDatabaseExampleApp, WebClusterExample, 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 org.apache.brooklyn.core.entity.factory.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

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.
<T extends Feed> T	addFeed(T feed) Deprecated. since 1.0.0; see FeedSupport#add(Feed)
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)
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.
EntityType	getEntityType() Information about the type of this entity; analogous to Java's object.getClass.
java.lang.String	getIconUrl() Deprecated. since 0.12.0 look up the RegisteredType and use its RegisteredType.getIconUrl() or use conveniences such as RegisteredTypes.getIconUrl().
java.lang.String	getId() The unique identifier for this entity.
java.util.Collection<Location>	getLocations() Return all the Locations this entity is deployed to.
Entity	getParent() The parent of this entity, null if no parent.
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.
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, getCatalogItemIdSearchPath, subscriptions, tags

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

config, getConfig

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

@Deprecated
 @Nullable
java.lang.String getIconUrl()

Deprecated. since 0.12.0 look up the RegisteredType and use its RegisteredType.getIconUrl() or use conveniences such as RegisteredTypes.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

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

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.

addFeed

@Deprecated
<T extends Feed> T addFeed(T feed)

Deprecated. since 1.0.0; see FeedSupport#add(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