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.Rfc8040;
  53 import org.opendaylight.restconf.nb.rfc8040.WriteDataParams;
  54 import org.opendaylight.restconf.nb.rfc8040.databind.jaxrs.QueryParams;
  55 import org.opendaylight.restconf.nb.rfc8040.handlers.SchemaContextHandler;
  56 import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
  57 import org.opendaylight.restconf.nb.rfc8040.legacy.QueryParameters;
  58 import org.opendaylight.restconf.nb.rfc8040.rests.services.api.RestconfDataService;
  59 import org.opendaylight.restconf.nb.rfc8040.rests.services.api.RestconfStreamsSubscriptionService;
  60 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.MdsalRestconfStrategy;
  61 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.RestconfStrategy;
  62 import org.opendaylight.restconf.nb.rfc8040.rests.utils.DeleteDataTransactionUtil;
  63 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PatchDataTransactionUtil;
  64 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PlainPatchDataTransactionUtil;
  65 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PostDataTransactionUtil;
  66 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PutDataTransactionUtil;
  67 import org.opendaylight.restconf.nb.rfc8040.rests.utils.ReadDataTransactionUtil;
  68 import org.opendaylight.restconf.nb.rfc8040.streams.Configuration;
  69 import org.opendaylight.restconf.nb.rfc8040.streams.listeners.NotificationListenerAdapter;
  70 import org.opendaylight.restconf.nb.rfc8040.utils.mapping.RestconfMappingNodeUtil;
  71 import org.opendaylight.restconf.nb.rfc8040.utils.parser.ParserIdentifier;
  72 import org.opendaylight.yang.gen.v1.urn.sal.restconf.event.subscription.rev140708.NotificationOutputTypeGrouping.NotificationOutputType;
  73 import org.opendaylight.yangtools.yang.common.ErrorTag;
  74 import org.opendaylight.yangtools.yang.common.ErrorType;
  75 import org.opendaylight.yangtools.yang.common.QName;
  76 import org.opendaylight.yangtools.yang.common.Revision;
  77 import org.opendaylight.yangtools.yang.common.RpcError;
  78 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  79 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  80 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  81 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  82 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  83 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  84 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  85 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
  86 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  87 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  88 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  89 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  90 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  91 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  92 import org.slf4j.Logger;
  93 import org.slf4j.LoggerFactory;
  94
  95 /**
  96  * Implementation of {@link RestconfDataService}.
  97  */
  98 @Path("/")
  99 public class RestconfDataServiceImpl implements RestconfDataService {
 100     private static final Logger LOG = LoggerFactory.getLogger(RestconfDataServiceImpl.class);
 101     private static final DateTimeFormatter FORMATTER = DateTimeFormatter.ofPattern("yyyy-MMM-dd HH:mm:ss");
 102     private static final QName NETCONF_BASE_QNAME = SchemaContext.NAME;
 103
 104     private final RestconfStreamsSubscriptionService delegRestconfSubscrService;
 105     private final SchemaContextHandler schemaContextHandler;
 106     private final MdsalRestconfStrategy restconfStrategy;
 107     private final DOMMountPointService mountPointService;
 108     private final SubscribeToStreamUtil streamUtils;
 109     private final DOMActionService actionService;
 110     private final DOMDataBroker dataBroker;
 111
 112     public RestconfDataServiceImpl(final SchemaContextHandler schemaContextHandler,
 113             final DOMDataBroker dataBroker, final DOMMountPointService  mountPointService,
 114             final RestconfStreamsSubscriptionService delegRestconfSubscrService,
 115             final DOMActionService actionService, final Configuration configuration) {
 116         this.schemaContextHandler = requireNonNull(schemaContextHandler);
 117         this.dataBroker = requireNonNull(dataBroker);
 118         restconfStrategy = new MdsalRestconfStrategy(dataBroker);
 119         this.mountPointService = requireNonNull(mountPointService);
 120         this.delegRestconfSubscrService = requireNonNull(delegRestconfSubscrService);
 121         this.actionService = requireNonNull(actionService);
 122         streamUtils = configuration.isUseSSE() ? SubscribeToStreamUtil.serverSentEvents()
 123                 : SubscribeToStreamUtil.webSockets();
 124     }
 125
 126     @Override
 127     public Response readData(final UriInfo uriInfo) {
 128         return readData(null, uriInfo);
 129     }
 130
 131     @Override
 132     public Response readData(final String identifier, final UriInfo uriInfo) {
 133         final EffectiveModelContext schemaContextRef = schemaContextHandler.get();
 134         final InstanceIdentifierContext<?> instanceIdentifier = ParserIdentifier.toInstanceIdentifier(
 135                 identifier, schemaContextRef, Optional.of(mountPointService));
 136         final QueryParameters parameters = ReadDataTransactionUtil.parseUriParameters(instanceIdentifier, uriInfo);
 137
 138         final DOMMountPoint mountPoint = instanceIdentifier.getMountPoint();
 139
 140         // FIXME: this looks quite crazy, why do we even have it?
 141         if (mountPoint == null && identifier != null && identifier.contains(STREAMS_PATH)
 142             && !identifier.contains(STREAM_PATH_PART)) {
 143             createAllYangNotificationStreams(schemaContextRef, uriInfo);
 144         }
 145
 146         final List<YangInstanceIdentifier> fieldPaths = parameters.getFieldPaths();
 147         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
 148         final NormalizedNode node;
 149         if (fieldPaths != null && !fieldPaths.isEmpty()) {
 150             node = ReadDataTransactionUtil.readData(parameters.getContent(), instanceIdentifier.getInstanceIdentifier(),
 151                     strategy, parameters.getWithDefault(), schemaContextRef, fieldPaths);
 152         } else {
 153             node = ReadDataTransactionUtil.readData(parameters.getContent(), instanceIdentifier.getInstanceIdentifier(),
 154                     strategy, parameters.getWithDefault(), schemaContextRef);
 155         }
 156
 157         // FIXME: this is utter craziness, refactor it properly!
 158         if (identifier != null && identifier.contains(STREAM_PATH) && identifier.contains(STREAM_ACCESS_PATH_PART)
 159                 && identifier.contains(STREAM_LOCATION_PATH_PART)) {
 160             final String value = (String) node.body();
 161             final String streamName = value.substring(value.indexOf(NOTIFICATION_STREAM + '/'));
 162             delegRestconfSubscrService.subscribeToStream(streamName, uriInfo);
 163         }
 164         if (node == null) {
 165             throw new RestconfDocumentedException(
 166                     "Request could not be completed because the relevant data model content does not exist",
 167                     ErrorType.PROTOCOL, ErrorTag.DATA_MISSING);
 168         }
 169
 170         switch (parameters.getContent()) {
 171             case ALL:
 172             case CONFIG:
 173                 final QName type = node.getIdentifier().getNodeType();
 174                 return Response.status(Status.OK)
 175                     .entity(NormalizedNodePayload.ofReadData(instanceIdentifier, node, parameters))
 176                     .header("ETag", '"' + type.getModule().getRevision().map(Revision::toString).orElse(null)
 177                         + "-" + type.getLocalName() + '"')
 178                     .header("Last-Modified", FORMATTER.format(LocalDateTime.now(Clock.systemUTC())))
 179                     .build();
 180             default:
 181                 return Response.status(Status.OK)
 182                     .entity(NormalizedNodePayload.ofReadData(instanceIdentifier, node, parameters))
 183                     .build();
 184         }
 185     }
 186
 187     private void createAllYangNotificationStreams(final EffectiveModelContext schemaContext, final UriInfo uriInfo) {
 188         final DOMDataTreeWriteTransaction transaction = dataBroker.newWriteOnlyTransaction();
 189         for (final NotificationDefinition notificationDefinition : schemaContext.getNotifications()) {
 190             writeNotificationStreamToDatastore(schemaContext, uriInfo, transaction,
 191                 CreateStreamUtil.createYangNotifiStream(notificationDefinition, schemaContext,
 192                     NotificationOutputType.XML));
 193             writeNotificationStreamToDatastore(schemaContext, uriInfo, transaction,
 194                 CreateStreamUtil.createYangNotifiStream(notificationDefinition, schemaContext,
 195                     NotificationOutputType.JSON));
 196         }
 197         try {
 198             transaction.commit().get();
 199         } catch (final InterruptedException | ExecutionException e) {
 200             throw new RestconfDocumentedException("Problem while putting data to DS.", e);
 201         }
 202     }
 203
 204     private void writeNotificationStreamToDatastore(final EffectiveModelContext schemaContext,
 205             final UriInfo uriInfo, final DOMDataTreeWriteOperations tx, final NotificationListenerAdapter listener) {
 206         final URI uri = streamUtils.prepareUriByStreamName(uriInfo, listener.getStreamName());
 207         final MapEntryNode mapToStreams = RestconfMappingNodeUtil.mapYangNotificationStreamByIetfRestconfMonitoring(
 208                 listener.getSchemaPath().lastNodeIdentifier(), schemaContext.getNotifications(), null,
 209                 listener.getOutputType(), uri);
 210
 211         tx.merge(LogicalDatastoreType.OPERATIONAL,
 212             Rfc8040.restconfStateStreamPath(mapToStreams.getIdentifier()), mapToStreams);
 213     }
 214
 215     @Override
 216     public Response putData(final String identifier, final NormalizedNodePayload payload, final UriInfo uriInfo) {
 217         requireNonNull(payload);
 218
 219         final WriteDataParams checkedParms = QueryParams.newWriteDataParams(uriInfo);
 220
 221         final InstanceIdentifierContext<? extends SchemaNode> iid = payload.getInstanceIdentifierContext();
 222
 223         validInputData(iid.getSchemaNode(), payload);
 224         validTopLevelNodeName(iid.getInstanceIdentifier(), payload);
 225         validateListKeysEqualityInPayloadAndUri(payload);
 226
 227         final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
 228         final EffectiveModelContext ref = mountPoint == null
 229                 ? schemaContextHandler.get() : modelContext(mountPoint);
 230
 231         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
 232         return PutDataTransactionUtil.putData(payload, ref, strategy, checkedParms.insert(), checkedParms.point());
 233     }
 234
 235     @Override
 236     public Response postData(final String identifier, final NormalizedNodePayload payload, final UriInfo uriInfo) {
 237         return postData(payload, uriInfo);
 238     }
 239
 240     @Override
 241     public Response postData(final NormalizedNodePayload payload, final UriInfo uriInfo) {
 242         requireNonNull(payload);
 243         if (payload.getInstanceIdentifierContext().getSchemaNode() instanceof ActionDefinition) {
 244             return invokeAction(payload);
 245         }
 246
 247         final WriteDataParams checkedParms = QueryParams.newWriteDataParams(uriInfo);
 248         final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
 249         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
 250         return PostDataTransactionUtil.postData(uriInfo, payload, strategy,
 251                 getSchemaContext(mountPoint), checkedParms.insert(), checkedParms.point());
 252     }
 253
 254     @Override
 255     public Response deleteData(final String identifier) {
 256         final InstanceIdentifierContext<?> instanceIdentifier = ParserIdentifier.toInstanceIdentifier(
 257                 identifier, schemaContextHandler.get(), Optional.of(mountPointService));
 258
 259         final DOMMountPoint mountPoint = instanceIdentifier.getMountPoint();
 260         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
 261         return DeleteDataTransactionUtil.deleteData(strategy, instanceIdentifier.getInstanceIdentifier());
 262     }
 263
 264     @Override
 265     public PatchStatusContext patchData(final String identifier, final PatchContext context, final UriInfo uriInfo) {
 266         return patchData(context, uriInfo);
 267     }
 268
 269     @Override
 270     public PatchStatusContext patchData(final PatchContext context, final UriInfo uriInfo) {
 271         final DOMMountPoint mountPoint = RestconfDocumentedException.throwIfNull(context,
 272             ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE, "No patch documented provided")
 273             .getInstanceIdentifierContext().getMountPoint();
 274         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
 275         return PatchDataTransactionUtil.patchData(context, strategy, getSchemaContext(mountPoint));
 276     }
 277
 278     @Override
 279     public Response patchData(final String identifier, final NormalizedNodePayload payload, final UriInfo uriInfo) {
 280         requireNonNull(payload);
 281
 282         final InstanceIdentifierContext<? extends SchemaNode> iid = payload.getInstanceIdentifierContext();
 283         validInputData(iid.getSchemaNode(), payload);
 284         validTopLevelNodeName(iid.getInstanceIdentifier(), payload);
 285         validateListKeysEqualityInPayloadAndUri(payload);
 286
 287         final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
 288         final EffectiveModelContext ref = mountPoint == null
 289                 ? schemaContextHandler.get() : modelContext(mountPoint);
 290         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
 291
 292         return PlainPatchDataTransactionUtil.patchData(payload, strategy, ref);
 293     }
 294
 295     private EffectiveModelContext getSchemaContext(final DOMMountPoint mountPoint) {
 296         return mountPoint == null ? schemaContextHandler.get() : modelContext(mountPoint);
 297     }
 298
 299     // FIXME: why is this synchronized?
 300     public synchronized RestconfStrategy getRestconfStrategy(final DOMMountPoint mountPoint) {
 301         if (mountPoint == null) {
 302             return restconfStrategy;
 303         }
 304
 305         return RestconfStrategy.forMountPoint(mountPoint).orElseThrow(() -> {
 306             LOG.warn("Mount point {} does not expose a suitable access interface", mountPoint.getIdentifier());
 307             return new RestconfDocumentedException("Could not find a supported access interface in mount point "
 308                 + mountPoint.getIdentifier());
 309         });
 310     }
 311
 312     /**
 313      * Invoke Action operation.
 314      *
 315      * @param payload {@link NormalizedNodePayload} - the body of the operation
 316      * @return {@link NormalizedNodePayload} wrapped in {@link Response}
 317      */
 318     public Response invokeAction(final NormalizedNodePayload payload) {
 319         final InstanceIdentifierContext<?> context = payload.getInstanceIdentifierContext();
 320         final DOMMountPoint mountPoint = context.getMountPoint();
 321         final Absolute schemaPath = Absolute.of(ImmutableList.copyOf(context.getSchemaNode().getPath()
 322             .getPathFromRoot()));
 323         final YangInstanceIdentifier yangIIdContext = context.getInstanceIdentifier();
 324         final NormalizedNode data = payload.getData();
 325
 326         if (yangIIdContext.isEmpty() && !NETCONF_BASE_QNAME.equals(data.getIdentifier().getNodeType())) {
 327             throw new RestconfDocumentedException("Instance identifier need to contain at least one path argument",
 328                 ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 329         }
 330
 331         final DOMActionResult response;
 332         final EffectiveModelContext schemaContextRef;
 333         if (mountPoint != null) {
 334             response = invokeAction((ContainerNode) data, schemaPath, yangIIdContext, mountPoint);
 335             schemaContextRef = modelContext(mountPoint);
 336         } else {
 337             response = invokeAction((ContainerNode) data, schemaPath, yangIIdContext, actionService);
 338             schemaContextRef = schemaContextHandler.get();
 339         }
 340         final DOMActionResult result = checkActionResponse(response);
 341
 342         ActionDefinition resultNodeSchema = null;
 343         ContainerNode resultData = null;
 344         if (result != null) {
 345             final Optional<ContainerNode> optOutput = result.getOutput();
 346             if (optOutput.isPresent()) {
 347                 resultData = optOutput.get();
 348                 resultNodeSchema = (ActionDefinition) context.getSchemaNode();
 349             }
 350         }
 351
 352         if (resultData != null && resultData.isEmpty()) {
 353             return Response.status(Status.NO_CONTENT).build();
 354         }
 355
 356         return Response.status(Status.OK)
 357             .entity(NormalizedNodePayload.ofNullable(
 358                 new InstanceIdentifierContext<>(yangIIdContext, resultNodeSchema, mountPoint, schemaContextRef),
 359                 resultData))
 360             .build();
 361     }
 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 }