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