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