Provide validation API

Author: sven1103

project-management/src/main/java/life/qbic/projectmanagement/application/api/AsyncProjectService.java

@@ -9,6 +9,7 @@
 import java.util.Set;
 import java.util.UUID;
 import life.qbic.application.commons.SortOrder;
+import life.qbic.projectmanagement.application.ValidationResult;
 import life.qbic.projectmanagement.application.batch.SampleUpdateRequest.SampleInformation;
 import life.qbic.projectmanagement.application.confounding.ConfoundingVariableService.ConfoundingVariableInformation;
 import life.qbic.projectmanagement.application.sample.SamplePreview;
@@ -222,6 +223,20 @@ Flux<SamplePreview> getSamplePreviews(String projectId, String experimentId, int
    */
   Mono<Sample> findSample(String projectId, String sampleId);
 
+  /**
+   * Submits multiple validation requests in a single service call.
+   *
+   * @param requests a list of one or more {@link ValidationRequest}.
+   * @return a {@link Flux} of {@link ValidationResponse}, providing the validation results for the
+   * submitted requests. Exceptions are provided as {@link Flux#error(Throwable)}.
+   * @throws UnknownRequestException if an unknown request has been used in the service call
+   * @throws RequestFailedException  if the request was not successfully executed
+   * @throws AccessDeniedException   if the user has insufficient rights
+   * @since 1.10.0
+   */
+  Flux<ValidationResponse> validate(List<ValidationRequest> requests) throws RequestFailedException;
+
+
   /**
    * Container of an update request for a service call and part of the
    * {@link ProjectUpdateRequest}.
@@ -255,14 +270,30 @@ sealed interface ExperimentUpdateResponseBody permits ConfoundingVariables, Expe
 
   }
 
+  /**
+   * A validation request body for information that shall be validated by the service.
+   * <p>
+   * Currently, permits:
+   *
+   * <ul>
+   *   <li>{@link SampleMetadata}</li>
+   * </ul>
+   *
+   * @since 1.10.0
+   */
+  sealed interface ValidationRequestBody permits SampleMetadata {
+
+  }
+
 
   /**
    * Cacheable requests provide a unique identifier so cache implementations can unambiguously
    * manage the requests.
    *
    * @since 1.9.0
    */
-  sealed interface CacheableRequest permits ProjectUpdateRequest, ExperimentUpdateRequest {
+  sealed interface CacheableRequest permits ExperimentUpdateRequest, ProjectUpdateRequest,
+      ValidationRequest {
 
     /**
      * Returns an ID that is unique to the request.
@@ -411,7 +442,8 @@ public List<ExperimentalVariable> experimentalVariables() {
    * @param unit         the unit for the value of the level. Can be null if no unit is set
    * @since 1.9.0
    */
-  record VariableLevel(Long variableId, String variableName, String levelValue, @Nullable String unit) {
+  record VariableLevel(Long variableId, String variableName, String levelValue,
+                       @Nullable String unit) {
 
   }
 
@@ -549,16 +581,15 @@ public List<ConfoundingVariableInformation> confoundingVariables() {
     }
   }
 
-
   /**
    * A service request to update an experiment
    *
    * @param projectId    the project's identifier. The project containing the experiment.
    * @param experimentId the experiment's identifier
    * @param body         the request body containing information on what was updated
-   * @param requestId    The identifier of the request. Please use
-   *                     {@link #ExperimentUpdateRequest(String, String,
-   *                     ExperimentUpdateRequestBody)} if it is not determined yet.
+   * @param requestId    the request ID, needs to be provided by the client and will be referenced
+   *                     in the response. If <code>null</code> or {@link String#isBlank()} is true,
+   *                     then a random UUID is assigned with {@link UUID#randomUUID()}
    * @since 1.9.0
    */
   record ExperimentUpdateRequest(String projectId, String experimentId,
@@ -662,26 +693,44 @@ record ProjectCreationResponse(String projectId) {
    *
    * @param projectId   the project's id
    * @param requestBody the information to be updated.
+   * @param requestId   the request ID, needs to be provided by the client and will be referenced in
+   *                    the response. If <code>null</code> or {@link String#isBlank()} is true, then
+   *                    a random UUID is assigned with {@link UUID#randomUUID()}.
    * @since 1.9.0
    */
   record ProjectUpdateRequest(String projectId, ProjectUpdateRequestBody requestBody,
-                              String id) implements CacheableRequest {
+                              String requestId) implements CacheableRequest {
+
+    public ProjectUpdateRequest {
+      if (projectId == null) {
+        throw new IllegalArgumentException("Project ID cannot be null");
+      }
+      if (projectId.isBlank()) {
+        throw new IllegalArgumentException("Project ID cannot be blank");
+      }
+      if (requestId != null && requestId.isBlank()) {
+        requestId = null;
+      }
+      if (requestId == null) {
+        requestId = UUID.randomUUID().toString();
+      }
+    }
+
 
     public ProjectUpdateRequest(String projectId, ProjectUpdateRequestBody requestBody) {
       this(projectId, requestBody, UUID.randomUUID().toString());
     }
 
-    @Override
-    public String requestId() {
-      return id;
-    }
   }
 
   /**
    * A service response from an update project information request.
    *
    * @param projectId    the project's id
    * @param responseBody the information that was updated.
+   * @param requestId    the request ID, needs to be provided by the client and will be referenced
+   *                     in the response. If <code>null</code> or {@link String#isBlank()} is true,
+   *                     then a random UUID is assigned with {@link UUID#randomUUID()}
    * @since 1.9.0
    */
   record ProjectUpdateResponse(String projectId, ProjectUpdateResponseBody responseBody,
@@ -697,6 +746,9 @@ record ProjectUpdateResponse(String projectId, ProjectUpdateResponseBody respons
       if (requestId != null && requestId.isBlank()) {
         requestId = null;
       }
+      if (requestId == null) {
+        requestId = UUID.randomUUID().toString();
+      }
     }
 
     /**
@@ -709,21 +761,62 @@ public Optional<String> retrieveRequestId() {
       return Optional.ofNullable(requestId);
     }
 
-    /**
-     * Returns the requestId, can be null.
-     *
-     * @return Returns the requestId, if no requestId is set, returns null.
-     */
-    @Override
-    public String requestId() {
-      return requestId;
-    }
-
     boolean hasRequestId() {
       return nonNull(requestId);
     }
   }
 
+  /**
+   * The actual request container for metadata validation.
+   * <p>
+   * A validation request contains a {@link ValidationRequestBody} with the actual metadata to be
+   * validated, next to the project ID and the request ID.
+   *
+   * @param projectId   the project ID of the project the metadata shall be validated for
+   * @param requestBody the actual metadata container with the information to be validated
+   * @param requestId   the request ID, needs to be provided by the client and will be referenced in
+   *                    the response. If <code>null</code> or {@link String#isBlank()} is true, then
+   *                    a random UUID is assigned with {@link UUID#randomUUID()}
+   * @since 1.10.0
+   */
+  record ValidationRequest(String projectId, ValidationRequestBody requestBody,
+                           String requestId) implements CacheableRequest {
+
+    public ValidationRequest {
+      if (projectId == null) {
+        throw new IllegalArgumentException("Project ID cannot be null");
+      }
+      if (projectId.isBlank()) {
+        throw new IllegalArgumentException("Project ID cannot be blank");
+      }
+      if (requestId != null && requestId.isBlank()) {
+        requestId = null;
+      }
+      if (requestId == null) {
+        requestId = UUID.randomUUID().toString();
+      }
+    }
+  }
+
+  /**
+   * The response to a corresponding {@link ValidationRequest} with information about the actual
+   * validation result.
+   * <p>
+   * The result itself is provided in the {@link ValidationResult} property.
+   *
+   * @param requestId the original ID of the request from {@link ValidationRequest}
+   * @param result    the validation report provided as {@link ValidationResult}
+   * @since 1.10.0
+   */
+  record ValidationResponse(String requestId, ValidationResult result) {
+
+    public ValidationResponse {
+      if (requestId == null || requestId.isBlank()) {
+        throw new IllegalArgumentException("Request ID cannot be null or blank");
+      }
+    }
+  }
+
   /**
    * Exception to indicate that the service did not recognise the request.
    *

project-management/src/main/java/life/qbic/projectmanagement/application/api/AsyncProjectServiceImpl.java

@@ -161,6 +161,12 @@ public Mono<Sample> findSample(String projectId, String sampleId) {
     }).subscribeOn(scheduler);
   }
 
+  @Override
+  public Flux<ValidationResponse> validate(List<ValidationRequest> requests)
+      throws RequestFailedException {
+    throw new RuntimeException("not implemented");
+  }
+
   @Override
   public Mono<ExperimentUpdateResponse> update(
       ExperimentUpdateRequest request) {

…t/application/sample/SampleMetadata.java …ment/application/api/SampleMetadata.javaproject-management/src/main/java/life/qbic/projectmanagement/application/sample/SampleMetadata.java renamed to project-management/src/main/java/life/qbic/projectmanagement/application/api/SampleMetadata.java project-management/src/main/java/life/qbic/projectmanagement/application/sample/SampleMetadata.java renamed to project-management/src/main/java/life/qbic/projectmanagement/application/api/SampleMetadata.java

@@ -1,7 +1,8 @@
-package life.qbic.projectmanagement.application.sample;
+package life.qbic.projectmanagement.application.api;
 
 import java.util.Map;
 import java.util.Optional;
+import life.qbic.projectmanagement.application.api.AsyncProjectService.ValidationRequestBody;
 import life.qbic.projectmanagement.application.confounding.ConfoundingVariableService.ConfoundingVariableInformation;
 import life.qbic.projectmanagement.domain.model.OntologyTerm;
 import life.qbic.projectmanagement.domain.model.sample.AnalysisMethod;
@@ -27,7 +28,7 @@ public record SampleMetadata(
     String comment,
     Map<ConfoundingVariableInformation, String> confoundingVariables,
     String experimentId
-) {
+) implements ValidationRequestBody {
 
   public static SampleMetadata createNew(String sampleName,
       AnalysisMethod analysisToBePerformed,

project-management/src/main/java/life/qbic/projectmanagement/application/sample/SampleRegistrationServiceV2.java

@@ -16,6 +16,7 @@
 import life.qbic.logging.api.Logger;
 import life.qbic.projectmanagement.application.DeletionService;
 import life.qbic.projectmanagement.application.api.SampleCodeService;
+import life.qbic.projectmanagement.application.api.SampleMetadata;
 import life.qbic.projectmanagement.application.batch.BatchRegistrationService;
 import life.qbic.projectmanagement.application.confounding.ConfoundingVariableService;
 import life.qbic.projectmanagement.application.confounding.ConfoundingVariableService.ExperimentReference;

project-management/src/main/java/life/qbic/projectmanagement/application/sample/SampleValidation.java

@@ -14,6 +14,7 @@
 import java.util.stream.Collectors;
 import life.qbic.projectmanagement.application.ValidationResult;
 import life.qbic.projectmanagement.application.ValidationResultWithPayload;
+import life.qbic.projectmanagement.application.api.SampleMetadata;
 import life.qbic.projectmanagement.application.confounding.ConfoundingVariableService;
 import life.qbic.projectmanagement.application.confounding.ConfoundingVariableService.ConfoundingVariableInformation;
 import life.qbic.projectmanagement.application.confounding.ConfoundingVariableService.ExperimentReference;

project-management/src/main/java/life/qbic/projectmanagement/application/sample/SampleValidationService.java

@@ -4,6 +4,7 @@
 import java.util.Objects;
 import java.util.concurrent.CompletableFuture;
 import life.qbic.projectmanagement.application.ValidationResultWithPayload;
+import life.qbic.projectmanagement.application.api.SampleMetadata;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.scheduling.annotation.Async;
 import org.springframework.security.access.prepost.PreAuthorize;

user-interface/src/main/java/life/qbic/datamanager/views/projects/project/samples/registration/batch/EditSampleBatchDialog.java

@@ -41,7 +41,7 @@
 import life.qbic.logging.service.LoggerFactory;
 import life.qbic.projectmanagement.application.ValidationResult;
 import life.qbic.projectmanagement.application.ValidationResultWithPayload;
-import life.qbic.projectmanagement.application.sample.SampleMetadata;
+import life.qbic.projectmanagement.application.api.SampleMetadata;
 import life.qbic.projectmanagement.application.sample.SampleValidationService;
 import life.qbic.projectmanagement.domain.model.batch.BatchId;
 import org.apache.poi.ss.usermodel.Workbook;

user-interface/src/main/java/life/qbic/datamanager/views/projects/project/samples/registration/batch/RegisterSampleBatchDialog.java

@@ -40,7 +40,7 @@
 import life.qbic.logging.service.LoggerFactory;
 import life.qbic.projectmanagement.application.ValidationResult;
 import life.qbic.projectmanagement.application.ValidationResultWithPayload;
-import life.qbic.projectmanagement.application.sample.SampleMetadata;
+import life.qbic.projectmanagement.application.api.SampleMetadata;
 import life.qbic.projectmanagement.application.sample.SampleValidationService;
 import org.apache.poi.ss.usermodel.Workbook;