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