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.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.collect.Maps;
  16 import com.google.common.util.concurrent.CheckedFuture;
  17 import com.google.common.util.concurrent.Futures;
  18 import java.util.ArrayList;
  19 import java.util.Collection;
  20 import java.util.Collections;
  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.mdsal.dom.api.DOMRpcException;
  26 import org.opendaylight.mdsal.dom.api.DOMRpcIdentifier;
  27 import org.opendaylight.mdsal.dom.api.DOMRpcImplementation;
  28 import org.opendaylight.mdsal.dom.api.DOMRpcImplementationNotAvailableException;
  29 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  30 import org.opendaylight.yangtools.yang.common.QName;
  31 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  32 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  33 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  34 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  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 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  40
  41 final class DOMRpcRoutingTable {
  42     private static final QName CONTEXT_REFERENCE = QName.create("urn:opendaylight:yang:extension:yang-ext",
  43             "2013-07-09", "context-reference").intern();
  44
  45     static final DOMRpcRoutingTable EMPTY = new DOMRpcRoutingTable();
  46
  47     private final Map<SchemaPath, AbstractDOMRpcRoutingTableEntry> rpcs;
  48     private final SchemaContext schemaContext;
  49
  50     private DOMRpcRoutingTable() {
  51         rpcs = Collections.emptyMap();
  52         schemaContext = null;
  53     }
  54
  55     private DOMRpcRoutingTable(final Map<SchemaPath, AbstractDOMRpcRoutingTableEntry> rpcs,
  56             final SchemaContext schemaContext) {
  57         this.rpcs = Preconditions.checkNotNull(rpcs);
  58         this.schemaContext = schemaContext;
  59     }
  60
  61     private static ListMultimap<SchemaPath, YangInstanceIdentifier> decomposeIdentifiers(
  62             final Set<DOMRpcIdentifier> rpcs) {
  63         final ListMultimap<SchemaPath, YangInstanceIdentifier> ret = LinkedListMultimap.create();
  64         for (DOMRpcIdentifier i : rpcs) {
  65             ret.put(i.getType(), i.getContextReference());
  66         }
  67         return ret;
  68     }
  69
  70     DOMRpcRoutingTable add(final DOMRpcImplementation implementation, final Set<DOMRpcIdentifier> rpcs) {
  71         if (rpcs.isEmpty()) {
  72             return this;
  73         }
  74
  75         // First decompose the identifiers to a multimap
  76         final ListMultimap<SchemaPath, YangInstanceIdentifier> toAdd = decomposeIdentifiers(rpcs);
  77
  78         // Now iterate over existing entries, modifying them as appropriate...
  79         final Builder<SchemaPath, AbstractDOMRpcRoutingTableEntry> mb = ImmutableMap.builder();
  80         for (Entry<SchemaPath, AbstractDOMRpcRoutingTableEntry> re : this.rpcs.entrySet()) {
  81             List<YangInstanceIdentifier> newRpcs = new ArrayList<>(toAdd.removeAll(re.getKey()));
  82             if (!newRpcs.isEmpty()) {
  83                 final AbstractDOMRpcRoutingTableEntry ne = re.getValue().add(implementation, newRpcs);
  84                 mb.put(re.getKey(), ne);
  85             } else {
  86                 mb.put(re);
  87             }
  88         }
  89
  90         // Finally add whatever is left in the decomposed multimap
  91         for (Entry<SchemaPath, Collection<YangInstanceIdentifier>> e : toAdd.asMap().entrySet()) {
  92             final Builder<YangInstanceIdentifier, List<DOMRpcImplementation>> vb = ImmutableMap.builder();
  93             final List<DOMRpcImplementation> v = Collections.singletonList(implementation);
  94             for (YangInstanceIdentifier i : e.getValue()) {
  95                 vb.put(i, v);
  96             }
  97
  98             mb.put(e.getKey(), createRpcEntry(schemaContext, e.getKey(), vb.build()));
  99         }
 100
 101         return new DOMRpcRoutingTable(mb.build(), schemaContext);
 102     }
 103
 104     DOMRpcRoutingTable remove(final DOMRpcImplementation implementation, final Set<DOMRpcIdentifier> rpcs) {
 105         if (rpcs.isEmpty()) {
 106             return this;
 107         }
 108
 109         // First decompose the identifiers to a multimap
 110         final ListMultimap<SchemaPath, YangInstanceIdentifier> toRemove = decomposeIdentifiers(rpcs);
 111
 112         // Now iterate over existing entries, modifying them as appropriate...
 113         final Builder<SchemaPath, AbstractDOMRpcRoutingTableEntry> b = ImmutableMap.builder();
 114         for (Entry<SchemaPath, AbstractDOMRpcRoutingTableEntry> e : this.rpcs.entrySet()) {
 115             final List<YangInstanceIdentifier> removed = new ArrayList<>(toRemove.removeAll(e.getKey()));
 116             if (!removed.isEmpty()) {
 117                 final AbstractDOMRpcRoutingTableEntry ne = e.getValue().remove(implementation, removed);
 118                 if (ne != null) {
 119                     b.put(e.getKey(), ne);
 120                 }
 121             } else {
 122                 b.put(e);
 123             }
 124         }
 125
 126         // All done, whatever is in toRemove, was not there in the first place
 127         return new DOMRpcRoutingTable(b.build(), schemaContext);
 128     }
 129
 130     boolean contains(final DOMRpcIdentifier input) {
 131         final AbstractDOMRpcRoutingTableEntry contexts = rpcs.get(input.getType());
 132         return contexts != null && contexts.containsContext(input.getContextReference());
 133     }
 134
 135     Map<SchemaPath, Set<YangInstanceIdentifier>> getRpcs() {
 136         return Maps.transformValues(rpcs, AbstractDOMRpcRoutingTableEntry::registeredIdentifiers);
 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.findModuleByNamespaceAndRevision(qname.getNamespace(), qname.getRevision());
 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             final ContainerSchemaNode input = rpcDef.getInput();
 160             if (input != null) {
 161                 for (DataSchemaNode c : input.getChildNodes()) {
 162                     for (UnknownSchemaNode extension : c.getUnknownSchemaNodes()) {
 163                         if (CONTEXT_REFERENCE.equals(extension.getNodeType())) {
 164                             final YangInstanceIdentifier keyId =
 165                                     YangInstanceIdentifier.builder().node(c.getQName()).build();
 166                             return new RoutedDOMRpcRoutingTableEntry(rpcDef, keyId, implementations);
 167                         }
 168                     }
 169                 }
 170             }
 171
 172             return new GlobalDOMRpcRoutingTableEntry(rpcDef, implementations);
 173         } else {
 174             return new UnknownDOMRpcRoutingTableEntry(key, implementations);
 175         }
 176     }
 177
 178     CheckedFuture<DOMRpcResult, DOMRpcException> invokeRpc(final SchemaPath type, final NormalizedNode<?, ?> input) {
 179         final AbstractDOMRpcRoutingTableEntry entry = rpcs.get(type);
 180         if (entry == null) {
 181             return Futures.<DOMRpcResult, DOMRpcException>immediateFailedCheckedFuture(
 182                     new DOMRpcImplementationNotAvailableException("No implementation of RPC %s available", type));
 183         }
 184
 185         return entry.invokeRpc(input);
 186     }
 187
 188     DOMRpcRoutingTable setSchemaContext(final SchemaContext context) {
 189         final Builder<SchemaPath, AbstractDOMRpcRoutingTableEntry> b = ImmutableMap.builder();
 190
 191         for (Entry<SchemaPath, AbstractDOMRpcRoutingTableEntry> e : rpcs.entrySet()) {
 192             b.put(e.getKey(), createRpcEntry(context, e.getKey(), e.getValue().getImplementations()));
 193         }
 194
 195         return new DOMRpcRoutingTable(b.build(), context);
 196     }
 197
 198 }