Development branch for v3.0.0

.github/workflows/gradle.yml

@@ -26,15 +26,16 @@ jobs:
     strategy:
       matrix:
         operating-system: [ubuntu-latest, macOS-latest, windows-latest]
-        jdk: [ 21 ]  # (open)JDK releases
+        jdk: [ 21 ]
+        distro: ['temurin']
 
     steps:
     - uses: actions/checkout@v4
     - name: Set up openJDK version
       uses: actions/setup-java@v4
       with:
         java-version: ${{ matrix.jdk }}
-        distribution: 'zulu'  # =openJDK
+        distribution: ${{ matrix.distro }}
     - name: Setup Gradle
       uses: gradle/actions/setup-gradle@v4
     - name: Build and Test with Gradle
@@ -45,7 +46,8 @@ jobs:
     - name: Docker build and test
       if: matrix.operating-system == 'ubuntu-latest' && matrix.jdk == 21
       run: |
-        curl --location --remote-name https://github.com/Orange-OpenSource/hurl/releases/download/4.0.0/hurl_4.0.0_amd64.deb
-        sudo dpkg -i hurl_4.0.0_amd64.deb
+        VERSION=6.0.0
+        curl --location --remote-name https://github.com/Orange-OpenSource/hurl/releases/download/$VERSION/hurl_${VERSION}_amd64.deb
+        sudo apt update && sudo apt install ./hurl_${VERSION}_amd64.deb
         time bash ./docker/test_docker.sh
       shell: bash

.gitignore

@@ -135,4 +135,8 @@ $RECYCLE.BIN/
 **/*.properties
 !/config/application-default.properties
 !/config/application-docker.properties
-##############
+##############
+
+test_prefix_data/
+config/*.bin
+config/*.pem

CITATION.cff

@@ -14,7 +14,8 @@ authors:
 title: "Typed PID Maker"
 type: software
 abstract: The Typed PID Maker is the entry point to integrate digital resources into the FAIR DO ecosystem. It allows to create PIDs for resources and to provide them with the necessary metadata to ensure that the resources can be found.
-date-released: 2020-10-01
+date-released: 2025-06-12
 url: "https://github.com/kit-data-manager/pit-service"
 repository-code: "https://github.com/kit-data-manager/pit-service"
 license: Apache-2.0
+version: 2.2.1

README.md

@@ -102,6 +102,27 @@ PID = prefix + (branding + uniquely-generated-string)
 
 All other configuration properties affect only the `uniquely-generated-string`. For example, you may choose a different generation method (UUID (default) or Hex Chunks) enforce casing (lower-case, upper-case).
 
+## What PID record validation means
+
+Our validation steps include the following:
+
+1. For each attribute, check if the values are valid according to their type specification.
+   - Values are considered to be in JSON format. If a type is complex, this implies a string-serialized JSON object.
+2. For each attribute which indicates a profile, resolve the profile definitions from the values of the attributes.
+   - Attributes which indicates profiles are internally known, but may be added using the [configuration](https://github.com/kit-data-manager/pit-service/blob/master/config/application-default.properties).
+3. For each profile definition, check if mandatory attributes are present.
+4. For each profile definition, check if only repeatable attributes have multiple occurrences.
+
+This implies the following properties:
+
+- A profile is not required,
+  - but all profiles which are present are being used for validation,
+  - and all of them have to pass.
+- Additional attributes are allowed if specified in the configuration of the Typed PID Maker instance.
+  - Otherwise, they are not allowed. Which makes it almost impossible to use multiple profiles.
+  - Only dtr-test supports an "additionalAttributesAllowed" boolean property per profile,
+  - But as it will not last and other DTRs do currently not support it, we don't support it either.
+
 ## How to build
 
 > Note: Alternatively, you can use the docker image.
@@ -111,9 +132,8 @@ All other configuration properties affect only the `uniquely-generated-string`.
 - Building (with tests): `./gradlew clean build`
 - Building (with verbose test output) `./gradlew -Dprofile=verbose clean build`
 - Building (without tests): `./gradlew clean build -x test`
-- Run docker integration tests:
-  - `./gradlew clean build` (by default, this will reuse the local build)
-  - `time bash ./docker/test_docker.sh` (runs test script)
+- Run docker integration tests: `time bash ./docker/test_docker.sh` (will reuse the local build)
+- Run dockerized validation benchmarks: `time bash ./docker/test_docker.sh benchmark` (will reuse the local build)
 - Doing a release: `./gradlew clean build release`
   - Will prompt you about version number to use and next version number
   - Will make a git tag which can later be used in a GitHub release

build.gradle

@@ -48,16 +48,16 @@ repositories {
 }
 
 ext {
-    springDocVersion  = '2.8.8'
+    springDocVersion = '2.8.9'
 }
 
 dependencies {
     // Due to the spring boot gradle plugin, we can omit versions in org.springframework.*
     // dependencies. It will automatically choose the fitting ones.
     implementation("edu.kit.datamanager:service-base:1.3.4")
     implementation("edu.kit.datamanager:repo-core:1.2.5")
-    // com.google.common, LoadingCache
-    implementation("com.google.guava:guava:33.4.8-jre")
+    // AsyncLoadingCache https://github.com/ben-manes/caffeine
+    implementation("com.github.ben-manes.caffeine:caffeine:3.1.8")
 
     // spring core, e.g. @EnableJpaRepositories
     implementation "org.springframework:spring-core"
@@ -81,8 +81,7 @@ dependencies {
     implementation "org.springframework.data:spring-data-elasticsearch"
 
     // More flexibility when (de-)serializing json:
-    //implementation("com.monitorjbl:spring-json-view:1.1.0")
-	implementation("com.github.everit-org.json-schema:org.everit.json.schema:1.14.4")
+    implementation(group: 'com.networknt', name: 'json-schema-validator', version: '1.5.7');
 
     implementation('org.apache.httpcomponents:httpclient:4.5.14')
     implementation('org.apache.httpcomponents:httpclient-cache:4.5.14')
@@ -155,7 +154,7 @@ test {
         println "Tests will have verbose output"
         testLogging {
             // tests are never "up-to-date", always print everything
-            outputs.upToDateWhen {false}
+            outputs.upToDateWhen { false }
             // show stdio when tests are running
             showStandardStreams = true
             // for junit5