API for requesting templates for sample registration and update (#1082)

Introduces a reactive API for requesting templates to register or update samples for a data manager experiment.

Author: sven1103

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

@@ -9,13 +9,15 @@
 import java.util.Set;
 import java.util.UUID;
 import life.qbic.application.commons.SortOrder;
+import life.qbic.projectmanagement.application.api.fair.DigitalObject;
 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;
 import life.qbic.projectmanagement.domain.model.sample.Sample;
 import life.qbic.projectmanagement.domain.model.sample.SampleRegistrationRequest;
 import org.springframework.lang.Nullable;
+import org.springframework.util.MimeType;
 import reactor.core.publisher.Flux;
 import reactor.core.publisher.Mono;
 
@@ -216,7 +218,7 @@ Flux<SamplePreview> getSamplePreviews(String projectId, String experimentId, int
    * @param projectId the project id to which the sample belongs to
    * @param sampleId  the sample id of the sample to find
    * @return a reactive container of {@link Sample} for the sample matching the sample id. For no
-   * matches a {@link Mono#empty()} is returned. Exceptions are * provided as
+   * matches a {@link Mono#empty()} is returned. Exceptions are provided as
    * {@link Mono#error(Throwable)}.
    * @throws RequestFailedException in case the request cannot be executed
    * @since 1.10.0
@@ -236,6 +238,44 @@ Flux<SamplePreview> getSamplePreviews(String projectId, String experimentId, int
    */
   Flux<ValidationResponse> validate(Flux<ValidationRequest> requests);
 
+  /**
+   * Requests a sample registration template in a desired {@link MimeType}.
+   * <p>
+   * If the mime type is not supported, a {@link UnsupportedMimeTypeException} will be provided as
+   * {@link Mono#error(Throwable)}.
+   *
+   * @param projectId    the project ID of the project the template should be created for
+   * @param experimentId the experiment ID of the experiment the template should be created for
+   * @param mimeType     the mime type the digital object should be
+   * @return a {@link Mono} with a {@link DigitalObject} providing the requested template
+   * @throws AccessDeniedException        if the user has insufficient rights
+   * @throws RequestFailedException       if the request cannot be executed
+   * @throws UnsupportedMimeTypeException if the service cannot provide the requested
+   *                                      {@link MimeType}
+   * @since 1.10.0
+   */
+  Mono<DigitalObject> sampleRegistrationTemplate(String projectId, String experimentId,
+      MimeType mimeType);
+
+  /**
+   * Requests a sample update template in a desired {@link MimeType}.
+   * <p>
+   * If the mime type is not supported, a {@link UnsupportedMimeTypeException} will be provided as
+   * {@link Mono#error(Throwable)}.
+   *
+   * @param projectId    the project ID of the project the template should be created for
+   * @param experimentId the experiment ID of the experiment the template should be created for
+   * @param mimeType     the mime type the digital object should be
+   * @return a {@link Mono} with a {@link DigitalObject} providing the requested template
+   * @throws AccessDeniedException        if the user has insufficient rights
+   * @throws RequestFailedException       if the request cannot be executed
+   * @throws UnsupportedMimeTypeException if the service cannot provide the requested
+   *                                      {@link MimeType}
+   * @since 1.10.0
+   */
+  Mono<DigitalObject> sampleUpdateTemplate(String projectId, String experimentId,
+      MimeType mimeType);
+
   /**
    * Container of an update request for a service call and part of the
    * {@link ProjectUpdateRequest}.
@@ -883,4 +923,16 @@ public AccessDeniedException(String message, Throwable cause) {
     }
   }
 
+  /**
+   * Exception to indicate that a service implementation cannot handle a certain mime type.
+   *
+   * @since 1.10.0
+   */
+  class UnsupportedMimeTypeException extends RuntimeException {
+
+    public UnsupportedMimeTypeException(String message) {
+      super(message);
+    }
+  }
+
 }

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

@@ -33,6 +33,7 @@
 import org.springframework.security.core.context.SecurityContext;
 import org.springframework.security.core.context.SecurityContextHolder;
 import org.springframework.stereotype.Service;
+import org.springframework.util.MimeType;
 import reactor.core.publisher.Flux;
 import reactor.core.publisher.FluxSink;
 import reactor.core.publisher.FluxSink.OverflowStrategy;
@@ -235,6 +236,18 @@ public Mono<Sample> findSample(String projectId, String sampleId) {
     }).subscribeOn(scheduler);
   }
 
+  @Override
+  public Mono<DigitalObject> sampleRegistrationTemplate(String projectId, String experimentId,
+      MimeType mimeType) {
+    throw new RuntimeException("not implemented");
+  }
+
+  @Override
+  public Mono<DigitalObject> sampleUpdateTemplate(String projectId, String experimentId,
+      MimeType mimeType) {
+    throw new RuntimeException("not implemented");
+  }
+
   @Override
   public Flux<ValidationResponse> validate(Flux<ValidationRequest> requests)
       throws RequestFailedException {