Refactor ServerRequest
[netconf.git] / restconf / restconf-nb / src / main / java / org / opendaylight / restconf / server / mdsal / MdsalRestconfServer.java
index b990b148edc9ae24e4edc0aa57aabd197a3be2ba..ca51fa156f956f7220577dc5b6c61f0c3d3bd25c 100644 (file)
@@ -19,7 +19,6 @@ import java.net.URI;
 import java.time.format.DateTimeParseException;
 import java.util.List;
 import java.util.Locale;
-import java.util.Map;
 import javax.annotation.PreDestroy;
 import javax.inject.Inject;
 import javax.inject.Singleton;
@@ -32,14 +31,11 @@ import org.opendaylight.mdsal.dom.api.DOMRpcService;
 import org.opendaylight.restconf.api.ApiPath;
 import org.opendaylight.restconf.api.FormattableBody;
 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
-import org.opendaylight.restconf.common.errors.RestconfFuture;
-import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.MdsalRestconfStrategy;
 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.RestconfStrategy;
 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.RestconfStrategy.StrategyAndTail;
 import org.opendaylight.restconf.server.api.ChildBody;
 import org.opendaylight.restconf.server.api.CreateResourceResult;
-import org.opendaylight.restconf.server.api.DataGetParams;
 import org.opendaylight.restconf.server.api.DataGetResult;
 import org.opendaylight.restconf.server.api.DataPatchResult;
 import org.opendaylight.restconf.server.api.DataPostBody;
@@ -53,21 +49,19 @@ import org.opendaylight.restconf.server.api.OperationInputBody;
 import org.opendaylight.restconf.server.api.PatchBody;
 import org.opendaylight.restconf.server.api.ResourceBody;
 import org.opendaylight.restconf.server.api.RestconfServer;
+import org.opendaylight.restconf.server.api.ServerException;
+import org.opendaylight.restconf.server.api.ServerRequest;
 import org.opendaylight.restconf.server.spi.RpcImplementation;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.restconf.rev170126.YangApi;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.restconf.rev170126.restconf.Restconf;
 import org.opendaylight.yangtools.yang.common.Empty;
 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.Revision;
 import org.opendaylight.yangtools.yang.common.YangNames;
-import org.opendaylight.yangtools.yang.data.spi.node.ImmutableNodes;
 import org.opendaylight.yangtools.yang.model.api.source.SourceIdentifier;
 import org.opendaylight.yangtools.yang.model.api.source.SourceRepresentation;
 import org.opendaylight.yangtools.yang.model.api.source.YangTextSource;
 import org.opendaylight.yangtools.yang.model.api.source.YinTextSource;
-import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
 import org.osgi.service.component.annotations.Activate;
 import org.osgi.service.component.annotations.Component;
 import org.osgi.service.component.annotations.Deactivate;
@@ -80,7 +74,6 @@ import org.osgi.service.component.annotations.ReferencePolicyOption;
 @Singleton
 @Component(service = RestconfServer.class)
 public final class MdsalRestconfServer implements RestconfServer, AutoCloseable {
-    private static final QName YANG_LIBRARY_VERSION = QName.create(Restconf.QNAME, "yang-library-version").intern();
     private static final VarHandle LOCAL_STRATEGY;
 
     static {
@@ -126,8 +119,8 @@ public final class MdsalRestconfServer implements RestconfServer, AutoCloseable
     }
 
     private @NonNull MdsalRestconfStrategy createLocalStrategy(final DatabindContext databind) {
-        return new MdsalRestconfStrategy(databind, dataBroker, rpcService, actionService,
-            databindProvider.sourceProvider(), mountPointService, localRpcs);
+        return new MdsalRestconfStrategy(databind, dataBroker, localRpcs, rpcService, actionService,
+            databindProvider.sourceProvider(), mountPointService);
     }
 
     private @NonNull MdsalRestconfStrategy localStrategy() {
@@ -150,163 +143,175 @@ public final class MdsalRestconfServer implements RestconfServer, AutoCloseable
     }
 
     @Override
-    public RestconfFuture<Empty> dataDELETE(final ApiPath identifier) {
+    public void dataDELETE(final ServerRequest<Empty> request, final ApiPath identifier) {
         final StrategyAndTail stratAndTail;
         try {
             stratAndTail = localStrategy().resolveStrategy(identifier);
-        } catch (RestconfDocumentedException e) {
-            return RestconfFuture.failed(e);
+        } catch (ServerException e) {
+            request.completeWith(e);
+            return;
         }
-        return stratAndTail.strategy().dataDELETE(stratAndTail.tail());
+        stratAndTail.strategy().dataDELETE(request, stratAndTail.tail());
     }
 
     @Override
-    public RestconfFuture<DataGetResult> dataGET(final DataGetParams params) {
-        return localStrategy().dataGET(ApiPath.empty(), params);
+    public void dataGET(final ServerRequest<DataGetResult> request) {
+        localStrategy().dataGET(request, ApiPath.empty());
     }
 
     @Override
-    public RestconfFuture<DataGetResult> dataGET(final ApiPath identifier, final DataGetParams params) {
+    public void dataGET(final ServerRequest<DataGetResult> request, final ApiPath identifier) {
         final StrategyAndTail stratAndTail;
         try {
             stratAndTail = localStrategy().resolveStrategy(identifier);
-        } catch (RestconfDocumentedException e) {
-            return RestconfFuture.failed(e);
+        } catch (ServerException e) {
+            request.completeWith(e);
+            return;
         }
-        return stratAndTail.strategy().dataGET(stratAndTail.tail(), params);
+        stratAndTail.strategy().dataGET(request, stratAndTail.tail());
     }
 
     @Override
-    public RestconfFuture<DataPatchResult> dataPATCH(final ResourceBody body) {
-        return localStrategy().dataPATCH(ApiPath.empty(), body);
+    public void dataPATCH(final ServerRequest<DataPatchResult> request, final ResourceBody body) {
+        localStrategy().dataPATCH(request, ApiPath.empty(), body);
     }
 
     @Override
-    public RestconfFuture<DataPatchResult> dataPATCH(final ApiPath identifier, final ResourceBody body) {
+    public void dataPATCH(final ServerRequest<DataPatchResult> request, final ApiPath identifier,
+            final ResourceBody body) {
         final StrategyAndTail strategyAndTail;
         try {
             strategyAndTail = localStrategy().resolveStrategy(identifier);
-        } catch (RestconfDocumentedException e) {
-            return RestconfFuture.failed(e);
+        } catch (ServerException e) {
+            request.completeWith(e);
+            return;
         }
-        return strategyAndTail.strategy().dataPATCH(strategyAndTail.tail(), body);
+        strategyAndTail.strategy().dataPATCH(request, strategyAndTail.tail(), body);
     }
 
     @Override
-    public RestconfFuture<DataYangPatchResult> dataPATCH(final Map<String, String> queryParameters,
-            final PatchBody body) {
-        return localStrategy().dataPATCH(ApiPath.empty(), queryParameters, body);
+    public void dataPATCH(final ServerRequest<DataYangPatchResult> request, final PatchBody body) {
+        localStrategy().dataPATCH(request, ApiPath.empty(), body);
     }
 
     @Override
-    public RestconfFuture<DataYangPatchResult> dataPATCH(final ApiPath identifier,
-            final Map<String, String> queryParameters, final PatchBody body) {
+    public void dataPATCH(final ServerRequest<DataYangPatchResult> request, final ApiPath identifier,
+            final PatchBody body) {
         final StrategyAndTail strategyAndTail;
         try {
             strategyAndTail = localStrategy().resolveStrategy(identifier);
-        } catch (RestconfDocumentedException e) {
-            return RestconfFuture.failed(e);
+        } catch (ServerException e) {
+            request.completeWith(e);
+            return;
         }
-        return strategyAndTail.strategy().dataPATCH(strategyAndTail.tail(), queryParameters, body);
+        strategyAndTail.strategy().dataPATCH(request, strategyAndTail.tail(), body);
     }
 
     @Override
-    public RestconfFuture<CreateResourceResult> dataPOST(final ChildBody body,
-            final Map<String, String> queryParameters) {
-        return localStrategy().dataCreatePOST(body, queryParameters);
+    public void dataPOST(final ServerRequest<CreateResourceResult> request, final ChildBody body) {
+        localStrategy().dataCreatePOST(request, body);
     }
 
     @Override
-    public RestconfFuture<? extends DataPostResult> dataPOST(final ApiPath identifier, final DataPostBody body,
-            final Map<String, String> queryParameters) {
+    public void dataPOST(final ServerRequest<DataPostResult> request, final ApiPath identifier,
+            final DataPostBody body) {
         final StrategyAndTail strategyAndTail;
         try {
             strategyAndTail = localStrategy().resolveStrategy(identifier);
-        } catch (RestconfDocumentedException e) {
-            return RestconfFuture.failed(e);
+        } catch (ServerException e) {
+            request.completeWith(e);
+            return;
         }
-        return strategyAndTail.strategy().dataPOST(strategyAndTail.tail(), body, queryParameters);
+        strategyAndTail.strategy().dataPOST(request, strategyAndTail.tail(), body);
     }
 
     @Override
-    public RestconfFuture<DataPutResult> dataPUT(final ResourceBody body, final Map<String, String> query) {
-        return localStrategy().dataPUT(ApiPath.empty(), body, query);
+    public void dataPUT(final ServerRequest<DataPutResult> request, final ResourceBody body) {
+        localStrategy().dataPUT(request, ApiPath.empty(), body);
     }
 
     @Override
-    public RestconfFuture<DataPutResult> dataPUT(final ApiPath identifier, final ResourceBody body,
-             final Map<String, String> queryParameters) {
+    public void dataPUT(final ServerRequest<DataPutResult> request, final ApiPath identifier, final ResourceBody body) {
         final StrategyAndTail strategyAndTail;
         try {
             strategyAndTail = localStrategy().resolveStrategy(identifier);
-        } catch (RestconfDocumentedException e) {
-            return RestconfFuture.failed(e);
+        } catch (ServerException e) {
+            request.completeWith(e);
+            return ;
         }
-        return strategyAndTail.strategy().dataPUT(strategyAndTail.tail(), body, queryParameters);
+        strategyAndTail.strategy().dataPUT(request, strategyAndTail.tail(), body);
     }
 
     @Override
-    public RestconfFuture<ModulesGetResult> modulesYangGET(final String fileName, final String revision) {
-        return modulesGET(fileName, revision, YangTextSource.class);
+    public void modulesYangGET(final ServerRequest<ModulesGetResult> request, final String fileName,
+            final String revision) {
+        modulesGET(request, fileName, revision, YangTextSource.class);
     }
 
     @Override
-    public RestconfFuture<ModulesGetResult> modulesYangGET(final ApiPath mountPath, final String fileName,
-            final String revision) {
-        return modulesGET(mountPath, fileName, revision, YangTextSource.class);
+    public void modulesYangGET(final ServerRequest<ModulesGetResult> request, final ApiPath mountPath,
+            final String fileName, final String revision) {
+        modulesGET(request, mountPath, fileName, revision, YangTextSource.class);
     }
 
     @Override
-    public RestconfFuture<ModulesGetResult> modulesYinGET(final String fileName, final String revision) {
-        return modulesGET(fileName, revision, YinTextSource.class);
+    public void modulesYinGET(final ServerRequest<ModulesGetResult> request, final String fileName,
+            final String revision) {
+        modulesGET(request, fileName, revision, YinTextSource.class);
     }
 
     @Override
-    public RestconfFuture<ModulesGetResult> modulesYinGET(final ApiPath mountPath, final String fileName,
-            final String revision) {
-        return modulesGET(mountPath, fileName, revision, YinTextSource.class);
+    public void modulesYinGET(final ServerRequest<ModulesGetResult> request, final ApiPath mountPath,
+            final String fileName, final String revision) {
+        modulesGET(request, mountPath, fileName, revision, YinTextSource.class);
     }
 
-    private @NonNull RestconfFuture<ModulesGetResult> modulesGET(final String fileName, final String revision,
+    private void modulesGET(final ServerRequest<ModulesGetResult> request, final String fileName, final String revision,
             final Class<? extends SourceRepresentation> representation) {
-        return modulesGET(localStrategy(), fileName, revision, representation);
+        modulesGET(request, localStrategy(), fileName, revision, representation);
     }
 
-    private @NonNull RestconfFuture<ModulesGetResult> modulesGET(final ApiPath mountPath, final String fileName,
-            final String revision, final Class<? extends SourceRepresentation> representation) {
+    private void modulesGET(final ServerRequest<ModulesGetResult> request, final ApiPath mountPath,
+            final String fileName, final String revision, final Class<? extends SourceRepresentation> representation) {
         final var mountOffset = mountPath.indexOf("yang-ext", "mount");
         if (mountOffset != mountPath.steps().size() - 1) {
-            return RestconfFuture.failed(new RestconfDocumentedException("Mount path has to end with yang-ext:mount"));
+            request.completeWith(new RestconfDocumentedException("Mount path has to end with yang-ext:mount"));
+            return;
         }
 
         final StrategyAndTail stratAndTail;
         try {
             stratAndTail = localStrategy().resolveStrategy(mountPath);
-        } catch (RestconfDocumentedException e) {
-            return RestconfFuture.failed(e);
+        } catch (ServerException e) {
+            request.completeWith(e);
+            return;
         }
         // FIXME: require remnant to be empty
-        return modulesGET(stratAndTail.strategy(), fileName, revision, representation);
+        modulesGET(request, stratAndTail.strategy(), fileName, revision, representation);
     }
 
-    private static @NonNull RestconfFuture<ModulesGetResult> modulesGET(final RestconfStrategy strategy,
+    private static void modulesGET(final ServerRequest<ModulesGetResult> request, final RestconfStrategy strategy,
             final String moduleName, final String revisionStr,
             final Class<? extends SourceRepresentation> representation) {
         if (moduleName == null) {
-            return RestconfFuture.failed(new RestconfDocumentedException("Module name must be supplied",
+            request.completeWith(new RestconfDocumentedException("Module name must be supplied",
                 ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE));
+            return;
         }
         if (moduleName.isEmpty() || !YangNames.IDENTIFIER_START.matches(moduleName.charAt(0))) {
-            return RestconfFuture.failed(new RestconfDocumentedException(
+            request.completeWith(new RestconfDocumentedException(
                 "Identifier must start with character from set 'a-zA-Z_", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE));
+            return;
         }
         if (moduleName.toUpperCase(Locale.ROOT).startsWith("XML")) {
-            return RestconfFuture.failed(new RestconfDocumentedException(
+            request.completeWith(new RestconfDocumentedException(
                 "Identifier must NOT start with XML ignore case", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE));
+            return;
         }
         if (YangNames.NOT_IDENTIFIER_PART.matchesAnyOf(moduleName.substring(1))) {
-            return RestconfFuture.failed(new RestconfDocumentedException(
+            request.completeWith(new RestconfDocumentedException(
                 "Supplied name has not expected identifier format", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE));
+            return;
         }
 
         // YANG Revision-compliant string is required
@@ -314,56 +319,54 @@ public final class MdsalRestconfServer implements RestconfServer, AutoCloseable
         try {
             revision = Revision.ofNullable(revisionStr).orElse(null);
         } catch (final DateTimeParseException e) {
-            return RestconfFuture.failed(new RestconfDocumentedException(
+            request.completeWith(new RestconfDocumentedException(
                 "Supplied revision is not in expected date format YYYY-mm-dd",
                 ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE, e));
+            return;
         }
 
-        return strategy.resolveSource(new SourceIdentifier(moduleName, revision), representation)
-            .transform(ModulesGetResult::new);
+        strategy.resolveSource(request, new SourceIdentifier(moduleName, revision), representation);
     }
 
     @Override
-    public RestconfFuture<FormattableBody> operationsGET() {
-        return localStrategy().operationsGET();
+    public void operationsGET(final ServerRequest<FormattableBody> request) {
+        localStrategy().operationsGET(request);
     }
 
     @Override
-    public RestconfFuture<FormattableBody> operationsGET(final ApiPath operation) {
+    public void operationsGET(final ServerRequest<FormattableBody> request, final ApiPath operation) {
         final StrategyAndTail strategyAndTail;
         try {
             strategyAndTail = localStrategy().resolveStrategy(operation);
-        } catch (RestconfDocumentedException e) {
-            return RestconfFuture.failed(e);
+        } catch (ServerException e) {
+            request.completeWith(e);
+            return;
+        }
+
+        final var strategy = strategyAndTail.strategy();
+        final var tail = strategyAndTail.tail();
+        if (tail.isEmpty()) {
+            strategy.operationsGET(request);
+        } else {
+            strategy.operationsGET(request, tail);
         }
-        return strategyAndTail.strategy().operationsGET(strategyAndTail.tail());
     }
 
     @Override
-    public RestconfFuture<InvokeResult> operationsPOST(final URI restconfURI, final ApiPath apiPath,
-            final Map<String, String> queryParameters, final OperationInputBody body) {
+    public void operationsPOST(final ServerRequest<InvokeResult> request, final URI restconfURI, final ApiPath apiPath,
+            final OperationInputBody body) {
         final StrategyAndTail strategyAndTail;
         try {
             strategyAndTail = localStrategy().resolveStrategy(apiPath);
-        } catch (RestconfDocumentedException e) {
-            return RestconfFuture.failed(e);
+        } catch (ServerException e) {
+            request.completeWith(e);
+            return;
         }
-        final var strategy = strategyAndTail.strategy();
-        return strategy.operationsPOST(restconfURI, strategyAndTail.tail(), queryParameters, body);
+        strategyAndTail.strategy().operationsPOST(request, restconfURI, strategyAndTail.tail(), body);
     }
 
     @Override
-    public RestconfFuture<NormalizedNodePayload> yangLibraryVersionGET() {
-        final var stack = SchemaInferenceStack.of(localStrategy().modelContext());
-        try {
-            stack.enterYangData(YangApi.NAME);
-            stack.enterDataTree(Restconf.QNAME);
-            stack.enterDataTree(YANG_LIBRARY_VERSION);
-        } catch (IllegalArgumentException e) {
-            return RestconfFuture.failed(new RestconfDocumentedException("RESTCONF is not available"));
-        }
-        return RestconfFuture.of(new NormalizedNodePayload(stack.toInference(),
-            ImmutableNodes.leafNode(YANG_LIBRARY_VERSION, stack.modelContext().findModuleStatements("ietf-yang-library")
-                .iterator().next().localQNameModule().revisionUnion().unionString())));
+    public void yangLibraryVersionGET(final ServerRequest<FormattableBody> request) {
+        localStrategy().yangLibraryVersionGET(request);
     }
 }