Merge pull request #238 from com-pas/java-17-upgrade

Upgrade to JDK 17 (include using TextBlocks)

Author: Dennis Labordus

.github/workflows/build-project.yml

@@ -37,11 +37,11 @@ jobs:
           key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
           restore-keys: ${{ runner.os }}-m2
 
-      - name: Set up JDK 1.11
+      - name: Set up JDK 17
         uses: actions/setup-java@v3
         with:
           distribution: 'zulu'
-          java-version: '11'
+          java-version: '17'
 
       - name: Create custom Maven Settings.xml
         uses: whelk-io/maven-settings-xml-action@v20

.github/workflows/release-project.yml

@@ -42,11 +42,11 @@ jobs:
         shell: bash
         # Extra the tagname form the git reference, value of GITHUB_REF will be something like refs/tags/<tag_name>.
         run: echo "##[set-output name=tagname;]$(echo ${GITHUB_REF##*/})"
-      - name: Set up JDK 1.11
+      - name: Set up JDK 17
         uses: actions/setup-java@v3
         with:
           distribution: 'zulu'
-          java-version: '11'
+          java-version: '17'
 
       - name: Create custom Maven Settings.xml
         uses: whelk-io/maven-settings-xml-action@v20

.github/workflows/sonarcloud-analysis.yml

@@ -30,11 +30,11 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Set up JDK 11
+      - name: Set up JDK 17
         uses: actions/setup-java@v3
         with:
           distribution: 'zulu'
-          java-version: '11'
+          java-version: '17'
       - name: Cache SonarCloud packages
         uses: actions/cache@v3
         with:

.mvn/wrapper/maven-wrapper.properties

@@ -1,2 +1,18 @@
-distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.1/apache-maven-3.8.1-bin.zip
-wrapperUrl=https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.4/apache-maven-3.8.4-bin.zip
+wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar

app/src/main/docker/Dockerfile-basex.jvm

@@ -23,7 +23,7 @@
 ###
 FROM registry.access.redhat.com/ubi8/ubi-minimal:8.6 
 
-ARG JAVA_PACKAGE=java-11-openjdk-headless
+ARG JAVA_PACKAGE=java-17-openjdk-headless
 ARG RUN_JAVA_VERSION=1.3.8
 ENV LANG='en_US.UTF-8' LANGUAGE='en_US:en'
 # Install java and the run-java script

app/src/main/docker/Dockerfile-postgresql.jvm

@@ -23,7 +23,7 @@
 ###
 FROM registry.access.redhat.com/ubi8/ubi-minimal:8.6 
 
-ARG JAVA_PACKAGE=java-11-openjdk-headless
+ARG JAVA_PACKAGE=java-17-openjdk-headless
 ARG RUN_JAVA_VERSION=1.3.8
 ENV LANG='en_US.UTF-8' LANGUAGE='en_US:en'
 # Install java and the run-java script

app/src/main/java/org/lfenergy/compas/scl/data/rest/v1/CompasCommonResource.java

@@ -22,7 +22,6 @@
 import javax.ws.rs.core.MediaType;
 import java.util.Arrays;
 import java.util.Comparator;
-import java.util.stream.Collectors;
 
 import static org.lfenergy.compas.scl.data.rest.Constants.READ_ROLE;
 
@@ -54,7 +53,7 @@ public TypeListResponse list(@HeaderParam("Authorization") String authHeader) {
                         .filter(sclFileType -> roles.contains(sclFileType.name() + "_" + READ_ROLE))
                         .map(sclFileType -> new Type(sclFileType.name(), sclFileType.getDescription()))
                         .sorted(Comparator.comparing(Type::getDescription))
-                        .collect(Collectors.toList()));
+                        .toList());
         return response;
     }
 

doc/basex.md

@@ -37,6 +37,28 @@ docker run --rm --name compas_basex \
 > **Note:** Replace <BASEX-DIR> with a directory on your local machine, for instance "~/basex".
 > All data will be stored in this directory under "data". This way data isn't lost after stopping the docker container.
 
+### Application depends on a running KeyCloak instance
+
+Beside a BaseX Database there is also a KeyCloak instance need to be running on port 8089 by default.
+See [README.md](../README.md#security) for default values, if custom keycloak is used.
+
+There is a preconfigured keycloak instance available in
+the [CoMPAS Deployment Repository](https://github.com/com-pas/compas-deployment). This repository can be cloned and
+when going to this directory the following command can be executed to create a local Docker Image with configuration.
+
+```shell
+cd <CoMPAS Deployment Repository Directory>/compas/keycloak
+docker build -t compas_keycloak . 
+```
+
+There is now a Docker Image `compas_keycloak` created that can be started using the following command
+
+```shell
+docker run --rm --name compas_keycloak \
+   -p 8089:8080 
+   -d compas_keycloak:latest
+```
+
 ### Building the application
 
 You can run the following command to build the BaseX version of the application.

doc/postgresql.md

@@ -56,7 +56,30 @@ docker run --rm --name compas_postgresql \
 ```
 
 > **Note:** Replace <LOCAL-DATA-DIR> with a directory on your local machine, for instance "~/postgres".
-> All data will be stored in this directory under "compas". This way data isn't lost after stopping the docker container.
+> All data will be stored in this directory under "compas". This way data isn't lost after stopping the docker
+> container.
+
+### Application depends on a running KeyCloak instance
+
+Beside a PostgreSQL Database there is also a KeyCloak instance need to be running on port 8089 by default.
+See [README.md](../README.md#security) for default values, if custom keycloak is used.
+
+There is a preconfigured keycloak instance available in
+the [CoMPAS Deployment Repository](https://github.com/com-pas/compas-deployment). This repository can be cloned and
+when going to this directory the following command can be executed to create a local Docker Image with configuration.
+
+```shell
+cd <CoMPAS Deployment Repository Directory>/compas/keycloak
+docker build -t compas_keycloak . 
+```
+
+There is now a Docker Image `compas_keycloak` created that can be started using the following command
+
+```shell
+docker run --rm --name compas_keycloak \
+   -p 8089:8080 
+   -d compas_keycloak:latest
+```
 
 ### Building the application
 

pom.xml

@@ -15,8 +15,7 @@ SPDX-License-Identifier: Apache-2.0
 
     <properties>
         <maven.compiler.parameters>true</maven.compiler.parameters>
-        <maven.compiler.source>11</maven.compiler.source>
-        <maven.compiler.target>11</maven.compiler.target>
+        <maven.compiler.release>17</maven.compiler.release>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
 
@@ -181,11 +180,11 @@ SPDX-License-Identifier: Apache-2.0
                     <artifactId>maven-jar-plugin</artifactId>
                     <version>3.2.2</version>
                     <executions>
-                      <execution>
-                        <goals>
-                          <goal>test-jar</goal>
-                        </goals>
-                      </execution>
+                        <execution>
+                            <goals>
+                                <goal>test-jar</goal>
+                            </goals>
+                        </execution>
                     </executions>
                 </plugin>
             </plugins>