io.joynr.provider.AbstractSubscriptionPublisher Maven / Gradle / Ivy
package io.joynr.provider;
/*
* #%L
* %%
* Copyright (C) 2017 BMW Car IT GmbH
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.concurrent.ConcurrentHashMap;
import io.joynr.pubsub.publication.AttributeListener;
import io.joynr.pubsub.publication.BroadcastFilter;
import io.joynr.pubsub.publication.BroadcastFilterImpl;
import io.joynr.pubsub.publication.BroadcastListener;
import io.joynr.pubsub.publication.MulticastListener;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public abstract class AbstractSubscriptionPublisher implements SubscriptionPublisherObservable, SubscriptionPublisher {
private static final Logger LOG = LoggerFactory.getLogger(AbstractSubscriptionPublisher.class);
ConcurrentHashMap> attributeListeners;
ConcurrentHashMap> broadcastListeners;
List multicastListeners;
protected ConcurrentHashMap> broadcastFilters;
public AbstractSubscriptionPublisher() {
attributeListeners = new ConcurrentHashMap>();
broadcastListeners = new ConcurrentHashMap>();
multicastListeners = new ArrayList<>();
broadcastFilters = new ConcurrentHashMap>();
}
/**
* Called by generated {@code AbstractProvider} classes to notify
* all registered listeners about the attribute change.
*
* NOTE: Provider implementations should _not_ call this method but use
* attribute specific {@code AbstractProvider.Changed}
* methods.
*
* @param attributeName the attribute name as defined in the Franca model.
* @param value the new value of the changed attribute.
*/
protected void onAttributeValueChanged(String attributeName, Object value) {
if (!attributeListeners.containsKey(attributeName)) {
return;
}
List listeners = attributeListeners.get(attributeName);
synchronized (listeners) {
for (AttributeListener listener : listeners) {
listener.attributeValueChanged(value);
}
}
}
/**
* Called by generated {@code AbstractProvider} classes to notify
* all registered listeners about the fired broadcast.
*
* NOTE: Provider implementations should _not_ call this method but use
* broadcast specific {@code AbstractProvider.fire}
* methods.
*
* @param broadcastName the broadcast name as defined in the Franca model.
* @param broadcastFilters the list of filters to apply.
* @param values the broadcast arguments.
*/
protected void fireBroadcast(String broadcastName, List broadcastFilters, Object... values) {
if (!broadcastListeners.containsKey(broadcastName)) {
return;
}
List listeners = broadcastListeners.get(broadcastName);
synchronized (listeners) {
for (BroadcastListener listener : listeners) {
listener.broadcastOccurred(broadcastFilters, values);
}
}
}
/**
* Called by generated {@code AbstractProvider} classes to notify
* all registered multicast listeners about the fired multicast.
*
* NOTE: Provider implementations should _not_ call this method but use
* multicast specific {@code AbstractProvider.fire}
* methods.
*
* @param multicastName the multicast name as defined in the Franca model (as a non-selective broadcast).
* @param partitions the partitions which will be used in transmitting the multicast
* @param values the broadcast arguments.
*/
protected void fireMulticast(String multicastName, String[] partitions, Object... values) {
List listeners;
synchronized (multicastListeners) {
listeners = new ArrayList<>(multicastListeners);
}
for (MulticastListener listener : listeners) {
listener.multicastOccurred(multicastName, partitions, values);
}
}
/**
* Registers an attribute listener that gets notified in case the attribute
* changes. This is used for on change subscriptions.
*
* @param attributeName the attribute name as defined in the Franca model
* to subscribe to.
* @param attributeListener the listener to add.
*/
public void registerAttributeListener(String attributeName, AttributeListener attributeListener) {
attributeListeners.putIfAbsent(attributeName, new ArrayList());
List listeners = attributeListeners.get(attributeName);
synchronized (listeners) {
listeners.add(attributeListener);
}
}
/**
* Unregisters an attribute listener.
*
* @param attributeName the attribute name as defined in the Franca model
* to unsubscribe from.
* @param attributeListener the listener to remove.
*/
public void unregisterAttributeListener(String attributeName, AttributeListener attributeListener) {
List listeners = attributeListeners.get(attributeName);
if (listeners == null) {
LOG.error("trying to unregister an attribute listener for attribute \"" + attributeName
+ "\" that was never registered");
return;
}
synchronized (listeners) {
boolean success = listeners.remove(attributeListener);
if (!success) {
LOG.error("trying to unregister an attribute listener for attribute \"" + attributeName
+ "\" that was never registered");
return;
}
}
}
/**
* Registers a broadcast listener that gets notified in case the broadcast
* is fired.
*
* @param broadcastName the broadcast name as defined in the Franca model
* to subscribe to.
* @param broadcastListener the listener to add.
*/
public void registerBroadcastListener(String broadcastName, BroadcastListener broadcastListener) {
broadcastListeners.putIfAbsent(broadcastName, new ArrayList());
List listeners = broadcastListeners.get(broadcastName);
synchronized (listeners) {
listeners.add(broadcastListener);
}
}
/**
* Unregisters a broadcast listener.
*
* @param broadcastName the broadcast name as defined in the Franca model
* to unsubscribe from.
* @param broadcastListener the listener to remove.
*/
public void unregisterBroadcastListener(String broadcastName, BroadcastListener broadcastListener) {
List listeners = broadcastListeners.get(broadcastName);
if (listeners == null) {
LOG.error("trying to unregister a listener for broadcast \"" + broadcastName
+ "\" that was never registered");
return;
}
synchronized (listeners) {
boolean success = listeners.remove(broadcastListener);
if (!success) {
LOG.error("trying to unregister a listener for broadcast \"" + broadcastName
+ "\" that was never registered");
return;
}
}
}
@Override
public void registerMulticastListener(MulticastListener multicastListener) {
synchronized (multicastListeners) {
multicastListeners.add(multicastListener);
}
}
@Override
public void unregisterMulticastListener(MulticastListener multicastListener) {
synchronized (multicastListeners) {
multicastListeners.remove(multicastListener);
}
}
/**
* 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.
*
* @param filter the filter to add.
*/
public void addBroadcastFilter(BroadcastFilterImpl filter) {
if (broadcastFilters.containsKey(filter.getName())) {
broadcastFilters.get(filter.getName()).add(filter);
} else {
ArrayList list = new ArrayList();
list.add(filter);
broadcastFilters.put(filter.getName(), list);
}
}
/**
* Adds multiple broadcast filters to the provider.
*
* @param filters the filters to add.
* @see AbstractSubscriptionPublisher#addBroadcastFilter(BroadcastFilterImpl filter)
*/
public void addBroadcastFilter(BroadcastFilterImpl... filters) {
List filtersList = Arrays.asList(filters);
for (BroadcastFilterImpl filter : filtersList) {
addBroadcastFilter(filter);
}
}
}