org.apache.brooklyn.api.objs

Interface BrooklynObject.SubscriptionSupport

All Known Subinterfaces:

BrooklynObjectInternal.SubscriptionSupportInternal, EntityInternal.EntitySubscriptionSupportInternal

All Known Implementing Classes:

AbstractEntity.BasicSubscriptionSupport, AbstractEntityAdjunct.BasicSubscriptionSupport, AbstractLocation.BasicSubscriptionSupport

Enclosing interface:

BrooklynObject

public static interface BrooklynObject.SubscriptionSupport

Method Summary

Modifier and Type	Method and Description
<T> SubscriptionHandle	subscribe(Entity producer, Sensor<T> sensor, SensorEventListener<? super T> listener) Allow us to subscribe to data from a Sensor on another entity.
<T> SubscriptionHandle	subscribe(java.util.Map<java.lang.String,?> flags, Entity producer, Sensor<T> sensor, SensorEventListener<? super T> listener) Allow us to subscribe to data from a Sensor on another entity.
<T> SubscriptionHandle	subscribeToChildren(Entity parent, Sensor<T> sensor, SensorEventListener<? super T> listener)
<T> SubscriptionHandle	subscribeToMembers(Group group, Sensor<T> sensor, SensorEventListener<? super T> listener)
boolean	unsubscribe(Entity producer) Unsubscribes from the given producer.
boolean	unsubscribe(Entity producer, SubscriptionHandle handle) Unsubscribes the given handle.
boolean	unsubscribe(SubscriptionHandle handle) Unsubscribes the given handle.

Method Detail

subscribe

<T> SubscriptionHandle subscribe(Entity producer,
                                 Sensor<T> sensor,
                                 SensorEventListener<? super T> listener)

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)

subscribe

<T> SubscriptionHandle subscribe(java.util.Map<java.lang.String,?> flags,
                                 Entity producer,
                                 Sensor<T> sensor,
                                 SensorEventListener<? super T> listener)

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

<T> SubscriptionHandle subscribeToChildren(Entity parent,
                                           Sensor<T> sensor,
                                           SensorEventListener<? super T> listener)

See Also:

SubscriptionManager.subscribeToChildren(Map, Entity, Sensor, SensorEventListener)

subscribeToMembers

<T> SubscriptionHandle subscribeToMembers(Group group,
                                          Sensor<T> sensor,
                                          SensorEventListener<? super T> listener)

See Also:

SubscriptionManager.subscribeToMembers(Group, Sensor, SensorEventListener)

unsubscribe

boolean unsubscribe(Entity producer)

Unsubscribes from the given producer.

See Also:

SubscriptionContext.unsubscribe(SubscriptionHandle)

unsubscribe

boolean unsubscribe(Entity producer,
                    SubscriptionHandle handle)

Unsubscribes the given handle.

See Also:

SubscriptionContext.unsubscribe(SubscriptionHandle)

unsubscribe

boolean unsubscribe(SubscriptionHandle handle)

Unsubscribes the given handle. It is (currently) more efficient to also pass in the producer - see unsubscribe(Entity, SubscriptionHandle)