dom/mdsal-dom-broker/src/main/java/org/opendaylight/mdsal/dom/broker/DOMRpcRoutingTable.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.base.Preconditions;
  12 import com.google.common.collect.ImmutableList;
  13 import com.google.common.collect.ImmutableMap;
  14 import com.google.common.collect.ImmutableMap.Builder;
  15 import com.google.common.collect.LinkedListMultimap;
  16 import com.google.common.collect.ListMultimap;
  17 import com.google.common.collect.Maps;
  18 import java.util.ArrayList;
  19 import java.util.Collection;
  20 import java.util.HashMap;
  21 import java.util.List;
  22 import java.util.Map;
  23 import java.util.Map.Entry;
  24 import java.util.Set;
  25 import org.eclipse.jdt.annotation.NonNull;
  26 import org.eclipse.jdt.annotation.Nullable;
  27 import org.opendaylight.mdsal.dom.api.DOMRpcAvailabilityListener;
  28 import org.opendaylight.mdsal.dom.api.DOMRpcIdentifier;
  29 import org.opendaylight.mdsal.dom.api.DOMRpcImplementation;
  30 import org.opendaylight.mdsal.dom.spi.RpcRoutingStrategy;
  31 import org.opendaylight.yangtools.yang.common.QName;
  32 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  33 import org.opendaylight.yangtools.yang.model.api.Module;
  34 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  35 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  36 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  37
  38 final class DOMRpcRoutingTable {
  39     static final DOMRpcRoutingTable EMPTY = new DOMRpcRoutingTable(ImmutableMap.of(), null);
  40
  41     private final Map<SchemaPath, AbstractDOMRpcRoutingTableEntry> rpcs;
  42     private final SchemaContext schemaContext;
  43
  44     private DOMRpcRoutingTable(final Map<SchemaPath, AbstractDOMRpcRoutingTableEntry> rpcs,
  45             final SchemaContext schemaContext) {
  46         this.rpcs = Preconditions.checkNotNull(rpcs);
  47         this.schemaContext = schemaContext;
  48     }
  49
  50     DOMRpcRoutingTable setSchemaContext(final SchemaContext context) {
  51         final Builder<SchemaPath, AbstractDOMRpcRoutingTableEntry> b = ImmutableMap.builder();
  52
  53         for (Entry<SchemaPath, AbstractDOMRpcRoutingTableEntry> e : rpcs.entrySet()) {
  54             b.put(e.getKey(), createRpcEntry(context, e.getKey(), e.getValue().getImplementations()));
  55         }
  56
  57         return new DOMRpcRoutingTable(b.build(), context);
  58     }
  59
  60     DOMRpcRoutingTable add(final DOMRpcImplementation implementation, final Set<DOMRpcIdentifier> rpcsToAdd) {
  61         if (rpcsToAdd.isEmpty()) {
  62             return this;
  63         }
  64
  65         // First decompose the identifiers to a multimap
  66         final ListMultimap<SchemaPath, YangInstanceIdentifier> toAdd = decomposeIdentifiers(rpcsToAdd);
  67
  68         // Now iterate over existing entries, modifying them as appropriate...
  69         final Builder<SchemaPath, AbstractDOMRpcRoutingTableEntry> mb = ImmutableMap.builder();
  70         for (Entry<SchemaPath, AbstractDOMRpcRoutingTableEntry> re : this.rpcs.entrySet()) {
  71             List<YangInstanceIdentifier> newRpcs = new ArrayList<>(toAdd.removeAll(re.getKey()));
  72             if (!newRpcs.isEmpty()) {
  73                 final AbstractDOMRpcRoutingTableEntry ne = re.getValue().add(implementation, newRpcs);
  74                 mb.put(re.getKey(), ne);
  75             } else {
  76                 mb.put(re);
  77             }
  78         }
  79
  80         // Finally add whatever is left in the decomposed multimap
  81         for (Entry<SchemaPath, Collection<YangInstanceIdentifier>> e : toAdd.asMap().entrySet()) {
  82             final Builder<YangInstanceIdentifier, List<DOMRpcImplementation>> vb = ImmutableMap.builder();
  83             final List<DOMRpcImplementation> v = ImmutableList.of(implementation);
  84             for (YangInstanceIdentifier i : e.getValue()) {
  85                 vb.put(i, v);
  86             }
  87
  88             mb.put(e.getKey(), createRpcEntry(schemaContext, e.getKey(), vb.build()));
  89         }
  90
  91         return new DOMRpcRoutingTable(mb.build(), schemaContext);
  92     }
  93
  94     DOMRpcRoutingTable remove(final DOMRpcImplementation implementation, final Set<DOMRpcIdentifier> rpcIds) {
  95         if (rpcIds.isEmpty()) {
  96             return this;
  97         }
  98
  99         // First decompose the identifiers to a multimap
 100         final ListMultimap<SchemaPath, YangInstanceIdentifier> toRemove = decomposeIdentifiers(rpcIds);
 101
 102         // Now iterate over existing entries, modifying them as appropriate...
 103         final Builder<SchemaPath, AbstractDOMRpcRoutingTableEntry> b = ImmutableMap.builder();
 104         for (Entry<SchemaPath, AbstractDOMRpcRoutingTableEntry> e : this.rpcs.entrySet()) {
 105             final List<YangInstanceIdentifier> removed = new ArrayList<>(toRemove.removeAll(e.getKey()));
 106             if (!removed.isEmpty()) {
 107                 final AbstractDOMRpcRoutingTableEntry ne = e.getValue().remove(implementation, removed);
 108                 if (ne != null) {
 109                     b.put(e.getKey(), ne);
 110                 }
 111             } else {
 112                 b.put(e);
 113             }
 114         }
 115
 116         // All done, whatever is in toRemove, was not there in the first place
 117         return new DOMRpcRoutingTable(b.build(), schemaContext);
 118     }
 119
 120     boolean contains(final DOMRpcIdentifier input) {
 121         final AbstractDOMRpcRoutingTableEntry contexts = rpcs.get(input.getType());
 122         return contexts != null && contexts.containsContext(input.getContextReference());
 123     }
 124
 125     @VisibleForTesting
 126     Map<SchemaPath, Set<YangInstanceIdentifier>> getRpcs() {
 127         return Maps.transformValues(rpcs, AbstractDOMRpcRoutingTableEntry::registeredIdentifiers);
 128     }
 129
 130     Map<SchemaPath, Set<YangInstanceIdentifier>> getRpcs(final DOMRpcAvailabilityListener listener) {
 131         final Map<SchemaPath, Set<YangInstanceIdentifier>> ret = new HashMap<>(rpcs.size());
 132         for (Entry<SchemaPath, AbstractDOMRpcRoutingTableEntry> e : rpcs.entrySet()) {
 133             final Set<YangInstanceIdentifier> ids = e.getValue().registeredIdentifiers(listener);
 134             if (!ids.isEmpty()) {
 135                 ret.put(e.getKey(), ids);
 136             }
 137         }
 138
 139         return ret;
 140     }
 141
 142     @Nullable AbstractDOMRpcRoutingTableEntry getEntry(final @NonNull SchemaPath type) {
 143         return rpcs.get(type);
 144     }
 145
 146     private static ListMultimap<SchemaPath, YangInstanceIdentifier> decomposeIdentifiers(
 147             final Set<DOMRpcIdentifier> rpcs) {
 148         final ListMultimap<SchemaPath, YangInstanceIdentifier> ret = LinkedListMultimap.create();
 149         for (DOMRpcIdentifier i : rpcs) {
 150             ret.put(i.getType(), i.getContextReference());
 151         }
 152         return ret;
 153     }
 154
 155     private static RpcDefinition findRpcDefinition(final SchemaContext context, final SchemaPath schemaPath) {
 156         if (context != null) {
 157             final QName qname = schemaPath.getPathFromRoot().iterator().next();
 158             final Module module = context.findModule(qname.getModule()).orElse(null);
 159             if (module != null && module.getRpcs() != null) {
 160                 for (RpcDefinition rpc : module.getRpcs()) {
 161                     if (qname.equals(rpc.getQName())) {
 162                         return rpc;
 163                     }
 164                 }
 165             }
 166         }
 167
 168         return null;
 169     }
 170
 171     private static AbstractDOMRpcRoutingTableEntry createRpcEntry(final SchemaContext context, final SchemaPath key,
 172             final Map<YangInstanceIdentifier, List<DOMRpcImplementation>> implementations) {
 173         final RpcDefinition rpcDef = findRpcDefinition(context, key);
 174         if (rpcDef == null) {
 175             return new UnknownDOMRpcRoutingTableEntry(key, implementations);
 176         }
 177
 178         final RpcRoutingStrategy strategy = RpcRoutingStrategy.from(rpcDef);
 179         if (strategy.isContextBasedRouted()) {
 180             return new RoutedDOMRpcRoutingTableEntry(rpcDef, YangInstanceIdentifier.of(strategy.getLeaf()),
 181                 implementations);
 182         }
 183
 184         return new GlobalDOMRpcRoutingTableEntry(rpcDef, implementations);
 185     }
 186 }