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