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