Get rid of string payload RestconfService#invokeRpc
[netconf.git] / restconf / restconf-nb-bierman02 / src / main / java / org / opendaylight / netconf / sal / restconf / impl / RestconfImpl.java
index 45c161e42f525f26456bf798f7bf112fe567cb93..e6cb1c16dadb38a6cfd58ebcea4a4931be618db2 100644 (file)
@@ -5,12 +5,9 @@
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  * and is available at http://www.eclipse.org/legal/epl-v10.html
  */
-
 package org.opendaylight.netconf.sal.restconf.impl;
 
 import com.google.common.annotations.VisibleForTesting;
-import com.google.common.base.CharMatcher;
-import com.google.common.base.Optional;
 import com.google.common.base.Preconditions;
 import com.google.common.base.Predicates;
 import com.google.common.base.Splitter;
@@ -19,7 +16,7 @@ import com.google.common.base.Throwables;
 import com.google.common.collect.ImmutableSet;
 import com.google.common.collect.Iterables;
 import com.google.common.collect.Maps;
-import com.google.common.util.concurrent.CheckedFuture;
+import com.google.common.util.concurrent.FluentFuture;
 import com.google.common.util.concurrent.Futures;
 import com.google.common.util.concurrent.ListenableFuture;
 import java.net.URI;
@@ -40,23 +37,27 @@ import java.util.Locale;
 import java.util.Map;
 import java.util.Map.Entry;
 import java.util.Objects;
+import java.util.Optional;
 import java.util.Set;
 import java.util.concurrent.CancellationException;
 import java.util.concurrent.ExecutionException;
+import javax.inject.Inject;
+import javax.inject.Singleton;
 import javax.ws.rs.core.Context;
 import javax.ws.rs.core.Response;
 import javax.ws.rs.core.Response.ResponseBuilder;
 import javax.ws.rs.core.Response.Status;
 import javax.ws.rs.core.UriBuilder;
 import javax.ws.rs.core.UriInfo;
-import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
-import org.opendaylight.controller.md.sal.common.api.data.OptimisticLockFailedException;
-import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
-import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint;
-import org.opendaylight.controller.md.sal.dom.api.DOMRpcImplementationNotAvailableException;
-import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
-import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
-import org.opendaylight.controller.md.sal.dom.spi.DefaultDOMRpcResult;
+import org.opendaylight.mdsal.common.api.CommitInfo;
+import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
+import org.opendaylight.mdsal.common.api.OptimisticLockFailedException;
+import org.opendaylight.mdsal.common.api.TransactionCommitFailedException;
+import org.opendaylight.mdsal.dom.api.DOMMountPoint;
+import org.opendaylight.mdsal.dom.api.DOMRpcImplementationNotAvailableException;
+import org.opendaylight.mdsal.dom.api.DOMRpcResult;
+import org.opendaylight.mdsal.dom.api.DOMRpcService;
+import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
 import org.opendaylight.netconf.sal.rest.api.Draft02;
 import org.opendaylight.netconf.sal.rest.api.RestconfService;
 import org.opendaylight.netconf.sal.streams.listeners.ListenerAdapter;
@@ -116,6 +117,7 @@ import org.opendaylight.yangtools.yang.model.util.SimpleSchemaContext;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+@Singleton
 public final class RestconfImpl implements RestconfService {
     /**
      * Notifications are served on port 8181.
@@ -175,11 +177,18 @@ public final class RestconfImpl implements RestconfService {
 
     private final ControllerContext controllerContext;
 
-    private RestconfImpl(final BrokerFacade broker, final ControllerContext controllerContext) {
+    @Inject
+    public RestconfImpl(final BrokerFacade broker, final ControllerContext controllerContext) {
         this.broker = broker;
         this.controllerContext = controllerContext;
     }
 
+    /**
+     * Factory method.
+     *
+     * @deprecated Just use {@link #RestconfImpl(BrokerFacade, ControllerContext)} constructor instead.
+     */
+    @Deprecated
     public static RestconfImpl newInstance(final BrokerFacade broker, final ControllerContext controllerContext) {
         return new RestconfImpl(broker, controllerContext);
     }
@@ -423,6 +432,11 @@ public final class RestconfImpl implements RestconfService {
     @Override
     public NormalizedNodeContext invokeRpc(final String identifier, final NormalizedNodeContext payload,
             final UriInfo uriInfo) {
+        if (payload == null) {
+            // no payload specified, reroute this to no payload invokeRpc implementation
+            return invokeRpc(identifier, uriInfo);
+        }
+
         final SchemaPath type = payload.getInstanceIdentifierContext().getSchemaNode().getPath();
         final URI namespace = payload.getInstanceIdentifierContext().getSchemaNode().getQName().getNamespace();
         final ListenableFuture<DOMRpcResult> response;
@@ -470,14 +484,10 @@ public final class RestconfImpl implements RestconfService {
                 resultData, QueryParametersParser.parseWriterParameters(uriInfo));
     }
 
-    @Override
-    public NormalizedNodeContext invokeRpc(final String identifier, final String noPayload, final UriInfo uriInfo) {
-        if (noPayload != null && !CharMatcher.whitespace().matchesAllOf(noPayload)) {
-            throw new RestconfDocumentedException("Content must be empty.", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
-        }
+    private NormalizedNodeContext invokeRpc(final String identifier, final UriInfo uriInfo) {
 
-        String identifierEncoded = null;
         DOMMountPoint mountPoint = null;
+        final String identifierEncoded;
         final SchemaContext schemaContext;
         if (identifier.contains(ControllerContext.MOUNT)) {
             // mounted RPC call - look up mount instance.
@@ -501,7 +511,7 @@ public final class RestconfImpl implements RestconfService {
 
         final String identifierDecoded = this.controllerContext.urlPathArgDecode(identifierEncoded);
 
-        RpcDefinition rpc = null;
+        RpcDefinition rpc;
         if (mountPoint == null) {
             rpc = this.controllerContext.getRpcDefinition(identifierDecoded);
         } else {
@@ -514,9 +524,9 @@ public final class RestconfImpl implements RestconfService {
         }
 
         if (!rpc.getInput().getChildNodes().isEmpty()) {
-            LOG.debug("RPC {} does not need input value.", rpc);
-            throw new RestconfDocumentedException("RPC " + rpc + " does not take any input value.",
-                    ErrorType.RPC, ErrorTag.INVALID_VALUE);
+            LOG.debug("No input specified for RPC {} with an input section", rpc);
+            throw new RestconfDocumentedException("No input specified for RPC " + rpc
+                    + " with an input section defined", ErrorType.RPC, ErrorTag.MISSING_ELEMENT);
         }
 
         final ListenableFuture<DOMRpcResult> response;
@@ -815,21 +825,28 @@ public final class RestconfImpl implements RestconfService {
             }
 
             try {
-                result.getFutureOfPutData().checkedGet();
-                return Response.status(result.getStatus()).build();
-            } catch (final TransactionCommitFailedException e) {
-                if (e instanceof OptimisticLockFailedException) {
+                result.getFutureOfPutData().get();
+            } catch (final InterruptedException e) {
+                LOG.debug("Update failed for {}", identifier, e);
+                throw new RestconfDocumentedException(e.getMessage(), e);
+            } catch (final ExecutionException e) {
+                final TransactionCommitFailedException failure = Throwables.getCauseAs(e,
+                    TransactionCommitFailedException.class);
+                if (failure instanceof OptimisticLockFailedException) {
                     if (--tries <= 0) {
                         LOG.debug("Got OptimisticLockFailedException on last try - failing {}", identifier);
-                        throw new RestconfDocumentedException(e.getMessage(), e, e.getErrorList());
+                        throw new RestconfDocumentedException(e.getMessage(), e, failure.getErrorList());
                     }
 
                     LOG.debug("Got OptimisticLockFailedException - trying again {}", identifier);
-                } else {
-                    LOG.debug("Update failed for {}", identifier, e);
-                    throw new RestconfDocumentedException(e.getMessage(), e, e.getErrorList());
+                    continue;
                 }
+
+                LOG.debug("Update failed for {}", identifier, e);
+                throw RestconfDocumentedException.decodeAndThrow(e.getMessage(), failure);
             }
+
+            return Response.status(result.getStatus()).build();
         }
     }
 
@@ -955,7 +972,7 @@ public final class RestconfImpl implements RestconfService {
                     "Point parameter can be used only with 'after' or 'before' values of Insert parameter.");
         }
 
-        CheckedFuture<Void, TransactionCommitFailedException> future;
+        FluentFuture<? extends CommitInfo> future;
         if (mountPoint != null) {
             future = this.broker.commitConfigurationDataPost(mountPoint, normalizedII, payload.getData(), insert,
                     point);
@@ -965,12 +982,14 @@ public final class RestconfImpl implements RestconfService {
         }
 
         try {
-            future.checkedGet();
-        } catch (final RestconfDocumentedException e) {
-            throw e;
-        } catch (final TransactionCommitFailedException e) {
+            future.get();
+        } catch (final InterruptedException e) {
+            LOG.info("Error creating data {}", uriInfo != null ? uriInfo.getPath() : "", e);
+            throw new RestconfDocumentedException(e.getMessage(), e);
+        } catch (final ExecutionException e) {
             LOG.info("Error creating data {}", uriInfo != null ? uriInfo.getPath() : "", e);
-            throw new RestconfDocumentedException(e.getMessage(), e, e.getErrorList());
+            throw RestconfDocumentedException.decodeAndThrow(e.getMessage(), Throwables.getCauseAs(e,
+                TransactionCommitFailedException.class));
         }
 
         LOG.trace("Successfuly created data.");
@@ -1009,7 +1028,7 @@ public final class RestconfImpl implements RestconfService {
         final DOMMountPoint mountPoint = iiWithData.getMountPoint();
         final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier();
 
-        final CheckedFuture<Void, TransactionCommitFailedException> future;
+        final FluentFuture<? extends CommitInfo> future;
         if (mountPoint != null) {
             future = this.broker.commitConfigurationDataDelete(mountPoint, normalizedII);
         } else {
@@ -1017,18 +1036,19 @@ public final class RestconfImpl implements RestconfService {
         }
 
         try {
-            future.checkedGet();
-        } catch (final TransactionCommitFailedException e) {
+            future.get();
+        } catch (final InterruptedException e) {
+            throw new RestconfDocumentedException(e.getMessage(), e);
+        } catch (final ExecutionException e) {
             final Optional<Throwable> searchedException = Iterables.tryFind(Throwables.getCausalChain(e),
-                    Predicates.instanceOf(ModifiedNodeDoesNotExistException.class));
+                    Predicates.instanceOf(ModifiedNodeDoesNotExistException.class)).toJavaUtil();
             if (searchedException.isPresent()) {
-                throw new RestconfDocumentedException("Data specified for delete doesn't exist.",
-                        ErrorType.APPLICATION, ErrorTag.DATA_MISSING, e);
+                throw new RestconfDocumentedException("Data specified for delete doesn't exist.", ErrorType.APPLICATION,
+                    ErrorTag.DATA_MISSING, e);
             }
 
-            final String errMsg = "Error while deleting data";
-            LOG.info(errMsg, e);
-            throw new RestconfDocumentedException(e.getMessage(), e, e.getErrorList());
+            throw RestconfDocumentedException.decodeAndThrow(e.getMessage(), Throwables.getCauseAs(e,
+                TransactionCommitFailedException.class));
         }
 
         return Response.status(Status.OK).build();
@@ -1202,7 +1222,7 @@ public final class RestconfImpl implements RestconfService {
         return uriToWebsocketServerBuilder.replacePath(streamName).build();
     }
 
-    private String getWsScheme(final UriInfo uriInfo) {
+    private static String getWsScheme(final UriInfo uriInfo) {
         URI uri = uriInfo.getAbsolutePath();
         if (uri == null) {
             return "ws";
@@ -1384,7 +1404,7 @@ public final class RestconfImpl implements RestconfService {
         return listModuleBuilder.build();
     }
 
-    protected MapEntryNode toModuleEntryNode(final Module module, final DataSchemaNode moduleSchemaNode) {
+    private MapEntryNode toModuleEntryNode(final Module module, final DataSchemaNode moduleSchemaNode) {
         Preconditions.checkArgument(moduleSchemaNode instanceof ListSchemaNode,
                 "moduleSchemaNode has to be of type ListSchemaNode");
         final ListSchemaNode listModuleSchemaNode = (ListSchemaNode) moduleSchemaNode;
@@ -1398,22 +1418,22 @@ public final class RestconfImpl implements RestconfService {
         moduleNodeValues
                 .withChild(Builders.leafBuilder((LeafSchemaNode) nameSchemaNode).withValue(module.getName()).build());
 
+        final QNameModule qNameModule = module.getQNameModule();
+
         instanceDataChildrenByName =
                 ControllerContext.findInstanceDataChildrenByName(listModuleSchemaNode, "revision");
         final DataSchemaNode revisionSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
         Preconditions.checkState(revisionSchemaNode instanceof LeafSchemaNode);
-        final java.util.Optional<Revision> revision = module.getQNameModule().getRevision();
-        if (revision.isPresent()) {
-            moduleNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) revisionSchemaNode)
-                .withValue(revision.get().toString()).build());
-        }
+        final java.util.Optional<Revision> revision = qNameModule.getRevision();
+        moduleNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) revisionSchemaNode)
+                .withValue(revision.map(Revision::toString).orElse("")).build());
 
         instanceDataChildrenByName =
                 ControllerContext.findInstanceDataChildrenByName(listModuleSchemaNode, "namespace");
         final DataSchemaNode namespaceSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
         Preconditions.checkState(namespaceSchemaNode instanceof LeafSchemaNode);
         moduleNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) namespaceSchemaNode)
-                .withValue(module.getNamespace().toString()).build());
+                .withValue(qNameModule.getNamespace().toString()).build());
 
         instanceDataChildrenByName =
                 ControllerContext.findInstanceDataChildrenByName(listModuleSchemaNode, "feature");
@@ -1455,7 +1475,7 @@ public final class RestconfImpl implements RestconfService {
         final DataSchemaNode replaySupportSchemaNode = Iterables.getFirst(instanceDataChildrenByName, null);
         Preconditions.checkState(replaySupportSchemaNode instanceof LeafSchemaNode);
         streamNodeValues.withChild(Builders.leafBuilder((LeafSchemaNode) replaySupportSchemaNode)
-                .withValue(Boolean.valueOf(true)).build());
+                .withValue(Boolean.TRUE).build());
 
         instanceDataChildrenByName =
                 ControllerContext.findInstanceDataChildrenByName(listStreamSchemaNode, "replay-log-creation-time");