Split out RFC8040-only constructs from yang-common
[netconf.git] / restconf / restconf-nb-rfc8040 / src / main / java / org / opendaylight / restconf / nb / rfc8040 / rests / services / impl / RestconfInvokeOperationsServiceImpl.java
index 49ba53be0e31a3221dc59659789f7ed66503dcbe..f2c70e8e268ea0f89fb03c986413b737ed0898da 100644 (file)
@@ -7,30 +7,50 @@
  */
 package org.opendaylight.restconf.nb.rfc8040.rests.services.impl;
 
-import java.net.URI;
+import static java.util.Objects.requireNonNull;
+
+import com.google.common.annotations.VisibleForTesting;
+import com.google.common.base.Throwables;
+import com.google.common.collect.ImmutableList;
+import com.google.common.util.concurrent.FutureCallback;
+import com.google.common.util.concurrent.Futures;
+import com.google.common.util.concurrent.ListenableFuture;
+import com.google.common.util.concurrent.MoreExecutors;
+import java.util.Optional;
+import java.util.concurrent.ExecutionException;
 import javax.ws.rs.Path;
 import javax.ws.rs.WebApplicationException;
-import javax.ws.rs.core.Response;
+import javax.ws.rs.container.AsyncResponse;
+import javax.ws.rs.core.Response.Status;
 import javax.ws.rs.core.UriInfo;
+import org.eclipse.jdt.annotation.NonNull;
 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
+import org.opendaylight.mdsal.dom.api.DOMRpcException;
 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
+import org.opendaylight.mdsal.dom.api.DOMRpcService;
+import org.opendaylight.mdsal.dom.api.DOMSchemaService;
+import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
-import org.opendaylight.restconf.common.errors.RestconfError.ErrorTag;
-import org.opendaylight.restconf.common.errors.RestconfError.ErrorType;
-import org.opendaylight.restconf.nb.rfc8040.handlers.RpcServiceHandler;
 import org.opendaylight.restconf.nb.rfc8040.handlers.SchemaContextHandler;
-import org.opendaylight.restconf.nb.rfc8040.references.SchemaContextRef;
+import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
 import org.opendaylight.restconf.nb.rfc8040.rests.services.api.RestconfInvokeOperationsService;
-import org.opendaylight.restconf.nb.rfc8040.rests.utils.CreateStreamUtil;
-import org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfInvokeOperationsUtil;
-import org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants;
+import org.opendaylight.yangtools.yang.common.ErrorTag;
+import org.opendaylight.yangtools.yang.common.ErrorType;
+import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.common.RpcError;
+import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
+import org.opendaylight.yangtools.yang.common.XMLNamespace;
+import org.opendaylight.yangtools.yang.common.YangConstants;
 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
-import org.opendaylight.yangtools.yang.model.api.SchemaPath;
+import org.opendaylight.yangtools.yang.model.api.SchemaNode;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * Implementation of {@link RestconfInvokeOperationsService}.
@@ -38,69 +58,132 @@ import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  */
 @Path("/")
 public class RestconfInvokeOperationsServiceImpl implements RestconfInvokeOperationsService {
+    private static final Logger LOG = LoggerFactory.getLogger(RestconfInvokeOperationsServiceImpl.class);
 
-    private volatile RpcServiceHandler rpcServiceHandler;
-    private volatile SchemaContextHandler schemaContextHandler;
+    // FIXME: at some point we do not want to have this here
+    private static final XMLNamespace SAL_REMOTE_NAMESPACE =
+        XMLNamespace.of("urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote");
 
-    public RestconfInvokeOperationsServiceImpl(final RpcServiceHandler rpcServiceHandler,
-            final SchemaContextHandler schemaContextHandler) {
-        this.rpcServiceHandler = rpcServiceHandler;
-        this.schemaContextHandler = schemaContextHandler;
-    }
+    private final DOMRpcService rpcService;
+    private final SchemaContextHandler schemaContextHandler;
 
-    @Override
-    public synchronized void updateHandlers(final Object... handlers) {
-        for (final Object object : handlers) {
-            if (object instanceof SchemaContextHandler) {
-                schemaContextHandler = (SchemaContextHandler) object;
-            } else if (object instanceof RpcServiceHandler) {
-                rpcServiceHandler = (RpcServiceHandler) object;
-            }
-        }
+    public RestconfInvokeOperationsServiceImpl(final DOMRpcService rpcService,
+            final SchemaContextHandler schemaContextHandler) {
+        this.rpcService = requireNonNull(rpcService);
+        this.schemaContextHandler = requireNonNull(schemaContextHandler);
     }
 
     @Override
-    public NormalizedNodeContext invokeRpc(final String identifier, final NormalizedNodeContext payload,
-            final UriInfo uriInfo) {
-        final SchemaContextRef refSchemaCtx = new SchemaContextRef(this.schemaContextHandler.get());
-        final SchemaPath schemaPath = payload.getInstanceIdentifierContext().getSchemaNode().getPath();
+    public void invokeRpc(final String identifier, final NormalizedNodePayload payload, final UriInfo uriInfo,
+            final AsyncResponse ar) {
+        final SchemaNode schema = payload.getInstanceIdentifierContext().getSchemaNode();
+        final QName rpcName = schema.getQName();
         final DOMMountPoint mountPoint = payload.getInstanceIdentifierContext().getMountPoint();
-        final URI namespace = payload.getInstanceIdentifierContext().getSchemaNode().getQName().getNamespace();
 
-        final DOMRpcResult response;
+        final ListenableFuture<? extends DOMRpcResult> future;
         final EffectiveModelContext schemaContextRef;
         if (mountPoint == null) {
-            if (namespace.equals(RestconfStreamsConstants.SAL_REMOTE_NAMESPACE.getNamespace())) {
-                if (identifier.contains(RestconfStreamsConstants.CREATE_DATA_SUBSCRIPTION)) {
-                    response = CreateStreamUtil.createDataChangeNotifiStream(payload, refSchemaCtx);
+            schemaContextRef = schemaContextHandler.get();
+
+            // FIXME: this really should be a normal RPC invocation service which has its own interface with JAX-RS
+            if (SAL_REMOTE_NAMESPACE.equals(rpcName.getNamespace())) {
+                if (identifier.contains("create-data-change-event-subscription")) {
+                    future = Futures.immediateFuture(
+                        CreateStreamUtil.createDataChangeNotifiStream(payload, schemaContextRef));
                 } else {
-                    throw new RestconfDocumentedException("Not supported operation", ErrorType.RPC,
-                            ErrorTag.OPERATION_NOT_SUPPORTED);
+                    future = Futures.immediateFailedFuture(new RestconfDocumentedException("Unsupported operation",
+                        ErrorType.RPC, ErrorTag.OPERATION_NOT_SUPPORTED));
                 }
             } else {
-                response = RestconfInvokeOperationsUtil.invokeRpc(payload.getData(), schemaPath,
-                        this.rpcServiceHandler);
+                future = invokeRpc(payload.getData(), rpcName, rpcService);
             }
-            schemaContextRef = this.schemaContextHandler.get();
         } else {
-            response = RestconfInvokeOperationsUtil.invokeRpcViaMountPoint(mountPoint, payload.getData(), schemaPath);
-            schemaContextRef = mountPoint.getEffectiveModelContext();
+            schemaContextRef = modelContext(mountPoint);
+            future = invokeRpc(payload.getData(), rpcName, mountPoint);
         }
 
-        final DOMRpcResult result = RestconfInvokeOperationsUtil.checkResponse(response);
+        Futures.addCallback(future, new FutureCallback<DOMRpcResult>() {
+            @Override
+            public void onSuccess(final DOMRpcResult response) {
+                final var errors = response.getErrors();
+                if (!errors.isEmpty()) {
+                    LOG.debug("RpcError message {}", response.getErrors());
+                    ar.resume(new RestconfDocumentedException("RPCerror message ", null, response.getErrors()));
+                    return;
+                }
 
-        RpcDefinition resultNodeSchema = null;
-        NormalizedNode<?, ?> resultData = null;
-        if (result != null && result.getResult() != null) {
-            resultData = result.getResult();
-            resultNodeSchema = (RpcDefinition) payload.getInstanceIdentifierContext().getSchemaNode();
-        }
+                final NormalizedNode resultData = response.getResult();
+                if (resultData == null || ((ContainerNode) resultData).isEmpty()) {
+                    ar.resume(new WebApplicationException(Status.NO_CONTENT));
+                } else {
+                    ar.resume(new NormalizedNodeContext(new InstanceIdentifierContext<>(null, (RpcDefinition) schema,
+                        mountPoint, schemaContextRef), resultData));
+                }
+            }
 
-        if (resultData != null && ((ContainerNode) resultData).getValue().isEmpty()) {
-            throw new WebApplicationException(Response.Status.NO_CONTENT);
-        } else {
-            return new NormalizedNodeContext(new InstanceIdentifierContext<>(null, resultNodeSchema, mountPoint,
-                    schemaContextRef), resultData);
+            @Override
+            public void onFailure(final Throwable failure) {
+                ar.resume(failure);
+            }
+        }, MoreExecutors.directExecutor());
+    }
+
+    /**
+     * Invoking rpc via mount point.
+     *
+     * @param mountPoint mount point
+     * @param data input data
+     * @param rpc RPC type
+     * @return {@link DOMRpcResult}
+     */
+    @VisibleForTesting
+    static ListenableFuture<? extends DOMRpcResult> invokeRpc(final NormalizedNode data, final QName rpc,
+            final DOMMountPoint mountPoint) {
+        return invokeRpc(data, rpc, mountPoint.getService(DOMRpcService.class).orElseThrow(() -> {
+            final String errmsg = "RPC service is missing.";
+            LOG.debug(errmsg);
+            return new RestconfDocumentedException(errmsg);
+        }));
+    }
+
+    /**
+     * Invoke rpc.
+     *
+     * @param data input data
+     * @param rpc RPC type
+     * @param rpcService rpc service to invoke rpc
+     * @return {@link DOMRpcResult}
+     */
+    @VisibleForTesting
+    static ListenableFuture<? extends DOMRpcResult> invokeRpc(final NormalizedNode data, final QName rpc,
+            final DOMRpcService rpcService) {
+        return Futures.catching(rpcService.invokeRpc(rpc, nonnullInput(rpc, data)),
+            DOMRpcException.class,
+            cause -> new DefaultDOMRpcResult(ImmutableList.of(RpcResultBuilder.newError(
+                RpcError.ErrorType.RPC, "operation-failed", cause.getMessage()))),
+            MoreExecutors.directExecutor());
+    }
+
+    private static @NonNull NormalizedNode nonnullInput(final QName type, final NormalizedNode input) {
+        return input != null ? input
+                : ImmutableNodes.containerNode(YangConstants.operationInputQName(type.getModule()));
+    }
+
+    @Deprecated
+    static <T> T checkedGet(final ListenableFuture<T> future) {
+        try {
+            return future.get();
+        } catch (InterruptedException e) {
+            throw new RestconfDocumentedException("Interrupted while waiting for result of invocation", e);
+        } catch (ExecutionException e) {
+            Throwables.throwIfInstanceOf(e.getCause(), RestconfDocumentedException.class);
+            throw new RestconfDocumentedException("Invocation failed", e);
         }
     }
+
+    private static EffectiveModelContext modelContext(final DOMMountPoint mountPoint) {
+        return mountPoint.getService(DOMSchemaService.class)
+            .flatMap(svc -> Optional.ofNullable(svc.getGlobalContext()))
+            .orElse(null);
+    }
 }