org.apache.brooklyn.api.mgmt

Interface SubscriptionContext

All Known Implementing Classes:

BasicSubscriptionContext

public interface SubscriptionContext

This is the context through which an Entity can manage its subscriptions.

Method Summary

Modifier and Type	Method and Description
java.util.Set<SubscriptionHandle>	getSubscriptions() Return the subscriptions associated with this context
<T> void	publish(SensorEvent<T> event)
<T> SubscriptionHandle	subscribe(Entity producer, Sensor<T> sensor, SensorEventListener<? super T> listener)
<T> SubscriptionHandle	subscribe(java.util.Map<java.lang.String,?> flags, Entity producer, Sensor<T> sensor, SensorEventListener<? super T> listener) As SubscriptionManager.subscribe(Map, Entity, Sensor, SensorEventListener) with default subscription parameters for this context
<T> SubscriptionHandle	subscribeToChildren(Entity parent, Sensor<T> sensor, SensorEventListener<? super T> listener)
<T> SubscriptionHandle	subscribeToChildren(java.util.Map<java.lang.String,java.lang.Object> flags, Entity parent, Sensor<T> sensor, SensorEventListener<? super T> listener)
<T> SubscriptionHandle	subscribeToMembers(Group parent, Sensor<T> sensor, SensorEventListener<? super T> listener)
<T> SubscriptionHandle	subscribeToMembers(java.util.Map<java.lang.String,java.lang.Object> flags, Group parent, Sensor<T> sensor, SensorEventListener<? super T> listener)
boolean	unsubscribe(SubscriptionHandle subscriptionId)
int	unsubscribeAll() causes all subscriptions to be deregistered

Method Detail

subscribe

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

As SubscriptionManager.subscribe(Map, Entity, Sensor, SensorEventListener) with default subscription parameters for this context

subscribe

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

See Also:

subscribe(Map, Entity, Sensor, SensorEventListener)

subscribeToChildren

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

See Also:

subscribe(Map, Entity, Sensor, SensorEventListener)

subscribeToChildren

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

See Also:

subscribe(Map, Entity, Sensor, SensorEventListener)

subscribeToMembers

<T> SubscriptionHandle subscribeToMembers(java.util.Map<java.lang.String,java.lang.Object> flags,
                                          Group parent,
                                          Sensor<T> sensor,
                                          SensorEventListener<? super T> listener)

See Also:

subscribe(Map, Entity, Sensor, SensorEventListener)

subscribeToMembers

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

See Also:

subscribe(Map, Entity, Sensor, SensorEventListener)

unsubscribe

boolean unsubscribe(SubscriptionHandle subscriptionId)

See Also:

SubscriptionManager.unsubscribe(SubscriptionHandle)

unsubscribeAll

int unsubscribeAll()

causes all subscriptions to be deregistered

Returns:

number of subscriptions removed

publish

<T> void publish(SensorEvent<T> event)

See Also:

SubscriptionManager.publish(SensorEvent)

getSubscriptions

java.util.Set<SubscriptionHandle> getSubscriptions()

Return the subscriptions associated with this context