org.apache.brooklyn.core.location

Class AbstractLocation.BasicSubscriptionSupport

java.lang.Object

org.apache.brooklyn.core.location.AbstractLocation.BasicSubscriptionSupport

All Implemented Interfaces:

BrooklynObject.SubscriptionSupport, BrooklynObjectInternal.SubscriptionSupportInternal

Enclosing class:

AbstractLocation

public class AbstractLocation.BasicSubscriptionSupport
extends java.lang.Object
implements BrooklynObjectInternal.SubscriptionSupportInternal

Constructor Summary

Constructors

Constructor and Description
BasicSubscriptionSupport()

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 producerParent, Sensor<T> sensor, SensorEventListener<? super T> listener)
<T> SubscriptionHandle	subscribeToMembers(Group producerGroup, 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.
void	unsubscribeAll()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicSubscriptionSupport

public BasicSubscriptionSupport()

Method Detail

subscribe

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

Description copied from interface: BrooklynObject.SubscriptionSupport

Allow us to subscribe to data from a Sensor on another entity.

Specified by:

subscribe in interface BrooklynObject.SubscriptionSupport

Returns:

a subscription id which can be used to unsubscribe

See Also:

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

subscribe

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

Description copied from interface: BrooklynObject.SubscriptionSupport

Allow us to subscribe to data from a Sensor on another entity.

Specified by:

subscribe in interface BrooklynObject.SubscriptionSupport

Returns:

a subscription id which can be used to unsubscribe

See Also:

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

subscribeToMembers

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

Specified by:

subscribeToMembers in interface BrooklynObject.SubscriptionSupport

See Also:

SubscriptionManager.subscribeToMembers(Group, Sensor, SensorEventListener)

subscribeToChildren

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

Specified by:

subscribeToChildren in interface BrooklynObject.SubscriptionSupport

See Also:

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

unsubscribe

public boolean unsubscribe(Entity producer)

Description copied from interface: BrooklynObject.SubscriptionSupport

Unsubscribes from the given producer.

Specified by:

unsubscribe in interface BrooklynObject.SubscriptionSupport

See Also:

SubscriptionContext.unsubscribe(SubscriptionHandle)

unsubscribe

public boolean unsubscribe(Entity producer,
                           SubscriptionHandle handle)

Description copied from interface: BrooklynObject.SubscriptionSupport

Unsubscribes the given handle.

Specified by:

unsubscribe in interface BrooklynObject.SubscriptionSupport

See Also:

SubscriptionContext.unsubscribe(SubscriptionHandle)

unsubscribe

public boolean unsubscribe(SubscriptionHandle handle)

Description copied from interface: BrooklynObject.SubscriptionSupport

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

Specified by:

unsubscribe in interface BrooklynObject.SubscriptionSupport

unsubscribeAll

public void unsubscribeAll()

Specified by:

unsubscribeAll in interface BrooklynObjectInternal.SubscriptionSupportInternal