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