Merge pull request #2372 from dzhw/release

Release v1.0.91

.travis.yml

@@ -19,17 +19,17 @@ addons:
       - g++-4.9
 stages:
     - name: build
-      if: NOT (branch =~ /^saikotitis.*$/ || branch =~ /^(development|master|test)$/)
+      if: NOT branch =~ /^(development|master|test)$/
     - name: build and deploy
       if: branch =~ /^(development|master|test)$/
     - name: e2e smoketests
-      if: type = cron || branch =~ /^saikotitis.*$/
+      if: type = cron
     - name: nightly e2e tests publicuser
-      if: type = cron || branch =~ /^saikotitis.*$/
+      if: type = cron
     - name: nightly e2e tests dataprovider
-      if: type = cron || branch =~ /^saikotitis.*$/
+      if: type = cron
     - name: nightly e2e tests publisher
-      if: type = cron || branch =~ /^saikotitis.*$/
+      if: type = cron
 jobs:
   include:
     - stage: build
@@ -202,5 +202,4 @@ jobs:
 notifications:
   email:
     recipients:
-      - secure: "oyEkjrcti+bTYz/TLA6tw6F6aTpeiWxMGyAsKOyYxYCjWw8sNsagiqzzLxcIdqy62ETCKmkGrYlJr1dofPT27j4pQgSuPT9EWkaviNfFG6AllGkW4+N6RdpMw3gXr0O/qtpy2LdXr1D8cP8Pji4V9DKriPkOMcE7tlBUHTCuDlchheenqszKpWBhQGtSipR0dDGo9AyhmbfUu9mnyl73A8Xi2XegKeie5J0JZzuiacwjbVZXO8JexyYN06rFpcyMIkdTUq4JHMENenszqYmZ4/P8QIymdxY/rBsNRXVl2vIXoFtOkIA+fjcPj6CuOxlGrs6+C5BvGc951uaicwFHDeZ15Csx2YpTTuqjNclgUYffGvaqwlUDrQhQ45paxYTqqLzStdbNJBaQEw8Oh3P6BdUKldDv93Y6ydkOeQlLBNS/+F1irNo8HtzUmHew3aF9unNAB1BD6x5jFlGUrO/xXra0RWiVD2p/q97cF8iEHyqlodRCtBFMZ+5F13fYbVPaIzwPWPgysvc0eDBE2W+hUPip7em/9pehhaVbhcy5fvmesHlMsmQc0UK/Rimfl2y3RXobGMNbyZheGWn+HJHn4K2Vy3D05AUPRn1z+XHh0H8i8L9M15JgvHq4hQVZtpyUbq1bgHcKFezB8v32Sd22bBMHXHbDe3h1hnlW7I3U+V8="
-      - secure: "l0q3avI4nJTwPKKfJldH/SdmeHB1grxsRiM/x2TX3bQE5JfYdureNVNAi85JXBiq/BilURWPNq+jYO+qJQRP4h5mwywJLmFy1JRWyfirglbu0fuC3NuB29qszhJ4ZVazoQM6Q46htXtignrDwABzn4sro20ns6L44ATBHT+npJmbVnfTTyWnhrGjJDlzp8uqNy//TbXWHMIVPgnCPv1w+9IdFxIIRbiVkSCRGkQMHxq4lMMqsg5x+wcyPnQYY+oLw2jx962lJQ2kXpD5yBTI22/0Kv9UxMXS4wYCPbhYeOF3xf4gVeTa1WSm0JjQRA/xI/o3lEPIp+FYubF+bpC+gOND1triu7mfn1VSbLr22xxYaevOzGDwc1dlEkm5wepakt6JyvzjCijafsi3rd6KhJ3QXXIvOeKFnmutaOR3zwBibeNuFDsc9nqd6dI+oQpKhmO3DVBZv/ftIccWZBHV7Z1N2F+GzKIpH3iE+cMjDIxRAQykql0p17/Bu2TvBUebnbMXiT8zKRnrFu6CHnOh3KroQl3KktNDqhVkcVLin4EP0RH9RjUds1M6N7den9IUJk49KF4gYtkPNEtdGekqv9BubAwc02XfseeEuyxK4t2f1xBPBLnzLgqqxkK5ZB1evJZ7oC8ShG9wyOCYjoJVEfwxOKJJ27dBjZWi5QX+n7M="
+      - secure: "rCV85HWYYl5lzvMatGA8h3O3t522tbxuSKIF3H6drTewXW17IRMuKaeBehF71Dva5vReIK6oLRx0YlAZK/SOZzY9+TDWwXFv7QeyDq/0c0cUaI9UX3wbf0puX9AZAIflNpkrc+NmV1vXci8A/MyZAfZFxKGJqE8wn1mGQnzJCD5D1sbcCXSrnQA0fOyyFq6ugr4vyIRY4iiu008WMFqP6V58dlxC3PJax3rPugXTUNzOHU1qiHdTA17R4q47hsmdJGtCNsAjemo+/D+w8nWp+DJokHsYv/SSngB5GprKv22vXiZWy3wnqjagvOfPHYZGfMYEtc7kMylOmrxrjx15cQiyIncJQKjabYCDQ2lkjjNS1bZTnobe/CHy+IkWxT/qiV/miDLOI0Tm6B6OQGJRhJoErBjRSnihZZo9fg8YVRJdApG3ZoWmuXwwOTi41rsHRdhClKzJzmSO+7paea7CPaobzvn54n2Lu1azp05GNG1hlxtNVlp7r7xh+e+W0JHj9trFmXq+vkO7nQtS3rtnnWnz8xqDBqXE3xWtRD0tiG0f9qev7AiMo+UTWEsvXuXI68ywHThppO2rHFN6RntLNgAwFzwwGBG0U4AblljYV7zT56f1xiEaAbe77Fyryi6uFTX7wJPLBLKfylWwt9vLgcDon/plVRuDivEvwBdgwQ8="

docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/AbstractShadowableRdcDomainObject.rst

@@ -2,6 +2,8 @@
 
 .. java:import:: org.springframework.data.mongodb.core.index Indexed
 
+.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation ValidHiddenShadow
+
 .. java:import:: lombok AccessLevel
 
 .. java:import:: lombok Data
@@ -16,12 +18,20 @@ AbstractShadowableRdcDomainObject
 .. java:package:: eu.dzhw.fdz.metadatamanagement.common.domain
    :noindex:
 
-.. java:type:: @Data @EqualsAndHashCode public abstract class AbstractShadowableRdcDomainObject extends AbstractRdcDomainObject
+.. java:type:: @Data @EqualsAndHashCode @ValidHiddenShadow public abstract class AbstractShadowableRdcDomainObject extends AbstractRdcDomainObject
 
-   Base class for all rdc domain objects which can exist as multiple versions.
+   Base class for all rdc domain objects which can exist as multiple versions (shadows).
 
 Fields
 ------
+hidden
+^^^^^^
+
+.. java:field:: private boolean hidden
+   :outertype: AbstractShadowableRdcDomainObject
+
+   True if and only if the shadow copy must not be available for the public user. Only shadow copies which have a successor may be hidden.
+
 serialVersionUID
 ^^^^^^^^^^^^^^^^
 

docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Task-TaskType.rst

@@ -37,9 +37,3 @@ DATA_SET_REPORT
 .. java:field:: public static final Task.TaskType DATA_SET_REPORT
    :outertype: Task.TaskType
 
-PROJECT_RELEASE
-^^^^^^^^^^^^^^^
-
-.. java:field:: public static final Task.TaskType PROJECT_RELEASE
-   :outertype: Task.TaskType
-

docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ShadowCopyQueueItem-Action.rst

@@ -0,0 +1,49 @@
+.. java:import:: java.time LocalDateTime
+
+.. java:import:: javax.validation.constraints NotNull
+
+.. java:import:: org.springframework.data.annotation Id
+
+.. java:import:: org.springframework.data.mongodb.core.mapping Document
+
+.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain AbstractRdcDomainObject
+
+.. java:import:: lombok AllArgsConstructor
+
+.. java:import:: lombok Data
+
+.. java:import:: lombok EqualsAndHashCode
+
+.. java:import:: lombok NoArgsConstructor
+
+ShadowCopyQueueItem.Action
+==========================
+
+.. java:package:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain
+   :noindex:
+
+.. java:type:: public enum Action
+   :outertype: ShadowCopyQueueItem
+
+   The action which will be performed for the shadows.
+
+Enum Constants
+--------------
+CREATE
+^^^^^^
+
+.. java:field:: public static final ShadowCopyQueueItem.Action CREATE
+   :outertype: ShadowCopyQueueItem.Action
+
+HIDE
+^^^^
+
+.. java:field:: public static final ShadowCopyQueueItem.Action HIDE
+   :outertype: ShadowCopyQueueItem.Action
+
+UNHIDE
+^^^^^^
+
+.. java:field:: public static final ShadowCopyQueueItem.Action UNHIDE
+   :outertype: ShadowCopyQueueItem.Action
+

docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ShadowCopyQueueItem.rst

@@ -28,13 +28,21 @@ ShadowCopyQueueItem
 
 Fields
 ------
+action
+^^^^^^
+
+.. java:field:: @NotNull private Action action
+   :outertype: ShadowCopyQueueItem
+
+   The action which will be performed for the shadow copies.
+
 dataAcquisitionProjectId
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. java:field:: @NotNull private String dataAcquisitionProjectId
    :outertype: ShadowCopyQueueItem
 
-   Project id for which a shadow copy should be created.
+   Project id for which a shadow copy should be created or hidden or unhidden.
 
 id
 ^^

docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ShadowHidingNotAllowedException.rst

@@ -0,0 +1,20 @@
+ShadowHidingNotAllowedException
+===============================
+
+.. java:package:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain
+   :noindex:
+
+.. java:type:: public class ShadowHidingNotAllowedException extends Exception
+
+   Exception which is thrown when the user tries to hide a master or the most recent shadow copy.
+
+   :author: René Reitmann
+
+Fields
+------
+serialVersionUID
+^^^^^^^^^^^^^^^^
+
+.. java:field:: private static final long serialVersionUID
+   :outertype: ShadowHidingNotAllowedException
+

docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/ShadowUnhidingNotAllowedException.rst

@@ -0,0 +1,20 @@
+ShadowUnhidingNotAllowedException
+=================================
+
+.. java:package:: eu.dzhw.fdz.metadatamanagement.projectmanagement.domain
+   :noindex:
+
+.. java:type:: public class ShadowUnhidingNotAllowedException extends Exception
+
+   Exception which is thrown when the user tries to unhide shadows which are already unhidden.
+
+   :author: René Reitmann
+
+Fields
+------
+serialVersionUID
+^^^^^^^^^^^^^^^^
+
+.. java:field:: private static final long serialVersionUID
+   :outertype: ShadowUnhidingNotAllowedException
+

docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/projectmanagement/domain/package-index.rst

@@ -17,5 +17,8 @@ Domain objects describing \ :java:ref:`eu.dzhw.fdz.metadatamanagement.projectman
    Release
    Requirements
    ShadowCopyQueueItem
+   ShadowCopyQueueItem-Action
    ShadowCopyReleaseToDaraNotAllowed
+   ShadowHidingNotAllowedException
+   ShadowUnhidingNotAllowedException
 

docs/source/questions.rst

@@ -50,3 +50,6 @@ meist "erkennbare" Nummerierung. Es wird zwischen fünf Fragetypen differenziert
 
 Die technische Dokumentation zum erstellen der Frage-Metadaten finden Sie hier:
 https://dzhw.github.io/questionMetadataPreparation/index.html
+
+Die Anleitung zur Zusammenstellung der Metadaten (inkl. Beschreibung der Attribute) finden Sie hier:
+https://dzhw.github.io/questionMetadataPreparation/articles/question_metadata_preparation_introduction.html

pom.xml

@@ -5,13 +5,13 @@
     <parent>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-parent</artifactId>
-        <version>2.1.7.RELEASE</version>
+        <version>2.1.8.RELEASE</version>
         <relativePath />
     </parent>
 
     <groupId>eu.dzhw.fdz.metadatamanagement</groupId>
     <artifactId>metadatamanagement</artifactId>
-    <version>1.0.90</version>
+    <version>1.0.91</version>
     <packaging>war</packaging>
     <name>metadatamanagement</name>
 
@@ -135,7 +135,7 @@
         <dependency>
             <groupId>org.apache.logging.log4j</groupId>
             <artifactId>log4j-core</artifactId>
-            <version>2.8.2</version>
+            <version>2.11.2</version>
         </dependency>
         <dependency>
             <groupId>org.apache.tika</groupId>
@@ -149,7 +149,7 @@
         <dependency>
             <groupId>org.javers</groupId>
             <artifactId>javers-spring-boot-starter-mongo</artifactId>
-            <version>5.6.3</version>
+            <version>5.7.2</version>
         </dependency>
         <dependency>
             <groupId>org.mapstruct</groupId>

src/main/java/eu/dzhw/fdz/metadatamanagement/common/domain/AbstractShadowableRdcDomainObject.java

@@ -4,16 +4,18 @@
 
 import org.springframework.data.mongodb.core.index.Indexed;
 
+import eu.dzhw.fdz.metadatamanagement.common.domain.validation.ValidHiddenShadow;
 import lombok.AccessLevel;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.Setter;
 
 /**
- * Base class for all rdc domain objects which can exist as multiple versions.
+ * Base class for all rdc domain objects which can exist as multiple versions (shadows).
  */
 @Data
 @EqualsAndHashCode(callSuper = false)
+@ValidHiddenShadow
 public abstract class AbstractShadowableRdcDomainObject extends AbstractRdcDomainObject {
 
   private static final long serialVersionUID = 8006229461938445620L;
@@ -30,9 +32,16 @@ public abstract class AbstractShadowableRdcDomainObject extends AbstractRdcDomai
   @Indexed
   private boolean shadow;
 
+  /**
+   * True if and only if the shadow copy must not be available for the public user.
+   * Only shadow copies which have a successor may be hidden.
+   */
+  private boolean hidden = false;
+
   /**
    * Set the master id for the document. This will modify it's
    * {@link AbstractShadowableRdcDomainObject#shadow} field as well.
+   * 
    * @param masterId Master id
    */
   public final void setMasterId(String masterId) {
@@ -43,6 +52,7 @@ public final void setMasterId(String masterId) {
   /**
    * Set the id for the document. This will modify it's
    * {@link AbstractShadowableRdcDomainObject#shadow} field as well.
+   * 
    * @param id Document id
    */
   public final void setId(String id) {
@@ -52,12 +62,14 @@ public final void setId(String id) {
 
   /**
    * Set masterId on implementations of {@link AbstractShadowableRdcDomainObject}.
+   * 
    * @param masterId Master Id
    */
   protected abstract void setMasterIdInternal(String masterId);
 
   /**
    * Set id on implementation of {@link AbstractShadowableRdcDomainObject}.
+   * 
    * @param id Id
    */
   protected abstract void setIdInternal(String id);

src/main/java/eu/dzhw/fdz/metadatamanagement/common/domain/Task.java

@@ -70,7 +70,6 @@ public enum TaskState {
    *
    */
   public enum TaskType {
-    DATA_SET_REPORT,
-    PROJECT_RELEASE
+    DATA_SET_REPORT
   }
 }

src/main/java/eu/dzhw/fdz/metadatamanagement/common/domain/validation/ValidHiddenShadow.java

@@ -0,0 +1,38 @@
+package eu.dzhw.fdz.metadatamanagement.common.domain.validation;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import javax.validation.Constraint;
+import javax.validation.Payload;
+
+import eu.dzhw.fdz.metadatamanagement.common.domain.AbstractShadowableRdcDomainObject;
+
+/**
+ * Validates that {@link AbstractShadowableRdcDomainObject} {@code hidden} is true if and only if
+ * the domain object is a shadow and has a successor.
+ */
+@Documented
+@Constraint(validatedBy = ValidHiddenShadowValidator.class)
+@Target({ElementType.TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+public @interface ValidHiddenShadow {
+
+  /**
+   * Defines the default error message.
+   */
+  String message() default "{common.domain.validation.error.invalid-hidden-shadow}";
+
+  /**
+   * Groups parameter.
+   */
+  Class<?>[] groups() default {};
+
+  /**
+   * Payload parameter.
+   */
+  Class<? extends Payload>[] payload() default {};
+}

src/main/java/eu/dzhw/fdz/metadatamanagement/common/domain/validation/ValidHiddenShadowValidator.java

@@ -0,0 +1,31 @@
+package eu.dzhw.fdz.metadatamanagement.common.domain.validation;
+
+import javax.validation.ConstraintValidator;
+import javax.validation.ConstraintValidatorContext;
+
+import org.springframework.util.StringUtils;
+
+import eu.dzhw.fdz.metadatamanagement.common.domain.AbstractShadowableRdcDomainObject;
+
+/**
+ * Default validator implementation for {@link ValidHiddenShadow} validation.
+ */
+public class ValidHiddenShadowValidator
+    implements ConstraintValidator<ValidHiddenShadow, AbstractShadowableRdcDomainObject> {
+
+  @Override
+  public boolean isValid(AbstractShadowableRdcDomainObject abstractShadowableRdcDomainObject,
+      ConstraintValidatorContext constraintValidatorContext) {
+
+    if (!abstractShadowableRdcDomainObject.isHidden()) {
+      return true;
+    }
+
+    if (abstractShadowableRdcDomainObject.isShadow()
+        && StringUtils.hasText(abstractShadowableRdcDomainObject.getSuccessorId())) {
+      return true;
+    }
+
+    return false;
+  }
+}

src/main/java/eu/dzhw/fdz/metadatamanagement/common/rest/GenericDomainObjectResourceController.java

@@ -30,7 +30,7 @@ public abstract class GenericDomainObjectResourceController
     <T extends AbstractRdcDomainObject, S extends CrudService<T>> {
 
   private final CrudService<T> crudService;
-  
+
   private final UserInformationProvider userInformationProvider;
 
   /**
@@ -53,6 +53,11 @@ public ResponseEntity<T> getDomainObject(String id) {
       return ResponseEntity.notFound().build();
     } else {
       T domainObject = optional.get();
+      if (userInformationProvider.isUserAnonymous()
+          && AbstractShadowableRdcDomainObject.class.isAssignableFrom(domainObject.getClass())
+          && ((AbstractShadowableRdcDomainObject) domainObject).isHidden()) {
+        return ResponseEntity.notFound().build();
+      }
       return ResponseEntity.ok()
           .cacheControl(CacheControl.maxAge(0, TimeUnit.DAYS).mustRevalidate().cachePublic())
           .eTag(domainObject.getVersion().toString()).lastModified(domainObject