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.ArrayList;
20 import java.util.Collection;
21 import java.util.Collections;
22 import java.util.List;
24 import java.util.Map.Entry;
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;
42 final class DOMRpcRoutingTable {
43 private static final QName CONTEXT_REFERENCE = QName.cachedReference(QName.create("urn:opendaylight:yang:extension:yang-ext", "2013-07-09", "context-reference"));
45 static final DOMRpcRoutingTable EMPTY = new DOMRpcRoutingTable();
46 private static final Function<AbstractDOMRpcRoutingTableEntry, Set<YangInstanceIdentifier>> EXTRACT_IDENTIFIERS =
47 new Function<AbstractDOMRpcRoutingTableEntry, Set<YangInstanceIdentifier>>() {
49 public Set<YangInstanceIdentifier> apply(final AbstractDOMRpcRoutingTableEntry input) {
50 return input.registeredIdentifiers();
53 private final Map<SchemaPath, AbstractDOMRpcRoutingTableEntry> rpcs;
54 private final SchemaContext schemaContext;
56 private DOMRpcRoutingTable() {
57 rpcs = Collections.emptyMap();
61 private DOMRpcRoutingTable(final Map<SchemaPath, AbstractDOMRpcRoutingTableEntry> rpcs, final SchemaContext schemaContext) {
62 this.rpcs = Preconditions.checkNotNull(rpcs);
63 this.schemaContext = schemaContext;
66 private static ListMultimap<SchemaPath, YangInstanceIdentifier> decomposeIdentifiers(final Set<DOMRpcIdentifier> rpcs) {
67 final ListMultimap<SchemaPath, YangInstanceIdentifier> ret = LinkedListMultimap.create();
68 for (DOMRpcIdentifier i : rpcs) {
69 ret.put(i.getType(), i.getContextReference());
74 DOMRpcRoutingTable add(final DOMRpcImplementation implementation, final Set<DOMRpcIdentifier> rpcs) {
79 // First decompose the identifiers to a multimap
80 final ListMultimap<SchemaPath, YangInstanceIdentifier> toAdd = decomposeIdentifiers(rpcs);
82 // Now iterate over existing entries, modifying them as appropriate...
83 final Builder<SchemaPath, AbstractDOMRpcRoutingTableEntry> mb = ImmutableMap.builder();
84 for (Entry<SchemaPath, AbstractDOMRpcRoutingTableEntry> re : this.rpcs.entrySet()) {
85 List<YangInstanceIdentifier> newRpcs = new ArrayList<>(toAdd.removeAll(re.getKey()));
86 if (!newRpcs.isEmpty()) {
87 final AbstractDOMRpcRoutingTableEntry ne = re.getValue().add(implementation, newRpcs);
88 mb.put(re.getKey(), ne);
94 // Finally add whatever is left in the decomposed multimap
95 for (Entry<SchemaPath, Collection<YangInstanceIdentifier>> e : toAdd.asMap().entrySet()) {
96 final Builder<YangInstanceIdentifier, List<DOMRpcImplementation>> vb = ImmutableMap.builder();
97 final List<DOMRpcImplementation> v = Collections.singletonList(implementation);
98 for (YangInstanceIdentifier i : e.getValue()) {
102 mb.put(e.getKey(), createRpcEntry(schemaContext, e.getKey(), vb.build()));
105 return new DOMRpcRoutingTable(mb.build(), schemaContext);
108 DOMRpcRoutingTable remove(final DOMRpcImplementation implementation, final Set<DOMRpcIdentifier> rpcs) {
109 if (rpcs.isEmpty()) {
113 // First decompose the identifiers to a multimap
114 final ListMultimap<SchemaPath, YangInstanceIdentifier> toRemove = decomposeIdentifiers(rpcs);
116 // Now iterate over existing entries, modifying them as appropriate...
117 final Builder<SchemaPath, AbstractDOMRpcRoutingTableEntry> b = ImmutableMap.builder();
118 for (Entry<SchemaPath, AbstractDOMRpcRoutingTableEntry> e : this.rpcs.entrySet()) {
119 final List<YangInstanceIdentifier> removed = new ArrayList<>(toRemove.removeAll(e.getKey()));
120 if (!removed.isEmpty()) {
121 final AbstractDOMRpcRoutingTableEntry ne = e.getValue().remove(implementation, removed);
123 b.put(e.getKey(), ne);
130 // All done, whatever is in toRemove, was not there in the first place
131 return new DOMRpcRoutingTable(b.build(), schemaContext);
134 boolean contains(final DOMRpcIdentifier input) {
135 final AbstractDOMRpcRoutingTableEntry contexts = rpcs.get(input.getType());
136 return contexts != null && contexts.containsContext(input.getContextReference());
139 Map<SchemaPath, Set<YangInstanceIdentifier>> getRpcs() {
140 return Maps.transformValues(rpcs, EXTRACT_IDENTIFIERS);
143 private static RpcDefinition findRpcDefinition(final SchemaContext context, final SchemaPath schemaPath) {
144 if (context != null) {
145 final QName qname = schemaPath.getPathFromRoot().iterator().next();
146 final Module module = context.findModuleByNamespaceAndRevision(qname.getNamespace(), qname.getRevision());
147 if (module != null && module.getRpcs() != null) {
148 for (RpcDefinition rpc : module.getRpcs()) {
149 if (qname.equals(rpc.getQName())) {
159 private static AbstractDOMRpcRoutingTableEntry createRpcEntry(final SchemaContext context, final SchemaPath key, final Map<YangInstanceIdentifier, List<DOMRpcImplementation>> implementations) {
160 final RpcDefinition rpcDef = findRpcDefinition(context, key);
161 if (rpcDef != null) {
162 final ContainerSchemaNode input = rpcDef.getInput();
164 for (DataSchemaNode c : input.getChildNodes()) {
165 for (UnknownSchemaNode extension : c.getUnknownSchemaNodes()) {
166 if (CONTEXT_REFERENCE.equals(extension.getNodeType())) {
167 final YangInstanceIdentifier keyId = YangInstanceIdentifier.builder().node(c.getQName()).build();
168 return new RoutedDOMRpcRoutingTableEntry(rpcDef, keyId, implementations);
174 return new GlobalDOMRpcRoutingTableEntry(rpcDef, implementations);
176 return new UnknownDOMRpcRoutingTableEntry(key, implementations);
180 CheckedFuture<DOMRpcResult, DOMRpcException> invokeRpc(final SchemaPath type, final NormalizedNode<?, ?> input) {
181 final AbstractDOMRpcRoutingTableEntry entry = rpcs.get(type);
183 return Futures.<DOMRpcResult, DOMRpcException>immediateFailedCheckedFuture(new DOMRpcImplementationNotAvailableException("No implementation of RPC %s available", type));
186 return entry.invokeRpc(input);
189 DOMRpcRoutingTable setSchemaContext(final SchemaContext context) {
190 final Builder<SchemaPath, AbstractDOMRpcRoutingTableEntry> b = ImmutableMap.builder();
192 for (Entry<SchemaPath, AbstractDOMRpcRoutingTableEntry> e : rpcs.entrySet()) {
193 b.put(e.getKey(), createRpcEntry(context, e.getKey(), e.getValue().getImplementations()));
196 return new DOMRpcRoutingTable(b.build(), context);