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