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