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.UriInfo;
  35 import org.eclipse.jdt.annotation.Nullable;
  36 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  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.DOMDataTreeWriteOperations;
  41 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  42 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
  43 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
  44 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
  45 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
  46 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
  47 import org.opendaylight.restconf.common.context.WriterParameters;
  48 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  49 import org.opendaylight.restconf.common.errors.RestconfError;
  50 import org.opendaylight.restconf.common.errors.RestconfError.ErrorTag;
  51 import org.opendaylight.restconf.common.patch.PatchContext;
  52 import org.opendaylight.restconf.common.patch.PatchStatusContext;
  53 import org.opendaylight.restconf.nb.rfc8040.Rfc8040;
  54 import org.opendaylight.restconf.nb.rfc8040.handlers.SchemaContextHandler;
  55 import org.opendaylight.restconf.nb.rfc8040.rests.services.api.RestconfDataService;
  56 import org.opendaylight.restconf.nb.rfc8040.rests.services.api.RestconfStreamsSubscriptionService;
  57 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.MdsalRestconfStrategy;
  58 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.RestconfStrategy;
  59 import org.opendaylight.restconf.nb.rfc8040.rests.utils.DeleteDataTransactionUtil;
  60 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PatchDataTransactionUtil;
  61 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PlainPatchDataTransactionUtil;
  62 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PostDataTransactionUtil;
  63 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PutDataTransactionUtil;
  64 import org.opendaylight.restconf.nb.rfc8040.rests.utils.ReadDataTransactionUtil;
  65 import org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfDataServiceConstant;
  66 import org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfDataServiceConstant.PostPutQueryParameters.Insert;
  67 import org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfInvokeOperationsUtil;
  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.concepts.Immutable;
  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, RestconfError.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(200)
 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(200).entity(new NormalizedNodeContext(instanceIdentifier, node, parameters)).build();
 188     }
 189
 190     private void createAllYangNotificationStreams(final EffectiveModelContext schemaContext, final UriInfo uriInfo) {
 191         final DOMDataTreeWriteTransaction transaction = dataBroker.newWriteOnlyTransaction();
 192         for (final NotificationDefinition notificationDefinition : schemaContext.getNotifications()) {
 193             writeNotificationStreamToDatastore(schemaContext, uriInfo, transaction,
 194                 CreateStreamUtil.createYangNotifiStream(notificationDefinition, schemaContext,
 195                     NotificationOutputType.XML));
 196             writeNotificationStreamToDatastore(schemaContext, uriInfo, transaction,
 197                 CreateStreamUtil.createYangNotifiStream(notificationDefinition, schemaContext,
 198                     NotificationOutputType.JSON));
 199         }
 200         try {
 201             transaction.commit().get();
 202         } catch (final InterruptedException | ExecutionException e) {
 203             throw new RestconfDocumentedException("Problem while putting data to DS.", e);
 204         }
 205     }
 206
 207     private void writeNotificationStreamToDatastore(final EffectiveModelContext schemaContext,
 208             final UriInfo uriInfo, final DOMDataTreeWriteOperations tx, final NotificationListenerAdapter listener) {
 209         final URI uri = streamUtils.prepareUriByStreamName(uriInfo, listener.getStreamName());
 210         final MapEntryNode mapToStreams = RestconfMappingNodeUtil.mapYangNotificationStreamByIetfRestconfMonitoring(
 211                 listener.getSchemaPath().lastNodeIdentifier(), schemaContext.getNotifications(), null,
 212                 listener.getOutputType(), uri);
 213
 214         tx.merge(LogicalDatastoreType.OPERATIONAL,
 215             Rfc8040.restconfStateStreamPath(mapToStreams.getIdentifier()), mapToStreams);
 216     }
 217
 218     @Override
 219     public Response putData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
 220         requireNonNull(payload);
 221
 222         final QueryParams checkedParms = checkQueryParameters(uriInfo);
 223
 224         final InstanceIdentifierContext<? extends SchemaNode> iid = payload.getInstanceIdentifierContext();
 225
 226         validInputData(iid.getSchemaNode(), payload);
 227         validTopLevelNodeName(iid.getInstanceIdentifier(), payload);
 228         validateListKeysEqualityInPayloadAndUri(payload);
 229
 230         final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
 231         final EffectiveModelContext ref = mountPoint == null
 232                 ? this.schemaContextHandler.get() : modelContext(mountPoint);
 233
 234         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
 235         return PutDataTransactionUtil.putData(payload, ref, strategy, checkedParms.insert, checkedParms.point);
 236     }
 237
 238     private static QueryParams checkQueryParameters(final UriInfo uriInfo) {
 239         boolean insertUsed = false;
 240         boolean pointUsed = false;
 241         Insert insert = null;
 242         String point = null;
 243
 244         for (final Entry<String, List<String>> entry : uriInfo.getQueryParameters().entrySet()) {
 245             switch (entry.getKey()) {
 246                 case INSERT:
 247                     if (insertUsed) {
 248                         throw new RestconfDocumentedException("Insert parameter can be used only once.",
 249                             ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
 250                     }
 251
 252                     insertUsed = true;
 253                     final String str = entry.getValue().get(0);
 254                     insert = Insert.forValue(str);
 255                     if (insert == null) {
 256                         throw new RestconfDocumentedException("Unrecognized insert parameter value '" + str + "'",
 257                             ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
 258                     }
 259                     break;
 260                 case POINT:
 261                     if (pointUsed) {
 262                         throw new RestconfDocumentedException("Point parameter can be used only once.",
 263                             ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
 264                     }
 265
 266                     pointUsed = true;
 267                     point = entry.getValue().get(0);
 268                     break;
 269                 default:
 270                     throw new RestconfDocumentedException("Bad parameter for post: " + entry.getKey(),
 271                             ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
 272             }
 273         }
 274
 275         checkQueryParams(insertUsed, pointUsed, insert);
 276         return new QueryParams(insert, point);
 277     }
 278
 279     private static void checkQueryParams(final boolean insertUsed, final boolean pointUsed, final Insert insert) {
 280         if (pointUsed) {
 281             if (!insertUsed) {
 282                 throw new RestconfDocumentedException("Point parameter can't be used without Insert parameter.",
 283                     ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
 284             }
 285
 286             if (insert != Insert.BEFORE && insert != Insert.AFTER) {
 287                 throw new RestconfDocumentedException(
 288                     "Point parameter can be used only with 'after' or 'before' values of Insert parameter.",
 289                     ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
 290             }
 291         }
 292     }
 293
 294     @Override
 295     public Response postData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
 296         return postData(payload, uriInfo);
 297     }
 298
 299     @Override
 300     public Response postData(final NormalizedNodeContext payload, final UriInfo uriInfo) {
 301         requireNonNull(payload);
 302         if (payload.getInstanceIdentifierContext().getSchemaNode() instanceof ActionDefinition) {
 303             return invokeAction(payload);
 304         }
 305
 306         final QueryParams checkedParms = checkQueryParameters(uriInfo);
 307         final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
 308         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
 309         return PostDataTransactionUtil.postData(uriInfo, payload, strategy,
 310                 getSchemaContext(mountPoint), checkedParms.insert, checkedParms.point);
 311     }
 312
 313     @Override
 314     public Response deleteData(final String identifier) {
 315         final InstanceIdentifierContext<?> instanceIdentifier = ParserIdentifier.toInstanceIdentifier(
 316                 identifier, this.schemaContextHandler.get(), Optional.of(mountPointService));
 317
 318         final DOMMountPoint mountPoint = instanceIdentifier.getMountPoint();
 319         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
 320         return DeleteDataTransactionUtil.deleteData(strategy, instanceIdentifier.getInstanceIdentifier());
 321     }
 322
 323     @Override
 324     public PatchStatusContext patchData(final String identifier, final PatchContext context, final UriInfo uriInfo) {
 325         return patchData(context, uriInfo);
 326     }
 327
 328     @Override
 329     public PatchStatusContext patchData(final PatchContext context, final UriInfo uriInfo) {
 330         final DOMMountPoint mountPoint = requireNonNull(context).getInstanceIdentifierContext().getMountPoint();
 331         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
 332         return PatchDataTransactionUtil.patchData(context, strategy, getSchemaContext(mountPoint));
 333     }
 334
 335     @Override
 336     public Response patchData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
 337         requireNonNull(payload);
 338
 339         final InstanceIdentifierContext<? extends SchemaNode> iid = payload
 340                 .getInstanceIdentifierContext();
 341
 342         validInputData(iid.getSchemaNode(), payload);
 343         validTopLevelNodeName(iid.getInstanceIdentifier(), payload);
 344         validateListKeysEqualityInPayloadAndUri(payload);
 345
 346         final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
 347         final EffectiveModelContext ref = mountPoint == null
 348                 ? this.schemaContextHandler.get() : modelContext(mountPoint);
 349         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
 350
 351         return PlainPatchDataTransactionUtil.patchData(payload, strategy, ref);
 352     }
 353
 354     private EffectiveModelContext getSchemaContext(final DOMMountPoint mountPoint) {
 355         return mountPoint == null ? schemaContextHandler.get() : modelContext(mountPoint);
 356     }
 357
 358     // FIXME: why is this synchronized?
 359     public synchronized RestconfStrategy getRestconfStrategy(final DOMMountPoint mountPoint) {
 360         if (mountPoint == null) {
 361             return restconfStrategy;
 362         }
 363
 364         return RestconfStrategy.forMountPoint(mountPoint).orElseThrow(() -> {
 365             LOG.warn("Mount point {} does not expose a suitable access interface", mountPoint.getIdentifier());
 366             return new RestconfDocumentedException("Could not find a supported access interface in mount point "
 367                 + mountPoint.getIdentifier());
 368         });
 369     }
 370
 371     /**
 372      * Invoke Action operation.
 373      *
 374      * @param payload {@link NormalizedNodeContext} - the body of the operation
 375      * @return {@link NormalizedNodeContext} wrapped in {@link Response}
 376      */
 377     public Response invokeAction(final NormalizedNodeContext payload) {
 378         final InstanceIdentifierContext<?> context = payload.getInstanceIdentifierContext();
 379         final DOMMountPoint mountPoint = context.getMountPoint();
 380         final Absolute schemaPath = Absolute.of(ImmutableList.copyOf(context.getSchemaNode().getPath()
 381             .getPathFromRoot()));
 382         final YangInstanceIdentifier yangIIdContext = context.getInstanceIdentifier();
 383         final NormalizedNode data = payload.getData();
 384
 385         if (yangIIdContext.isEmpty()
 386             && !RestconfDataServiceConstant.NETCONF_BASE_QNAME.equals(data.getIdentifier().getNodeType())) {
 387             throw new RestconfDocumentedException("Instance identifier need to contain at least one path argument",
 388                 ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 389         }
 390
 391         final DOMActionResult response;
 392         final EffectiveModelContext schemaContextRef;
 393         if (mountPoint != null) {
 394             response = RestconfInvokeOperationsUtil.invokeAction((ContainerNode) data, schemaPath, yangIIdContext,
 395                 mountPoint);
 396             schemaContextRef = modelContext(mountPoint);
 397         } else {
 398             response = RestconfInvokeOperationsUtil.invokeAction((ContainerNode) data, schemaPath, yangIIdContext,
 399                 actionService);
 400             schemaContextRef = this.schemaContextHandler.get();
 401         }
 402         final DOMActionResult result = RestconfInvokeOperationsUtil.checkActionResponse(response);
 403
 404         ActionDefinition resultNodeSchema = null;
 405         ContainerNode resultData = null;
 406         if (result != null) {
 407             final Optional<ContainerNode> optOutput = result.getOutput();
 408             if (optOutput.isPresent()) {
 409                 resultData = optOutput.get();
 410                 resultNodeSchema = (ActionDefinition) context.getSchemaNode();
 411             }
 412         }
 413
 414         if (resultData != null && resultData.isEmpty()) {
 415             return Response.status(Response.Status.NO_CONTENT).build();
 416         }
 417
 418         return Response.status(200).entity(new NormalizedNodeContext(new InstanceIdentifierContext<>(yangIIdContext,
 419                 resultNodeSchema, mountPoint, schemaContextRef), resultData)).build();
 420     }
 421
 422     /**
 423      * Valid input data with {@link SchemaNode}.
 424      *
 425      * @param schemaNode {@link SchemaNode}
 426      * @param payload    input data
 427      */
 428     @VisibleForTesting
 429     public static void validInputData(final SchemaNode schemaNode, final NormalizedNodeContext payload) {
 430         if (schemaNode != null && payload.getData() == null) {
 431             throw new RestconfDocumentedException("Input is required.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 432         } else if (schemaNode == null && payload.getData() != null) {
 433             throw new RestconfDocumentedException("No input expected.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 434         }
 435     }
 436
 437     /**
 438      * Valid top level node name.
 439      *
 440      * @param path    path of node
 441      * @param payload data
 442      */
 443     @VisibleForTesting
 444     public static void validTopLevelNodeName(final YangInstanceIdentifier path, final NormalizedNodeContext payload) {
 445         final String payloadName = payload.getData().getIdentifier().getNodeType().getLocalName();
 446
 447         if (path.isEmpty()) {
 448             if (!payload.getData().getIdentifier().getNodeType().equals(
 449                 RestconfDataServiceConstant.NETCONF_BASE_QNAME)) {
 450                 throw new RestconfDocumentedException("Instance identifier has to contain at least one path argument",
 451                         ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 452             }
 453         } else {
 454             final String identifierName = path.getLastPathArgument().getNodeType().getLocalName();
 455             if (!payloadName.equals(identifierName)) {
 456                 throw new RestconfDocumentedException(
 457                         "Payload name (" + payloadName + ") is different from identifier name (" + identifierName + ")",
 458                         ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 459             }
 460         }
 461     }
 462
 463
 464     /**
 465      * Validates whether keys in {@code payload} are equal to values of keys in
 466      * {@code iiWithData} for list schema node.
 467      *
 468      * @throws RestconfDocumentedException if key values or key count in payload and URI isn't equal
 469      */
 470     @VisibleForTesting
 471     public static void validateListKeysEqualityInPayloadAndUri(final NormalizedNodeContext payload) {
 472         final InstanceIdentifierContext<?> iiWithData = payload.getInstanceIdentifierContext();
 473         final PathArgument lastPathArgument = iiWithData.getInstanceIdentifier().getLastPathArgument();
 474         final SchemaNode schemaNode = iiWithData.getSchemaNode();
 475         final NormalizedNode data = payload.getData();
 476         if (schemaNode instanceof ListSchemaNode) {
 477             final List<QName> keyDefinitions = ((ListSchemaNode) schemaNode).getKeyDefinition();
 478             if (lastPathArgument instanceof NodeIdentifierWithPredicates && data instanceof MapEntryNode) {
 479                 final Map<QName, Object> uriKeyValues = ((NodeIdentifierWithPredicates) lastPathArgument).asMap();
 480                 isEqualUriAndPayloadKeyValues(uriKeyValues, (MapEntryNode) data, keyDefinitions);
 481             }
 482         }
 483     }
 484
 485     private static void isEqualUriAndPayloadKeyValues(final Map<QName, Object> uriKeyValues, final MapEntryNode payload,
 486             final List<QName> keyDefinitions) {
 487         final Map<QName, Object> mutableCopyUriKeyValues = new HashMap<>(uriKeyValues);
 488         for (final QName keyDefinition : keyDefinitions) {
 489             final Object uriKeyValue = RestconfDocumentedException.throwIfNull(
 490                     mutableCopyUriKeyValues.remove(keyDefinition), ErrorType.PROTOCOL, ErrorTag.DATA_MISSING,
 491                     "Missing key %s in URI.", keyDefinition);
 492
 493             final Object dataKeyValue = payload.getIdentifier().getValue(keyDefinition);
 494
 495             if (!uriKeyValue.equals(dataKeyValue)) {
 496                 final String errMsg = "The value '" + uriKeyValue + "' for key '" + keyDefinition.getLocalName()
 497                         + "' specified in the URI doesn't match the value '" + dataKeyValue
 498                         + "' specified in the message body. ";
 499                 throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
 500             }
 501         }
 502     }
 503
 504     private static EffectiveModelContext modelContext(final DOMMountPoint mountPoint) {
 505         return mountPoint.getService(DOMSchemaService.class)
 506             .flatMap(svc -> Optional.ofNullable(svc.getGlobalContext()))
 507             .orElse(null);
 508     }
 509 }