EntityLocal (Apache Brooklyn)

All Superinterfaces:

BrooklynObject, Configurable, Entity, Identifiable

All Known Subinterfaces:

EntityInternal

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

Deprecated.
since 0.9.0; use Entity or EntityInternal
```
public interface EntityLocal
extends Entity
```
Extended Entity interface for use in places where the caller should have certain privileges, such as setting attribute values, adding policies, etc. FIXME Moved from core project to api project because of bug in groovy's covariant return types. EntityDriver needs to return EntityLocal rather than Entity, to avoid changing a whole load of sub-types. FIXME Add setAttribute(AttributeSensorAndConfigKey) back in if/when move it back, or if we extract an interface for AttributeSensorAndConfigKey.

Nested Class Summary
- 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

Methods
Modifier and Type	Method and Description
`<T> void`	`emit(Sensor<T> sensor, T value)` Deprecated. since 0.8.0; use `SensorSupport#emit(Sensor, Object)` via code like `sensors().emit(sensor, val)`.
`<T> T`	`getConfig(ConfigKey.HasConfigKey<T> key, T defaultValue)` Deprecated. in 0.5; use `#getConfig(HasConfigKey)`
`<T> T`	`getConfig(ConfigKey<T> key, T defaultValue)` Deprecated. in 0.5; use `Configurable.getConfig(ConfigKey)`
`<T> T`	`modifyAttribute(AttributeSensor<T> attribute, modifier)` Deprecated. since 0.8.0; use `SensorSupport#modify(AttributeSensor, Function)` via code like `sensors().modify(attribute, modifier)`.
`boolean`	`removeAllEnrichers()` Deprecated. since 0.9.0; see `EnricherSupportInternal#removeAllEnrichers()`, e.g. `((EntityInternal)entity).enrichers().removeAllEnrichers()`
`boolean`	`removeAllPolicies()` Deprecated. since 0.9.0; see `PolicySupportInternal#removeAllPolicies()`, e.g. `((EntityInternal)entity).policies().removeAllPolicies()`
`<T> T`	`setAttribute(AttributeSensor<T> attribute, T val)` Deprecated. since 0.8.0; use `SensorSupport#set(AttributeSensor, Object)` via code like `sensors().set(attribute, val)`.
`<T> T`	`setConfig(ConfigKey.HasConfigKey<T> key, T val)` Deprecated. since 0.7.0; use `Configurable.config()`, such as `entity.config().set(key, val)`
`<T> T`	`setConfig(ConfigKey.HasConfigKey<T> key, Task<T> val)` Deprecated. since 0.7.0; use `Configurable.config()`, such as `entity.config().set(key, val)`
`<T> T`	`setConfig(ConfigKey<T> key, T val)` Deprecated. since 0.7.0; use `Configurable.config()`, such as `entity.config().set(key, val)`
`<T> T`	`setConfig(ConfigKey<T> key, Task<T> val)` Deprecated. since 0.7.0; use `Configurable.config()`, such as `entity.config().set(key, val)`
`<T> SubscriptionHandle`	`subscribe(Entity producer, Sensor<T> sensor, SensorEventListener<? super T> listener)` Deprecated. since 0.9.0; see `SubscriptionSupportInternal#getSubscriptionContext()`, e.g. with `subscriptions().getSubscriptionContext()`
`<T> SubscriptionHandle`	`subscribeToChildren(Entity parent, Sensor<T> sensor, SensorEventListener<? super T> listener)` Deprecated. since 0.9.0; see `SubscriptionSupport#subscribeToChildren(Entity, Sensor, SensorEventListener)`, e.g. with `subscriptions().subscribeToChildren(...)`
`<T> SubscriptionHandle`	`subscribeToMembers(Group group, Sensor<T> sensor, SensorEventListener<? super T> listener)` Deprecated. since 0.9.0; see `SubscriptionSupport#subscribeToMembers(Entity, Sensor, SensorEventListener)`, e.g. with `subscriptions().subscribeToMembers(...)`
`boolean`	`unsubscribe(Entity producer)` Deprecated. since 0.9.0; see `SubscriptionSupport#unsubscribe(Entity)`, e.g. with `subscriptions().unsubscribe(...)`
`boolean`	`unsubscribe(Entity producer, SubscriptionHandle handle)` Deprecated. since 0.9.0; see `SubscriptionSupport#unsubscribe(Entity, SubscriptionHandle)`, e.g. with `subscriptions().unsubscribe(...)`

Methods inherited from interface org.apache.brooklyn.api.entity.Entity
addChild, addChild, addEnricher, addEnricher, addFeed, addGroup, addPolicy, addPolicy, clearParent, enrichers, getApplication, getApplicationId, getAttribute, getChildren, getConfig, getConfigRaw, getConfigRaw, getCreationTime, getDisplayName, getEnrichers, getEntityType, getGroups, getIconUrl, getId, getLocations, getParent, getPolicies, groups, invoke, policies, relations, removeChild, removeEnricher, removeGroup, removePolicy, sensors, setDisplayName, setParent

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

- Method Detail
  - setConfig
```
@Deprecated
<T> T setConfig(ConfigKey<T> key,
                         T val)
```
    Deprecated. since 0.7.0; use Configurable.config(), such as entity.config().set(key, val)
    
    Specified by:
    
    setConfig in interface Configurable
    
    Returns:
    the old value, or null if there was not one
  - setConfig
```
@Deprecated
<T> T setConfig(ConfigKey<T> key,
                         Task<T> val)
```
    Deprecated. since 0.7.0; use Configurable.config(), such as entity.config().set(key, val)
  - setConfig
```
@Deprecated
<T> T setConfig(ConfigKey.HasConfigKey<T> key,
                         T val)
```
    Deprecated. since 0.7.0; use Configurable.config(), such as entity.config().set(key, val)
  - setConfig
```
@Deprecated
<T> T setConfig(ConfigKey.HasConfigKey<T> key,
                         Task<T> val)
```
    Deprecated. since 0.7.0; use Configurable.config(), such as entity.config().set(key, val)
  - setAttribute
```
<T> T setAttribute(AttributeSensor<T> attribute,
                 T val)
```
    Deprecated. since 0.8.0; use SensorSupport#set(AttributeSensor, Object) via code like sensors().set(attribute, val).
  - modifyAttribute
```
<T> T modifyAttribute(AttributeSensor<T> attribute,
                     modifier)
```
    Deprecated. since 0.8.0; use SensorSupport#modify(AttributeSensor, Function) via code like sensors().modify(attribute, modifier).
  - emit
```
<T> void emit(Sensor<T> sensor,
            T value)
```
    Deprecated. since 0.8.0; use SensorSupport#emit(Sensor, Object) via code like sensors().emit(sensor, val).
  - getConfig
```
<T> T getConfig(ConfigKey<T> key,
              T defaultValue)
```
    Deprecated. in 0.5; use Configurable.getConfig(ConfigKey)
  - getConfig
```
<T> T getConfig(ConfigKey.HasConfigKey<T> key,
              T defaultValue)
```
    Deprecated. in 0.5; use #getConfig(HasConfigKey)
  - subscribe
```
@Deprecated
<T> SubscriptionHandle subscribe(Entity producer,
                                          Sensor<T> sensor,
                                          SensorEventListener<? super T> listener)
```
    Deprecated. since 0.9.0; see SubscriptionSupportInternal#getSubscriptionContext(), e.g. with subscriptions().getSubscriptionContext()
    
    Allow us to subscribe to data from a Sensor on another entity.
    
    Returns:
    a subscription id which can be used to unsubscribe
    See Also:
    SubscriptionManager.subscribe(Map, Entity, Sensor, SensorEventListener)
  - subscribeToChildren
```
@Deprecated
<T> SubscriptionHandle subscribeToChildren(Entity parent,
                                                    Sensor<T> sensor,
                                                    SensorEventListener<? super T> listener)
```
    Deprecated. since 0.9.0; see SubscriptionSupport#subscribeToChildren(Entity, Sensor, SensorEventListener), e.g. with subscriptions().subscribeToChildren(...)
    
    See Also:
    SubscriptionManager.subscribeToChildren(Map, Entity, Sensor, SensorEventListener)
  - subscribeToMembers
```
@Deprecated
<T> SubscriptionHandle subscribeToMembers(Group group,
                                                   Sensor<T> sensor,
                                                   SensorEventListener<? super T> listener)
```
    Deprecated. since 0.9.0; see SubscriptionSupport#subscribeToMembers(Entity, Sensor, SensorEventListener), e.g. with subscriptions().subscribeToMembers(...)
    
    See Also:
    SubscriptionManager.subscribeToMembers(Group, Sensor, SensorEventListener)
  - unsubscribe
```
@Deprecated
boolean unsubscribe(Entity producer)
```
    Deprecated. since 0.9.0; see SubscriptionSupport#unsubscribe(Entity), e.g. with subscriptions().unsubscribe(...)
    
    Unsubscribes from the given producer.
    
    See Also:
    SubscriptionContext.unsubscribe(SubscriptionHandle)
  - unsubscribe
```
@Deprecated
boolean unsubscribe(Entity producer,
                             SubscriptionHandle handle)
```
    Deprecated. since 0.9.0; see SubscriptionSupport#unsubscribe(Entity, SubscriptionHandle), e.g. with subscriptions().unsubscribe(...)
    
    Unsubscribes the given handle.
    
    See Also:
    SubscriptionContext.unsubscribe(SubscriptionHandle)
  - removeAllPolicies
```
@Deprecated
boolean removeAllPolicies()
```
    Deprecated. since 0.9.0; see PolicySupportInternal#removeAllPolicies(), e.g. ((EntityInternal)entity).policies().removeAllPolicies()
    
    Removes all policy from this entity.
    
    Returns:
    True if any policies existed at this entity; false otherwise
  - removeAllEnrichers
```
@Deprecated
boolean removeAllEnrichers()
```
    Deprecated. since 0.9.0; see EnricherSupportInternal#removeAllEnrichers(), e.g. ((EntityInternal)entity).enrichers().removeAllEnrichers()
    
    Removes all enricher from this entity. Use with caution as some entities automatically register enrichers; this will remove those enrichers as well.
    
    Returns:
    True if any enrichers existed at this entity; false otherwise

Interface EntityLocal

Nested Class Summary

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

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.entity.Entity

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

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

Method Detail

setConfig

setConfig

setConfig

setConfig

setAttribute

modifyAttribute

emit

getConfig

getConfig

subscribe

subscribeToChildren

subscribeToMembers

unsubscribe

unsubscribe

removeAllPolicies

removeAllEnrichers