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.DOMMountPoint;
  43 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
  44 import org.opendaylight.mdsal.dom.spi.SimpleDOMActionResult;
  45 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
  46 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  47 import org.opendaylight.restconf.common.patch.PatchContext;
  48 import org.opendaylight.restconf.common.patch.PatchStatusContext;
  49 import org.opendaylight.restconf.nb.rfc8040.ReadDataParams;
  50 import org.opendaylight.restconf.nb.rfc8040.WriteDataParams;
  51 import org.opendaylight.restconf.nb.rfc8040.databind.DatabindProvider;
  52 import org.opendaylight.restconf.nb.rfc8040.databind.jaxrs.QueryParams;
  53 import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
  54 import org.opendaylight.restconf.nb.rfc8040.legacy.QueryParameters;
  55 import org.opendaylight.restconf.nb.rfc8040.monitoring.RestconfStateStreams;
  56 import org.opendaylight.restconf.nb.rfc8040.rests.services.api.RestconfDataService;
  57 import org.opendaylight.restconf.nb.rfc8040.rests.services.api.RestconfStreamsSubscriptionService;
  58 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.MdsalRestconfStrategy;
  59 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.RestconfStrategy;
  60 import org.opendaylight.restconf.nb.rfc8040.rests.utils.DeleteDataTransactionUtil;
  61 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PatchDataTransactionUtil;
  62 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PlainPatchDataTransactionUtil;
  63 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PostDataTransactionUtil;
  64 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PutDataTransactionUtil;
  65 import org.opendaylight.restconf.nb.rfc8040.rests.utils.ReadDataTransactionUtil;
  66 import org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants;
  67 import org.opendaylight.restconf.nb.rfc8040.streams.StreamsConfiguration;
  68 import org.opendaylight.restconf.nb.rfc8040.streams.listeners.ListenersBroker;
  69 import org.opendaylight.restconf.nb.rfc8040.streams.listeners.NotificationListenerAdapter;
  70 import org.opendaylight.restconf.nb.rfc8040.utils.parser.ParserIdentifier;
  71 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.restconf.rev170126.restconf.restconf.Data;
  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.SchemaNode;
  88 import org.opendaylight.yangtools.yang.model.api.stmt.NotificationEffectiveStatement;
  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
 101     private final RestconfStreamsSubscriptionService delegRestconfSubscrService;
 102     private final DatabindProvider databindProvider;
 103     private final MdsalRestconfStrategy restconfStrategy;
 104     private final DOMMountPointService mountPointService;
 105     private final SubscribeToStreamUtil streamUtils;
 106     private final DOMActionService actionService;
 107     private final DOMDataBroker dataBroker;
 108
 109     public RestconfDataServiceImpl(final DatabindProvider databindProvider,
 110             final DOMDataBroker dataBroker, final DOMMountPointService  mountPointService,
 111             final RestconfStreamsSubscriptionService delegRestconfSubscrService,
 112             final DOMActionService actionService, final StreamsConfiguration configuration) {
 113         this.databindProvider = requireNonNull(databindProvider);
 114         this.dataBroker = requireNonNull(dataBroker);
 115         restconfStrategy = new MdsalRestconfStrategy(dataBroker);
 116         this.mountPointService = requireNonNull(mountPointService);
 117         this.delegRestconfSubscrService = requireNonNull(delegRestconfSubscrService);
 118         this.actionService = requireNonNull(actionService);
 119         streamUtils = configuration.useSSE() ? SubscribeToStreamUtil.serverSentEvents()
 120                 : SubscribeToStreamUtil.webSockets();
 121     }
 122
 123     @Override
 124     public Response readData(final UriInfo uriInfo) {
 125         return readData(null, uriInfo);
 126     }
 127
 128     @Override
 129     public Response readData(final String identifier, final UriInfo uriInfo) {
 130         final ReadDataParams readParams = QueryParams.newReadDataParams(uriInfo);
 131
 132         final EffectiveModelContext schemaContextRef = databindProvider.currentContext().modelContext();
 133         // FIXME: go through
 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.name().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 var transaction = dataBroker.newWriteOnlyTransaction();
 187
 188         for (var module : schemaContext.getModuleStatements().values()) {
 189             final var moduleName = module.argument().getLocalName();
 190             // Note: this handles only RFC6020 notifications
 191             module.streamEffectiveSubstatements(NotificationEffectiveStatement.class).forEach(notification -> {
 192                 final var notifName = notification.argument();
 193
 194                 writeNotificationStreamToDatastore(schemaContext, uriInfo, transaction,
 195                     createYangNotifiStream(moduleName, notifName, NotificationOutputType.XML));
 196                 writeNotificationStreamToDatastore(schemaContext, uriInfo, transaction,
 197                     createYangNotifiStream(moduleName, notifName, NotificationOutputType.JSON));
 198             });
 199         }
 200
 201         try {
 202             transaction.commit().get();
 203         } catch (final InterruptedException | ExecutionException e) {
 204             throw new RestconfDocumentedException("Problem while putting data to DS.", e);
 205         }
 206     }
 207
 208     private static NotificationListenerAdapter createYangNotifiStream(final String moduleName, final QName notifName,
 209             final NotificationOutputType outputType) {
 210         final var streamName = createNotificationStreamName(moduleName, notifName.getLocalName(), outputType);
 211         final var listenersBroker = ListenersBroker.getInstance();
 212
 213         final var existing = listenersBroker.notificationListenerFor(streamName);
 214         return existing != null ? existing
 215             : listenersBroker.registerNotificationListener(Absolute.of(notifName), streamName, outputType);
 216     }
 217
 218     private static String createNotificationStreamName(final String moduleName, final String notifName,
 219             final NotificationOutputType outputType) {
 220         final var sb = new StringBuilder()
 221             .append(RestconfStreamsConstants.NOTIFICATION_STREAM)
 222             .append('/').append(moduleName).append(':').append(notifName);
 223         if (outputType != NotificationOutputType.XML) {
 224             sb.append('/').append(outputType.getName());
 225         }
 226         return sb.toString();
 227     }
 228
 229     private void writeNotificationStreamToDatastore(final EffectiveModelContext schemaContext,
 230             final UriInfo uriInfo, final DOMDataTreeWriteOperations tx, final NotificationListenerAdapter listener) {
 231         final URI uri = streamUtils.prepareUriByStreamName(uriInfo, listener.getStreamName());
 232         final MapEntryNode mapToStreams = RestconfStateStreams.notificationStreamEntry(schemaContext,
 233                 listener.getSchemaPath().lastNodeIdentifier(), null, listener.getOutputType(), uri);
 234
 235         tx.merge(LogicalDatastoreType.OPERATIONAL,
 236             RestconfStateStreams.restconfStateStreamPath(mapToStreams.name()), mapToStreams);
 237     }
 238
 239     @Override
 240     public Response putData(final String identifier, final NormalizedNodePayload payload, final UriInfo uriInfo) {
 241         requireNonNull(payload);
 242
 243         final WriteDataParams params = QueryParams.newWriteDataParams(uriInfo);
 244
 245         final InstanceIdentifierContext iid = payload.getInstanceIdentifierContext();
 246         final YangInstanceIdentifier path = iid.getInstanceIdentifier();
 247
 248         validInputData(iid.getSchemaNode() != null, payload);
 249         validTopLevelNodeName(path, payload);
 250         validateListKeysEqualityInPayloadAndUri(payload);
 251
 252         final RestconfStrategy strategy = getRestconfStrategy(iid.getMountPoint());
 253         return PutDataTransactionUtil.putData(path, payload.getData(), iid.getSchemaContext(), strategy, params);
 254     }
 255
 256     @Override
 257     public Response postData(final String identifier, final NormalizedNodePayload payload, final UriInfo uriInfo) {
 258         return postData(payload, uriInfo);
 259     }
 260
 261     @Override
 262     public Response postData(final NormalizedNodePayload payload, final UriInfo uriInfo) {
 263         requireNonNull(payload);
 264         final InstanceIdentifierContext iid = payload.getInstanceIdentifierContext();
 265         if (iid.getSchemaNode() instanceof ActionDefinition) {
 266             return invokeAction(payload);
 267         }
 268
 269         final WriteDataParams params = QueryParams.newWriteDataParams(uriInfo);
 270         final RestconfStrategy strategy = getRestconfStrategy(iid.getMountPoint());
 271         return PostDataTransactionUtil.postData(uriInfo, iid.getInstanceIdentifier(), payload.getData(), strategy,
 272             iid.getSchemaContext(), params);
 273     }
 274
 275     @Override
 276     public Response deleteData(final String identifier) {
 277         final InstanceIdentifierContext instanceIdentifier = ParserIdentifier.toInstanceIdentifier(identifier,
 278             databindProvider.currentContext().modelContext(), Optional.of(mountPointService));
 279
 280         final DOMMountPoint mountPoint = instanceIdentifier.getMountPoint();
 281         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
 282         return DeleteDataTransactionUtil.deleteData(strategy, instanceIdentifier.getInstanceIdentifier());
 283     }
 284
 285     @Override
 286     public PatchStatusContext patchData(final String identifier, final PatchContext context, final UriInfo uriInfo) {
 287         return patchData(context, uriInfo);
 288     }
 289
 290     @Override
 291     public PatchStatusContext patchData(final PatchContext context, final UriInfo uriInfo) {
 292         final InstanceIdentifierContext iid = RestconfDocumentedException.throwIfNull(context,
 293             ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE, "No patch documented provided")
 294             .getInstanceIdentifierContext();
 295         final RestconfStrategy strategy = getRestconfStrategy(iid.getMountPoint());
 296         return PatchDataTransactionUtil.patchData(context, strategy, iid.getSchemaContext());
 297     }
 298
 299     @Override
 300     public Response patchData(final String identifier, final NormalizedNodePayload payload, final UriInfo uriInfo) {
 301         requireNonNull(payload);
 302
 303         final InstanceIdentifierContext iid = payload.getInstanceIdentifierContext();
 304         final YangInstanceIdentifier path = iid.getInstanceIdentifier();
 305         validInputData(iid.getSchemaNode() != null, payload);
 306         validTopLevelNodeName(path, payload);
 307         validateListKeysEqualityInPayloadAndUri(payload);
 308
 309         final RestconfStrategy strategy = getRestconfStrategy(iid.getMountPoint());
 310         return PlainPatchDataTransactionUtil.patchData(path, payload.getData(), strategy, iid.getSchemaContext());
 311     }
 312
 313     @VisibleForTesting
 314     final RestconfStrategy getRestconfStrategy(final DOMMountPoint mountPoint) {
 315         if (mountPoint == null) {
 316             return restconfStrategy;
 317         }
 318
 319         return RestconfStrategy.forMountPoint(mountPoint).orElseThrow(() -> {
 320             LOG.warn("Mount point {} does not expose a suitable access interface", mountPoint.getIdentifier());
 321             return new RestconfDocumentedException("Could not find a supported access interface in mount point "
 322                 + mountPoint.getIdentifier());
 323         });
 324     }
 325
 326     /**
 327      * Invoke Action operation.
 328      *
 329      * @param payload {@link NormalizedNodePayload} - the body of the operation
 330      * @return {@link NormalizedNodePayload} wrapped in {@link Response}
 331      */
 332     public Response invokeAction(final NormalizedNodePayload payload) {
 333         final InstanceIdentifierContext context = payload.getInstanceIdentifierContext();
 334         final YangInstanceIdentifier yangIIdContext = context.getInstanceIdentifier();
 335         final NormalizedNode data = payload.getData();
 336
 337         if (yangIIdContext.isEmpty() && !Data.QNAME.equals(data.name().getNodeType())) {
 338             throw new RestconfDocumentedException("Instance identifier need to contain at least one path argument",
 339                 ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 340         }
 341
 342         final DOMMountPoint mountPoint = context.getMountPoint();
 343         final Absolute schemaPath = context.inference().toSchemaInferenceStack().toSchemaNodeIdentifier();
 344         final DOMActionResult response;
 345         if (mountPoint != null) {
 346             response = invokeAction((ContainerNode) data, schemaPath, yangIIdContext, mountPoint);
 347         } else {
 348             response = invokeAction((ContainerNode) data, schemaPath, yangIIdContext, actionService);
 349         }
 350         final DOMActionResult result = checkActionResponse(response);
 351
 352         ContainerNode resultData = null;
 353         if (result != null) {
 354             resultData = result.getOutput().orElse(null);
 355         }
 356
 357         if (resultData != null && resultData.isEmpty()) {
 358             return Response.status(Status.NO_CONTENT).build();
 359         }
 360
 361         return Response.status(Status.OK)
 362             .entity(NormalizedNodePayload.ofNullable(context, resultData))
 363             .build();
 364     }
 365
 366     /**
 367      * Invoking Action via mount point.
 368      *
 369      * @param mountPoint mount point
 370      * @param data input data
 371      * @param schemaPath schema path of data
 372      * @return {@link DOMActionResult}
 373      */
 374     private static DOMActionResult invokeAction(final ContainerNode data,
 375             final Absolute schemaPath, final YangInstanceIdentifier yangIId, final DOMMountPoint mountPoint) {
 376         return invokeAction(data, schemaPath, yangIId, mountPoint.getService(DOMActionService.class)
 377             .orElseThrow(() -> new RestconfDocumentedException("DomAction service is missing.")));
 378     }
 379
 380     /**
 381      * Invoke Action via ActionServiceHandler.
 382      *
 383      * @param data input data
 384      * @param yangIId invocation context
 385      * @param schemaPath schema path of data
 386      * @param actionService action service to invoke action
 387      * @return {@link DOMActionResult}
 388      */
 389     // FIXME: NETCONF-718: we should be returning a future here
 390     private static DOMActionResult invokeAction(final ContainerNode data, final Absolute schemaPath,
 391             final YangInstanceIdentifier yangIId, final DOMActionService actionService) {
 392         return RestconfInvokeOperationsServiceImpl.checkedGet(Futures.catching(actionService.invokeAction(
 393             schemaPath, new DOMDataTreeIdentifier(LogicalDatastoreType.OPERATIONAL, yangIId.getParent()), data),
 394             DOMActionException.class,
 395             cause -> new SimpleDOMActionResult(List.of(RpcResultBuilder.newError(
 396                 ErrorType.RPC, ErrorTag.OPERATION_FAILED, cause.getMessage()))),
 397             MoreExecutors.directExecutor()));
 398     }
 399
 400     /**
 401      * Check the validity of the result.
 402      *
 403      * @param response response of Action
 404      * @return {@link DOMActionResult} result
 405      */
 406     private static DOMActionResult checkActionResponse(final DOMActionResult response) {
 407         if (response == null) {
 408             return null;
 409         }
 410
 411         try {
 412             if (response.getErrors().isEmpty()) {
 413                 return response;
 414             }
 415             LOG.debug("InvokeAction Error Message {}", response.getErrors());
 416             throw new RestconfDocumentedException("InvokeAction Error Message ", null, response.getErrors());
 417         } catch (final CancellationException e) {
 418             final String errMsg = "The Action Operation was cancelled while executing.";
 419             LOG.debug("Cancel Execution: {}", errMsg, e);
 420             throw new RestconfDocumentedException(errMsg, ErrorType.RPC, ErrorTag.PARTIAL_OPERATION, e);
 421         }
 422     }
 423
 424     /**
 425      * Valid input data based on presence of a schema node.
 426      *
 427      * @param haveSchemaNode true if there is an underlying schema node
 428      * @param payload    input data
 429      */
 430     @VisibleForTesting
 431     static void validInputData(final boolean haveSchemaNode, final NormalizedNodePayload payload) {
 432         final boolean haveData = payload.getData() != null;
 433         if (haveSchemaNode) {
 434             if (!haveData) {
 435                 throw new RestconfDocumentedException("Input is required.", ErrorType.PROTOCOL,
 436                     ErrorTag.MALFORMED_MESSAGE);
 437             }
 438         } else if (haveData) {
 439             throw new RestconfDocumentedException("No input expected.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 440         }
 441     }
 442
 443     /**
 444      * Valid top level node name.
 445      *
 446      * @param path    path of node
 447      * @param payload data
 448      */
 449     @VisibleForTesting
 450     static void validTopLevelNodeName(final YangInstanceIdentifier path, final NormalizedNodePayload payload) {
 451         final QName dataNodeType = payload.getData().name().getNodeType();
 452         if (path.isEmpty()) {
 453             if (!Data.QNAME.equals(dataNodeType)) {
 454                 throw new RestconfDocumentedException("Instance identifier has to contain at least one path argument",
 455                         ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 456             }
 457         } else {
 458             final String identifierName = path.getLastPathArgument().getNodeType().getLocalName();
 459             final String payloadName = dataNodeType.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      * Validates whether keys in {@code payload} are equal to values of keys in
 470      * {@code iiWithData} for list schema node.
 471      *
 472      * @throws RestconfDocumentedException if key values or key count in payload and URI isn't equal
 473      */
 474     @VisibleForTesting
 475     static void validateListKeysEqualityInPayloadAndUri(final NormalizedNodePayload payload) {
 476         final InstanceIdentifierContext iiWithData = payload.getInstanceIdentifierContext();
 477         final PathArgument lastPathArgument = iiWithData.getInstanceIdentifier().getLastPathArgument();
 478         final SchemaNode schemaNode = iiWithData.getSchemaNode();
 479         final NormalizedNode data = payload.getData();
 480         if (schemaNode instanceof ListSchemaNode listSchema) {
 481             final var keyDefinitions = listSchema.getKeyDefinition();
 482             if (lastPathArgument instanceof NodeIdentifierWithPredicates && data instanceof MapEntryNode) {
 483                 final Map<QName, Object> uriKeyValues = ((NodeIdentifierWithPredicates) lastPathArgument).asMap();
 484                 isEqualUriAndPayloadKeyValues(uriKeyValues, (MapEntryNode) data, keyDefinitions);
 485             }
 486         }
 487     }
 488
 489     private static void isEqualUriAndPayloadKeyValues(final Map<QName, Object> uriKeyValues, final MapEntryNode payload,
 490             final List<QName> keyDefinitions) {
 491         final Map<QName, Object> mutableCopyUriKeyValues = new HashMap<>(uriKeyValues);
 492         for (final QName keyDefinition : keyDefinitions) {
 493             final Object uriKeyValue = RestconfDocumentedException.throwIfNull(
 494                     mutableCopyUriKeyValues.remove(keyDefinition), ErrorType.PROTOCOL, ErrorTag.DATA_MISSING,
 495                     "Missing key %s in URI.", keyDefinition);
 496
 497             final Object dataKeyValue = payload.name().getValue(keyDefinition);
 498
 499             if (!uriKeyValue.equals(dataKeyValue)) {
 500                 final String errMsg = "The value '" + uriKeyValue + "' for key '" + keyDefinition.getLocalName()
 501                         + "' specified in the URI doesn't match the value '" + dataKeyValue
 502                         + "' specified in the message body. ";
 503                 throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
 504             }
 505         }
 506     }
 507 }