Remove RestconfError.ErrorTag
[netconf.git] / restconf / restconf-nb-rfc8040 / src / main / java / org / opendaylight / restconf / nb / rfc8040 / rests / services / impl / RestconfDataServiceImpl.java
1 /*
2  * Copyright (c) 2016 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.restconf.nb.rfc8040.rests.services.impl;
9
10 import static java.util.Objects.requireNonNull;
11 import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfDataServiceConstant.PostPutQueryParameters.INSERT;
12 import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfDataServiceConstant.PostPutQueryParameters.POINT;
13 import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.NOTIFICATION_STREAM;
14 import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.STREAMS_PATH;
15 import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.STREAM_ACCESS_PATH_PART;
16 import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.STREAM_LOCATION_PATH_PART;
17 import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.STREAM_PATH;
18 import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.STREAM_PATH_PART;
19
20 import com.google.common.annotations.VisibleForTesting;
21 import com.google.common.collect.ImmutableList;
22 import java.net.URI;
23 import java.time.Clock;
24 import java.time.LocalDateTime;
25 import java.time.format.DateTimeFormatter;
26 import java.util.HashMap;
27 import java.util.List;
28 import java.util.Map;
29 import java.util.Map.Entry;
30 import java.util.Optional;
31 import java.util.concurrent.ExecutionException;
32 import javax.ws.rs.Path;
33 import javax.ws.rs.core.Response;
34 import javax.ws.rs.core.Response.Status;
35 import javax.ws.rs.core.UriInfo;
36 import org.eclipse.jdt.annotation.Nullable;
37 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
38 import org.opendaylight.mdsal.dom.api.DOMActionResult;
39 import org.opendaylight.mdsal.dom.api.DOMActionService;
40 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
41 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteOperations;
42 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
43 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
44 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
45 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
46 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
47 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
48 import org.opendaylight.restconf.common.context.WriterParameters;
49 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
50 import org.opendaylight.restconf.common.patch.PatchContext;
51 import org.opendaylight.restconf.common.patch.PatchStatusContext;
52 import org.opendaylight.restconf.nb.rfc8040.Rfc8040;
53 import org.opendaylight.restconf.nb.rfc8040.handlers.SchemaContextHandler;
54 import org.opendaylight.restconf.nb.rfc8040.rests.services.api.RestconfDataService;
55 import org.opendaylight.restconf.nb.rfc8040.rests.services.api.RestconfStreamsSubscriptionService;
56 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.MdsalRestconfStrategy;
57 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.RestconfStrategy;
58 import org.opendaylight.restconf.nb.rfc8040.rests.utils.DeleteDataTransactionUtil;
59 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PatchDataTransactionUtil;
60 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PlainPatchDataTransactionUtil;
61 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PostDataTransactionUtil;
62 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PutDataTransactionUtil;
63 import org.opendaylight.restconf.nb.rfc8040.rests.utils.ReadDataTransactionUtil;
64 import org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfDataServiceConstant;
65 import org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfDataServiceConstant.PostPutQueryParameters.Insert;
66 import org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfInvokeOperationsUtil;
67 import org.opendaylight.restconf.nb.rfc8040.streams.Configuration;
68 import org.opendaylight.restconf.nb.rfc8040.streams.listeners.NotificationListenerAdapter;
69 import org.opendaylight.restconf.nb.rfc8040.utils.mapping.RestconfMappingNodeUtil;
70 import org.opendaylight.restconf.nb.rfc8040.utils.parser.ParserIdentifier;
71 import org.opendaylight.yang.gen.v1.urn.sal.restconf.event.subscription.rev140708.NotificationOutputTypeGrouping.NotificationOutputType;
72 import org.opendaylight.yangtools.concepts.Immutable;
73 import org.opendaylight.yangtools.yang.common.ErrorTag;
74 import org.opendaylight.yangtools.yang.common.ErrorType;
75 import org.opendaylight.yangtools.yang.common.QName;
76 import org.opendaylight.yangtools.yang.common.Revision;
77 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
78 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
79 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
80 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
81 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
82 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
83 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
84 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
85 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
86 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
87 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
88 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
89 import org.slf4j.Logger;
90 import org.slf4j.LoggerFactory;
91
92 /**
93  * Implementation of {@link RestconfDataService}.
94  */
95 @Path("/")
96 public class RestconfDataServiceImpl implements RestconfDataService {
97     // FIXME: we should be able to interpret 'point' and refactor this class into a behavior
98     private static final class QueryParams implements Immutable {
99         final @Nullable String point;
100         final @Nullable Insert insert;
101
102         QueryParams(final @Nullable Insert insert, final @Nullable String point) {
103             this.insert = insert;
104             this.point = point;
105         }
106     }
107
108     private static final Logger LOG = LoggerFactory.getLogger(RestconfDataServiceImpl.class);
109     private static final DateTimeFormatter FORMATTER = DateTimeFormatter.ofPattern("yyyy-MMM-dd HH:mm:ss");
110
111     private final RestconfStreamsSubscriptionService delegRestconfSubscrService;
112     private final SchemaContextHandler schemaContextHandler;
113     private final MdsalRestconfStrategy restconfStrategy;
114     private final DOMMountPointService mountPointService;
115     private final SubscribeToStreamUtil streamUtils;
116     private final DOMActionService actionService;
117     private final DOMDataBroker dataBroker;
118
119     public RestconfDataServiceImpl(final SchemaContextHandler schemaContextHandler,
120             final DOMDataBroker dataBroker, final DOMMountPointService  mountPointService,
121             final RestconfStreamsSubscriptionService delegRestconfSubscrService,
122             final DOMActionService actionService, final Configuration configuration) {
123         this.schemaContextHandler = requireNonNull(schemaContextHandler);
124         this.dataBroker = requireNonNull(dataBroker);
125         this.restconfStrategy = new MdsalRestconfStrategy(dataBroker);
126         this.mountPointService = requireNonNull(mountPointService);
127         this.delegRestconfSubscrService = requireNonNull(delegRestconfSubscrService);
128         this.actionService = requireNonNull(actionService);
129         streamUtils = configuration.isUseSSE() ? SubscribeToStreamUtil.serverSentEvents()
130                 : SubscribeToStreamUtil.webSockets();
131     }
132
133     @Override
134     public Response readData(final UriInfo uriInfo) {
135         return readData(null, uriInfo);
136     }
137
138     @Override
139     public Response readData(final String identifier, final UriInfo uriInfo) {
140         final EffectiveModelContext schemaContextRef = this.schemaContextHandler.get();
141         final InstanceIdentifierContext<?> instanceIdentifier = ParserIdentifier.toInstanceIdentifier(
142                 identifier, schemaContextRef, Optional.of(mountPointService));
143         final WriterParameters parameters = ReadDataTransactionUtil.parseUriParameters(instanceIdentifier, uriInfo);
144
145         final DOMMountPoint mountPoint = instanceIdentifier.getMountPoint();
146
147         // FIXME: this looks quite crazy, why do we even have it?
148         if (mountPoint == null && identifier != null && identifier.contains(STREAMS_PATH)
149             && !identifier.contains(STREAM_PATH_PART)) {
150             createAllYangNotificationStreams(schemaContextRef, uriInfo);
151         }
152
153         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
154         final NormalizedNode node;
155         if (parameters.getFieldPaths() != null && !parameters.getFieldPaths().isEmpty()) {
156             node = ReadDataTransactionUtil.readData(parameters.getContent(), instanceIdentifier.getInstanceIdentifier(),
157                     strategy, parameters.getWithDefault(), schemaContextRef, parameters.getFieldPaths());
158         } else {
159             node = ReadDataTransactionUtil.readData(parameters.getContent(), instanceIdentifier.getInstanceIdentifier(),
160                     strategy, parameters.getWithDefault(), schemaContextRef);
161         }
162
163         // FIXME: this is utter craziness, refactor it properly!
164         if (identifier != null && identifier.contains(STREAM_PATH) && identifier.contains(STREAM_ACCESS_PATH_PART)
165                 && identifier.contains(STREAM_LOCATION_PATH_PART)) {
166             final String value = (String) node.body();
167             final String streamName = value.substring(value.indexOf(NOTIFICATION_STREAM + '/'));
168             this.delegRestconfSubscrService.subscribeToStream(streamName, uriInfo);
169         }
170         if (node == null) {
171             throw new RestconfDocumentedException(
172                     "Request could not be completed because the relevant data model content does not exist",
173                     ErrorType.PROTOCOL, ErrorTag.DATA_MISSING);
174         }
175
176         if (parameters.getContent().equals(RestconfDataServiceConstant.ReadData.ALL)
177                     || parameters.getContent().equals(RestconfDataServiceConstant.ReadData.CONFIG)) {
178             final QName type = node.getIdentifier().getNodeType();
179             return Response.status(Status.OK)
180                     .entity(new NormalizedNodeContext(instanceIdentifier, node, parameters))
181                     .header("ETag", '"' + type.getModule().getRevision().map(Revision::toString).orElse(null)
182                         + "-" + type.getLocalName() + '"')
183                     .header("Last-Modified", FORMATTER.format(LocalDateTime.now(Clock.systemUTC())))
184                     .build();
185         }
186
187         return Response.status(Status.OK)
188             .entity(new NormalizedNodeContext(instanceIdentifier, node, parameters))
189             .build();
190     }
191
192     private void createAllYangNotificationStreams(final EffectiveModelContext schemaContext, final UriInfo uriInfo) {
193         final DOMDataTreeWriteTransaction transaction = dataBroker.newWriteOnlyTransaction();
194         for (final NotificationDefinition notificationDefinition : schemaContext.getNotifications()) {
195             writeNotificationStreamToDatastore(schemaContext, uriInfo, transaction,
196                 CreateStreamUtil.createYangNotifiStream(notificationDefinition, schemaContext,
197                     NotificationOutputType.XML));
198             writeNotificationStreamToDatastore(schemaContext, uriInfo, transaction,
199                 CreateStreamUtil.createYangNotifiStream(notificationDefinition, schemaContext,
200                     NotificationOutputType.JSON));
201         }
202         try {
203             transaction.commit().get();
204         } catch (final InterruptedException | ExecutionException e) {
205             throw new RestconfDocumentedException("Problem while putting data to DS.", e);
206         }
207     }
208
209     private void writeNotificationStreamToDatastore(final EffectiveModelContext schemaContext,
210             final UriInfo uriInfo, final DOMDataTreeWriteOperations tx, final NotificationListenerAdapter listener) {
211         final URI uri = streamUtils.prepareUriByStreamName(uriInfo, listener.getStreamName());
212         final MapEntryNode mapToStreams = RestconfMappingNodeUtil.mapYangNotificationStreamByIetfRestconfMonitoring(
213                 listener.getSchemaPath().lastNodeIdentifier(), schemaContext.getNotifications(), null,
214                 listener.getOutputType(), uri);
215
216         tx.merge(LogicalDatastoreType.OPERATIONAL,
217             Rfc8040.restconfStateStreamPath(mapToStreams.getIdentifier()), mapToStreams);
218     }
219
220     @Override
221     public Response putData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
222         requireNonNull(payload);
223
224         final QueryParams checkedParms = checkQueryParameters(uriInfo);
225
226         final InstanceIdentifierContext<? extends SchemaNode> iid = payload.getInstanceIdentifierContext();
227
228         validInputData(iid.getSchemaNode(), payload);
229         validTopLevelNodeName(iid.getInstanceIdentifier(), payload);
230         validateListKeysEqualityInPayloadAndUri(payload);
231
232         final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
233         final EffectiveModelContext ref = mountPoint == null
234                 ? this.schemaContextHandler.get() : modelContext(mountPoint);
235
236         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
237         return PutDataTransactionUtil.putData(payload, ref, strategy, checkedParms.insert, checkedParms.point);
238     }
239
240     private static QueryParams checkQueryParameters(final UriInfo uriInfo) {
241         boolean insertUsed = false;
242         boolean pointUsed = false;
243         Insert insert = null;
244         String point = null;
245
246         for (final Entry<String, List<String>> entry : uriInfo.getQueryParameters().entrySet()) {
247             switch (entry.getKey()) {
248                 case INSERT:
249                     if (insertUsed) {
250                         throw new RestconfDocumentedException("Insert parameter can be used only once.",
251                             ErrorType.PROTOCOL, ErrorTag.BAD_ELEMENT);
252                     }
253
254                     insertUsed = true;
255                     final String str = entry.getValue().get(0);
256                     insert = Insert.forValue(str);
257                     if (insert == null) {
258                         throw new RestconfDocumentedException("Unrecognized insert parameter value '" + str + "'",
259                             ErrorType.PROTOCOL, ErrorTag.BAD_ELEMENT);
260                     }
261                     break;
262                 case POINT:
263                     if (pointUsed) {
264                         throw new RestconfDocumentedException("Point parameter can be used only once.",
265                             ErrorType.PROTOCOL, ErrorTag.BAD_ELEMENT);
266                     }
267
268                     pointUsed = true;
269                     point = entry.getValue().get(0);
270                     break;
271                 default:
272                     throw new RestconfDocumentedException("Bad parameter for post: " + entry.getKey(),
273                             ErrorType.PROTOCOL, ErrorTag.BAD_ELEMENT);
274             }
275         }
276
277         checkQueryParams(insertUsed, pointUsed, insert);
278         return new QueryParams(insert, point);
279     }
280
281     private static void checkQueryParams(final boolean insertUsed, final boolean pointUsed, final Insert insert) {
282         if (pointUsed) {
283             if (!insertUsed) {
284                 throw new RestconfDocumentedException("Point parameter can't be used without Insert parameter.",
285                     ErrorType.PROTOCOL, ErrorTag.BAD_ELEMENT);
286             }
287
288             if (insert != Insert.BEFORE && insert != Insert.AFTER) {
289                 throw new RestconfDocumentedException(
290                     "Point parameter can be used only with 'after' or 'before' values of Insert parameter.",
291                     ErrorType.PROTOCOL, ErrorTag.BAD_ELEMENT);
292             }
293         }
294     }
295
296     @Override
297     public Response postData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
298         return postData(payload, uriInfo);
299     }
300
301     @Override
302     public Response postData(final NormalizedNodeContext payload, final UriInfo uriInfo) {
303         requireNonNull(payload);
304         if (payload.getInstanceIdentifierContext().getSchemaNode() instanceof ActionDefinition) {
305             return invokeAction(payload);
306         }
307
308         final QueryParams checkedParms = checkQueryParameters(uriInfo);
309         final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
310         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
311         return PostDataTransactionUtil.postData(uriInfo, payload, strategy,
312                 getSchemaContext(mountPoint), checkedParms.insert, checkedParms.point);
313     }
314
315     @Override
316     public Response deleteData(final String identifier) {
317         final InstanceIdentifierContext<?> instanceIdentifier = ParserIdentifier.toInstanceIdentifier(
318                 identifier, this.schemaContextHandler.get(), Optional.of(mountPointService));
319
320         final DOMMountPoint mountPoint = instanceIdentifier.getMountPoint();
321         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
322         return DeleteDataTransactionUtil.deleteData(strategy, instanceIdentifier.getInstanceIdentifier());
323     }
324
325     @Override
326     public PatchStatusContext patchData(final String identifier, final PatchContext context, final UriInfo uriInfo) {
327         return patchData(context, uriInfo);
328     }
329
330     @Override
331     public PatchStatusContext patchData(final PatchContext context, final UriInfo uriInfo) {
332         final DOMMountPoint mountPoint = RestconfDocumentedException.throwIfNull(context,
333             ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE, "No patch documented provided")
334             .getInstanceIdentifierContext().getMountPoint();
335         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
336         return PatchDataTransactionUtil.patchData(context, strategy, getSchemaContext(mountPoint));
337     }
338
339     @Override
340     public Response patchData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
341         requireNonNull(payload);
342
343         final InstanceIdentifierContext<? extends SchemaNode> iid = payload.getInstanceIdentifierContext();
344         validInputData(iid.getSchemaNode(), payload);
345         validTopLevelNodeName(iid.getInstanceIdentifier(), payload);
346         validateListKeysEqualityInPayloadAndUri(payload);
347
348         final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
349         final EffectiveModelContext ref = mountPoint == null
350                 ? this.schemaContextHandler.get() : modelContext(mountPoint);
351         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
352
353         return PlainPatchDataTransactionUtil.patchData(payload, strategy, ref);
354     }
355
356     private EffectiveModelContext getSchemaContext(final DOMMountPoint mountPoint) {
357         return mountPoint == null ? schemaContextHandler.get() : modelContext(mountPoint);
358     }
359
360     // FIXME: why is this synchronized?
361     public synchronized RestconfStrategy getRestconfStrategy(final DOMMountPoint mountPoint) {
362         if (mountPoint == null) {
363             return restconfStrategy;
364         }
365
366         return RestconfStrategy.forMountPoint(mountPoint).orElseThrow(() -> {
367             LOG.warn("Mount point {} does not expose a suitable access interface", mountPoint.getIdentifier());
368             return new RestconfDocumentedException("Could not find a supported access interface in mount point "
369                 + mountPoint.getIdentifier());
370         });
371     }
372
373     /**
374      * Invoke Action operation.
375      *
376      * @param payload {@link NormalizedNodeContext} - the body of the operation
377      * @return {@link NormalizedNodeContext} wrapped in {@link Response}
378      */
379     public Response invokeAction(final NormalizedNodeContext payload) {
380         final InstanceIdentifierContext<?> context = payload.getInstanceIdentifierContext();
381         final DOMMountPoint mountPoint = context.getMountPoint();
382         final Absolute schemaPath = Absolute.of(ImmutableList.copyOf(context.getSchemaNode().getPath()
383             .getPathFromRoot()));
384         final YangInstanceIdentifier yangIIdContext = context.getInstanceIdentifier();
385         final NormalizedNode data = payload.getData();
386
387         if (yangIIdContext.isEmpty()
388             && !RestconfDataServiceConstant.NETCONF_BASE_QNAME.equals(data.getIdentifier().getNodeType())) {
389             throw new RestconfDocumentedException("Instance identifier need to contain at least one path argument",
390                 ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
391         }
392
393         final DOMActionResult response;
394         final EffectiveModelContext schemaContextRef;
395         if (mountPoint != null) {
396             response = RestconfInvokeOperationsUtil.invokeAction((ContainerNode) data, schemaPath, yangIIdContext,
397                 mountPoint);
398             schemaContextRef = modelContext(mountPoint);
399         } else {
400             response = RestconfInvokeOperationsUtil.invokeAction((ContainerNode) data, schemaPath, yangIIdContext,
401                 actionService);
402             schemaContextRef = this.schemaContextHandler.get();
403         }
404         final DOMActionResult result = RestconfInvokeOperationsUtil.checkActionResponse(response);
405
406         ActionDefinition resultNodeSchema = null;
407         ContainerNode resultData = null;
408         if (result != null) {
409             final Optional<ContainerNode> optOutput = result.getOutput();
410             if (optOutput.isPresent()) {
411                 resultData = optOutput.get();
412                 resultNodeSchema = (ActionDefinition) context.getSchemaNode();
413             }
414         }
415
416         if (resultData != null && resultData.isEmpty()) {
417             return Response.status(Status.NO_CONTENT).build();
418         }
419
420         return Response.status(Status.OK)
421             .entity(new NormalizedNodeContext(
422                 new InstanceIdentifierContext<>(yangIIdContext, resultNodeSchema, mountPoint, schemaContextRef),
423                 resultData))
424             .build();
425     }
426
427     /**
428      * Valid input data with {@link SchemaNode}.
429      *
430      * @param schemaNode {@link SchemaNode}
431      * @param payload    input data
432      */
433     @VisibleForTesting
434     public static void validInputData(final SchemaNode schemaNode, final NormalizedNodeContext payload) {
435         if (schemaNode != null && payload.getData() == null) {
436             throw new RestconfDocumentedException("Input is required.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
437         } else if (schemaNode == null && payload.getData() != null) {
438             throw new RestconfDocumentedException("No input expected.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
439         }
440     }
441
442     /**
443      * Valid top level node name.
444      *
445      * @param path    path of node
446      * @param payload data
447      */
448     @VisibleForTesting
449     public static void validTopLevelNodeName(final YangInstanceIdentifier path, final NormalizedNodeContext payload) {
450         final String payloadName = payload.getData().getIdentifier().getNodeType().getLocalName();
451
452         if (path.isEmpty()) {
453             if (!payload.getData().getIdentifier().getNodeType().equals(
454                 RestconfDataServiceConstant.NETCONF_BASE_QNAME)) {
455                 throw new RestconfDocumentedException("Instance identifier has to contain at least one path argument",
456                         ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
457             }
458         } else {
459             final String identifierName = path.getLastPathArgument().getNodeType().getLocalName();
460             if (!payloadName.equals(identifierName)) {
461                 throw new RestconfDocumentedException(
462                         "Payload name (" + payloadName + ") is different from identifier name (" + identifierName + ")",
463                         ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
464             }
465         }
466     }
467
468
469     /**
470      * Validates whether keys in {@code payload} are equal to values of keys in
471      * {@code iiWithData} for list schema node.
472      *
473      * @throws RestconfDocumentedException if key values or key count in payload and URI isn't equal
474      */
475     @VisibleForTesting
476     public static void validateListKeysEqualityInPayloadAndUri(final NormalizedNodeContext payload) {
477         final InstanceIdentifierContext<?> iiWithData = payload.getInstanceIdentifierContext();
478         final PathArgument lastPathArgument = iiWithData.getInstanceIdentifier().getLastPathArgument();
479         final SchemaNode schemaNode = iiWithData.getSchemaNode();
480         final NormalizedNode data = payload.getData();
481         if (schemaNode instanceof ListSchemaNode) {
482             final List<QName> keyDefinitions = ((ListSchemaNode) schemaNode).getKeyDefinition();
483             if (lastPathArgument instanceof NodeIdentifierWithPredicates && data instanceof MapEntryNode) {
484                 final Map<QName, Object> uriKeyValues = ((NodeIdentifierWithPredicates) lastPathArgument).asMap();
485                 isEqualUriAndPayloadKeyValues(uriKeyValues, (MapEntryNode) data, keyDefinitions);
486             }
487         }
488     }
489
490     private static void isEqualUriAndPayloadKeyValues(final Map<QName, Object> uriKeyValues, final MapEntryNode payload,
491             final List<QName> keyDefinitions) {
492         final Map<QName, Object> mutableCopyUriKeyValues = new HashMap<>(uriKeyValues);
493         for (final QName keyDefinition : keyDefinitions) {
494             final Object uriKeyValue = RestconfDocumentedException.throwIfNull(
495                     mutableCopyUriKeyValues.remove(keyDefinition), ErrorType.PROTOCOL, ErrorTag.DATA_MISSING,
496                     "Missing key %s in URI.", keyDefinition);
497
498             final Object dataKeyValue = payload.getIdentifier().getValue(keyDefinition);
499
500             if (!uriKeyValue.equals(dataKeyValue)) {
501                 final String errMsg = "The value '" + uriKeyValue + "' for key '" + keyDefinition.getLocalName()
502                         + "' specified in the URI doesn't match the value '" + dataKeyValue
503                         + "' specified in the message body. ";
504                 throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
505             }
506         }
507     }
508
509     private static EffectiveModelContext modelContext(final DOMMountPoint mountPoint) {
510         return mountPoint.getService(DOMSchemaService.class)
511             .flatMap(svc -> Optional.ofNullable(svc.getGlobalContext()))
512             .orElse(null);
513     }
514 }