org.apache.brooklyn.core.entity

Interface EntityInternal

All Superinterfaces:

BrooklynObject, BrooklynObjectInternal, Configurable, Entity, EntityLocal, Identifiable, Rebindable

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, ConditionalEntityImpl, 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, LocationEntityImpl, 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, RelativeEntityTestCaseImpl, ResilientMongoDbApp, RiakClusterExample, RiakClusterImpl, RiakNodeImpl, RubyRepNodeImpl, SaltEntityImpl, SameServerEntityImpl, SequenceEntityImpl, SequenceGroupImpl, ServerPoolImpl, SimpleApplicationImpl, SimpleCassandraCluster, SimpleEntityImpl, SimpleShellCommandTestImpl, SimulatedExternalMonitorImpl, SimulatedJBoss7ServerImpl, SimulatedMySqlNodeImpl, SimulatedNginxControllerImpl, SimulatedTheeTierApp, SimulatedVanillaSoftwareProcessImpl, SingleWebServerExample, SoftwareProcessImpl, SolrServerImpl, StandaloneQpidBrokerExample, StormDeploymentImpl, StormImpl, StormSampleApp, TargetableTestComponentImpl, TestCaseImpl, TestEffectorImpl, TestEndpointReachableImpl, TestHttpCallImpl, TestSensorImpl, TestSshCommandImpl, TestWinrmCommandImpl, Tomcat8ServerImpl, TomcatServerImpl, UrlMappingImpl, VanillaJavaAppImpl, VanillaSoftwareProcessImpl, VanillaWindowsProcessImpl, WebClusterDatabaseExample, WebClusterDatabaseExampleApp, WebClusterExample, WideAreaCassandraCluster, ZabbixServerImpl, ZooKeeperEnsembleImpl, ZooKeeperNodeImpl

@Beta
public interface EntityInternal
extends BrooklynObjectInternal, EntityLocal, Rebindable

Extended Entity interface with additional functionality that is purely-internal (i.e. intended for the brooklyn framework only).

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	EntityInternal.EnricherSupportInternal
static interface	EntityInternal.EntitySubscriptionSupportInternal
static interface	EntityInternal.FeedSupport
static interface	EntityInternal.GroupSupportInternal
static interface	EntityInternal.PolicySupportInternal
static interface	EntityInternal.SensorSupportInternal

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

BrooklynObjectInternal.ConfigurationSupportInternal, BrooklynObjectInternal.RelationSupportInternal<T extends BrooklynObject>, BrooklynObjectInternal.SubscriptionSupportInternal

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.entity.Entity

Entity.AdjunctSupport<T extends EntityAdjunct>, Entity.EnricherSupport, Entity.GroupSupport, Entity.PolicySupport, 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
void	addLocations(java.util.Collection<? extends Location> locations)
void	addLocationsWithoutPublishing(java.util.Collection<? extends Location> locations) Adds the given locations to this entity, but without emitting AbstractEntity.LOCATION_ADDED events, and without auto-managing the locations.
void	clearLocations()
EntityInternal	configure(java.util.Map flags) Must be called before the entity is started.
void	destroy() Should be invoked at end-of-life to clean up the item.
EntityInternal.EnricherSupportInternal	enrichers()
EntityInternal.FeedSupport	feeds()
java.util.Map<AttributeSensor,java.lang.Object>	getAllAttributes() Deprecated. since 0.8.0; use EntityInternal.SensorSupportInternal.getAll() via code like sensors().getAll().
Effector<?>	getEffector(java.lang.String effectorName) returns the effector registered against a given name
ExecutionContext	getExecutionContext() Returns the task execution context for the entity.
EntityInternal.FeedSupport	getFeedSupport() Deprecated. since 0.7.0-M2; use feeds()
ManagementContext	getManagementContext() Returns the management context for the entity.
EntityManagementSupport	getManagementSupport()
EntityDynamicType	getMutableEntityType() returns the dynamic type corresponding to the type of this entity instance
RebindSupport<EntityMemento>	getRebindSupport() Users are strongly discouraged from calling or overriding this method.
EntityInternal.GroupSupportInternal	groups()
EntityInternal.PolicySupportInternal	policies()
BrooklynObjectInternal.RelationSupportInternal<Entity>	relations() Relations specify a typed, directed connection between two entities.
void	removeAttribute(AttributeSensor<?> attribute) Deprecated. since 0.8.0; use EntityInternal.SensorSupportInternal.remove(AttributeSensor) via code like sensors().remove(attribute).
void	removeLocations(java.util.Collection<? extends Location> locations)
void	requestPersist() Can be called to request that the entity be persisted.
EntityInternal.SensorSupportInternal	sensors()
<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).
EntityInternal.EntitySubscriptionSupportInternal	subscriptions() Subscriptions are the mechanism for receiving notifications of sensor-events (e.g.
java.util.Map<java.lang.String,java.lang.String>	toMetadataRecord()

Methods inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

config, setCatalogItemId

Methods inherited from interface org.apache.brooklyn.api.entity.EntityLocal

emit, modifyAttribute, removeAllEnrichers, removeAllPolicies, setAttribute, setConfig, setConfig, setConfig, setConfig, subscribe, subscribeToChildren, subscribeToMembers, unsubscribe, unsubscribe

Methods inherited from interface org.apache.brooklyn.api.entity.Entity

addChild, addChild, addEnricher, addEnricher, addFeed, addGroup, addPolicy, addPolicy, clearParent, getApplication, getApplicationId, getAttribute, getChildren, getConfig, getCreationTime, getDisplayName, getEnrichers, getEntityType, getGroups, getIconUrl, getId, getLocations, getParent, getPolicies, invoke, removeChild, removeEnricher, removeGroup, removePolicy, setDisplayName, setParent

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

getCatalogItemId, tags

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

getConfig

Method Detail

addLocations

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

removeLocations

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

addLocationsWithoutPublishing

@Beta
void addLocationsWithoutPublishing(@Nullable
                                         java.util.Collection<? extends Location> locations)

Adds the given locations to this entity, but without emitting AbstractEntity.LOCATION_ADDED events, and without auto-managing the locations. This is for internal purposes only; it is primarily intended for use during rebind.

clearLocations

void clearLocations()

setAttributeWithoutPublishing

@Deprecated
<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).

getAllAttributes

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

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

removeAttribute

@Deprecated
 @Beta
void removeAttribute(AttributeSensor<?> attribute)

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

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.

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

relations

BrooklynObjectInternal.RelationSupportInternal<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

Specified by:

relations in interface BrooklynObjectInternal

Specified by:

relations in interface Entity

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.

subscriptions

EntityInternal.EntitySubscriptionSupportInternal subscriptions()

Description copied from interface: BrooklynObject

Subscriptions are the mechanism for receiving notifications of sensor-events (e.g. attribute-changed) from other entities.

Specified by:

subscriptions in interface BrooklynObject

Specified by:

subscriptions in interface BrooklynObjectInternal

sensors

EntityInternal.SensorSupportInternal sensors()

Specified by:

sensors in interface Entity

policies

EntityInternal.PolicySupportInternal policies()

Specified by:

policies in interface Entity

enrichers

EntityInternal.EnricherSupportInternal enrichers()

Specified by:

enrichers in interface Entity

groups

EntityInternal.GroupSupportInternal groups()

Specified by:

groups in interface Entity