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 final class DOMRpcRoutingTable {
  41
  42     static final DOMRpcRoutingTable EMPTY = new DOMRpcRoutingTable(ImmutableMap.of(), null);
  43
  44     private final Map<SchemaPath, AbstractDOMRpcRoutingTableEntry> rpcs;
  45     private final SchemaContext schemaContext;
  46
  47     private DOMRpcRoutingTable(final Map<SchemaPath, AbstractDOMRpcRoutingTableEntry> rpcs, final SchemaContext schemaContext) {
  48         this.rpcs = Preconditions.checkNotNull(rpcs);
  49         this.schemaContext = schemaContext;
  50     }
  51
  52     static ListMultimap<SchemaPath, YangInstanceIdentifier> decomposeIdentifiers(final Set<DOMRpcIdentifier> rpcs) {
  53         final ListMultimap<SchemaPath, YangInstanceIdentifier> ret = LinkedListMultimap.create();
  54         for (DOMRpcIdentifier i : rpcs) {
  55             ret.put(i.getType(), i.getContextReference());
  56         }
  57         return ret;
  58     }
  59
  60     DOMRpcRoutingTable add(final DOMRpcImplementation implementation, final Set<DOMRpcIdentifier> rpcs) {
  61         if (rpcs.isEmpty()) {
  62             return this;
  63         }
  64
  65         // First decompose the identifiers to a multimap
  66         final ListMultimap<SchemaPath, YangInstanceIdentifier> toAdd = decomposeIdentifiers(rpcs);
  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 = Collections.singletonList(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> rpcs) {
  95         if (rpcs.isEmpty()) {
  96             return this;
  97         }
  98
  99         // First decompose the identifiers to a multimap
 100         final ListMultimap<SchemaPath, YangInstanceIdentifier> toRemove = decomposeIdentifiers(rpcs);
 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     Map<SchemaPath, Set<YangInstanceIdentifier>> getRpcs(final DOMRpcAvailabilityListener l) {
 126         final Map<SchemaPath, Set<YangInstanceIdentifier>> ret = new HashMap<>(rpcs.size());
 127         for (Entry<SchemaPath, AbstractDOMRpcRoutingTableEntry> e : rpcs.entrySet()) {
 128             final Set<YangInstanceIdentifier> ids = e.getValue().registeredIdentifiers(l);
 129             if (!ids.isEmpty()) {
 130                 ret.put(e.getKey(), ids);
 131             }
 132         }
 133
 134         return ret;
 135     }
 136
 137     private static RpcDefinition findRpcDefinition(final SchemaContext context, final SchemaPath schemaPath) {
 138         if (context != null) {
 139             final QName qname = schemaPath.getPathFromRoot().iterator().next();
 140             final Module module = context.findModuleByNamespaceAndRevision(qname.getNamespace(), qname.getRevision());
 141             if (module != null && module.getRpcs() != null) {
 142                 for (RpcDefinition rpc : module.getRpcs()) {
 143                     if (qname.equals(rpc.getQName())) {
 144                         return rpc;
 145                     }
 146                 }
 147             }
 148         }
 149
 150         return null;
 151     }
 152
 153     private static AbstractDOMRpcRoutingTableEntry createRpcEntry(final SchemaContext context, final SchemaPath key,
 154             final Map<YangInstanceIdentifier, List<DOMRpcImplementation>> implementations) {
 155         final RpcDefinition rpcDef = findRpcDefinition(context, key);
 156         if (rpcDef == null) {
 157             return new UnknownDOMRpcRoutingTableEntry(key, implementations);
 158         }
 159
 160         final RpcRoutingStrategy strategy = RpcRoutingStrategy.from(rpcDef);
 161         if (strategy.isContextBasedRouted()) {
 162             return new RoutedDOMRpcRoutingTableEntry(rpcDef, YangInstanceIdentifier.of(strategy.getLeaf()),
 163                 implementations);
 164
 165         }
 166
 167         return new GlobalDOMRpcRoutingTableEntry(rpcDef, implementations);
 168     }
 169
 170     CheckedFuture<DOMRpcResult, DOMRpcException> invokeRpc(final SchemaPath type, final NormalizedNode<?, ?> input) {
 171         final AbstractDOMRpcRoutingTableEntry entry = rpcs.get(type);
 172         if (entry == null) {
 173             return Futures.<DOMRpcResult, DOMRpcException>immediateFailedCheckedFuture(
 174                 new DOMRpcImplementationNotAvailableException("No implementation of RPC %s available", type));
 175         }
 176
 177         return entry.invokeRpc(input);
 178     }
 179
 180     DOMRpcRoutingTable setSchemaContext(final SchemaContext context) {
 181         final Builder<SchemaPath, AbstractDOMRpcRoutingTableEntry> b = ImmutableMap.builder();
 182
 183         for (Entry<SchemaPath, AbstractDOMRpcRoutingTableEntry> e : rpcs.entrySet()) {
 184             b.put(e.getKey(), createRpcEntry(context, e.getKey(), e.getValue().getImplementations()));
 185         }
 186
 187         return new DOMRpcRoutingTable(b.build(), context);
 188     }
 189 }