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