dom/mdsal-dom-broker/src/main/java/org/opendaylight/mdsal/dom/broker/DOMRpcRouter.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.mdsal.dom.broker;
   9
  10 import com.google.common.annotations.VisibleForTesting;
  11 import com.google.common.collect.Collections2;
  12 import com.google.common.collect.ImmutableList;
  13 import com.google.common.collect.ImmutableList.Builder;
  14 import com.google.common.collect.ImmutableSet;
  15 import com.google.common.collect.MapDifference;
  16 import com.google.common.collect.MapDifference.ValueDifference;
  17 import com.google.common.collect.Maps;
  18 import com.google.common.collect.Sets;
  19 import com.google.common.util.concurrent.CheckedFuture;
  20 import com.google.common.util.concurrent.ThreadFactoryBuilder;
  21 import java.util.ArrayList;
  22 import java.util.Collection;
  23 import java.util.Collections;
  24 import java.util.Map;
  25 import java.util.Map.Entry;
  26 import java.util.Set;
  27 import java.util.concurrent.ExecutorService;
  28 import java.util.concurrent.Executors;
  29 import java.util.concurrent.ThreadFactory;
  30 import javax.annotation.concurrent.GuardedBy;
  31 import org.opendaylight.mdsal.dom.api.DOMRpcAvailabilityListener;
  32 import org.opendaylight.mdsal.dom.api.DOMRpcException;
  33 import org.opendaylight.mdsal.dom.api.DOMRpcIdentifier;
  34 import org.opendaylight.mdsal.dom.api.DOMRpcImplementation;
  35 import org.opendaylight.mdsal.dom.api.DOMRpcImplementationRegistration;
  36 import org.opendaylight.mdsal.dom.api.DOMRpcProviderService;
  37 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  38 import org.opendaylight.mdsal.dom.api.DOMRpcService;
  39 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
  40 import org.opendaylight.mdsal.dom.spi.AbstractDOMRpcImplementationRegistration;
  41 import org.opendaylight.yangtools.concepts.AbstractListenerRegistration;
  42 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  43 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  44 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  45 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  46 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
  47 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  48
  49 public final class DOMRpcRouter implements AutoCloseable, DOMRpcService, DOMRpcProviderService, SchemaContextListener {
  50     private static final ThreadFactory THREAD_FACTORY = new ThreadFactoryBuilder().setNameFormat(
  51             "DOMRpcRouter-listener-%s").setDaemon(true).build();
  52
  53     private final ExecutorService listenerNotifier = Executors.newSingleThreadExecutor(THREAD_FACTORY);
  54
  55     @GuardedBy("this")
  56     private Collection<Registration<?>> listeners = Collections.emptyList();
  57
  58     private volatile DOMRpcRoutingTable routingTable = DOMRpcRoutingTable.EMPTY;
  59
  60     private ListenerRegistration<?> listenerRegistration;
  61
  62     public static DOMRpcRouter newInstance(final DOMSchemaService schemaService) {
  63         final DOMRpcRouter rpcRouter = new DOMRpcRouter();
  64         rpcRouter.listenerRegistration = schemaService.registerSchemaContextListener(rpcRouter);
  65         return rpcRouter;
  66     }
  67
  68     @Override
  69     public <T extends DOMRpcImplementation> DOMRpcImplementationRegistration<T> registerRpcImplementation(
  70             final T implementation, final DOMRpcIdentifier... rpcs) {
  71         return registerRpcImplementation(implementation, ImmutableSet.copyOf(rpcs));
  72     }
  73
  74     @Override
  75     public synchronized <T extends DOMRpcImplementation> DOMRpcImplementationRegistration<T>
  76             registerRpcImplementation(final T implementation, final Set<DOMRpcIdentifier> rpcs) {
  77         final DOMRpcRoutingTable oldTable = routingTable;
  78         final DOMRpcRoutingTable newTable = oldTable.add(implementation, rpcs);
  79         routingTable = newTable;
  80
  81         listenerNotifier.execute(() -> notifyAdded(newTable, implementation));
  82
  83         return new AbstractDOMRpcImplementationRegistration<T>(implementation) {
  84             @Override
  85             protected void removeRegistration() {
  86                 removeRpcImplementation(getInstance(), rpcs);
  87             }
  88         };
  89     }
  90
  91     private synchronized void removeRpcImplementation(final DOMRpcImplementation implementation,
  92             final Set<DOMRpcIdentifier> rpcs) {
  93         final DOMRpcRoutingTable oldTable = routingTable;
  94         final DOMRpcRoutingTable newTable = oldTable.remove(implementation, rpcs);
  95         routingTable = newTable;
  96
  97         listenerNotifier.execute(() -> notifyRemoved(newTable, implementation));
  98     }
  99
 100     @Override
 101     public CheckedFuture<DOMRpcResult, DOMRpcException> invokeRpc(final SchemaPath type,
 102             final NormalizedNode<?, ?> input) {
 103         return routingTable.invokeRpc(type, input);
 104     }
 105
 106     private synchronized void removeListener(final ListenerRegistration<? extends DOMRpcAvailabilityListener> reg) {
 107         listeners = ImmutableList.copyOf(Collections2.filter(listeners, input -> !reg.equals(input)));
 108     }
 109
 110     private synchronized void notifyAdded(final DOMRpcRoutingTable newTable, final DOMRpcImplementation impl) {
 111         for (Registration<?> l : listeners) {
 112             l.addRpc(newTable, impl);
 113         }
 114     }
 115
 116     private synchronized void notifyRemoved(final DOMRpcRoutingTable newTable, final DOMRpcImplementation impl) {
 117         for (Registration<?> l : listeners) {
 118             l.removeRpc(newTable, impl);
 119         }
 120     }
 121
 122     @Override
 123     public synchronized <T extends DOMRpcAvailabilityListener> ListenerRegistration<T> registerRpcListener(
 124             final T listener) {
 125         final Registration<T> ret = new Registration<>(this, listener);
 126         final Builder<Registration<?>> b = ImmutableList.builder();
 127         b.addAll(listeners);
 128         b.add(ret);
 129         listeners = b.build();
 130
 131         listenerNotifier.execute(() -> ret.initialTable(routingTable));
 132         return ret;
 133     }
 134
 135     @Override
 136     public synchronized void onGlobalContextUpdated(final SchemaContext context) {
 137         final DOMRpcRoutingTable oldTable = routingTable;
 138         final DOMRpcRoutingTable newTable = oldTable.setSchemaContext(context);
 139         routingTable = newTable;
 140     }
 141
 142     @Override
 143     public void close() {
 144         listenerNotifier.shutdown();
 145
 146         if (listenerRegistration != null) {
 147             listenerRegistration.close();
 148         }
 149     }
 150
 151     @VisibleForTesting
 152     Collection<?> listeners() {
 153         return listeners;
 154     }
 155
 156     @VisibleForTesting
 157     DOMRpcRoutingTable routingTable() {
 158         return routingTable;
 159     }
 160
 161     private static final class Registration<T extends DOMRpcAvailabilityListener>
 162         extends AbstractListenerRegistration<T> {
 163
 164         private final DOMRpcRouter router;
 165
 166         private Map<SchemaPath, Set<YangInstanceIdentifier>> prevRpcs;
 167
 168         Registration(final DOMRpcRouter router, final T listener) {
 169             super(listener);
 170             this.router = router;
 171         }
 172
 173         @Override
 174         protected void removeRegistration() {
 175             router.removeListener(this);
 176         }
 177
 178         void initialTable(final DOMRpcRoutingTable newTable) {
 179             final T l = getInstance();
 180             if (l == null) {
 181                 return;
 182             }
 183
 184             final Map<SchemaPath, Set<YangInstanceIdentifier>> rpcs = newTable.getRpcs(l);
 185             final Collection<DOMRpcIdentifier> added = new ArrayList<>();
 186             for (Entry<SchemaPath, Set<YangInstanceIdentifier>> e : rpcs.entrySet()) {
 187                 added.addAll(Collections2.transform(e.getValue(), i -> DOMRpcIdentifier.create(e.getKey(), i)));
 188             }
 189             prevRpcs = rpcs;
 190             if (!added.isEmpty()) {
 191                 l.onRpcAvailable(added);
 192             }
 193         }
 194
 195         void addRpc(final DOMRpcRoutingTable newTable, final DOMRpcImplementation impl) {
 196             final T l = getInstance();
 197             if (l == null || !l.acceptsImplementation(impl)) {
 198                 return;
 199             }
 200
 201             final Map<SchemaPath, Set<YangInstanceIdentifier>> rpcs = newTable.getRpcs(l);
 202             final MapDifference<SchemaPath, Set<YangInstanceIdentifier>> diff = Maps.difference(prevRpcs, rpcs);
 203
 204             final Collection<DOMRpcIdentifier> added = new ArrayList<>();
 205             for (Entry<SchemaPath, Set<YangInstanceIdentifier>> e : diff.entriesOnlyOnRight().entrySet()) {
 206                 added.addAll(Collections2.transform(e.getValue(), i -> DOMRpcIdentifier.create(e.getKey(), i)));
 207             }
 208             for (Entry<SchemaPath, ValueDifference<Set<YangInstanceIdentifier>>> e :
 209                     diff.entriesDiffering().entrySet()) {
 210                 for (YangInstanceIdentifier i : Sets.difference(e.getValue().rightValue(), e.getValue().leftValue())) {
 211                     added.add(DOMRpcIdentifier.create(e.getKey(), i));
 212                 }
 213             }
 214
 215             prevRpcs = rpcs;
 216             if (!added.isEmpty()) {
 217                 l.onRpcAvailable(added);
 218             }
 219         }
 220
 221         void removeRpc(final DOMRpcRoutingTable newTable, final DOMRpcImplementation impl) {
 222             final T l = getInstance();
 223             if (l == null || !l.acceptsImplementation(impl)) {
 224                 return;
 225             }
 226
 227             final Map<SchemaPath, Set<YangInstanceIdentifier>> rpcs = newTable.getRpcs(l);
 228             final MapDifference<SchemaPath, Set<YangInstanceIdentifier>> diff = Maps.difference(prevRpcs, rpcs);
 229
 230             final Collection<DOMRpcIdentifier> removed = new ArrayList<>();
 231             for (Entry<SchemaPath, Set<YangInstanceIdentifier>> e : diff.entriesOnlyOnLeft().entrySet()) {
 232                 removed.addAll(Collections2.transform(e.getValue(), i -> DOMRpcIdentifier.create(e.getKey(), i)));
 233             }
 234             for (Entry<SchemaPath, ValueDifference<Set<YangInstanceIdentifier>>> e :
 235                     diff.entriesDiffering().entrySet()) {
 236                 for (YangInstanceIdentifier i : Sets.difference(e.getValue().leftValue(), e.getValue().rightValue())) {
 237                     removed.add(DOMRpcIdentifier.create(e.getKey(), i));
 238                 }
 239             }
 240
 241             prevRpcs = rpcs;
 242             if (!removed.isEmpty()) {
 243                 l.onRpcUnavailable(removed);
 244             }
 245         }
 246     }
 247 }