restconf/restconf-nb/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.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.remote.rev140114.CreateDataChangeEventSubscriptionInput;
  37 import org.opendaylight.yangtools.yang.common.ErrorTag;
  38 import org.opendaylight.yangtools.yang.common.ErrorType;
  39 import org.opendaylight.yangtools.yang.common.QName;
  40 import org.opendaylight.yangtools.yang.common.QNameModule;
  41 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  42 import org.opendaylight.yangtools.yang.common.YangConstants;
  43 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  44 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  45 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  46 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  47 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  48 import org.slf4j.Logger;
  49 import org.slf4j.LoggerFactory;
  50
  51 /**
  52  * Implementation of {@link RestconfInvokeOperationsService}.
  53  *
  54  */
  55 @Path("/")
  56 public class RestconfInvokeOperationsServiceImpl implements RestconfInvokeOperationsService {
  57     private static final Logger LOG = LoggerFactory.getLogger(RestconfInvokeOperationsServiceImpl.class);
  58
  59     // FIXME: at some point we do not want to have this here, as this is only used for dispatch
  60     private static final QNameModule SAL_REMOTE_NAMESPACE = CreateDataChangeEventSubscriptionInput.QNAME.getModule();
  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             //        except ... we check 'identifier' for .contains() instead of exact RPC name!
  84             if (SAL_REMOTE_NAMESPACE.equals(rpcName.getModule())) {
  85                 if (identifier.contains("create-data-change-event-subscription")) {
  86                     future = Futures.immediateFuture(
  87                         CreateStreamUtil.createDataChangeNotifiStream(payload, schemaContext));
  88                 } else {
  89                     future = Futures.immediateFailedFuture(new RestconfDocumentedException("Unsupported operation",
  90                         ErrorType.RPC, ErrorTag.OPERATION_NOT_SUPPORTED));
  91                 }
  92             } else {
  93                 future = invokeRpc(payload.getData(), rpcName, rpcService);
  94             }
  95         } else {
  96             future = invokeRpc(payload.getData(), rpcName, mountPoint);
  97         }
  98
  99         Futures.addCallback(future, new FutureCallback<DOMRpcResult>() {
 100             @Override
 101             public void onSuccess(final DOMRpcResult response) {
 102                 final var errors = response.getErrors();
 103                 if (!errors.isEmpty()) {
 104                     LOG.debug("RpcError message {}", response.getErrors());
 105                     ar.resume(new RestconfDocumentedException("RPCerror message ", null, response.getErrors()));
 106                     return;
 107                 }
 108
 109                 final NormalizedNode resultData = response.getResult();
 110                 if (resultData == null || ((ContainerNode) resultData).isEmpty()) {
 111                     ar.resume(new WebApplicationException(Status.NO_CONTENT));
 112                 } else {
 113                     ar.resume(NormalizedNodePayload.of(context, resultData));
 114                 }
 115             }
 116
 117             @Override
 118             public void onFailure(final Throwable failure) {
 119                 ar.resume(failure);
 120             }
 121         }, MoreExecutors.directExecutor());
 122     }
 123
 124     /**
 125      * Invoking rpc via mount point.
 126      *
 127      * @param mountPoint mount point
 128      * @param data input data
 129      * @param rpc RPC type
 130      * @return {@link DOMRpcResult}
 131      */
 132     @VisibleForTesting
 133     static ListenableFuture<? extends DOMRpcResult> invokeRpc(final NormalizedNode data, final QName rpc,
 134             final DOMMountPoint mountPoint) {
 135         return invokeRpc(data, rpc, mountPoint.getService(DOMRpcService.class).orElseThrow(() -> {
 136             final String errmsg = "RPC service is missing.";
 137             LOG.debug(errmsg);
 138             return new RestconfDocumentedException(errmsg);
 139         }));
 140     }
 141
 142     /**
 143      * Invoke rpc.
 144      *
 145      * @param data input data
 146      * @param rpc RPC type
 147      * @param rpcService rpc service to invoke rpc
 148      * @return {@link DOMRpcResult}
 149      */
 150     @VisibleForTesting
 151     static ListenableFuture<? extends DOMRpcResult> invokeRpc(final NormalizedNode data, final QName rpc,
 152             final DOMRpcService rpcService) {
 153         return Futures.catching(rpcService.invokeRpc(rpc, nonnullInput(rpc, data)),
 154             DOMRpcException.class,
 155             cause -> new DefaultDOMRpcResult(List.of(RpcResultBuilder.newError(ErrorType.RPC, ErrorTag.OPERATION_FAILED,
 156                 cause.getMessage()))),
 157             MoreExecutors.directExecutor());
 158     }
 159
 160     private static @NonNull NormalizedNode nonnullInput(final QName type, final NormalizedNode input) {
 161         return input != null ? input
 162                 : ImmutableNodes.containerNode(YangConstants.operationInputQName(type.getModule()));
 163     }
 164
 165     @Deprecated
 166     static <T> T checkedGet(final ListenableFuture<T> future) {
 167         try {
 168             return future.get();
 169         } catch (InterruptedException e) {
 170             throw new RestconfDocumentedException("Interrupted while waiting for result of invocation", e);
 171         } catch (ExecutionException e) {
 172             Throwables.throwIfInstanceOf(e.getCause(), RestconfDocumentedException.class);
 173             throw new RestconfDocumentedException("Invocation failed", e);
 174         }
 175     }
 176 }