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