2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.md.sal.dom.broker.impl;
10 import com.google.common.base.Function;
11 import com.google.common.base.Preconditions;
12 import com.google.common.collect.ImmutableMap;
13 import com.google.common.collect.ImmutableMap.Builder;
14 import com.google.common.collect.LinkedListMultimap;
15 import com.google.common.collect.ListMultimap;
16 import com.google.common.collect.Maps;
17 import com.google.common.util.concurrent.CheckedFuture;
18 import com.google.common.util.concurrent.Futures;
19 import java.util.Collection;
20 import java.util.Collections;
21 import java.util.List;
23 import java.util.Map.Entry;
25 import org.opendaylight.controller.md.sal.dom.api.DOMRpcException;
26 import org.opendaylight.controller.md.sal.dom.api.DOMRpcIdentifier;
27 import org.opendaylight.controller.md.sal.dom.api.DOMRpcImplementation;
28 import org.opendaylight.controller.md.sal.dom.api.DOMRpcImplementationNotAvailableException;
29 import org.opendaylight.controller.md.sal.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;
41 final class DOMRpcRoutingTable {
42 private static final QName CONTEXT_REFERENCE = QName.cachedReference(QName.create("urn:opendaylight:yang:extension:yang-ext", "2013-07-09", "context-reference"));
44 static final DOMRpcRoutingTable EMPTY = new DOMRpcRoutingTable();
45 private static final Function<AbstractDOMRpcRoutingTableEntry, Set<YangInstanceIdentifier>> EXTRACT_IDENTIFIERS =
46 new Function<AbstractDOMRpcRoutingTableEntry, Set<YangInstanceIdentifier>>() {
48 public Set<YangInstanceIdentifier> apply(final AbstractDOMRpcRoutingTableEntry input) {
49 return input.registeredIdentifiers();
52 private final Map<SchemaPath, AbstractDOMRpcRoutingTableEntry> rpcs;
53 private final SchemaContext schemaContext;
55 private DOMRpcRoutingTable() {
56 rpcs = Collections.emptyMap();
60 private DOMRpcRoutingTable(final Map<SchemaPath, AbstractDOMRpcRoutingTableEntry> rpcs, final SchemaContext schemaContext) {
61 this.rpcs = Preconditions.checkNotNull(rpcs);
62 this.schemaContext = schemaContext;
65 private static ListMultimap<SchemaPath, YangInstanceIdentifier> decomposeIdentifiers(final Set<DOMRpcIdentifier> rpcs) {
66 final ListMultimap<SchemaPath, YangInstanceIdentifier> ret = LinkedListMultimap.create();
67 for (DOMRpcIdentifier i : rpcs) {
68 ret.put(i.getType(), i.getContextReference());
73 DOMRpcRoutingTable add(final DOMRpcImplementation implementation, final Set<DOMRpcIdentifier> rpcs) {
78 // First decompose the identifiers to a multimap
79 final ListMultimap<SchemaPath, YangInstanceIdentifier> toAdd = decomposeIdentifiers(rpcs);
81 // Now iterate over existing entries, modifying them as appropriate...
82 final Builder<SchemaPath, AbstractDOMRpcRoutingTableEntry> mb = ImmutableMap.builder();
83 for (Entry<SchemaPath, AbstractDOMRpcRoutingTableEntry> re : this.rpcs.entrySet()) {
84 List<YangInstanceIdentifier> newRpcs = toAdd.removeAll(re.getKey());
85 if (!newRpcs.isEmpty()) {
86 final AbstractDOMRpcRoutingTableEntry ne = re.getValue().add(implementation, newRpcs);
87 mb.put(re.getKey(), ne);
93 // Finally add whatever is left in the decomposed multimap
94 for (Entry<SchemaPath, Collection<YangInstanceIdentifier>> e : toAdd.asMap().entrySet()) {
95 final Builder<YangInstanceIdentifier, List<DOMRpcImplementation>> vb = ImmutableMap.builder();
96 final List<DOMRpcImplementation> v = Collections.singletonList(implementation);
97 for (YangInstanceIdentifier i : e.getValue()) {
101 mb.put(e.getKey(), createRpcEntry(schemaContext, e.getKey(), vb.build()));
104 return new DOMRpcRoutingTable(mb.build(), schemaContext);
107 DOMRpcRoutingTable remove(final DOMRpcImplementation implementation, final Set<DOMRpcIdentifier> rpcs) {
108 if (rpcs.isEmpty()) {
112 // First decompose the identifiers to a multimap
113 final ListMultimap<SchemaPath, YangInstanceIdentifier> toRemove = decomposeIdentifiers(rpcs);
115 // Now iterate over existing entries, modifying them as appropriate...
116 final Builder<SchemaPath, AbstractDOMRpcRoutingTableEntry> b = ImmutableMap.builder();
117 for (Entry<SchemaPath, AbstractDOMRpcRoutingTableEntry> e : this.rpcs.entrySet()) {
118 final List<YangInstanceIdentifier> removed = toRemove.removeAll(e.getKey());
119 if (!removed.isEmpty()) {
120 final AbstractDOMRpcRoutingTableEntry ne = e.getValue().remove(implementation, removed);
122 b.put(e.getKey(), ne);
129 // All done, whatever is in toRemove, was not there in the first place
130 return new DOMRpcRoutingTable(b.build(), schemaContext);
133 boolean contains(final DOMRpcIdentifier input) {
134 final AbstractDOMRpcRoutingTableEntry contexts = rpcs.get(input.getType());
135 return contexts != null && contexts.containsContext(input.getContextReference());
138 Map<SchemaPath, Set<YangInstanceIdentifier>> getRpcs() {
139 return Maps.transformValues(rpcs, EXTRACT_IDENTIFIERS);
142 private static RpcDefinition findRpcDefinition(final SchemaContext context, final SchemaPath schemaPath) {
143 if (context != null) {
144 final QName qname = schemaPath.getPathFromRoot().iterator().next();
145 final Module module = context.findModuleByNamespaceAndRevision(qname.getNamespace(), qname.getRevision());
146 if (module != null && module.getRpcs() != null) {
147 for (RpcDefinition rpc : module.getRpcs()) {
148 if (qname.equals(rpc.getQName())) {
158 private static AbstractDOMRpcRoutingTableEntry createRpcEntry(final SchemaContext context, final SchemaPath key, final Map<YangInstanceIdentifier, List<DOMRpcImplementation>> implementations) {
159 final RpcDefinition rpcDef = findRpcDefinition(context, key);
160 if (rpcDef != null) {
161 final ContainerSchemaNode input = rpcDef.getInput();
163 for (DataSchemaNode c : input.getChildNodes()) {
164 for (UnknownSchemaNode extension : c.getUnknownSchemaNodes()) {
165 if (CONTEXT_REFERENCE.equals(extension.getNodeType())) {
166 final YangInstanceIdentifier keyId = YangInstanceIdentifier.builder().node(input.getQName()).node(c.getQName()).build();
167 return new RoutedDOMRpcRoutingTableEntry(rpcDef, keyId, implementations);
173 return new GlobalDOMRpcRoutingTableEntry(rpcDef, implementations);
175 return new UnknownDOMRpcRoutingTableEntry(key, implementations);
179 CheckedFuture<DOMRpcResult, DOMRpcException> invokeRpc(final SchemaPath type, final NormalizedNode<?, ?> input) {
180 final AbstractDOMRpcRoutingTableEntry entry = rpcs.get(type);
182 return Futures.<DOMRpcResult, DOMRpcException>immediateFailedCheckedFuture(new DOMRpcImplementationNotAvailableException("No implementation of RPC %s available", type));
185 return entry.invokeRpc(input);
188 DOMRpcRoutingTable setSchemaContext(final SchemaContext context) {
189 final Builder<SchemaPath, AbstractDOMRpcRoutingTableEntry> b = ImmutableMap.builder();
191 for (Entry<SchemaPath, AbstractDOMRpcRoutingTableEntry> e : rpcs.entrySet()) {
192 b.put(e.getKey(), createRpcEntry(context, e.getKey(), e.getValue().getImplementations()));
195 return new DOMRpcRoutingTable(b.build(), context);