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.Response.Status;
  35 import javax.ws.rs.core.UriInfo;
  36 import org.eclipse.jdt.annotation.Nullable;
  37 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  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.DOMDataTreeWriteOperations;
  42 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  43 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
  44 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
  45 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
  46 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
  47 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
  48 import org.opendaylight.restconf.common.context.WriterParameters;
  49 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  50 import org.opendaylight.restconf.common.errors.RestconfError;
  51 import org.opendaylight.restconf.common.errors.RestconfError.ErrorTag;
  52 import org.opendaylight.restconf.common.patch.PatchContext;
  53 import org.opendaylight.restconf.common.patch.PatchStatusContext;
  54 import org.opendaylight.restconf.nb.rfc8040.Rfc8040;
  55 import org.opendaylight.restconf.nb.rfc8040.handlers.SchemaContextHandler;
  56 import org.opendaylight.restconf.nb.rfc8040.rests.services.api.RestconfDataService;
  57 import org.opendaylight.restconf.nb.rfc8040.rests.services.api.RestconfStreamsSubscriptionService;
  58 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.MdsalRestconfStrategy;
  59 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.RestconfStrategy;
  60 import org.opendaylight.restconf.nb.rfc8040.rests.utils.DeleteDataTransactionUtil;
  61 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PatchDataTransactionUtil;
  62 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PlainPatchDataTransactionUtil;
  63 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PostDataTransactionUtil;
  64 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PutDataTransactionUtil;
  65 import org.opendaylight.restconf.nb.rfc8040.rests.utils.ReadDataTransactionUtil;
  66 import org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfDataServiceConstant;
  67 import org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfDataServiceConstant.PostPutQueryParameters.Insert;
  68 import org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfInvokeOperationsUtil;
  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.concepts.Immutable;
  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.data.api.YangInstanceIdentifier;
  79 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  80 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  81 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  82 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  83 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  84 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
  85 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  86 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  87 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  88 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  89 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  90 import org.slf4j.Logger;
  91 import org.slf4j.LoggerFactory;
  92
  93 /**
  94  * Implementation of {@link RestconfDataService}.
  95  */
  96 @Path("/")
  97 public class RestconfDataServiceImpl implements RestconfDataService {
  98     // FIXME: we should be able to interpret 'point' and refactor this class into a behavior
  99     private static final class QueryParams implements Immutable {
 100         final @Nullable String point;
 101         final @Nullable Insert insert;
 102
 103         QueryParams(final @Nullable Insert insert, final @Nullable String point) {
 104             this.insert = insert;
 105             this.point = point;
 106         }
 107     }
 108
 109     private static final Logger LOG = LoggerFactory.getLogger(RestconfDataServiceImpl.class);
 110     private static final DateTimeFormatter FORMATTER = DateTimeFormatter.ofPattern("yyyy-MMM-dd HH:mm:ss");
 111
 112     private final RestconfStreamsSubscriptionService delegRestconfSubscrService;
 113     private final SchemaContextHandler schemaContextHandler;
 114     private final MdsalRestconfStrategy restconfStrategy;
 115     private final DOMMountPointService mountPointService;
 116     private final SubscribeToStreamUtil streamUtils;
 117     private final DOMActionService actionService;
 118     private final DOMDataBroker dataBroker;
 119
 120     public RestconfDataServiceImpl(final SchemaContextHandler schemaContextHandler,
 121             final DOMDataBroker dataBroker, final DOMMountPointService  mountPointService,
 122             final RestconfStreamsSubscriptionService delegRestconfSubscrService,
 123             final DOMActionService actionService, final Configuration configuration) {
 124         this.schemaContextHandler = requireNonNull(schemaContextHandler);
 125         this.dataBroker = requireNonNull(dataBroker);
 126         this.restconfStrategy = new MdsalRestconfStrategy(dataBroker);
 127         this.mountPointService = requireNonNull(mountPointService);
 128         this.delegRestconfSubscrService = requireNonNull(delegRestconfSubscrService);
 129         this.actionService = requireNonNull(actionService);
 130         streamUtils = configuration.isUseSSE() ? SubscribeToStreamUtil.serverSentEvents()
 131                 : SubscribeToStreamUtil.webSockets();
 132     }
 133
 134     @Override
 135     public Response readData(final UriInfo uriInfo) {
 136         return readData(null, uriInfo);
 137     }
 138
 139     @Override
 140     public Response readData(final String identifier, final UriInfo uriInfo) {
 141         final EffectiveModelContext schemaContextRef = this.schemaContextHandler.get();
 142         final InstanceIdentifierContext<?> instanceIdentifier = ParserIdentifier.toInstanceIdentifier(
 143                 identifier, schemaContextRef, Optional.of(mountPointService));
 144         final WriterParameters parameters = ReadDataTransactionUtil.parseUriParameters(instanceIdentifier, uriInfo);
 145
 146         final DOMMountPoint mountPoint = instanceIdentifier.getMountPoint();
 147
 148         // FIXME: this looks quite crazy, why do we even have it?
 149         if (mountPoint == null && identifier != null && identifier.contains(STREAMS_PATH)
 150             && !identifier.contains(STREAM_PATH_PART)) {
 151             createAllYangNotificationStreams(schemaContextRef, uriInfo);
 152         }
 153
 154         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
 155         final NormalizedNode node;
 156         if (parameters.getFieldPaths() != null && !parameters.getFieldPaths().isEmpty()) {
 157             node = ReadDataTransactionUtil.readData(parameters.getContent(), instanceIdentifier.getInstanceIdentifier(),
 158                     strategy, parameters.getWithDefault(), schemaContextRef, parameters.getFieldPaths());
 159         } else {
 160             node = ReadDataTransactionUtil.readData(parameters.getContent(), instanceIdentifier.getInstanceIdentifier(),
 161                     strategy, parameters.getWithDefault(), schemaContextRef);
 162         }
 163
 164         // FIXME: this is utter craziness, refactor it properly!
 165         if (identifier != null && identifier.contains(STREAM_PATH) && identifier.contains(STREAM_ACCESS_PATH_PART)
 166                 && identifier.contains(STREAM_LOCATION_PATH_PART)) {
 167             final String value = (String) node.body();
 168             final String streamName = value.substring(value.indexOf(NOTIFICATION_STREAM + '/'));
 169             this.delegRestconfSubscrService.subscribeToStream(streamName, uriInfo);
 170         }
 171         if (node == null) {
 172             throw new RestconfDocumentedException(
 173                     "Request could not be completed because the relevant data model content does not exist",
 174                     ErrorType.PROTOCOL, RestconfError.ErrorTag.DATA_MISSING);
 175         }
 176
 177         if (parameters.getContent().equals(RestconfDataServiceConstant.ReadData.ALL)
 178                     || parameters.getContent().equals(RestconfDataServiceConstant.ReadData.CONFIG)) {
 179             final QName type = node.getIdentifier().getNodeType();
 180             return Response.status(Status.OK)
 181                     .entity(new NormalizedNodeContext(instanceIdentifier, node, parameters))
 182                     .header("ETag", '"' + type.getModule().getRevision().map(Revision::toString).orElse(null)
 183                         + "-" + type.getLocalName() + '"')
 184                     .header("Last-Modified", FORMATTER.format(LocalDateTime.now(Clock.systemUTC())))
 185                     .build();
 186         }
 187
 188         return Response.status(Status.OK)
 189             .entity(new NormalizedNodeContext(instanceIdentifier, node, parameters))
 190             .build();
 191     }
 192
 193     private void createAllYangNotificationStreams(final EffectiveModelContext schemaContext, final UriInfo uriInfo) {
 194         final DOMDataTreeWriteTransaction transaction = dataBroker.newWriteOnlyTransaction();
 195         for (final NotificationDefinition notificationDefinition : schemaContext.getNotifications()) {
 196             writeNotificationStreamToDatastore(schemaContext, uriInfo, transaction,
 197                 CreateStreamUtil.createYangNotifiStream(notificationDefinition, schemaContext,
 198                     NotificationOutputType.XML));
 199             writeNotificationStreamToDatastore(schemaContext, uriInfo, transaction,
 200                 CreateStreamUtil.createYangNotifiStream(notificationDefinition, schemaContext,
 201                     NotificationOutputType.JSON));
 202         }
 203         try {
 204             transaction.commit().get();
 205         } catch (final InterruptedException | ExecutionException e) {
 206             throw new RestconfDocumentedException("Problem while putting data to DS.", e);
 207         }
 208     }
 209
 210     private void writeNotificationStreamToDatastore(final EffectiveModelContext schemaContext,
 211             final UriInfo uriInfo, final DOMDataTreeWriteOperations tx, final NotificationListenerAdapter listener) {
 212         final URI uri = streamUtils.prepareUriByStreamName(uriInfo, listener.getStreamName());
 213         final MapEntryNode mapToStreams = RestconfMappingNodeUtil.mapYangNotificationStreamByIetfRestconfMonitoring(
 214                 listener.getSchemaPath().lastNodeIdentifier(), schemaContext.getNotifications(), null,
 215                 listener.getOutputType(), uri);
 216
 217         tx.merge(LogicalDatastoreType.OPERATIONAL,
 218             Rfc8040.restconfStateStreamPath(mapToStreams.getIdentifier()), mapToStreams);
 219     }
 220
 221     @Override
 222     public Response putData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
 223         requireNonNull(payload);
 224
 225         final QueryParams checkedParms = checkQueryParameters(uriInfo);
 226
 227         final InstanceIdentifierContext<? extends SchemaNode> iid = payload.getInstanceIdentifierContext();
 228
 229         validInputData(iid.getSchemaNode(), payload);
 230         validTopLevelNodeName(iid.getInstanceIdentifier(), payload);
 231         validateListKeysEqualityInPayloadAndUri(payload);
 232
 233         final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
 234         final EffectiveModelContext ref = mountPoint == null
 235                 ? this.schemaContextHandler.get() : modelContext(mountPoint);
 236
 237         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
 238         return PutDataTransactionUtil.putData(payload, ref, strategy, checkedParms.insert, checkedParms.point);
 239     }
 240
 241     private static QueryParams checkQueryParameters(final UriInfo uriInfo) {
 242         boolean insertUsed = false;
 243         boolean pointUsed = false;
 244         Insert insert = null;
 245         String point = null;
 246
 247         for (final Entry<String, List<String>> entry : uriInfo.getQueryParameters().entrySet()) {
 248             switch (entry.getKey()) {
 249                 case INSERT:
 250                     if (insertUsed) {
 251                         throw new RestconfDocumentedException("Insert parameter can be used only once.",
 252                             ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
 253                     }
 254
 255                     insertUsed = true;
 256                     final String str = entry.getValue().get(0);
 257                     insert = Insert.forValue(str);
 258                     if (insert == null) {
 259                         throw new RestconfDocumentedException("Unrecognized insert parameter value '" + str + "'",
 260                             ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
 261                     }
 262                     break;
 263                 case POINT:
 264                     if (pointUsed) {
 265                         throw new RestconfDocumentedException("Point parameter can be used only once.",
 266                             ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
 267                     }
 268
 269                     pointUsed = true;
 270                     point = entry.getValue().get(0);
 271                     break;
 272                 default:
 273                     throw new RestconfDocumentedException("Bad parameter for post: " + entry.getKey(),
 274                             ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
 275             }
 276         }
 277
 278         checkQueryParams(insertUsed, pointUsed, insert);
 279         return new QueryParams(insert, point);
 280     }
 281
 282     private static void checkQueryParams(final boolean insertUsed, final boolean pointUsed, final Insert insert) {
 283         if (pointUsed) {
 284             if (!insertUsed) {
 285                 throw new RestconfDocumentedException("Point parameter can't be used without Insert parameter.",
 286                     ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
 287             }
 288
 289             if (insert != Insert.BEFORE && insert != Insert.AFTER) {
 290                 throw new RestconfDocumentedException(
 291                     "Point parameter can be used only with 'after' or 'before' values of Insert parameter.",
 292                     ErrorType.PROTOCOL, RestconfError.ErrorTag.BAD_ELEMENT);
 293             }
 294         }
 295     }
 296
 297     @Override
 298     public Response postData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
 299         return postData(payload, uriInfo);
 300     }
 301
 302     @Override
 303     public Response postData(final NormalizedNodeContext payload, final UriInfo uriInfo) {
 304         requireNonNull(payload);
 305         if (payload.getInstanceIdentifierContext().getSchemaNode() instanceof ActionDefinition) {
 306             return invokeAction(payload);
 307         }
 308
 309         final QueryParams checkedParms = checkQueryParameters(uriInfo);
 310         final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
 311         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
 312         return PostDataTransactionUtil.postData(uriInfo, payload, strategy,
 313                 getSchemaContext(mountPoint), checkedParms.insert, checkedParms.point);
 314     }
 315
 316     @Override
 317     public Response deleteData(final String identifier) {
 318         final InstanceIdentifierContext<?> instanceIdentifier = ParserIdentifier.toInstanceIdentifier(
 319                 identifier, this.schemaContextHandler.get(), Optional.of(mountPointService));
 320
 321         final DOMMountPoint mountPoint = instanceIdentifier.getMountPoint();
 322         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
 323         return DeleteDataTransactionUtil.deleteData(strategy, instanceIdentifier.getInstanceIdentifier());
 324     }
 325
 326     @Override
 327     public PatchStatusContext patchData(final String identifier, final PatchContext context, final UriInfo uriInfo) {
 328         return patchData(context, uriInfo);
 329     }
 330
 331     @Override
 332     public PatchStatusContext patchData(final PatchContext context, final UriInfo uriInfo) {
 333         final DOMMountPoint mountPoint = RestconfDocumentedException.throwIfNull(context,
 334             ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE, "No patch documented provided")
 335             .getInstanceIdentifierContext().getMountPoint();
 336         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
 337         return PatchDataTransactionUtil.patchData(context, strategy, getSchemaContext(mountPoint));
 338     }
 339
 340     @Override
 341     public Response patchData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
 342         requireNonNull(payload);
 343
 344         final InstanceIdentifierContext<? extends SchemaNode> iid = payload.getInstanceIdentifierContext();
 345         validInputData(iid.getSchemaNode(), payload);
 346         validTopLevelNodeName(iid.getInstanceIdentifier(), payload);
 347         validateListKeysEqualityInPayloadAndUri(payload);
 348
 349         final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
 350         final EffectiveModelContext ref = mountPoint == null
 351                 ? this.schemaContextHandler.get() : modelContext(mountPoint);
 352         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
 353
 354         return PlainPatchDataTransactionUtil.patchData(payload, strategy, ref);
 355     }
 356
 357     private EffectiveModelContext getSchemaContext(final DOMMountPoint mountPoint) {
 358         return mountPoint == null ? schemaContextHandler.get() : modelContext(mountPoint);
 359     }
 360
 361     // FIXME: why is this synchronized?
 362     public synchronized RestconfStrategy getRestconfStrategy(final DOMMountPoint mountPoint) {
 363         if (mountPoint == null) {
 364             return restconfStrategy;
 365         }
 366
 367         return RestconfStrategy.forMountPoint(mountPoint).orElseThrow(() -> {
 368             LOG.warn("Mount point {} does not expose a suitable access interface", mountPoint.getIdentifier());
 369             return new RestconfDocumentedException("Could not find a supported access interface in mount point "
 370                 + mountPoint.getIdentifier());
 371         });
 372     }
 373
 374     /**
 375      * Invoke Action operation.
 376      *
 377      * @param payload {@link NormalizedNodeContext} - the body of the operation
 378      * @return {@link NormalizedNodeContext} wrapped in {@link Response}
 379      */
 380     public Response invokeAction(final NormalizedNodeContext payload) {
 381         final InstanceIdentifierContext<?> context = payload.getInstanceIdentifierContext();
 382         final DOMMountPoint mountPoint = context.getMountPoint();
 383         final Absolute schemaPath = Absolute.of(ImmutableList.copyOf(context.getSchemaNode().getPath()
 384             .getPathFromRoot()));
 385         final YangInstanceIdentifier yangIIdContext = context.getInstanceIdentifier();
 386         final NormalizedNode data = payload.getData();
 387
 388         if (yangIIdContext.isEmpty()
 389             && !RestconfDataServiceConstant.NETCONF_BASE_QNAME.equals(data.getIdentifier().getNodeType())) {
 390             throw new RestconfDocumentedException("Instance identifier need to contain at least one path argument",
 391                 ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 392         }
 393
 394         final DOMActionResult response;
 395         final EffectiveModelContext schemaContextRef;
 396         if (mountPoint != null) {
 397             response = RestconfInvokeOperationsUtil.invokeAction((ContainerNode) data, schemaPath, yangIIdContext,
 398                 mountPoint);
 399             schemaContextRef = modelContext(mountPoint);
 400         } else {
 401             response = RestconfInvokeOperationsUtil.invokeAction((ContainerNode) data, schemaPath, yangIIdContext,
 402                 actionService);
 403             schemaContextRef = this.schemaContextHandler.get();
 404         }
 405         final DOMActionResult result = RestconfInvokeOperationsUtil.checkActionResponse(response);
 406
 407         ActionDefinition resultNodeSchema = null;
 408         ContainerNode resultData = null;
 409         if (result != null) {
 410             final Optional<ContainerNode> optOutput = result.getOutput();
 411             if (optOutput.isPresent()) {
 412                 resultData = optOutput.get();
 413                 resultNodeSchema = (ActionDefinition) context.getSchemaNode();
 414             }
 415         }
 416
 417         if (resultData != null && resultData.isEmpty()) {
 418             return Response.status(Status.NO_CONTENT).build();
 419         }
 420
 421         return Response.status(Status.OK)
 422             .entity(new NormalizedNodeContext(
 423                 new InstanceIdentifierContext<>(yangIIdContext, resultNodeSchema, mountPoint, schemaContextRef),
 424                 resultData))
 425             .build();
 426     }
 427
 428     /**
 429      * Valid input data with {@link SchemaNode}.
 430      *
 431      * @param schemaNode {@link SchemaNode}
 432      * @param payload    input data
 433      */
 434     @VisibleForTesting
 435     public static void validInputData(final SchemaNode schemaNode, final NormalizedNodeContext payload) {
 436         if (schemaNode != null && payload.getData() == null) {
 437             throw new RestconfDocumentedException("Input is required.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 438         } else if (schemaNode == null && payload.getData() != null) {
 439             throw new RestconfDocumentedException("No input expected.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 440         }
 441     }
 442
 443     /**
 444      * Valid top level node name.
 445      *
 446      * @param path    path of node
 447      * @param payload data
 448      */
 449     @VisibleForTesting
 450     public static void validTopLevelNodeName(final YangInstanceIdentifier path, final NormalizedNodeContext payload) {
 451         final String payloadName = payload.getData().getIdentifier().getNodeType().getLocalName();
 452
 453         if (path.isEmpty()) {
 454             if (!payload.getData().getIdentifier().getNodeType().equals(
 455                 RestconfDataServiceConstant.NETCONF_BASE_QNAME)) {
 456                 throw new RestconfDocumentedException("Instance identifier has to contain at least one path argument",
 457                         ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 458             }
 459         } else {
 460             final String identifierName = path.getLastPathArgument().getNodeType().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 NormalizedNodeContext 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 }