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         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 = 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 List<YangInstanceIdentifier> fieldPaths = parameters.getFieldPaths();
 161         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
 162         final NormalizedNode node;
 163         if (fieldPaths != null && !fieldPaths.isEmpty()) {
 164             node = ReadDataTransactionUtil.readData(parameters.getContent(), instanceIdentifier.getInstanceIdentifier(),
 165                     strategy, parameters.getWithDefault(), schemaContextRef, fieldPaths);
 166         } else {
 167             node = ReadDataTransactionUtil.readData(parameters.getContent(), instanceIdentifier.getInstanceIdentifier(),
 168                     strategy, parameters.getWithDefault(), schemaContextRef);
 169         }
 170
 171         // FIXME: this is utter craziness, refactor it properly!
 172         if (identifier != null && identifier.contains(STREAM_PATH) && identifier.contains(STREAM_ACCESS_PATH_PART)
 173                 && identifier.contains(STREAM_LOCATION_PATH_PART)) {
 174             final String value = (String) node.body();
 175             final String streamName = value.substring(value.indexOf(NOTIFICATION_STREAM + '/'));
 176             delegRestconfSubscrService.subscribeToStream(streamName, uriInfo);
 177         }
 178         if (node == null) {
 179             throw new RestconfDocumentedException(
 180                     "Request could not be completed because the relevant data model content does not exist",
 181                     ErrorType.PROTOCOL, ErrorTag.DATA_MISSING);
 182         }
 183
 184         if (parameters.getContent().equals(RestconfDataServiceConstant.ReadData.ALL)
 185                     || parameters.getContent().equals(RestconfDataServiceConstant.ReadData.CONFIG)) {
 186             final QName type = node.getIdentifier().getNodeType();
 187             return Response.status(Status.OK)
 188                     .entity(new NormalizedNodeContext(instanceIdentifier, node, parameters))
 189                     .header("ETag", '"' + type.getModule().getRevision().map(Revision::toString).orElse(null)
 190                         + "-" + type.getLocalName() + '"')
 191                     .header("Last-Modified", FORMATTER.format(LocalDateTime.now(Clock.systemUTC())))
 192                     .build();
 193         }
 194
 195         return Response.status(Status.OK)
 196             .entity(new NormalizedNodeContext(instanceIdentifier, node, parameters))
 197             .build();
 198     }
 199
 200     private void createAllYangNotificationStreams(final EffectiveModelContext schemaContext, final UriInfo uriInfo) {
 201         final DOMDataTreeWriteTransaction transaction = dataBroker.newWriteOnlyTransaction();
 202         for (final NotificationDefinition notificationDefinition : schemaContext.getNotifications()) {
 203             writeNotificationStreamToDatastore(schemaContext, uriInfo, transaction,
 204                 CreateStreamUtil.createYangNotifiStream(notificationDefinition, schemaContext,
 205                     NotificationOutputType.XML));
 206             writeNotificationStreamToDatastore(schemaContext, uriInfo, transaction,
 207                 CreateStreamUtil.createYangNotifiStream(notificationDefinition, schemaContext,
 208                     NotificationOutputType.JSON));
 209         }
 210         try {
 211             transaction.commit().get();
 212         } catch (final InterruptedException | ExecutionException e) {
 213             throw new RestconfDocumentedException("Problem while putting data to DS.", e);
 214         }
 215     }
 216
 217     private void writeNotificationStreamToDatastore(final EffectiveModelContext schemaContext,
 218             final UriInfo uriInfo, final DOMDataTreeWriteOperations tx, final NotificationListenerAdapter listener) {
 219         final URI uri = streamUtils.prepareUriByStreamName(uriInfo, listener.getStreamName());
 220         final MapEntryNode mapToStreams = RestconfMappingNodeUtil.mapYangNotificationStreamByIetfRestconfMonitoring(
 221                 listener.getSchemaPath().lastNodeIdentifier(), schemaContext.getNotifications(), null,
 222                 listener.getOutputType(), uri);
 223
 224         tx.merge(LogicalDatastoreType.OPERATIONAL,
 225             Rfc8040.restconfStateStreamPath(mapToStreams.getIdentifier()), mapToStreams);
 226     }
 227
 228     @Override
 229     public Response putData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
 230         requireNonNull(payload);
 231
 232         final QueryParams checkedParms = checkQueryParameters(uriInfo);
 233
 234         final InstanceIdentifierContext<? extends SchemaNode> iid = payload.getInstanceIdentifierContext();
 235
 236         validInputData(iid.getSchemaNode(), payload);
 237         validTopLevelNodeName(iid.getInstanceIdentifier(), payload);
 238         validateListKeysEqualityInPayloadAndUri(payload);
 239
 240         final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
 241         final EffectiveModelContext ref = mountPoint == null
 242                 ? schemaContextHandler.get() : modelContext(mountPoint);
 243
 244         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
 245         return PutDataTransactionUtil.putData(payload, ref, strategy, checkedParms.insert, checkedParms.point);
 246     }
 247
 248     private static QueryParams checkQueryParameters(final UriInfo uriInfo) {
 249         boolean insertUsed = false;
 250         boolean pointUsed = false;
 251         Insert insert = null;
 252         String point = null;
 253
 254         for (final Entry<String, List<String>> entry : uriInfo.getQueryParameters().entrySet()) {
 255             switch (entry.getKey()) {
 256                 case INSERT:
 257                     if (insertUsed) {
 258                         throw new RestconfDocumentedException("Insert parameter can be used only once.",
 259                             ErrorType.PROTOCOL, ErrorTag.BAD_ELEMENT);
 260                     }
 261
 262                     insertUsed = true;
 263                     final String str = entry.getValue().get(0);
 264                     insert = Insert.forValue(str);
 265                     if (insert == null) {
 266                         throw new RestconfDocumentedException("Unrecognized insert parameter value '" + str + "'",
 267                             ErrorType.PROTOCOL, ErrorTag.BAD_ELEMENT);
 268                     }
 269                     break;
 270                 case POINT:
 271                     if (pointUsed) {
 272                         throw new RestconfDocumentedException("Point parameter can be used only once.",
 273                             ErrorType.PROTOCOL, ErrorTag.BAD_ELEMENT);
 274                     }
 275
 276                     pointUsed = true;
 277                     point = entry.getValue().get(0);
 278                     break;
 279                 default:
 280                     throw new RestconfDocumentedException("Bad parameter for post: " + entry.getKey(),
 281                             ErrorType.PROTOCOL, ErrorTag.BAD_ELEMENT);
 282             }
 283         }
 284
 285         checkQueryParams(insertUsed, pointUsed, insert);
 286         return new QueryParams(insert, point);
 287     }
 288
 289     private static void checkQueryParams(final boolean insertUsed, final boolean pointUsed, final Insert insert) {
 290         if (pointUsed) {
 291             if (!insertUsed) {
 292                 throw new RestconfDocumentedException("Point parameter can't be used without Insert parameter.",
 293                     ErrorType.PROTOCOL, ErrorTag.BAD_ELEMENT);
 294             }
 295
 296             if (insert != Insert.BEFORE && insert != Insert.AFTER) {
 297                 throw new RestconfDocumentedException(
 298                     "Point parameter can be used only with 'after' or 'before' values of Insert parameter.",
 299                     ErrorType.PROTOCOL, ErrorTag.BAD_ELEMENT);
 300             }
 301         }
 302     }
 303
 304     @Override
 305     public Response postData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
 306         return postData(payload, uriInfo);
 307     }
 308
 309     @Override
 310     public Response postData(final NormalizedNodeContext payload, final UriInfo uriInfo) {
 311         requireNonNull(payload);
 312         if (payload.getInstanceIdentifierContext().getSchemaNode() instanceof ActionDefinition) {
 313             return invokeAction(payload);
 314         }
 315
 316         final QueryParams checkedParms = checkQueryParameters(uriInfo);
 317         final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
 318         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
 319         return PostDataTransactionUtil.postData(uriInfo, payload, strategy,
 320                 getSchemaContext(mountPoint), checkedParms.insert, checkedParms.point);
 321     }
 322
 323     @Override
 324     public Response deleteData(final String identifier) {
 325         final InstanceIdentifierContext<?> instanceIdentifier = ParserIdentifier.toInstanceIdentifier(
 326                 identifier, schemaContextHandler.get(), Optional.of(mountPointService));
 327
 328         final DOMMountPoint mountPoint = instanceIdentifier.getMountPoint();
 329         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
 330         return DeleteDataTransactionUtil.deleteData(strategy, instanceIdentifier.getInstanceIdentifier());
 331     }
 332
 333     @Override
 334     public PatchStatusContext patchData(final String identifier, final PatchContext context, final UriInfo uriInfo) {
 335         return patchData(context, uriInfo);
 336     }
 337
 338     @Override
 339     public PatchStatusContext patchData(final PatchContext context, final UriInfo uriInfo) {
 340         final DOMMountPoint mountPoint = RestconfDocumentedException.throwIfNull(context,
 341             ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE, "No patch documented provided")
 342             .getInstanceIdentifierContext().getMountPoint();
 343         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
 344         return PatchDataTransactionUtil.patchData(context, strategy, getSchemaContext(mountPoint));
 345     }
 346
 347     @Override
 348     public Response patchData(final String identifier, final NormalizedNodeContext payload, final UriInfo uriInfo) {
 349         requireNonNull(payload);
 350
 351         final InstanceIdentifierContext<? extends SchemaNode> iid = payload.getInstanceIdentifierContext();
 352         validInputData(iid.getSchemaNode(), payload);
 353         validTopLevelNodeName(iid.getInstanceIdentifier(), payload);
 354         validateListKeysEqualityInPayloadAndUri(payload);
 355
 356         final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
 357         final EffectiveModelContext ref = mountPoint == null
 358                 ? schemaContextHandler.get() : modelContext(mountPoint);
 359         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
 360
 361         return PlainPatchDataTransactionUtil.patchData(payload, strategy, ref);
 362     }
 363
 364     private EffectiveModelContext getSchemaContext(final DOMMountPoint mountPoint) {
 365         return mountPoint == null ? schemaContextHandler.get() : modelContext(mountPoint);
 366     }
 367
 368     // FIXME: why is this synchronized?
 369     public synchronized RestconfStrategy getRestconfStrategy(final DOMMountPoint mountPoint) {
 370         if (mountPoint == null) {
 371             return restconfStrategy;
 372         }
 373
 374         return RestconfStrategy.forMountPoint(mountPoint).orElseThrow(() -> {
 375             LOG.warn("Mount point {} does not expose a suitable access interface", mountPoint.getIdentifier());
 376             return new RestconfDocumentedException("Could not find a supported access interface in mount point "
 377                 + mountPoint.getIdentifier());
 378         });
 379     }
 380
 381     /**
 382      * Invoke Action operation.
 383      *
 384      * @param payload {@link NormalizedNodeContext} - the body of the operation
 385      * @return {@link NormalizedNodeContext} wrapped in {@link Response}
 386      */
 387     public Response invokeAction(final NormalizedNodeContext payload) {
 388         final InstanceIdentifierContext<?> context = payload.getInstanceIdentifierContext();
 389         final DOMMountPoint mountPoint = context.getMountPoint();
 390         final Absolute schemaPath = Absolute.of(ImmutableList.copyOf(context.getSchemaNode().getPath()
 391             .getPathFromRoot()));
 392         final YangInstanceIdentifier yangIIdContext = context.getInstanceIdentifier();
 393         final NormalizedNode data = payload.getData();
 394
 395         if (yangIIdContext.isEmpty()
 396             && !RestconfDataServiceConstant.NETCONF_BASE_QNAME.equals(data.getIdentifier().getNodeType())) {
 397             throw new RestconfDocumentedException("Instance identifier need to contain at least one path argument",
 398                 ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 399         }
 400
 401         final DOMActionResult response;
 402         final EffectiveModelContext schemaContextRef;
 403         if (mountPoint != null) {
 404             response = invokeAction((ContainerNode) data, schemaPath, yangIIdContext, mountPoint);
 405             schemaContextRef = modelContext(mountPoint);
 406         } else {
 407             response = invokeAction((ContainerNode) data, schemaPath, yangIIdContext, actionService);
 408             schemaContextRef = schemaContextHandler.get();
 409         }
 410         final DOMActionResult result = checkActionResponse(response);
 411
 412         ActionDefinition resultNodeSchema = null;
 413         ContainerNode resultData = null;
 414         if (result != null) {
 415             final Optional<ContainerNode> optOutput = result.getOutput();
 416             if (optOutput.isPresent()) {
 417                 resultData = optOutput.get();
 418                 resultNodeSchema = (ActionDefinition) context.getSchemaNode();
 419             }
 420         }
 421
 422         if (resultData != null && resultData.isEmpty()) {
 423             return Response.status(Status.NO_CONTENT).build();
 424         }
 425
 426         return Response.status(Status.OK)
 427             .entity(new NormalizedNodeContext(
 428                 new InstanceIdentifierContext<>(yangIIdContext, resultNodeSchema, mountPoint, schemaContextRef),
 429                 resultData))
 430             .build();
 431     }
 432
 433
 434     /**
 435      * Invoking Action via mount point.
 436      *
 437      * @param mountPoint mount point
 438      * @param data input data
 439      * @param schemaPath schema path of data
 440      * @return {@link DOMActionResult}
 441      */
 442     private static DOMActionResult invokeAction(final ContainerNode data,
 443             final Absolute schemaPath, final YangInstanceIdentifier yangIId, final DOMMountPoint mountPoint) {
 444         return invokeAction(data, schemaPath, yangIId, mountPoint.getService(DOMActionService.class)
 445             .orElseThrow(() -> new RestconfDocumentedException("DomAction service is missing.")));
 446     }
 447
 448     /**
 449      * Invoke Action via ActionServiceHandler.
 450      *
 451      * @param data input data
 452      * @param yangIId invocation context
 453      * @param schemaPath schema path of data
 454      * @param actionService action service to invoke action
 455      * @return {@link DOMActionResult}
 456      */
 457     // FIXME: NETCONF-718: we should be returning a future here
 458     private static DOMActionResult invokeAction(final ContainerNode data, final Absolute schemaPath,
 459             final YangInstanceIdentifier yangIId, final DOMActionService actionService) {
 460         return RestconfInvokeOperationsServiceImpl.checkedGet(Futures.catching(actionService.invokeAction(
 461             schemaPath, new DOMDataTreeIdentifier(LogicalDatastoreType.OPERATIONAL, yangIId.getParent()), data),
 462             DOMActionException.class,
 463             cause -> new SimpleDOMActionResult(ImmutableList.of(RpcResultBuilder.newError(
 464                 RpcError.ErrorType.RPC, "operation-failed", cause.getMessage()))),
 465             MoreExecutors.directExecutor()));
 466     }
 467
 468     /**
 469      * Check the validity of the result.
 470      *
 471      * @param response response of Action
 472      * @return {@link DOMActionResult} result
 473      */
 474     private static DOMActionResult checkActionResponse(final DOMActionResult response) {
 475         if (response == null) {
 476             return null;
 477         }
 478
 479         try {
 480             if (response.getErrors().isEmpty()) {
 481                 return response;
 482             }
 483             LOG.debug("InvokeAction Error Message {}", response.getErrors());
 484             throw new RestconfDocumentedException("InvokeAction Error Message ", null, response.getErrors());
 485         } catch (final CancellationException e) {
 486             final String errMsg = "The Action Operation was cancelled while executing.";
 487             LOG.debug("Cancel Execution: {}", errMsg, e);
 488             throw new RestconfDocumentedException(errMsg, ErrorType.RPC, ErrorTag.PARTIAL_OPERATION, e);
 489         }
 490     }
 491
 492     /**
 493      * Valid input data with {@link SchemaNode}.
 494      *
 495      * @param schemaNode {@link SchemaNode}
 496      * @param payload    input data
 497      */
 498     @VisibleForTesting
 499     public static void validInputData(final SchemaNode schemaNode, final NormalizedNodeContext payload) {
 500         if (schemaNode != null && payload.getData() == null) {
 501             throw new RestconfDocumentedException("Input is required.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 502         } else if (schemaNode == null && payload.getData() != null) {
 503             throw new RestconfDocumentedException("No input expected.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 504         }
 505     }
 506
 507     /**
 508      * Valid top level node name.
 509      *
 510      * @param path    path of node
 511      * @param payload data
 512      */
 513     @VisibleForTesting
 514     public static void validTopLevelNodeName(final YangInstanceIdentifier path, final NormalizedNodeContext payload) {
 515         final String payloadName = payload.getData().getIdentifier().getNodeType().getLocalName();
 516
 517         if (path.isEmpty()) {
 518             if (!payload.getData().getIdentifier().getNodeType().equals(
 519                 RestconfDataServiceConstant.NETCONF_BASE_QNAME)) {
 520                 throw new RestconfDocumentedException("Instance identifier has to contain at least one path argument",
 521                         ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 522             }
 523         } else {
 524             final String identifierName = path.getLastPathArgument().getNodeType().getLocalName();
 525             if (!payloadName.equals(identifierName)) {
 526                 throw new RestconfDocumentedException(
 527                         "Payload name (" + payloadName + ") is different from identifier name (" + identifierName + ")",
 528                         ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 529             }
 530         }
 531     }
 532
 533
 534     /**
 535      * Validates whether keys in {@code payload} are equal to values of keys in
 536      * {@code iiWithData} for list schema node.
 537      *
 538      * @throws RestconfDocumentedException if key values or key count in payload and URI isn't equal
 539      */
 540     @VisibleForTesting
 541     public static void validateListKeysEqualityInPayloadAndUri(final NormalizedNodeContext payload) {
 542         final InstanceIdentifierContext<?> iiWithData = payload.getInstanceIdentifierContext();
 543         final PathArgument lastPathArgument = iiWithData.getInstanceIdentifier().getLastPathArgument();
 544         final SchemaNode schemaNode = iiWithData.getSchemaNode();
 545         final NormalizedNode data = payload.getData();
 546         if (schemaNode instanceof ListSchemaNode) {
 547             final List<QName> keyDefinitions = ((ListSchemaNode) schemaNode).getKeyDefinition();
 548             if (lastPathArgument instanceof NodeIdentifierWithPredicates && data instanceof MapEntryNode) {
 549                 final Map<QName, Object> uriKeyValues = ((NodeIdentifierWithPredicates) lastPathArgument).asMap();
 550                 isEqualUriAndPayloadKeyValues(uriKeyValues, (MapEntryNode) data, keyDefinitions);
 551             }
 552         }
 553     }
 554
 555     private static void isEqualUriAndPayloadKeyValues(final Map<QName, Object> uriKeyValues, final MapEntryNode payload,
 556             final List<QName> keyDefinitions) {
 557         final Map<QName, Object> mutableCopyUriKeyValues = new HashMap<>(uriKeyValues);
 558         for (final QName keyDefinition : keyDefinitions) {
 559             final Object uriKeyValue = RestconfDocumentedException.throwIfNull(
 560                     mutableCopyUriKeyValues.remove(keyDefinition), ErrorType.PROTOCOL, ErrorTag.DATA_MISSING,
 561                     "Missing key %s in URI.", keyDefinition);
 562
 563             final Object dataKeyValue = payload.getIdentifier().getValue(keyDefinition);
 564
 565             if (!uriKeyValue.equals(dataKeyValue)) {
 566                 final String errMsg = "The value '" + uriKeyValue + "' for key '" + keyDefinition.getLocalName()
 567                         + "' specified in the URI doesn't match the value '" + dataKeyValue
 568                         + "' specified in the message body. ";
 569                 throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
 570             }
 571         }
 572     }
 573
 574     private static EffectiveModelContext modelContext(final DOMMountPoint mountPoint) {
 575         return mountPoint.getService(DOMSchemaService.class)
 576             .flatMap(svc -> Optional.ofNullable(svc.getGlobalContext()))
 577             .orElse(null);
 578     }
 579 }