2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.mdsal.dom.broker;
10 import com.google.common.annotations.VisibleForTesting;
11 import com.google.common.collect.ImmutableList;
12 import com.google.common.collect.ImmutableMultimap;
13 import com.google.common.collect.Multimap;
14 import com.google.common.collect.Multimaps;
15 import com.google.common.util.concurrent.Futures;
16 import com.google.common.util.concurrent.ListenableFuture;
17 import com.google.common.util.concurrent.MoreExecutors;
18 import com.google.common.util.concurrent.ThreadFactoryBuilder;
19 import java.util.ArrayList;
20 import java.util.Collection;
21 import java.util.HashMap;
22 import java.util.List;
25 import java.util.concurrent.ExecutorService;
26 import java.util.concurrent.Executors;
27 import java.util.concurrent.ScheduledFuture;
28 import java.util.concurrent.ScheduledThreadPoolExecutor;
29 import java.util.concurrent.TimeUnit;
30 import javax.annotation.PreDestroy;
31 import javax.inject.Inject;
32 import org.eclipse.jdt.annotation.NonNull;
33 import org.opendaylight.mdsal.dom.api.DOMNotification;
34 import org.opendaylight.mdsal.dom.api.DOMNotificationListener;
35 import org.opendaylight.mdsal.dom.api.DOMNotificationPublishService;
36 import org.opendaylight.mdsal.dom.api.DOMNotificationService;
37 import org.opendaylight.mdsal.dom.spi.DOMNotificationSubscriptionListener;
38 import org.opendaylight.mdsal.dom.spi.DOMNotificationSubscriptionListenerRegistry;
39 import org.opendaylight.yangtools.concepts.AbstractListenerRegistration;
40 import org.opendaylight.yangtools.concepts.AbstractRegistration;
41 import org.opendaylight.yangtools.concepts.ListenerRegistration;
42 import org.opendaylight.yangtools.concepts.Registration;
43 import org.opendaylight.yangtools.util.ListenerRegistry;
44 import org.opendaylight.yangtools.util.concurrent.EqualityQueuedNotificationManager;
45 import org.opendaylight.yangtools.util.concurrent.FluentFutures;
46 import org.opendaylight.yangtools.util.concurrent.QueuedNotificationManager;
47 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
48 import org.osgi.service.component.annotations.Activate;
49 import org.osgi.service.component.annotations.Component;
50 import org.osgi.service.component.annotations.Deactivate;
51 import org.osgi.service.metatype.annotations.AttributeDefinition;
52 import org.osgi.service.metatype.annotations.Designate;
53 import org.osgi.service.metatype.annotations.ObjectClassDefinition;
54 import org.slf4j.Logger;
55 import org.slf4j.LoggerFactory;
58 * Joint implementation of {@link DOMNotificationPublishService} and {@link DOMNotificationService}. Provides
59 * routing of notifications from publishers to subscribers.
62 * Internal implementation one by using a {@link QueuedNotificationManager}.
65 @Component(immediate = true, configurationPid = "org.opendaylight.mdsal.dom.notification", service = {
66 DOMNotificationService.class, DOMNotificationPublishService.class,
67 DOMNotificationSubscriptionListenerRegistry.class
69 @Designate(ocd = DOMNotificationRouter.Config.class)
70 // Non-final for testing
71 public class DOMNotificationRouter implements AutoCloseable, DOMNotificationPublishService,
72 DOMNotificationService, DOMNotificationSubscriptionListenerRegistry {
73 @ObjectClassDefinition()
74 public @interface Config {
75 @AttributeDefinition(name = "notification-queue-depth")
76 int queueDepth() default 65536;
80 abstract static sealed class Reg<T extends DOMNotificationListener> extends AbstractListenerRegistration<T> {
81 Reg(final @NonNull T listener) {
86 private final class SingleReg<T extends DOMNotificationListener> extends Reg<T> {
87 SingleReg(final @NonNull T listener) {
92 protected void removeRegistration() {
93 DOMNotificationRouter.this.removeRegistration(this);
97 private static final class ComponentReg extends Reg<DOMNotificationListener> {
98 ComponentReg(final @NonNull DOMNotificationListener listener) {
103 protected void removeRegistration() {
108 private static final Logger LOG = LoggerFactory.getLogger(DOMNotificationRouter.class);
109 private static final ListenableFuture<Void> NO_LISTENERS = FluentFutures.immediateNullFluentFuture();
111 private final ListenerRegistry<DOMNotificationSubscriptionListener> subscriptionListeners =
112 ListenerRegistry.create();
113 private final EqualityQueuedNotificationManager<AbstractListenerRegistration<? extends DOMNotificationListener>,
114 DOMNotificationRouterEvent> queueNotificationManager;
115 private final ScheduledThreadPoolExecutor observer;
116 private final ExecutorService executor;
118 private volatile Multimap<Absolute, Reg<?>> listeners = ImmutableMultimap.of();
121 public DOMNotificationRouter(final int maxQueueCapacity) {
122 observer = new ScheduledThreadPoolExecutor(1, new ThreadFactoryBuilder()
124 .setNameFormat("DOMNotificationRouter-observer-%d")
126 executor = Executors.newCachedThreadPool(new ThreadFactoryBuilder()
128 .setNameFormat("DOMNotificationRouter-listeners-%d")
130 queueNotificationManager = new EqualityQueuedNotificationManager<>("DOMNotificationRouter", executor,
131 maxQueueCapacity, DOMNotificationRouter::deliverEvents);
135 public DOMNotificationRouter(final Config config) {
136 this(config.queueDepth());
137 LOG.info("DOM Notification Router started");
140 @Deprecated(forRemoval = true)
141 public static DOMNotificationRouter create(final int maxQueueCapacity) {
142 return new DOMNotificationRouter(maxQueueCapacity);
146 public synchronized <T extends DOMNotificationListener> ListenerRegistration<T> registerNotificationListener(
147 final T listener, final Collection<Absolute> types) {
148 final var reg = new SingleReg<>(listener);
150 if (!types.isEmpty()) {
151 final var b = ImmutableMultimap.<Absolute, Reg<?>>builder();
154 for (var t : types) {
158 replaceListeners(b.build());
165 public synchronized Registration registerNotificationListeners(
166 final Map<Absolute, DOMNotificationListener> typeToListener) {
167 final var b = ImmutableMultimap.<Absolute, Reg<?>>builder();
170 final var tmp = new HashMap<DOMNotificationListener, ComponentReg>();
171 for (var e : typeToListener.entrySet()) {
172 b.put(e.getKey(), tmp.computeIfAbsent(e.getValue(), ComponentReg::new));
175 final var regs = List.copyOf(tmp.values());
176 return new AbstractRegistration() {
178 protected void removeRegistration() {
179 regs.forEach(ComponentReg::close);
180 removeRegistrations(regs);
185 private synchronized void removeRegistration(final SingleReg<?> reg) {
186 replaceListeners(ImmutableMultimap.copyOf(Multimaps.filterValues(listeners, input -> input != reg)));
189 private synchronized void removeRegistrations(final List<ComponentReg> regs) {
190 replaceListeners(ImmutableMultimap.copyOf(Multimaps.filterValues(listeners, input -> !regs.contains(input))));
194 * Swaps registered listeners and triggers notification update.
196 * @param newListeners is used to notify listenerTypes changed
198 private void replaceListeners(final Multimap<Absolute, Reg<?>> newListeners) {
199 listeners = newListeners;
200 notifyListenerTypesChanged(newListeners.keySet());
203 @SuppressWarnings("checkstyle:IllegalCatch")
204 private void notifyListenerTypesChanged(final Set<Absolute> typesAfter) {
205 final List<? extends DOMNotificationSubscriptionListener> listenersAfter =
206 subscriptionListeners.streamListeners().collect(ImmutableList.toImmutableList());
207 executor.execute(() -> {
208 for (final DOMNotificationSubscriptionListener subListener : listenersAfter) {
210 subListener.onSubscriptionChanged(typesAfter);
211 } catch (final Exception e) {
212 LOG.warn("Uncaught exception during invoking listener {}", subListener, e);
219 public <L extends DOMNotificationSubscriptionListener> ListenerRegistration<L> registerSubscriptionListener(
221 final Set<Absolute> initialTypes = listeners.keySet();
222 executor.execute(() -> listener.onSubscriptionChanged(initialTypes));
223 return subscriptionListeners.register(listener);
227 ListenableFuture<? extends Object> publish(final DOMNotification notification,
228 final Collection<Reg<?>> subscribers) {
229 final List<ListenableFuture<Void>> futures = new ArrayList<>(subscribers.size());
230 subscribers.forEach(subscriber -> {
231 final DOMNotificationRouterEvent event = new DOMNotificationRouterEvent(notification);
232 futures.add(event.future());
233 queueNotificationManager.submitNotification(subscriber, event);
235 return Futures.transform(Futures.successfulAsList(futures), ignored -> (Void)null,
236 MoreExecutors.directExecutor());
240 public ListenableFuture<? extends Object> putNotification(final DOMNotification notification)
241 throws InterruptedException {
242 final var subscribers = listeners.get(notification.getType());
243 if (subscribers.isEmpty()) {
247 return publish(notification, subscribers);
251 public ListenableFuture<? extends Object> offerNotification(final DOMNotification notification) {
252 final var subscribers = listeners.get(notification.getType());
253 if (subscribers.isEmpty()) {
257 return publish(notification, subscribers);
261 public ListenableFuture<? extends Object> offerNotification(final DOMNotification notification, final long timeout,
262 final TimeUnit unit) throws InterruptedException {
263 final var subscribers = listeners.get(notification.getType());
264 if (subscribers.isEmpty()) {
267 // Attempt to perform a non-blocking publish first
268 final ListenableFuture<?> noBlock = publish(notification, subscribers);
269 if (!DOMNotificationPublishService.REJECTED.equals(noBlock)) {
274 final Thread publishThread = Thread.currentThread();
275 ScheduledFuture<?> timerTask = observer.schedule(publishThread::interrupt, timeout, unit);
276 final ListenableFuture<?> withBlock = putNotification(notification);
277 timerTask.cancel(true);
278 if (observer.getQueue().size() > 50) {
282 } catch (InterruptedException e) {
283 return DOMNotificationPublishService.REJECTED;
290 public void close() {
293 LOG.info("DOM Notification Router stopped");
297 ExecutorService executor() {
302 ExecutorService observer() {
307 Multimap<Absolute, ?> listeners() {
312 ListenerRegistry<DOMNotificationSubscriptionListener> subscriptionListeners() {
313 return subscriptionListeners;
316 private static void deliverEvents(final AbstractListenerRegistration<? extends DOMNotificationListener> reg,
317 final ImmutableList<DOMNotificationRouterEvent> events) {
318 if (reg.notClosed()) {
319 final DOMNotificationListener listener = reg.getInstance();
320 for (DOMNotificationRouterEvent event : events) {
321 event.deliverTo(listener);
324 events.forEach(DOMNotificationRouterEvent::clear);