Propagator (Apache Brooklyn)

java.lang.Object
- org.apache.brooklyn.core.objs.AbstractBrooklynObject
- - org.apache.brooklyn.core.objs.AbstractEntityAdjunct
  - - org.apache.brooklyn.core.enricher.AbstractEnricher
    - - org.apache.brooklyn.enricher.stock.Propagator

All Implemented Interfaces:

Rebindable, BrooklynObject, Configurable, EntityAdjunct, Identifiable, Enricher, SensorEventListener<java.lang.Object>, BrooklynObjectInternal
```
public class Propagator
extends AbstractEnricher
implements SensorEventListener<java.lang.Object>
```

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.brooklyn.core.objs.AbstractEntityAdjunct
  AbstractEntityAdjunct.AdjunctTagSupport, AbstractEntityAdjunct.BasicSubscriptionSupport
- 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
- Nested classes/interfaces inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal
  BrooklynObjectInternal.ConfigurationSupportInternal, BrooklynObjectInternal.RelationSupportInternal<T extends BrooklynObject>, BrooklynObjectInternal.SubscriptionSupportInternal

Field Summary

Fields
Modifier and Type	Field and Description
`static ConfigKey<Entity>`	`PRODUCER`
`static ConfigKey<java.util.Collection<? extends Sensor<?>>>`	`PROPAGATING`
`static ConfigKey<java.lang.Boolean>`	`PROPAGATING_ALL`
`static ConfigKey<java.util.Collection<Sensor<?>>>`	`PROPAGATING_ALL_BUT`
`static ConfigKey<java.util.Map<? extends Sensor<?>,? extends Sensor<?>>>`	`SENSOR_MAPPING`
`static java.util.Set<Sensor<?>>`	`SENSORS_NOT_USUALLY_PROPAGATED`

Fields inherited from class org.apache.brooklyn.core.enricher.AbstractEnricher
SUPPRESS_DUPLICATES

Fields inherited from interface org.apache.brooklyn.api.sensor.SensorEventListener
NOOP

Constructor Summary

Constructors
Constructor and Description

Propagator()

Constructors
Constructor and Description
`Propagator()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`emitAllAttributes()` useful once sensors are added to emit all values
`void`	`emitAllAttributes(boolean includeNullValues)`
`void`	`onEvent(SensorEvent<java.lang.Object> event)` The `SensorEvent` handler method.
`void`	`setEntity(EntityLocal entity)`

Methods inherited from class org.apache.brooklyn.core.enricher.AbstractEnricher
getEnricherType, getRebindSupport, relations

Methods inherited from class org.apache.brooklyn.core.objs.AbstractEntityAdjunct
config, configure, destroy, getAdjunctType, getConfig, getConfigMap, getDisplayName, getUniqueTag, isDestroyed, isRunning, setConfig, setDisplayName, subscribe, subscribeToChildren, subscribeToMembers, subscriptions, tags, toString, unsubscribe, unsubscribe

Methods inherited from class org.apache.brooklyn.core.objs.AbstractBrooklynObject
getCatalogItemId, getId, getManagementContext, init, rebind, setCatalogItemId, setManagementContext

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.brooklyn.api.sensor.Enricher
getId

Methods inherited from interface org.apache.brooklyn.api.objs.EntityAdjunct
getUniqueTag, isDestroyed, isRunning

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

Methods inherited from interface org.apache.brooklyn.api.objs.Configurable
config, getConfig, setConfig

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

Field Detail

SENSORS_NOT_USUALLY_PROPAGATED

public static final java.util.Set<Sensor<?>> SENSORS_NOT_USUALLY_PROPAGATED

PRODUCER

public static ConfigKey<Entity> PRODUCER

PROPAGATING_ALL_BUT

public static ConfigKey<java.util.Collection<Sensor<?>>> PROPAGATING_ALL_BUT

PROPAGATING_ALL

public static ConfigKey<java.lang.Boolean> PROPAGATING_ALL

PROPAGATING

public static ConfigKey<java.util.Collection<? extends Sensor<?>>> PROPAGATING

SENSOR_MAPPING

public static ConfigKey<java.util.Map<? extends Sensor<?>,? extends Sensor<?>>> SENSOR_MAPPING

Constructor Detail
- Propagator
```
public Propagator()
```

Method Detail
- setEntity
```
public void setEntity(EntityLocal entity)
```
  Overrides:
  
  setEntity in class AbstractEnricher
- onEvent
```
public void onEvent(SensorEvent<java.lang.Object> event)
```
  Description copied from interface: SensorEventListener
  
  The SensorEvent handler method.
  
  Specified by:
  
  onEvent in interface SensorEventListener<java.lang.Object>
- emitAllAttributes
```
public void emitAllAttributes()
```
  useful once sensors are added to emit all values
- emitAllAttributes
```
public void emitAllAttributes(boolean includeNullValues)
```

Class Propagator

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.brooklyn.core.objs.AbstractEntityAdjunct

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

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

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

Field Summary

Fields inherited from class org.apache.brooklyn.core.enricher.AbstractEnricher

Fields inherited from interface org.apache.brooklyn.api.sensor.SensorEventListener

Constructor Summary

Method Summary

Methods inherited from class org.apache.brooklyn.core.enricher.AbstractEnricher

Methods inherited from class org.apache.brooklyn.core.objs.AbstractEntityAdjunct

Methods inherited from class org.apache.brooklyn.core.objs.AbstractBrooklynObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.brooklyn.api.sensor.Enricher

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

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

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

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

Field Detail

SENSORS_NOT_USUALLY_PROPAGATED

PRODUCER

PROPAGATING_ALL_BUT

PROPAGATING_ALL

PROPAGATING

SENSOR_MAPPING

Constructor Detail

Propagator

Method Detail

setEntity

onEvent

emitAllAttributes

emitAllAttributes