org.apache.brooklyn.core.mgmt.internal

Class LocalSubscriptionManager

java.lang.Object

org.apache.brooklyn.core.mgmt.internal.AbstractSubscriptionManager

org.apache.brooklyn.core.mgmt.internal.LocalSubscriptionManager

All Implemented Interfaces:

SubscriptionManager

public class LocalSubscriptionManager
extends AbstractSubscriptionManager

A SubscriptionManager that stores subscription details locally. Synchronization model: methods in this class synch on this object to ensure subscription order and delivery order on publish.

Frequently it will be called by a thread holding a lock on a value (eg AttributeMap, this synchronized methods here should not call to any value that may require that lock. In particular notifications of initial value should not look up values.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.brooklyn.core.mgmt.internal.AbstractSubscriptionManager

AbstractSubscriptionManager.EntitySensorToken

Constructor Summary

Constructors

Constructor and Description
LocalSubscriptionManager(ExecutionManager m)

Method Summary

Modifier and Type	Method and Description
long	getNumSubscriptions()
java.util.Set<SubscriptionHandle>	getSubscriptionsForEntitySensor(Entity source, Sensor<?> sensor) Return the subscriptions on a given source-sensor pair
java.util.Set<SubscriptionHandle>	getSubscriptionsForSubscriber(java.lang.Object subscriber) Return the subscriptions requested by a given subscriber
long	getTotalEventsDelivered() The total number of sensor change events submitted for delivery, counting multiple deliveries for multipe subscribers (see getTotalEventsPublished()), but excluding initial notifications, and incremented when submitted ie prior to delivery
long	getTotalEventsPublished() The total number of sensor change events generated (irrespective of number subscribers, see getTotalEventsDelivered())
<T> void	publish(SensorEvent<T> event) performs the actual publishing -- ie distribution to subscriptions
java.lang.String	toString()
boolean	unsubscribe(SubscriptionHandle sh) Unsubscribe the given subscription id.

Methods inherited from class org.apache.brooklyn.core.mgmt.internal.AbstractSubscriptionManager

subscribe, subscribe, subscribeToChildren, subscribeToChildren, subscribeToMembers, subscribeToMembers

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalSubscriptionManager

public LocalSubscriptionManager(ExecutionManager m)

Method Detail

getNumSubscriptions

public long getNumSubscriptions()

getTotalEventsPublished

public long getTotalEventsPublished()

The total number of sensor change events generated (irrespective of number subscribers, see getTotalEventsDelivered())

getTotalEventsDelivered

public long getTotalEventsDelivered()

The total number of sensor change events submitted for delivery, counting multiple deliveries for multipe subscribers (see getTotalEventsPublished()), but excluding initial notifications, and incremented when submitted ie prior to delivery

getSubscriptionsForSubscriber

public java.util.Set<SubscriptionHandle> getSubscriptionsForSubscriber(java.lang.Object subscriber)

Description copied from interface: SubscriptionManager

Return the subscriptions requested by a given subscriber

getSubscriptionsForEntitySensor

public java.util.Set<SubscriptionHandle> getSubscriptionsForEntitySensor(Entity source,
                                                                         Sensor<?> sensor)

Description copied from interface: SubscriptionManager

Return the subscriptions on a given source-sensor pair

unsubscribe

public boolean unsubscribe(SubscriptionHandle sh)

Unsubscribe the given subscription id.

Returns:

true if such a subscription was present (and it will now be removed)

See Also:

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

publish

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

Description copied from class: AbstractSubscriptionManager

performs the actual publishing -- ie distribution to subscriptions

Specified by:

publish in interface SubscriptionManager

Specified by:

publish in class AbstractSubscriptionManager

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object