restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/rests/services/impl/RestconfInvokeOperationsServiceImpl.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
  12 import com.google.common.annotations.VisibleForTesting;
  13 import com.google.common.base.Throwables;
  14 import com.google.common.util.concurrent.FutureCallback;
  15 import com.google.common.util.concurrent.Futures;
  16 import com.google.common.util.concurrent.ListenableFuture;
  17 import com.google.common.util.concurrent.MoreExecutors;
  18 import java.util.List;
  19 import java.util.concurrent.ExecutionException;
  20 import javax.ws.rs.Path;
  21 import javax.ws.rs.WebApplicationException;
  22 import javax.ws.rs.container.AsyncResponse;
  23 import javax.ws.rs.core.Response.Status;
  24 import javax.ws.rs.core.UriInfo;
  25 import org.eclipse.jdt.annotation.NonNull;
  26 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
  27 import org.opendaylight.mdsal.dom.api.DOMRpcException;
  28 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  29 import org.opendaylight.mdsal.dom.api.DOMRpcService;
  30 import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
  31 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
  32 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  33 import org.opendaylight.restconf.nb.rfc8040.handlers.SchemaContextHandler;
  34 import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
  35 import org.opendaylight.restconf.nb.rfc8040.rests.services.api.RestconfInvokeOperationsService;
  36 import org.opendaylight.yangtools.yang.common.ErrorTag;
  37 import org.opendaylight.yangtools.yang.common.ErrorType;
  38 import org.opendaylight.yangtools.yang.common.QName;
  39 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  40 import org.opendaylight.yangtools.yang.common.XMLNamespace;
  41 import org.opendaylight.yangtools.yang.common.YangConstants;
  42 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  43 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  44 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  45 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  46 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  47 import org.slf4j.Logger;
  48 import org.slf4j.LoggerFactory;
  49
  50 /**
  51  * Implementation of {@link RestconfInvokeOperationsService}.
  52  *
  53  */
  54 @Path("/")
  55 public class RestconfInvokeOperationsServiceImpl implements RestconfInvokeOperationsService {
  56     private static final Logger LOG = LoggerFactory.getLogger(RestconfInvokeOperationsServiceImpl.class);
  57
  58     // FIXME: at some point we do not want to have this here
  59     private static final XMLNamespace SAL_REMOTE_NAMESPACE =
  60         XMLNamespace.of("urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote");
  61
  62     private final DOMRpcService rpcService;
  63     private final SchemaContextHandler schemaContextHandler;
  64
  65     public RestconfInvokeOperationsServiceImpl(final DOMRpcService rpcService,
  66             final SchemaContextHandler schemaContextHandler) {
  67         this.rpcService = requireNonNull(rpcService);
  68         this.schemaContextHandler = requireNonNull(schemaContextHandler);
  69     }
  70
  71     @Override
  72     public void invokeRpc(final String identifier, final NormalizedNodePayload payload, final UriInfo uriInfo,
  73             final AsyncResponse ar) {
  74         final InstanceIdentifierContext context = payload.getInstanceIdentifierContext();
  75         final EffectiveModelContext schemaContext = context.getSchemaContext();
  76         final DOMMountPoint mountPoint = context.getMountPoint();
  77         final SchemaNode schema = context.getSchemaNode();
  78         final QName rpcName = schema.getQName();
  79
  80         final ListenableFuture<? extends DOMRpcResult> future;
  81         if (mountPoint == null) {
  82             // FIXME: this really should be a normal RPC invocation service which has its own interface with JAX-RS
  83             if (SAL_REMOTE_NAMESPACE.equals(rpcName.getNamespace())) {
  84                 if (identifier.contains("create-data-change-event-subscription")) {
  85                     future = Futures.immediateFuture(
  86                         CreateStreamUtil.createDataChangeNotifiStream(payload, schemaContext));
  87                 } else {
  88                     future = Futures.immediateFailedFuture(new RestconfDocumentedException("Unsupported operation",
  89                         ErrorType.RPC, ErrorTag.OPERATION_NOT_SUPPORTED));
  90                 }
  91             } else {
  92                 future = invokeRpc(payload.getData(), rpcName, rpcService);
  93             }
  94         } else {
  95             future = invokeRpc(payload.getData(), rpcName, mountPoint);
  96         }
  97
  98         Futures.addCallback(future, new FutureCallback<DOMRpcResult>() {
  99             @Override
 100             public void onSuccess(final DOMRpcResult response) {
 101                 final var errors = response.getErrors();
 102                 if (!errors.isEmpty()) {
 103                     LOG.debug("RpcError message {}", response.getErrors());
 104                     ar.resume(new RestconfDocumentedException("RPCerror message ", null, response.getErrors()));
 105                     return;
 106                 }
 107
 108                 final NormalizedNode resultData = response.getResult();
 109                 if (resultData == null || ((ContainerNode) resultData).isEmpty()) {
 110                     ar.resume(new WebApplicationException(Status.NO_CONTENT));
 111                 } else {
 112                     ar.resume(NormalizedNodePayload.of(context, resultData));
 113                 }
 114             }
 115
 116             @Override
 117             public void onFailure(final Throwable failure) {
 118                 ar.resume(failure);
 119             }
 120         }, MoreExecutors.directExecutor());
 121     }
 122
 123     /**
 124      * Invoking rpc via mount point.
 125      *
 126      * @param mountPoint mount point
 127      * @param data input data
 128      * @param rpc RPC type
 129      * @return {@link DOMRpcResult}
 130      */
 131     @VisibleForTesting
 132     static ListenableFuture<? extends DOMRpcResult> invokeRpc(final NormalizedNode data, final QName rpc,
 133             final DOMMountPoint mountPoint) {
 134         return invokeRpc(data, rpc, mountPoint.getService(DOMRpcService.class).orElseThrow(() -> {
 135             final String errmsg = "RPC service is missing.";
 136             LOG.debug(errmsg);
 137             return new RestconfDocumentedException(errmsg);
 138         }));
 139     }
 140
 141     /**
 142      * Invoke rpc.
 143      *
 144      * @param data input data
 145      * @param rpc RPC type
 146      * @param rpcService rpc service to invoke rpc
 147      * @return {@link DOMRpcResult}
 148      */
 149     @VisibleForTesting
 150     static ListenableFuture<? extends DOMRpcResult> invokeRpc(final NormalizedNode data, final QName rpc,
 151             final DOMRpcService rpcService) {
 152         return Futures.catching(rpcService.invokeRpc(rpc, nonnullInput(rpc, data)),
 153             DOMRpcException.class,
 154             cause -> new DefaultDOMRpcResult(List.of(RpcResultBuilder.newError(ErrorType.RPC, ErrorTag.OPERATION_FAILED,
 155                 cause.getMessage()))),
 156             MoreExecutors.directExecutor());
 157     }
 158
 159     private static @NonNull NormalizedNode nonnullInput(final QName type, final NormalizedNode input) {
 160         return input != null ? input
 161                 : ImmutableNodes.containerNode(YangConstants.operationInputQName(type.getModule()));
 162     }
 163
 164     @Deprecated
 165     static <T> T checkedGet(final ListenableFuture<T> future) {
 166         try {
 167             return future.get();
 168         } catch (InterruptedException e) {
 169             throw new RestconfDocumentedException("Interrupted while waiting for result of invocation", e);
 170         } catch (ExecutionException e) {
 171             Throwables.throwIfInstanceOf(e.getCause(), RestconfDocumentedException.class);
 172             throw new RestconfDocumentedException("Invocation failed", e);
 173         }
 174     }
 175 }