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