2 * Copyright (c) 2014 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.netconf.sal.restconf.impl;
10 import com.google.common.base.Function;
11 import com.google.common.base.Objects;
12 import com.google.common.base.Optional;
13 import com.google.common.base.Preconditions;
14 import com.google.common.base.Predicate;
15 import com.google.common.base.Splitter;
16 import com.google.common.base.Strings;
17 import com.google.common.collect.ImmutableMap;
18 import com.google.common.collect.Iterables;
19 import java.io.UnsupportedEncodingException;
21 import java.net.URLDecoder;
22 import java.net.URLEncoder;
23 import java.util.ArrayList;
24 import java.util.Arrays;
25 import java.util.Collection;
26 import java.util.Collections;
27 import java.util.Date;
28 import java.util.HashMap;
29 import java.util.List;
32 import java.util.concurrent.atomic.AtomicReference;
33 import javax.ws.rs.core.Response.Status;
34 import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizationException;
35 import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizationOperation;
36 import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizer;
37 import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint;
38 import org.opendaylight.controller.md.sal.dom.api.DOMMountPointService;
39 import org.opendaylight.netconf.sal.rest.api.Draft02;
40 import org.opendaylight.netconf.sal.rest.impl.RestUtil;
41 import org.opendaylight.netconf.sal.restconf.impl.RestconfError.ErrorTag;
42 import org.opendaylight.netconf.sal.restconf.impl.RestconfError.ErrorType;
43 import org.opendaylight.yangtools.concepts.Codec;
44 import org.opendaylight.yangtools.yang.common.QName;
45 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
46 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
47 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.InstanceIdentifierBuilder;
48 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
49 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
50 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
51 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
52 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
53 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
54 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
55 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
56 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
57 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
58 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
59 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
60 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
61 import org.opendaylight.yangtools.yang.model.api.Module;
62 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
63 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
64 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
65 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
66 import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
67 import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
68 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
69 import org.slf4j.Logger;
70 import org.slf4j.LoggerFactory;
72 public class ControllerContext implements SchemaContextListener {
73 private final static Logger LOG = LoggerFactory.getLogger(ControllerContext.class);
75 private final static ControllerContext INSTANCE = new ControllerContext();
77 private final static String NULL_VALUE = "null";
79 private final static String MOUNT_MODULE = "yang-ext";
81 private final static String MOUNT_NODE = "mount";
83 public final static String MOUNT = "yang-ext:mount";
85 private final static String URI_ENCODING_CHAR_SET = "ISO-8859-1";
87 private static final Splitter SLASH_SPLITTER = Splitter.on('/');
89 private static final YangInstanceIdentifier ROOT = YangInstanceIdentifier.builder().build();
91 private final AtomicReference<Map<QName, RpcDefinition>> qnameToRpc =
92 new AtomicReference<>(Collections.<QName, RpcDefinition>emptyMap());
94 private volatile SchemaContext globalSchema;
95 private volatile DOMMountPointService mountService;
97 private DataNormalizer dataNormalizer;
99 public void setGlobalSchema(final SchemaContext globalSchema) {
100 this.globalSchema = globalSchema;
101 dataNormalizer = new DataNormalizer(globalSchema);
104 public void setMountService(final DOMMountPointService mountService) {
105 this.mountService = mountService;
108 private ControllerContext() {
111 public static ControllerContext getInstance() {
112 return ControllerContext.INSTANCE;
115 private void checkPreconditions() {
116 if (globalSchema == null) {
117 throw new RestconfDocumentedException(Status.SERVICE_UNAVAILABLE);
121 public void setSchemas(final SchemaContext schemas) {
122 onGlobalContextUpdated(schemas);
125 public InstanceIdentifierContext<?> toInstanceIdentifier(final String restconfInstance) {
126 return toIdentifier(restconfInstance, false);
129 public SchemaContext getGlobalSchema() {
133 public InstanceIdentifierContext<?> toMountPointIdentifier(final String restconfInstance) {
134 return toIdentifier(restconfInstance, true);
137 private InstanceIdentifierContext<?> toIdentifier(final String restconfInstance, final boolean toMountPointIdentifier) {
138 checkPreconditions();
140 if(restconfInstance == null) {
141 return new InstanceIdentifierContext<>(ROOT, globalSchema, null, globalSchema);
144 final List<String> pathArgs = urlPathArgsDecode(SLASH_SPLITTER.split(restconfInstance));
145 omitFirstAndLastEmptyString(pathArgs);
146 if (pathArgs.isEmpty()) {
150 final String first = pathArgs.iterator().next();
151 final String startModule = ControllerContext.toModuleName(first);
152 if (startModule == null) {
153 throw new RestconfDocumentedException("First node in URI has to be in format \"moduleName:nodeName\"",
154 ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
157 final InstanceIdentifierBuilder builder = YangInstanceIdentifier.builder();
158 final Module latestModule = globalSchema.findModuleByName(startModule, null);
160 if (latestModule == null) {
161 throw new RestconfDocumentedException("The module named '" + startModule + "' does not exist.", ErrorType.PROTOCOL, ErrorTag.UNKNOWN_ELEMENT);
164 final InstanceIdentifierContext<?> iiWithSchemaNode = collectPathArguments(builder, pathArgs, latestModule, null,
165 toMountPointIdentifier);
167 if (iiWithSchemaNode == null) {
168 throw new RestconfDocumentedException("URI has bad format", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
171 return iiWithSchemaNode;
174 private static List<String> omitFirstAndLastEmptyString(final List<String> list) {
175 if (list.isEmpty()) {
179 final String head = list.iterator().next();
180 if (head.isEmpty()) {
184 if (list.isEmpty()) {
188 final String last = list.get(list.size() - 1);
189 if (last.isEmpty()) {
190 list.remove(list.size() - 1);
195 public Module findModuleByName(final String moduleName) {
196 checkPreconditions();
197 Preconditions.checkArgument(moduleName != null && !moduleName.isEmpty());
198 return globalSchema.findModuleByName(moduleName, null);
201 public Module findModuleByName(final DOMMountPoint mountPoint, final String moduleName) {
202 Preconditions.checkArgument(moduleName != null && mountPoint != null);
204 final SchemaContext mountPointSchema = mountPoint.getSchemaContext();
205 if (mountPointSchema == null) {
209 return mountPointSchema.findModuleByName(moduleName, null);
212 public Module findModuleByNamespace(final URI namespace) {
213 checkPreconditions();
214 Preconditions.checkArgument(namespace != null);
215 return globalSchema.findModuleByNamespaceAndRevision(namespace, null);
218 public Module findModuleByNamespace(final DOMMountPoint mountPoint, final URI namespace) {
219 Preconditions.checkArgument(namespace != null && mountPoint != null);
221 final SchemaContext mountPointSchema = mountPoint.getSchemaContext();
222 if (mountPointSchema == null) {
226 return mountPointSchema.findModuleByNamespaceAndRevision(namespace, null);
229 public Module findModuleByNameAndRevision(final QName module) {
230 checkPreconditions();
231 Preconditions.checkArgument(module != null && module.getLocalName() != null && module.getRevision() != null);
233 return globalSchema.findModuleByName(module.getLocalName(), module.getRevision());
236 public Module findModuleByNameAndRevision(final DOMMountPoint mountPoint, final QName module) {
237 checkPreconditions();
238 Preconditions.checkArgument(module != null && module.getLocalName() != null && module.getRevision() != null
239 && mountPoint != null);
241 final SchemaContext schemaContext = mountPoint.getSchemaContext();
242 return schemaContext == null ? null : schemaContext.findModuleByName(module.getLocalName(),
243 module.getRevision());
246 public DataNodeContainer getDataNodeContainerFor(final YangInstanceIdentifier path) {
247 checkPreconditions();
249 final Iterable<PathArgument> elements = path.getPathArguments();
250 final PathArgument head = elements.iterator().next();
251 final QName startQName = head.getNodeType();
252 final Module initialModule = globalSchema.findModuleByNamespaceAndRevision(startQName.getNamespace(),
253 startQName.getRevision());
254 DataNodeContainer node = initialModule;
255 for (final PathArgument element : elements) {
256 final QName _nodeType = element.getNodeType();
257 final DataSchemaNode potentialNode = ControllerContext.childByQName(node, _nodeType);
258 if (potentialNode == null || !ControllerContext.isListOrContainer(potentialNode)) {
261 node = (DataNodeContainer) potentialNode;
267 public String toFullRestconfIdentifier(final YangInstanceIdentifier path, final DOMMountPoint mount) {
268 checkPreconditions();
270 final Iterable<PathArgument> elements = path.getPathArguments();
271 final StringBuilder builder = new StringBuilder();
272 final PathArgument head = elements.iterator().next();
273 final QName startQName = head.getNodeType();
274 final SchemaContext schemaContext;
276 schemaContext = mount.getSchemaContext();
278 schemaContext = globalSchema;
280 final Module initialModule = schemaContext.findModuleByNamespaceAndRevision(startQName.getNamespace(),
281 startQName.getRevision());
282 DataNodeContainer node = initialModule;
283 for (final PathArgument element : elements) {
284 if (!(element instanceof AugmentationIdentifier)) {
285 final QName _nodeType = element.getNodeType();
286 final DataSchemaNode potentialNode = ControllerContext.childByQName(node, _nodeType);
287 if (!(element instanceof NodeIdentifier && potentialNode instanceof ListSchemaNode) &&
288 !(potentialNode instanceof ChoiceSchemaNode)) {
289 builder.append(convertToRestconfIdentifier(element, potentialNode, mount));
290 if (potentialNode instanceof DataNodeContainer) {
291 node = (DataNodeContainer) potentialNode;
297 return builder.toString();
300 public String findModuleNameByNamespace(final URI namespace) {
301 checkPreconditions();
303 final Module module = this.findModuleByNamespace(namespace);
304 return module == null ? null : module.getName();
307 public String findModuleNameByNamespace(final DOMMountPoint mountPoint, final URI namespace) {
308 final Module module = this.findModuleByNamespace(mountPoint, namespace);
309 return module == null ? null : module.getName();
312 public URI findNamespaceByModuleName(final String moduleName) {
313 final Module module = this.findModuleByName(moduleName);
314 return module == null ? null : module.getNamespace();
317 public URI findNamespaceByModuleName(final DOMMountPoint mountPoint, final String moduleName) {
318 final Module module = this.findModuleByName(mountPoint, moduleName);
319 return module == null ? null : module.getNamespace();
322 public Set<Module> getAllModules(final DOMMountPoint mountPoint) {
323 checkPreconditions();
325 final SchemaContext schemaContext = mountPoint == null ? null : mountPoint.getSchemaContext();
326 return schemaContext == null ? null : schemaContext.getModules();
329 public Set<Module> getAllModules() {
330 checkPreconditions();
331 return globalSchema.getModules();
334 private static final CharSequence toRestconfIdentifier(final SchemaContext context, final QName qname) {
335 final Module schema = context.findModuleByNamespaceAndRevision(qname.getNamespace(), qname.getRevision());
336 return schema == null ? null : schema.getName() + ':' + qname.getLocalName();
339 public CharSequence toRestconfIdentifier(final QName qname, final DOMMountPoint mount) {
340 final SchemaContext schema;
342 schema = mount.getSchemaContext();
344 checkPreconditions();
345 schema = globalSchema;
348 return toRestconfIdentifier(schema, qname);
351 public CharSequence toRestconfIdentifier(final QName qname) {
352 checkPreconditions();
354 return toRestconfIdentifier(globalSchema, qname);
357 public CharSequence toRestconfIdentifier(final DOMMountPoint mountPoint, final QName qname) {
358 if (mountPoint == null) {
362 return toRestconfIdentifier(mountPoint.getSchemaContext(), qname);
365 public Module getRestconfModule() {
366 return findModuleByNameAndRevision(Draft02.RestConfModule.IETF_RESTCONF_QNAME);
369 private static final Predicate<GroupingDefinition> ERRORS_GROUPING_FILTER = new Predicate<GroupingDefinition>() {
371 public boolean apply(final GroupingDefinition g) {
372 return Draft02.RestConfModule.ERRORS_GROUPING_SCHEMA_NODE.equals(g.getQName().getLocalName());
376 public DataSchemaNode getRestconfModuleErrorsSchemaNode() {
377 final Module restconfModule = getRestconfModule();
378 if (restconfModule == null) {
382 final Set<GroupingDefinition> groupings = restconfModule.getGroupings();
384 final Iterable<GroupingDefinition> filteredGroups = Iterables.filter(groupings, ERRORS_GROUPING_FILTER);
386 final GroupingDefinition restconfGrouping = Iterables.getFirst(filteredGroups, null);
388 final List<DataSchemaNode> instanceDataChildrenByName = findInstanceDataChildrenByName(restconfGrouping,
389 Draft02.RestConfModule.ERRORS_CONTAINER_SCHEMA_NODE);
390 return Iterables.getFirst(instanceDataChildrenByName, null);
393 private static final Predicate<GroupingDefinition> GROUPING_FILTER = new Predicate<GroupingDefinition>() {
395 public boolean apply(final GroupingDefinition g) {
396 return Draft02.RestConfModule.RESTCONF_GROUPING_SCHEMA_NODE.equals(g.getQName().getLocalName());
400 public DataSchemaNode getRestconfModuleRestConfSchemaNode(final Module inRestconfModule, final String schemaNodeName) {
401 Module restconfModule = inRestconfModule;
402 if (restconfModule == null) {
403 restconfModule = getRestconfModule();
406 if (restconfModule == null) {
410 final Set<GroupingDefinition> groupings = restconfModule.getGroupings();
411 final Iterable<GroupingDefinition> filteredGroups = Iterables.filter(groupings, GROUPING_FILTER);
412 final GroupingDefinition restconfGrouping = Iterables.getFirst(filteredGroups, null);
414 final List<DataSchemaNode> instanceDataChildrenByName = findInstanceDataChildrenByName(restconfGrouping,
415 Draft02.RestConfModule.RESTCONF_CONTAINER_SCHEMA_NODE);
416 final DataSchemaNode restconfContainer = Iterables.getFirst(instanceDataChildrenByName, null);
418 if (Objects.equal(schemaNodeName, Draft02.RestConfModule.OPERATIONS_CONTAINER_SCHEMA_NODE)) {
419 final List<DataSchemaNode> instances = findInstanceDataChildrenByName(
420 ((DataNodeContainer) restconfContainer), Draft02.RestConfModule.OPERATIONS_CONTAINER_SCHEMA_NODE);
421 return Iterables.getFirst(instances, null);
422 } else if (Objects.equal(schemaNodeName, Draft02.RestConfModule.STREAMS_CONTAINER_SCHEMA_NODE)) {
423 final List<DataSchemaNode> instances = findInstanceDataChildrenByName(
424 ((DataNodeContainer) restconfContainer), Draft02.RestConfModule.STREAMS_CONTAINER_SCHEMA_NODE);
425 return Iterables.getFirst(instances, null);
426 } else if (Objects.equal(schemaNodeName, Draft02.RestConfModule.STREAM_LIST_SCHEMA_NODE)) {
427 List<DataSchemaNode> instances = findInstanceDataChildrenByName(
428 ((DataNodeContainer) restconfContainer), Draft02.RestConfModule.STREAMS_CONTAINER_SCHEMA_NODE);
429 final DataSchemaNode modules = Iterables.getFirst(instances, null);
430 instances = findInstanceDataChildrenByName(((DataNodeContainer) modules),
431 Draft02.RestConfModule.STREAM_LIST_SCHEMA_NODE);
432 return Iterables.getFirst(instances, null);
433 } else if (Objects.equal(schemaNodeName, Draft02.RestConfModule.MODULES_CONTAINER_SCHEMA_NODE)) {
434 final List<DataSchemaNode> instances = findInstanceDataChildrenByName(
435 ((DataNodeContainer) restconfContainer), Draft02.RestConfModule.MODULES_CONTAINER_SCHEMA_NODE);
436 return Iterables.getFirst(instances, null);
437 } else if (Objects.equal(schemaNodeName, Draft02.RestConfModule.MODULE_LIST_SCHEMA_NODE)) {
438 List<DataSchemaNode> instances = findInstanceDataChildrenByName(
439 ((DataNodeContainer) restconfContainer), Draft02.RestConfModule.MODULES_CONTAINER_SCHEMA_NODE);
440 final DataSchemaNode modules = Iterables.getFirst(instances, null);
441 instances = findInstanceDataChildrenByName(((DataNodeContainer) modules),
442 Draft02.RestConfModule.MODULE_LIST_SCHEMA_NODE);
443 return Iterables.getFirst(instances, null);
444 } else if (Objects.equal(schemaNodeName, Draft02.RestConfModule.STREAMS_CONTAINER_SCHEMA_NODE)) {
445 final List<DataSchemaNode> instances = findInstanceDataChildrenByName(
446 ((DataNodeContainer) restconfContainer), Draft02.RestConfModule.STREAMS_CONTAINER_SCHEMA_NODE);
447 return Iterables.getFirst(instances, null);
453 private static DataSchemaNode childByQName(final ChoiceSchemaNode container, final QName name) {
454 for (final ChoiceCaseNode caze : container.getCases()) {
455 final DataSchemaNode ret = ControllerContext.childByQName(caze, name);
464 private static DataSchemaNode childByQName(final ChoiceCaseNode container, final QName name) {
465 return container.getDataChildByName(name);
468 private static DataSchemaNode childByQName(final ContainerSchemaNode container, final QName name) {
469 return ControllerContext.dataNodeChildByQName(container, name);
472 private static DataSchemaNode childByQName(final ListSchemaNode container, final QName name) {
473 return ControllerContext.dataNodeChildByQName(container, name);
476 private static DataSchemaNode childByQName(final Module container, final QName name) {
477 return ControllerContext.dataNodeChildByQName(container, name);
480 private static DataSchemaNode childByQName(final DataSchemaNode container, final QName name) {
484 private static DataSchemaNode dataNodeChildByQName(final DataNodeContainer container, final QName name) {
485 final DataSchemaNode ret = container.getDataChildByName(name);
487 for (final DataSchemaNode node : container.getChildNodes()) {
488 if ((node instanceof ChoiceSchemaNode)) {
489 final ChoiceSchemaNode choiceNode = ((ChoiceSchemaNode) node);
490 final DataSchemaNode childByQName = ControllerContext.childByQName(choiceNode, name);
491 if (childByQName != null) {
500 private String toUriString(final Object object, final LeafSchemaNode leafNode, final DOMMountPoint mount) throws UnsupportedEncodingException {
501 final Codec<Object, Object> codec = RestCodec.from(leafNode.getType(), mount);
502 return object == null ? "" : URLEncoder.encode(codec.serialize(object).toString(), ControllerContext.URI_ENCODING_CHAR_SET);
505 private InstanceIdentifierContext<?> collectPathArguments(final InstanceIdentifierBuilder builder,
506 final List<String> strings, final DataNodeContainer parentNode, final DOMMountPoint mountPoint,
507 final boolean returnJustMountPoint) {
508 Preconditions.<List<String>> checkNotNull(strings);
510 if (parentNode == null) {
514 if (strings.isEmpty()) {
515 return createContext(builder.build(), ((DataSchemaNode) parentNode), mountPoint,mountPoint != null ? mountPoint.getSchemaContext() : globalSchema);
518 final String head = strings.iterator().next();
519 final String nodeName = toNodeName(head);
520 final String moduleName = ControllerContext.toModuleName(head);
522 DataSchemaNode targetNode = null;
523 if (!Strings.isNullOrEmpty(moduleName)) {
524 if (Objects.equal(moduleName, ControllerContext.MOUNT_MODULE)
525 && Objects.equal(nodeName, ControllerContext.MOUNT_NODE)) {
526 if (mountPoint != null) {
527 throw new RestconfDocumentedException("Restconf supports just one mount point in URI.",
528 ErrorType.APPLICATION, ErrorTag.OPERATION_NOT_SUPPORTED);
531 if (mountService == null) {
532 throw new RestconfDocumentedException(
533 "MountService was not found. Finding behind mount points does not work.",
534 ErrorType.APPLICATION, ErrorTag.OPERATION_NOT_SUPPORTED);
537 final YangInstanceIdentifier partialPath = dataNormalizer.toNormalized(builder.build());
538 final Optional<DOMMountPoint> mountOpt = mountService.getMountPoint(partialPath);
539 if (!mountOpt.isPresent()) {
540 LOG.debug("Instance identifier to missing mount point: {}", partialPath);
541 throw new RestconfDocumentedException("Mount point does not exist.", ErrorType.PROTOCOL,
542 ErrorTag.DATA_MISSING);
544 final DOMMountPoint mount = mountOpt.get();
546 final SchemaContext mountPointSchema = mount.getSchemaContext();
547 if (mountPointSchema == null) {
548 throw new RestconfDocumentedException("Mount point does not contain any schema with modules.",
549 ErrorType.APPLICATION, ErrorTag.UNKNOWN_ELEMENT);
552 if (returnJustMountPoint || strings.size() == 1) {
553 final YangInstanceIdentifier instance = YangInstanceIdentifier.builder().build();
554 return new InstanceIdentifierContext<>(instance, mountPointSchema, mount,mountPointSchema);
557 final String moduleNameBehindMountPoint = toModuleName(strings.get(1));
558 if (moduleNameBehindMountPoint == null) {
559 throw new RestconfDocumentedException(
560 "First node after mount point in URI has to be in format \"moduleName:nodeName\"",
561 ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
564 final Module moduleBehindMountPoint = mountPointSchema.findModuleByName(moduleNameBehindMountPoint, null);
565 if (moduleBehindMountPoint == null) {
566 throw new RestconfDocumentedException("\"" + moduleName
567 + "\" module does not exist in mount point.", ErrorType.PROTOCOL, ErrorTag.UNKNOWN_ELEMENT);
570 final List<String> subList = strings.subList(1, strings.size());
571 return collectPathArguments(YangInstanceIdentifier.builder(), subList, moduleBehindMountPoint, mount,
572 returnJustMountPoint);
575 Module module = null;
576 if (mountPoint == null) {
577 checkPreconditions();
578 module = globalSchema.findModuleByName(moduleName, null);
579 if (module == null) {
580 throw new RestconfDocumentedException("\"" + moduleName + "\" module does not exist.",
581 ErrorType.PROTOCOL, ErrorTag.UNKNOWN_ELEMENT);
584 final SchemaContext schemaContext = mountPoint.getSchemaContext();
585 if (schemaContext != null) {
586 module = schemaContext.findModuleByName(moduleName, null);
590 if (module == null) {
591 throw new RestconfDocumentedException("\"" + moduleName
592 + "\" module does not exist in mount point.", ErrorType.PROTOCOL, ErrorTag.UNKNOWN_ELEMENT);
596 targetNode = findInstanceDataChildByNameAndNamespace(parentNode, nodeName, module.getNamespace());
598 if (targetNode == null && parentNode instanceof Module) {
599 final RpcDefinition rpc;
600 if (mountPoint == null) {
601 rpc = ControllerContext.getInstance().getRpcDefinition(head, module.getRevision());
603 final String rpcName = toNodeName(head);
604 rpc = ControllerContext.getInstance().getRpcDefinition(module, rpcName);
607 return new InstanceIdentifierContext<RpcDefinition>(builder.build(), rpc, mountPoint,
608 mountPoint != null ? mountPoint.getSchemaContext() : globalSchema);
612 if (targetNode == null) {
613 throw new RestconfDocumentedException("URI has bad format. Possible reasons:\n" + " 1. \"" + head
614 + "\" was not found in parent data node.\n" + " 2. \"" + head
615 + "\" is behind mount point. Then it should be in format \"/" + MOUNT + "/" + head + "\".",
616 ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
619 final List<DataSchemaNode> potentialSchemaNodes = findInstanceDataChildrenByName(parentNode, nodeName);
620 if (potentialSchemaNodes.size() > 1) {
621 final StringBuilder strBuilder = new StringBuilder();
622 for (final DataSchemaNode potentialNodeSchema : potentialSchemaNodes) {
623 strBuilder.append(" ").append(potentialNodeSchema.getQName().getNamespace()).append("\n");
626 throw new RestconfDocumentedException(
627 "URI has bad format. Node \""
629 + "\" is added as augment from more than one module. "
630 + "Therefore the node must have module name and it has to be in format \"moduleName:nodeName\"."
631 + "\nThe node is added as augment from modules with namespaces:\n"
632 + strBuilder.toString(), ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
635 if (potentialSchemaNodes.isEmpty()) {
636 throw new RestconfDocumentedException("\"" + nodeName + "\" in URI was not found in parent data node",
637 ErrorType.PROTOCOL, ErrorTag.UNKNOWN_ELEMENT);
640 targetNode = potentialSchemaNodes.iterator().next();
643 if (!ControllerContext.isListOrContainer(targetNode)) {
644 throw new RestconfDocumentedException("URI has bad format. Node \"" + head
645 + "\" must be Container or List yang type.", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
649 if ((targetNode instanceof ListSchemaNode)) {
650 final ListSchemaNode listNode = ((ListSchemaNode) targetNode);
651 final int keysSize = listNode.getKeyDefinition().size();
652 if ((strings.size() - consumed) < keysSize) {
653 throw new RestconfDocumentedException("Missing key for list \"" + listNode.getQName().getLocalName()
654 + "\".", ErrorType.PROTOCOL, ErrorTag.DATA_MISSING);
657 final List<String> uriKeyValues = strings.subList(consumed, consumed + keysSize);
658 final HashMap<QName, Object> keyValues = new HashMap<QName, Object>();
660 for (final QName key : listNode.getKeyDefinition()) {
662 final String uriKeyValue = uriKeyValues.get(i);
663 if (uriKeyValue.equals(NULL_VALUE)) {
664 throw new RestconfDocumentedException("URI has bad format. List \""
665 + listNode.getQName().getLocalName() + "\" cannot contain \"null\" value as a key.",
666 ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
669 addKeyValue(keyValues, listNode.getDataChildByName(key), uriKeyValue, mountPoint);
674 consumed = consumed + i;
675 builder.nodeWithKey(targetNode.getQName(), keyValues);
677 builder.node(targetNode.getQName());
680 if ((targetNode instanceof DataNodeContainer)) {
681 final List<String> remaining = strings.subList(consumed, strings.size());
682 return collectPathArguments(builder, remaining, ((DataNodeContainer) targetNode), mountPoint,
683 returnJustMountPoint);
686 return createContext(builder.build(), targetNode, mountPoint,mountPoint != null ? mountPoint.getSchemaContext() : globalSchema);
689 private InstanceIdentifierContext<?> createContext(final YangInstanceIdentifier instance, final DataSchemaNode dataSchemaNode,
690 final DOMMountPoint mountPoint, final SchemaContext schemaContext) {
692 final YangInstanceIdentifier instanceIdentifier = new DataNormalizer(schemaContext).toNormalized(instance);
693 return new InstanceIdentifierContext<>(instanceIdentifier, dataSchemaNode, mountPoint,schemaContext);
696 public static DataSchemaNode findInstanceDataChildByNameAndNamespace(final DataNodeContainer container, final String name,
697 final URI namespace) {
698 Preconditions.<URI> checkNotNull(namespace);
700 final List<DataSchemaNode> potentialSchemaNodes = findInstanceDataChildrenByName(container, name);
702 final Predicate<DataSchemaNode> filter = new Predicate<DataSchemaNode>() {
704 public boolean apply(final DataSchemaNode node) {
705 return Objects.equal(node.getQName().getNamespace(), namespace);
709 final Iterable<DataSchemaNode> result = Iterables.filter(potentialSchemaNodes, filter);
710 return Iterables.getFirst(result, null);
713 public static List<DataSchemaNode> findInstanceDataChildrenByName(final DataNodeContainer container, final String name) {
714 Preconditions.<DataNodeContainer> checkNotNull(container);
715 Preconditions.<String> checkNotNull(name);
717 final List<DataSchemaNode> instantiatedDataNodeContainers = new ArrayList<DataSchemaNode>();
718 collectInstanceDataNodeContainers(instantiatedDataNodeContainers, container, name);
719 return instantiatedDataNodeContainers;
722 private static final Function<ChoiceSchemaNode, Set<ChoiceCaseNode>> CHOICE_FUNCTION = new Function<ChoiceSchemaNode, Set<ChoiceCaseNode>>() {
724 public Set<ChoiceCaseNode> apply(final ChoiceSchemaNode node) {
725 return node.getCases();
729 private static void collectInstanceDataNodeContainers(final List<DataSchemaNode> potentialSchemaNodes,
730 final DataNodeContainer container, final String name) {
732 final Predicate<DataSchemaNode> filter = new Predicate<DataSchemaNode>() {
734 public boolean apply(final DataSchemaNode node) {
735 return Objects.equal(node.getQName().getLocalName(), name);
739 final Iterable<DataSchemaNode> nodes = Iterables.filter(container.getChildNodes(), filter);
741 // Can't combine this loop with the filter above because the filter is
742 // lazily-applied by Iterables.filter.
743 for (final DataSchemaNode potentialNode : nodes) {
744 if (isInstantiatedDataSchema(potentialNode)) {
745 potentialSchemaNodes.add(potentialNode);
749 final Iterable<ChoiceSchemaNode> choiceNodes = Iterables.filter(container.getChildNodes(), ChoiceSchemaNode.class);
750 final Iterable<Set<ChoiceCaseNode>> map = Iterables.transform(choiceNodes, CHOICE_FUNCTION);
752 final Iterable<ChoiceCaseNode> allCases = Iterables.<ChoiceCaseNode> concat(map);
753 for (final ChoiceCaseNode caze : allCases) {
754 collectInstanceDataNodeContainers(potentialSchemaNodes, caze, name);
758 public static boolean isInstantiatedDataSchema(final DataSchemaNode node) {
759 return node instanceof LeafSchemaNode || node instanceof LeafListSchemaNode
760 || node instanceof ContainerSchemaNode || node instanceof ListSchemaNode
761 || node instanceof AnyXmlSchemaNode;
764 private void addKeyValue(final HashMap<QName, Object> map, final DataSchemaNode node, final String uriValue,
765 final DOMMountPoint mountPoint) {
766 Preconditions.checkNotNull(uriValue);
767 Preconditions.checkArgument((node instanceof LeafSchemaNode));
769 final String urlDecoded = urlPathArgDecode(uriValue);
770 TypeDefinition<?> typedef = ((LeafSchemaNode) node).getType();
771 final TypeDefinition<?> baseType = RestUtil.resolveBaseTypeFrom(typedef);
772 if (baseType instanceof LeafrefTypeDefinition) {
773 typedef = SchemaContextUtil.getBaseTypeForLeafRef((LeafrefTypeDefinition) baseType, globalSchema, node);
775 Codec<Object, Object> codec = RestCodec.from(typedef, mountPoint);
776 Object decoded = codec.deserialize(urlDecoded);
777 String additionalInfo = "";
778 if (decoded == null) {
779 if ((baseType instanceof IdentityrefTypeDefinition)) {
780 decoded = toQName(urlDecoded, null);
781 additionalInfo = "For key which is of type identityref it should be in format module_name:identity_name.";
785 if (decoded == null) {
786 throw new RestconfDocumentedException(uriValue + " from URI can't be resolved. " + additionalInfo,
787 ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
790 map.put(node.getQName(), decoded);
793 private static String toModuleName(final String str) {
794 final int idx = str.indexOf(':');
799 // Make sure there is only one occurrence
800 if (str.indexOf(':', idx + 1) != -1) {
804 return str.substring(0, idx);
807 private static String toNodeName(final String str) {
808 final int idx = str.indexOf(':');
813 // Make sure there is only one occurrence
814 if (str.indexOf(':', idx + 1) != -1) {
818 return str.substring(idx + 1);
821 private QName toQName(final String name, final Date revisionDate) {
822 checkPreconditions();
823 final String module = toModuleName(name);
824 final String node = toNodeName(name);
825 final Module m = globalSchema.findModuleByName(module, revisionDate);
826 return m == null ? null : QName.create(m.getQNameModule(), node);
829 private static boolean isListOrContainer(final DataSchemaNode node) {
830 return node instanceof ListSchemaNode || node instanceof ContainerSchemaNode;
833 public RpcDefinition getRpcDefinition(final String name, final Date revisionDate) {
834 final QName validName = toQName(name, revisionDate);
835 return validName == null ? null : qnameToRpc.get().get(validName);
838 private RpcDefinition getRpcDefinition(final Module module, final String rpcName) {
839 QName rpcQName = QName.create(module.getQNameModule(), rpcName);
840 for (RpcDefinition rpcDefinition : module.getRpcs()) {
841 if (rpcQName.equals(rpcDefinition.getQName())) {
842 return rpcDefinition;
849 public void onGlobalContextUpdated(final SchemaContext context) {
850 if (context != null) {
851 final Collection<RpcDefinition> defs = context.getOperations();
852 final Map<QName, RpcDefinition> newMap = new HashMap<>(defs.size());
854 for (final RpcDefinition operation : defs) {
855 newMap.put(operation.getQName(), operation);
858 // FIXME: still not completely atomic
859 qnameToRpc.set(ImmutableMap.copyOf(newMap));
860 setGlobalSchema(context);
864 public static List<String> urlPathArgsDecode(final Iterable<String> strings) {
866 final List<String> decodedPathArgs = new ArrayList<String>();
867 for (final String pathArg : strings) {
868 final String _decode = URLDecoder.decode(pathArg, URI_ENCODING_CHAR_SET);
869 decodedPathArgs.add(_decode);
871 return decodedPathArgs;
872 } catch (final UnsupportedEncodingException e) {
873 throw new RestconfDocumentedException("Invalid URL path '" + strings + "': " + e.getMessage(),
874 ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
878 public String urlPathArgDecode(final String pathArg) {
879 if (pathArg != null) {
881 return URLDecoder.decode(pathArg, URI_ENCODING_CHAR_SET);
882 } catch (final UnsupportedEncodingException e) {
883 throw new RestconfDocumentedException("Invalid URL path arg '" + pathArg + "': " + e.getMessage(),
884 ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
891 private CharSequence convertToRestconfIdentifier(final PathArgument argument, final DataSchemaNode node, final DOMMountPoint mount) {
892 if (argument instanceof NodeIdentifier) {
893 return convertToRestconfIdentifier((NodeIdentifier) argument, mount);
894 } else if (argument instanceof NodeIdentifierWithPredicates && node instanceof ListSchemaNode) {
895 return convertToRestconfIdentifierWithPredicates((NodeIdentifierWithPredicates) argument, (ListSchemaNode) node, mount);
896 } else if (argument != null && node != null) {
897 throw new IllegalArgumentException("Conversion of generic path argument is not supported");
899 throw new IllegalArgumentException("Unhandled parameter types: "
900 + Arrays.<Object> asList(argument, node).toString());
904 private CharSequence convertToRestconfIdentifier(final NodeIdentifier argument, final DOMMountPoint node) {
905 return "/" + this.toRestconfIdentifier(argument.getNodeType(),node);
908 private CharSequence convertToRestconfIdentifierWithPredicates(final NodeIdentifierWithPredicates argument,
909 final ListSchemaNode node, final DOMMountPoint mount) {
910 final QName nodeType = argument.getNodeType();
911 final CharSequence nodeIdentifier = this.toRestconfIdentifier(nodeType, mount);
912 final Map<QName, Object> keyValues = argument.getKeyValues();
914 final StringBuilder builder = new StringBuilder();
916 builder.append(nodeIdentifier);
919 final List<QName> keyDefinition = node.getKeyDefinition();
920 boolean hasElements = false;
921 for (final QName key : keyDefinition) {
922 for (final DataSchemaNode listChild : node.getChildNodes()) {
923 if (listChild.getQName().equals(key)) {
931 Preconditions.checkState(listChild instanceof LeafSchemaNode, "List key has to consist of leaves");
932 builder.append(toUriString(keyValues.get(key), (LeafSchemaNode)listChild, mount));
933 } catch (final UnsupportedEncodingException e) {
934 LOG.error("Error parsing URI: {}", keyValues.get(key), e);
942 return builder.toString();
945 private static DataSchemaNode childByQName(final Object container, final QName name) {
946 if (container instanceof ChoiceCaseNode) {
947 return childByQName((ChoiceCaseNode) container, name);
948 } else if (container instanceof ChoiceSchemaNode) {
949 return childByQName((ChoiceSchemaNode) container, name);
950 } else if (container instanceof ContainerSchemaNode) {
951 return childByQName((ContainerSchemaNode) container, name);
952 } else if (container instanceof ListSchemaNode) {
953 return childByQName((ListSchemaNode) container, name);
954 } else if (container instanceof DataSchemaNode) {
955 return childByQName((DataSchemaNode) container, name);
956 } else if (container instanceof Module) {
957 return childByQName((Module) container, name);
959 throw new IllegalArgumentException("Unhandled parameter types: "
960 + Arrays.<Object> asList(container, name).toString());
964 public YangInstanceIdentifier toNormalized(final YangInstanceIdentifier legacy) {
966 return dataNormalizer.toNormalized(legacy);
967 } catch (final NullPointerException e) {
968 throw new RestconfDocumentedException("Data normalizer isn't set. Normalization isn't possible", e);
972 public YangInstanceIdentifier toXpathRepresentation(final YangInstanceIdentifier instanceIdentifier) {
974 return dataNormalizer.toLegacy(instanceIdentifier);
975 } catch (final NullPointerException e) {
976 throw new RestconfDocumentedException("Data normalizer isn't set. Normalization isn't possible", e);
977 } catch (final DataNormalizationException e) {
978 throw new RestconfDocumentedException("Data normalizer failed. Normalization isn't possible", e);
982 public boolean isNodeMixin(final YangInstanceIdentifier path) {
983 final DataNormalizationOperation<?> operation;
985 operation = dataNormalizer.getOperation(path);
986 } catch (final DataNormalizationException e) {
987 throw new RestconfDocumentedException("Data normalizer failed. Normalization isn't possible", e);
989 return operation.isMixin();
992 public DataNormalizationOperation<?> getRootOperation() {
993 return dataNormalizer.getRootOperation();