EntityInternal (Apache Brooklyn)

All Superinterfaces:

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

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
```
@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.FeedSupport
- Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObjectInternal
  BrooklynObjectInternal.ConfigurationSupportInternal
- Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObject
  BrooklynObject.TagSupport
- Nested classes/interfaces inherited from interface brooklyn.entity.trait.Configurable
  Configurable.ConfigurationSupport

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`EntityInternal.FeedSupport`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addLocations(java.util.Collection<? extends Location> 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.FeedSupport`	`feeds()`
`java.util.Map<AttributeSensor,java.lang.Object>`	`getAllAttributes()`
`java.util.Map<ConfigKey<?>,java.lang.Object>`	`getAllConfig()` Deprecated. since 0.7.0; instead just use methods on `ConfigurationSupportInternal` returned by `BrooklynObjectInternal.config()`, e.g. getBag().getAllConfigAsConfigKeyMap().
`ConfigBag`	`getAllConfigBag()` Deprecated. since 0.7.0; use `BrooklynObjectInternal.config()`, such as `entity.config().getBag()`
`EntityConfigMap`	`getConfigMap()` Deprecated. since 0.7.0; instead just use methods on `ConfigurationSupportInternal` returned by `BrooklynObjectInternal.config()`
`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()`
`ConfigBag`	`getLocalConfigBag()` Deprecated. since 0.7.0; use `BrooklynObjectInternal.config()`, such as `entity.config().getLocalBag()`
`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.
`SubscriptionContext`	`getSubscriptionContext()`
`void`	`refreshInheritedConfig()` Deprecated. since 0.7.0; use `BrooklynObjectInternal.config()`, such as `entity.config().refreshInheritedConfig()`
`void`	`removeAttribute(AttributeSensor<?> attribute)`
`void`	`removeLocations(java.util.Collection<? extends Location> locations)`
`void`	`requestPersist()` Can be called to request that the entity be persisted.
`<T> T`	`setAttributeWithoutPublishing(AttributeSensor<T> sensor, T val)` Like `EntityLocal.setAttribute(AttributeSensor, Object)`, except does not publish an attribute-change event.
`java.util.Map<java.lang.String,java.lang.String>`	`toMetadataRecord()`

Methods inherited from interface brooklyn.basic.BrooklynObjectInternal
config, setCatalogItemId

Methods inherited from interface brooklyn.entity.basic.EntityLocal
emit, getConfig, getConfig, modifyAttribute, removeAllEnrichers, removeAllPolicies, setAttribute, setConfig, setConfig, setConfig, setConfig, setDisplayName, subscribe, subscribeToChildren, subscribeToMembers, unsubscribe, unsubscribe

Methods inherited from interface brooklyn.entity.Entity
addChild, addChild, addEnricher, addEnricher, addFeed, addGroup, addPolicy, addPolicy, addTag, clearParent, containsTag, getApplication, getApplicationId, getAttribute, getChildren, getConfig, getConfig, getConfigRaw, getConfigRaw, getCreationTime, getDisplayName, getEnrichers, getEntityType, getGroups, getIconUrl, getId, getLocations, getParent, getPolicies, getTags, invoke, removeChild, removeEnricher, removeGroup, removePolicy, removeTag, setParent

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

- Method Detail
  - addLocations
```
void addLocations(java.util.Collection<? extends Location> locations)
```
  - removeLocations
```
void removeLocations(java.util.Collection<? extends Location> locations)
```
  - clearLocations
```
void clearLocations()
```
  - setAttributeWithoutPublishing
```
<T> T setAttributeWithoutPublishing(AttributeSensor<T> sensor,
                                  T val)
```
    Like EntityLocal.setAttribute(AttributeSensor, Object), except does not publish an attribute-change event.
  - getConfigMap
```
@Deprecated
EntityConfigMap getConfigMap()
```
    Deprecated. since 0.7.0; instead just use methods on ConfigurationSupportInternal returned by BrooklynObjectInternal.config()
  - getAllConfig
```
@Deprecated
@Beta
java.util.Map<ConfigKey<?>,java.lang.Object> getAllConfig()
```
    Deprecated. since 0.7.0; instead just use methods on ConfigurationSupportInternal returned by BrooklynObjectInternal.config(), e.g. getBag().getAllConfigAsConfigKeyMap().
    
    Returns:
    a read-only copy of all the config key/value pairs on this entity.
  - getAllConfigBag
```
@Deprecated
ConfigBag getAllConfigBag()
```
    Deprecated. since 0.7.0; use BrooklynObjectInternal.config(), such as entity.config().getBag()
    
    Returns a read-only view of all the config key/value pairs on this entity, backed by a string-based map, including config names that did not match anything on this entity.
  - getLocalConfigBag
```
@Deprecated
ConfigBag getLocalConfigBag()
```
    Deprecated. since 0.7.0; use BrooklynObjectInternal.config(), such as entity.config().getLocalBag()
    
    Returns a read-only view of the local (i.e. not inherited) config key/value pairs on this entity, backed by a string-based map, including config names that did not match anything on this entity.
  - getAllAttributes
```
@Beta
java.util.Map<AttributeSensor,java.lang.Object> getAllAttributes()
```
  - removeAttribute
```
@Beta
void removeAttribute(AttributeSensor<?> attribute)
```
  - refreshInheritedConfig
```
@Deprecated
void refreshInheritedConfig()
```
    Deprecated. since 0.7.0; use BrooklynObjectInternal.config(), such as entity.config().refreshInheritedConfig()
  - 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.
  - getSubscriptionContext
```
SubscriptionContext getSubscriptionContext()
```
  - 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
  - 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.

Interface EntityInternal

Nested Class Summary

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

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

Methods inherited from interface brooklyn.entity.basic.EntityLocal

Methods inherited from interface brooklyn.entity.Entity

Methods inherited from interface brooklyn.basic.BrooklynObject

Method Detail

addLocations

removeLocations

clearLocations

setAttributeWithoutPublishing

getConfigMap

getAllConfig

getAllConfigBag

getLocalConfigBag

getAllAttributes

removeAttribute

refreshInheritedConfig

configure

getManagementSupport

destroy

getManagementContext

getExecutionContext

getSubscriptionContext

getMutableEntityType

getEffector

feeds

getFeedSupport

toMetadataRecord

getRebindSupport

requestPersist