org.apache.brooklyn.core.entity

Class AbstractEntity.BasicSubscriptionSupport

java.lang.Object

org.apache.brooklyn.core.entity.AbstractEntity.BasicSubscriptionSupport

All Implemented Interfaces:

BrooklynObject.SubscriptionSupport, EntityInternal.EntitySubscriptionSupportInternal, BrooklynObjectInternal.SubscriptionSupportInternal

Enclosing class:

AbstractEntity

@Beta
public class AbstractEntity.BasicSubscriptionSupport
extends java.lang.Object
implements EntityInternal.EntitySubscriptionSupportInternal

Direct use of this class is strongly discouraged. It will become private in a future release, once BrooklynObject.subscriptions() is reverted to return SubscriptionSupportInternal instead of AbstractEntity.BasicSubscriptionSupport.

Constructor Summary

Constructors

Constructor and Description
BasicSubscriptionSupport()

Method Summary

Modifier and Type	Method and Description
SubscriptionContext	getSubscriptionContext()
<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 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)

subscribeToChildren

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

Specified by:

subscribeToChildren in interface BrooklynObject.SubscriptionSupport

See Also:

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

subscribeToMembers

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

Specified by:

subscribeToMembers in interface BrooklynObject.SubscriptionSupport

See Also:

SubscriptionManager.subscribeToMembers(Group, Sensor, SensorEventListener)

unsubscribe

public boolean unsubscribe(Entity producer)

Unsubscribes the given producer.

Specified by:

unsubscribe in interface BrooklynObject.SubscriptionSupport

See Also:

SubscriptionContext.unsubscribe(SubscriptionHandle)

unsubscribe

public boolean unsubscribe(Entity producer,
                           SubscriptionHandle handle)

Unsubscribes the given handle.

Specified by:

unsubscribe in interface BrooklynObject.SubscriptionSupport

See Also:

SubscriptionContext.unsubscribe(SubscriptionHandle)

unsubscribe

public boolean unsubscribe(SubscriptionHandle handle)

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

Specified by:

unsubscribe in interface BrooklynObject.SubscriptionSupport

unsubscribeAll

public void unsubscribeAll()

Specified by:

unsubscribeAll in interface BrooklynObjectInternal.SubscriptionSupportInternal

getSubscriptionContext

public SubscriptionContext getSubscriptionContext()

Specified by:

getSubscriptionContext in interface EntityInternal.EntitySubscriptionSupportInternal