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