Package io.joynr.provider

Class AbstractSubscriptionPublisher

java.lang.Object

io.joynr.provider.AbstractSubscriptionPublisher

All Implemented Interfaces:

SubscriptionPublisher, SubscriptionPublisherObservable

Direct Known Subclasses:

AccessControlListEditorSubscriptionPublisherImpl, DiscoverySubscriptionPublisherImpl, GlobalCapabilitiesDirectorySubscriptionPublisherImpl, MessageNotificationSubscriptionPublisherImpl, ProviderReregistrationControllerSubscriptionPublisherImpl, RoutingSubscriptionPublisherImpl

public abstract class AbstractSubscriptionPublisher
extends Object
implements SubscriptionPublisherObservable, SubscriptionPublisher

Field Summary

Fields

Modifier and Type	Field	Description
protected ConcurrentHashMap<String,List<BroadcastFilter>>	broadcastFilters

Constructor Summary

Constructors

Constructor	Description
AbstractSubscriptionPublisher()

Method Summary

Modifier and Type	Method	Description
void	addBroadcastFilter(BroadcastFilterImpl filter)	Adds a broadcast filter to the provider.
void	addBroadcastFilter(BroadcastFilterImpl... filters)	Adds multiple broadcast filters to the provider.
protected void	fireBroadcast(String broadcastName, List<BroadcastFilter> broadcastFilters, Object... values)	Called by generated <Interface>AbstractProvider classes to notify all registered listeners about the fired broadcast.
protected void	fireMulticast(String multicastName, String[] partitions, Object... values)	Called by generated <Interface>AbstractProvider classes to notify all registered multicast listeners about the fired multicast.
protected void	onAttributeValueChanged(String attributeName, Object value)	Called by generated <Interface>AbstractProvider classes to notify all registered listeners about the attribute change.
void	registerAttributeListener(String attributeName, AttributeListener attributeListener)	Registers an attribute listener that gets notified in case the attribute changes.
void	registerBroadcastListener(String broadcastName, BroadcastListener broadcastListener)	Registers a broadcast listener that gets notified in case the broadcast is fired.
void	registerMulticastListener(MulticastListener multicastListener)	Registers a multicast listener which will be notified anytime a multicast is fired.
void	unregisterAttributeListener(String attributeName, AttributeListener attributeListener)	Unregisters an attribute listener.
void	unregisterBroadcastListener(String broadcastName, BroadcastListener broadcastListener)	Unregisters a broadcast listener.
void	unregisterMulticastListener(MulticastListener multicastListener)	Unregisters a listener previously registered with SubscriptionPublisherObservable.registerMulticastListener(MulticastListener)}.

Methods inherited from class java.lang.Object

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

Field Detail

broadcastFilters

protected ConcurrentHashMap<String,List<BroadcastFilter>> broadcastFilters

Constructor Detail

AbstractSubscriptionPublisher

public AbstractSubscriptionPublisher()

Method Detail

onAttributeValueChanged

protected void onAttributeValueChanged(String attributeName,
                                       Object value)

Called by generated <Interface>AbstractProvider classes to notify all registered listeners about the attribute change.

NOTE: Provider implementations should _not_ call this method but use attribute specific <Interface>AbstractProvider.<attribute>Changed methods.

Parameters:

attributeName - the attribute name as defined in the Franca model.

value - the new value of the changed attribute.

fireBroadcast

protected void fireBroadcast(String broadcastName,
                             List<BroadcastFilter> broadcastFilters,
                             Object... values)

Called by generated <Interface>AbstractProvider classes to notify all registered listeners about the fired broadcast.

NOTE: Provider implementations should _not_ call this method but use broadcast specific <Interface>AbstractProvider.fire<Broadcast> methods.

Parameters:

broadcastName - the broadcast name as defined in the Franca model.

broadcastFilters - the list of filters to apply.

values - the broadcast arguments.

fireMulticast

protected void fireMulticast(String multicastName,
                             String[] partitions,
                             Object... values)

Called by generated <Interface>AbstractProvider classes to notify all registered multicast listeners about the fired multicast.

NOTE: Provider implementations should _not_ call this method but use multicast specific <Interface>AbstractProvider.fire<Multicast> methods.

Parameters:

multicastName - the multicast name as defined in the Franca model (as a non-selective broadcast).

partitions - the partitions which will be used in transmitting the multicast

values - the broadcast arguments.

registerAttributeListener

public void registerAttributeListener(String attributeName,
                                      AttributeListener attributeListener)

Registers an attribute listener that gets notified in case the attribute changes. This is used for on change subscriptions.

Specified by:

registerAttributeListener in interface SubscriptionPublisherObservable

Parameters:

attributeName - the attribute name as defined in the Franca model to subscribe to.

attributeListener - the listener to add.

unregisterAttributeListener

public void unregisterAttributeListener(String attributeName,
                                        AttributeListener attributeListener)

Unregisters an attribute listener.

Specified by:

unregisterAttributeListener in interface SubscriptionPublisherObservable

Parameters:

attributeName - the attribute name as defined in the Franca model to unsubscribe from.

attributeListener - the listener to remove.

registerBroadcastListener

public void registerBroadcastListener(String broadcastName,
                                      BroadcastListener broadcastListener)

Registers a broadcast listener that gets notified in case the broadcast is fired.

Specified by:

registerBroadcastListener in interface SubscriptionPublisherObservable

Parameters:

broadcastName - the broadcast name as defined in the Franca model to subscribe to.

broadcastListener - the listener to add.

unregisterBroadcastListener

public void unregisterBroadcastListener(String broadcastName,
                                        BroadcastListener broadcastListener)

Unregisters a broadcast listener.

Specified by:

unregisterBroadcastListener in interface SubscriptionPublisherObservable

Parameters:

broadcastName - the broadcast name as defined in the Franca model to unsubscribe from.

broadcastListener - the listener to remove.

registerMulticastListener

public void registerMulticastListener(MulticastListener multicastListener)

Description copied from interface: SubscriptionPublisherObservable

Registers a multicast listener which will be notified anytime a multicast is fired.

Specified by:

registerMulticastListener in interface SubscriptionPublisherObservable

Parameters:

multicastListener - the listener to register.

unregisterMulticastListener

public void unregisterMulticastListener(MulticastListener multicastListener)

Description copied from interface: SubscriptionPublisherObservable

Unregisters a listener previously registered with SubscriptionPublisherObservable.registerMulticastListener(MulticastListener)}. If the listener passed in was not previously registered or has already been unregistered, then this is a no-op.

Specified by:

unregisterMulticastListener in interface SubscriptionPublisherObservable

Parameters:

multicastListener - the listener to unregister.

addBroadcastFilter

public void addBroadcastFilter(BroadcastFilterImpl filter)

Adds a broadcast filter to the provider. The filter is specific for a single broadcast as defined in the Franca model. It will be executed once for each subscribed client whenever the broadcast is fired. Clients set individual filter parameters to control filter behavior.

Specified by:

addBroadcastFilter in interface SubscriptionPublisher

Parameters:

filter - the filter to add.

addBroadcastFilter

public void addBroadcastFilter(BroadcastFilterImpl... filters)

Adds multiple broadcast filters to the provider.

Specified by:

addBroadcastFilter in interface SubscriptionPublisher

Parameters:

filters - the filters to add.

See Also:

addBroadcastFilter(BroadcastFilterImpl filter)