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