restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/rests/services/impl/RestconfDataServiceImpl.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.restconf.nb.rfc8040.rests.services.impl;
   9
  10 import static java.util.Objects.requireNonNull;
  11 import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.NOTIFICATION_STREAM;
  12 import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.STREAMS_PATH;
  13 import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.STREAM_ACCESS_PATH_PART;
  14 import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.STREAM_LOCATION_PATH_PART;
  15 import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.STREAM_PATH;
  16 import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.STREAM_PATH_PART;
  17
  18 import com.google.common.annotations.VisibleForTesting;
  19 import com.google.common.collect.ImmutableList;
  20 import com.google.common.util.concurrent.Futures;
  21 import com.google.common.util.concurrent.MoreExecutors;
  22 import java.net.URI;
  23 import java.time.Clock;
  24 import java.time.LocalDateTime;
  25 import java.time.format.DateTimeFormatter;
  26 import java.util.HashMap;
  27 import java.util.List;
  28 import java.util.Map;
  29 import java.util.Map.Entry;
  30 import java.util.Optional;
  31 import java.util.concurrent.CancellationException;
  32 import java.util.concurrent.ExecutionException;
  33 import javax.ws.rs.Path;
  34 import javax.ws.rs.core.Response;
  35 import javax.ws.rs.core.Response.Status;
  36 import javax.ws.rs.core.UriInfo;
  37 import org.eclipse.jdt.annotation.Nullable;
  38 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  39 import org.opendaylight.mdsal.dom.api.DOMActionException;
  40 import org.opendaylight.mdsal.dom.api.DOMActionResult;
  41 import org.opendaylight.mdsal.dom.api.DOMActionService;
  42 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  43 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  44 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteOperations;
  45 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  46 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
  47 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
  48 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
  49 import org.opendaylight.mdsal.dom.spi.SimpleDOMActionResult;
  50 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
  51 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  52 import org.opendaylight.restconf.common.patch.PatchContext;
  53 import org.opendaylight.restconf.common.patch.PatchStatusContext;
  54 import org.opendaylight.restconf.nb.rfc8040.InsertParameter;
  55 import org.opendaylight.restconf.nb.rfc8040.PointParameter;
  56 import org.opendaylight.restconf.nb.rfc8040.Rfc8040;
  57 import org.opendaylight.restconf.nb.rfc8040.handlers.SchemaContextHandler;
  58 import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
  59 import org.opendaylight.restconf.nb.rfc8040.legacy.QueryParameters;
  60 import org.opendaylight.restconf.nb.rfc8040.rests.services.api.RestconfDataService;
  61 import org.opendaylight.restconf.nb.rfc8040.rests.services.api.RestconfStreamsSubscriptionService;
  62 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.MdsalRestconfStrategy;
  63 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.RestconfStrategy;
  64 import org.opendaylight.restconf.nb.rfc8040.rests.utils.DeleteDataTransactionUtil;
  65 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PatchDataTransactionUtil;
  66 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PlainPatchDataTransactionUtil;
  67 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PostDataTransactionUtil;
  68 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PutDataTransactionUtil;
  69 import org.opendaylight.restconf.nb.rfc8040.rests.utils.ReadDataTransactionUtil;
  70 import org.opendaylight.restconf.nb.rfc8040.streams.Configuration;
  71 import org.opendaylight.restconf.nb.rfc8040.streams.listeners.NotificationListenerAdapter;
  72 import org.opendaylight.restconf.nb.rfc8040.utils.mapping.RestconfMappingNodeUtil;
  73 import org.opendaylight.restconf.nb.rfc8040.utils.parser.ParserIdentifier;
  74 import org.opendaylight.yang.gen.v1.urn.sal.restconf.event.subscription.rev140708.NotificationOutputTypeGrouping.NotificationOutputType;
  75 import org.opendaylight.yangtools.concepts.Immutable;
  76 import org.opendaylight.yangtools.yang.common.ErrorTag;
  77 import org.opendaylight.yangtools.yang.common.ErrorType;
  78 import org.opendaylight.yangtools.yang.common.QName;
  79 import org.opendaylight.yangtools.yang.common.Revision;
  80 import org.opendaylight.yangtools.yang.common.RpcError;
  81 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  82 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  83 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  84 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  85 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  86 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  87 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  88 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
  89 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  90 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  91 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  92 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  93 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  94 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  95 import org.slf4j.Logger;
  96 import org.slf4j.LoggerFactory;
  97
  98 /**
  99  * Implementation of {@link RestconfDataService}.
 100  */
 101 @Path("/")
 102 public class RestconfDataServiceImpl implements RestconfDataService {
 103     // FIXME: we should be able to interpret 'point' and refactor this class into a behavior
 104     private static final class QueryParams implements Immutable {
 105         final @Nullable PointParameter point;
 106         final @Nullable InsertParameter insert;
 107
 108         QueryParams(final @Nullable InsertParameter insert, final @Nullable PointParameter point) {
 109             this.insert = insert;
 110             this.point = point;
 111         }
 112     }
 113
 114     private static final Logger LOG = LoggerFactory.getLogger(RestconfDataServiceImpl.class);
 115     private static final DateTimeFormatter FORMATTER = DateTimeFormatter.ofPattern("yyyy-MMM-dd HH:mm:ss");
 116     private static final QName NETCONF_BASE_QNAME = SchemaContext.NAME;
 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 QueryParameters 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         switch (parameters.getContent()) {
 185             case ALL:
 186             case CONFIG:
 187                 final QName type = node.getIdentifier().getNodeType();
 188                 return Response.status(Status.OK)
 189                     .entity(NormalizedNodePayload.ofReadData(instanceIdentifier, node, parameters))
 190                     .header("ETag", '"' + type.getModule().getRevision().map(Revision::toString).orElse(null)
 191                         + "-" + type.getLocalName() + '"')
 192                     .header("Last-Modified", FORMATTER.format(LocalDateTime.now(Clock.systemUTC())))
 193                     .build();
 194             default:
 195                 return Response.status(Status.OK)
 196                     .entity(NormalizedNodePayload.ofReadData(instanceIdentifier, node, parameters))
 197                     .build();
 198         }
 199     }
 200
 201     private void createAllYangNotificationStreams(final EffectiveModelContext schemaContext, final UriInfo uriInfo) {
 202         final DOMDataTreeWriteTransaction transaction = dataBroker.newWriteOnlyTransaction();
 203         for (final NotificationDefinition notificationDefinition : schemaContext.getNotifications()) {
 204             writeNotificationStreamToDatastore(schemaContext, uriInfo, transaction,
 205                 CreateStreamUtil.createYangNotifiStream(notificationDefinition, schemaContext,
 206                     NotificationOutputType.XML));
 207             writeNotificationStreamToDatastore(schemaContext, uriInfo, transaction,
 208                 CreateStreamUtil.createYangNotifiStream(notificationDefinition, schemaContext,
 209                     NotificationOutputType.JSON));
 210         }
 211         try {
 212             transaction.commit().get();
 213         } catch (final InterruptedException | ExecutionException e) {
 214             throw new RestconfDocumentedException("Problem while putting data to DS.", e);
 215         }
 216     }
 217
 218     private void writeNotificationStreamToDatastore(final EffectiveModelContext schemaContext,
 219             final UriInfo uriInfo, final DOMDataTreeWriteOperations tx, final NotificationListenerAdapter listener) {
 220         final URI uri = streamUtils.prepareUriByStreamName(uriInfo, listener.getStreamName());
 221         final MapEntryNode mapToStreams = RestconfMappingNodeUtil.mapYangNotificationStreamByIetfRestconfMonitoring(
 222                 listener.getSchemaPath().lastNodeIdentifier(), schemaContext.getNotifications(), null,
 223                 listener.getOutputType(), uri);
 224
 225         tx.merge(LogicalDatastoreType.OPERATIONAL,
 226             Rfc8040.restconfStateStreamPath(mapToStreams.getIdentifier()), mapToStreams);
 227     }
 228
 229     @Override
 230     public Response putData(final String identifier, final NormalizedNodePayload payload, final UriInfo uriInfo) {
 231         requireNonNull(payload);
 232
 233         final QueryParams checkedParms = checkQueryParameters(uriInfo);
 234
 235         final InstanceIdentifierContext<? extends SchemaNode> iid = payload.getInstanceIdentifierContext();
 236
 237         validInputData(iid.getSchemaNode(), payload);
 238         validTopLevelNodeName(iid.getInstanceIdentifier(), payload);
 239         validateListKeysEqualityInPayloadAndUri(payload);
 240
 241         final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
 242         final EffectiveModelContext ref = mountPoint == null
 243                 ? schemaContextHandler.get() : modelContext(mountPoint);
 244
 245         final RestconfStrategy strategy = getRestconfStrategy(mountPoint);
 246         return PutDataTransactionUtil.putData(payload, ref, strategy, checkedParms.insert, checkedParms.point);
 247     }
 248
 249     private static QueryParams checkQueryParameters(final UriInfo uriInfo) {
 250         boolean insertUsed = false;
 251         boolean pointUsed = false;
 252         InsertParameter insert = null;
 253         PointParameter point = null;
 254
 255         for (final Entry<String, List<String>> entry : uriInfo.getQueryParameters().entrySet()) {
 256             final String uriName = entry.getKey();
 257             if (InsertParameter.uriName().equals(uriName)) {
 258                 if (insertUsed) {
 259                     throw new RestconfDocumentedException("Insert parameter can be used only once.",
 260                         ErrorType.PROTOCOL, ErrorTag.BAD_ELEMENT);
 261                 }
 262
 263                 insertUsed = true;
 264                 final String str = entry.getValue().get(0);
 265                 insert = InsertParameter.forUriValue(str);
 266                 if (insert == null) {
 267                     throw new RestconfDocumentedException("Unrecognized insert parameter value '" + str + "'",
 268                         ErrorType.PROTOCOL, ErrorTag.BAD_ELEMENT);
 269                 }
 270             } else if (PointParameter.uriName().equals(uriName)) {
 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 = PointParameter.forUriValue(entry.getValue().get(0));
 278             } else {
 279                 throw new RestconfDocumentedException("Bad parameter for post: " + uriName,
 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,
 289             final InsertParameter 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             if (insert != InsertParameter.BEFORE && insert != InsertParameter.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 NormalizedNodePayload payload, final UriInfo uriInfo) {
 305         return postData(payload, uriInfo);
 306     }
 307
 308     @Override
 309     public Response postData(final NormalizedNodePayload 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, 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 NormalizedNodePayload 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                 ? 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 NormalizedNodePayload} - the body of the operation
 384      * @return {@link NormalizedNodePayload} wrapped in {@link Response}
 385      */
 386     public Response invokeAction(final NormalizedNodePayload 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() && !NETCONF_BASE_QNAME.equals(data.getIdentifier().getNodeType())) {
 395             throw new RestconfDocumentedException("Instance identifier need to contain at least one path argument",
 396                 ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 397         }
 398
 399         final DOMActionResult response;
 400         final EffectiveModelContext schemaContextRef;
 401         if (mountPoint != null) {
 402             response = invokeAction((ContainerNode) data, schemaPath, yangIIdContext, mountPoint);
 403             schemaContextRef = modelContext(mountPoint);
 404         } else {
 405             response = invokeAction((ContainerNode) data, schemaPath, yangIIdContext, actionService);
 406             schemaContextRef = schemaContextHandler.get();
 407         }
 408         final DOMActionResult result = checkActionResponse(response);
 409
 410         ActionDefinition resultNodeSchema = null;
 411         ContainerNode resultData = null;
 412         if (result != null) {
 413             final Optional<ContainerNode> optOutput = result.getOutput();
 414             if (optOutput.isPresent()) {
 415                 resultData = optOutput.get();
 416                 resultNodeSchema = (ActionDefinition) context.getSchemaNode();
 417             }
 418         }
 419
 420         if (resultData != null && resultData.isEmpty()) {
 421             return Response.status(Status.NO_CONTENT).build();
 422         }
 423
 424         return Response.status(Status.OK)
 425             .entity(NormalizedNodePayload.ofNullable(
 426                 new InstanceIdentifierContext<>(yangIIdContext, resultNodeSchema, mountPoint, schemaContextRef),
 427                 resultData))
 428             .build();
 429     }
 430
 431
 432     /**
 433      * Invoking Action via mount point.
 434      *
 435      * @param mountPoint mount point
 436      * @param data input data
 437      * @param schemaPath schema path of data
 438      * @return {@link DOMActionResult}
 439      */
 440     private static DOMActionResult invokeAction(final ContainerNode data,
 441             final Absolute schemaPath, final YangInstanceIdentifier yangIId, final DOMMountPoint mountPoint) {
 442         return invokeAction(data, schemaPath, yangIId, mountPoint.getService(DOMActionService.class)
 443             .orElseThrow(() -> new RestconfDocumentedException("DomAction service is missing.")));
 444     }
 445
 446     /**
 447      * Invoke Action via ActionServiceHandler.
 448      *
 449      * @param data input data
 450      * @param yangIId invocation context
 451      * @param schemaPath schema path of data
 452      * @param actionService action service to invoke action
 453      * @return {@link DOMActionResult}
 454      */
 455     // FIXME: NETCONF-718: we should be returning a future here
 456     private static DOMActionResult invokeAction(final ContainerNode data, final Absolute schemaPath,
 457             final YangInstanceIdentifier yangIId, final DOMActionService actionService) {
 458         return RestconfInvokeOperationsServiceImpl.checkedGet(Futures.catching(actionService.invokeAction(
 459             schemaPath, new DOMDataTreeIdentifier(LogicalDatastoreType.OPERATIONAL, yangIId.getParent()), data),
 460             DOMActionException.class,
 461             cause -> new SimpleDOMActionResult(ImmutableList.of(RpcResultBuilder.newError(
 462                 RpcError.ErrorType.RPC, "operation-failed", cause.getMessage()))),
 463             MoreExecutors.directExecutor()));
 464     }
 465
 466     /**
 467      * Check the validity of the result.
 468      *
 469      * @param response response of Action
 470      * @return {@link DOMActionResult} result
 471      */
 472     private static DOMActionResult checkActionResponse(final DOMActionResult response) {
 473         if (response == null) {
 474             return null;
 475         }
 476
 477         try {
 478             if (response.getErrors().isEmpty()) {
 479                 return response;
 480             }
 481             LOG.debug("InvokeAction Error Message {}", response.getErrors());
 482             throw new RestconfDocumentedException("InvokeAction Error Message ", null, response.getErrors());
 483         } catch (final CancellationException e) {
 484             final String errMsg = "The Action Operation was cancelled while executing.";
 485             LOG.debug("Cancel Execution: {}", errMsg, e);
 486             throw new RestconfDocumentedException(errMsg, ErrorType.RPC, ErrorTag.PARTIAL_OPERATION, e);
 487         }
 488     }
 489
 490     /**
 491      * Valid input data with {@link SchemaNode}.
 492      *
 493      * @param schemaNode {@link SchemaNode}
 494      * @param payload    input data
 495      */
 496     @VisibleForTesting
 497     public static void validInputData(final SchemaNode schemaNode, final NormalizedNodePayload payload) {
 498         if (schemaNode != null && payload.getData() == null) {
 499             throw new RestconfDocumentedException("Input is required.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 500         } else if (schemaNode == null && payload.getData() != null) {
 501             throw new RestconfDocumentedException("No input expected.", ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 502         }
 503     }
 504
 505     /**
 506      * Valid top level node name.
 507      *
 508      * @param path    path of node
 509      * @param payload data
 510      */
 511     @VisibleForTesting
 512     public static void validTopLevelNodeName(final YangInstanceIdentifier path, final NormalizedNodePayload payload) {
 513         final QName dataNodeType = payload.getData().getIdentifier().getNodeType();
 514         if (path.isEmpty()) {
 515             if (!NETCONF_BASE_QNAME.equals(dataNodeType)) {
 516                 throw new RestconfDocumentedException("Instance identifier has to contain at least one path argument",
 517                         ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 518             }
 519         } else {
 520             final String identifierName = path.getLastPathArgument().getNodeType().getLocalName();
 521             final String payloadName = dataNodeType.getLocalName();
 522             if (!payloadName.equals(identifierName)) {
 523                 throw new RestconfDocumentedException(
 524                         "Payload name (" + payloadName + ") is different from identifier name (" + identifierName + ")",
 525                         ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 526             }
 527         }
 528     }
 529
 530
 531     /**
 532      * Validates whether keys in {@code payload} are equal to values of keys in
 533      * {@code iiWithData} for list schema node.
 534      *
 535      * @throws RestconfDocumentedException if key values or key count in payload and URI isn't equal
 536      */
 537     @VisibleForTesting
 538     public static void validateListKeysEqualityInPayloadAndUri(final NormalizedNodePayload payload) {
 539         final InstanceIdentifierContext<?> iiWithData = payload.getInstanceIdentifierContext();
 540         final PathArgument lastPathArgument = iiWithData.getInstanceIdentifier().getLastPathArgument();
 541         final SchemaNode schemaNode = iiWithData.getSchemaNode();
 542         final NormalizedNode data = payload.getData();
 543         if (schemaNode instanceof ListSchemaNode) {
 544             final List<QName> keyDefinitions = ((ListSchemaNode) schemaNode).getKeyDefinition();
 545             if (lastPathArgument instanceof NodeIdentifierWithPredicates && data instanceof MapEntryNode) {
 546                 final Map<QName, Object> uriKeyValues = ((NodeIdentifierWithPredicates) lastPathArgument).asMap();
 547                 isEqualUriAndPayloadKeyValues(uriKeyValues, (MapEntryNode) data, keyDefinitions);
 548             }
 549         }
 550     }
 551
 552     private static void isEqualUriAndPayloadKeyValues(final Map<QName, Object> uriKeyValues, final MapEntryNode payload,
 553             final List<QName> keyDefinitions) {
 554         final Map<QName, Object> mutableCopyUriKeyValues = new HashMap<>(uriKeyValues);
 555         for (final QName keyDefinition : keyDefinitions) {
 556             final Object uriKeyValue = RestconfDocumentedException.throwIfNull(
 557                     mutableCopyUriKeyValues.remove(keyDefinition), ErrorType.PROTOCOL, ErrorTag.DATA_MISSING,
 558                     "Missing key %s in URI.", keyDefinition);
 559
 560             final Object dataKeyValue = payload.getIdentifier().getValue(keyDefinition);
 561
 562             if (!uriKeyValue.equals(dataKeyValue)) {
 563                 final String errMsg = "The value '" + uriKeyValue + "' for key '" + keyDefinition.getLocalName()
 564                         + "' specified in the URI doesn't match the value '" + dataKeyValue
 565                         + "' specified in the message body. ";
 566                 throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
 567             }
 568         }
 569     }
 570
 571     private static EffectiveModelContext modelContext(final DOMMountPoint mountPoint) {
 572         return mountPoint.getService(DOMSchemaService.class)
 573             .flatMap(svc -> Optional.ofNullable(svc.getGlobalContext()))
 574             .orElse(null);
 575     }
 576 }