Upgrade SpringBoot 2 to SpringBoot 3 (javax -> jakarta)

hhn-helpdesk-backend/README.md

@@ -0,0 +1,46 @@
+# Local Development
+## Initial steps (only needed once)
+### Keycloak Docker Container
+1. [Install docker](https://docs.docker.com/engine/install/)
+2. [Start local keycloak as docker container](https://www.keycloak.org/getting-started/getting-started-docker)
+   - Version should match the 
+   - Change version as needed and be sure to **not** use port 8080)
+```bash
+docker run --name keycloak-local -p 8888:8080 -e KEYCLOAK_ADMIN=admin -e KEYCLOAK_ADMIN_PASSWORD=admin quay.io/keycloak/keycloak:22.0.4 start-dev
+```
+3. Create new client in master realm with the following configuration:
+   - `Client ID: helpdesk_admin` 
+   - `Client authentication: True`
+   - `Service accounts roles: True`
+   - Leave `Root URL`, `Home URL`, `Valid redirect URIs`, `Web origins`, and everything else empty or with the standard 
+   - Go to `Credentials` and copy `Client secret` into `application.properties` --> `hhn.keycloak.admin.client.secret`
+   - Go to `Service accounts roles` and press 'Assign roles' --> Filter by clients --> Assign the following:
+     - `(institution-realm) manage-users`
+     - `(institution-realm) query-users`
+     - `(institution-realm) view-users` 
+   - Go to `Client scopes` --> `helpdesk_admin-dedicated` and verify that Client ID, Client Host, and Client IP Address token mappers exist 
+5. Create realm `helpdesk` and `institution`
+6. Create role `HHN_HELPDESK_ADMIN` in `helpdesk` realm
+7. Create new client in `helpdesk` realm
+   - `Client ID: helpdesk_user`
+   - `Client authentication: True`
+   - `Valid redirect URIs: http://localhost:3000/login/oauth2/code/keycloak`
+   - Copy `Client secret` from the Credentials Tab into `application.properties` --> `keycloak.credentials.secret`
+8. Go to `Client scopes` --> `helpdesk_user-dedicated` and configure a new predefined mapper from type "realm roles"
+   - `Name: helpdesk-realm-role-mapper`
+   - `Add to ID token: False`
+   - `Add to access token: False`
+   - `Add to userinfo: True`
+9. Create user `example_admin` in realm `helpdesk`, assign the role `HHN_HELPDESK_ADMIN` and set the password to `example_admin`
+10. Create users `example_user1` and `example_user2` in `institution` realm
+
+### PostgreSQL Database 
+1. Install postgres (or use the official docker container)
+2. Create database `helpdesk`
+3. If you do not use postgres:postgres as default login for your local PostgreSQL installation, change the the parameters inside `application.properties`
+
+### Run first build with maven 
+```bash
+mvn clean package
+mvn spring-boot:run
+```

hhn-helpdesk-backend/pom.xml

@@ -22,12 +22,12 @@
     <parent>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-parent</artifactId>
-        <version>2.7.12</version>
+        <version>3.1.4</version>
     </parent>
 
     <artifactId>hhn-helpdesk-backend</artifactId>
     <groupId>de.hs-heilbronn.rz</groupId>
-    <version>1.0.3-SNAPSHOT</version>
+    <version>1.0.4-SNAPSHOT</version>
 
     <organization>
         <name>Hochschule Heilbronn</name>
@@ -36,13 +36,13 @@
     <properties>
         <copyright.year>2023</copyright.year>
 
-        <keycloak.version>21.0.1</keycloak.version>
+        <keycloak.version>22.0.4</keycloak.version>
 
         <maven.compiler.source>17</maven.compiler.source>
         <maven.compiler.target>17</maven.compiler.target>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
-        <commons-lang3.version>3.12.0</commons-lang3.version>
+        <commons-lang3.version>3.13.0</commons-lang3.version>
         <fop.version>2.9</fop.version>
         <qrgen.version>3.0.1</qrgen.version>
         <!-- pdfbox needs to be compatible with ${fop.version}. Don't upgrade pdfbox to 3.x without checking fop first -->
@@ -58,18 +58,6 @@
         </repository>
     </repositories>
 
-    <dependencyManagement>
-        <dependencies>
-            <dependency>
-                <groupId>org.keycloak.bom</groupId>
-                <artifactId>keycloak-adapter-bom</artifactId>
-                <version>${keycloak.version}</version>
-                <type>pom</type>
-                <scope>import</scope>
-            </dependency>
-        </dependencies>
-    </dependencyManagement>
-
     <dependencies>
         <dependency>
             <groupId>org.springframework.boot</groupId>
@@ -84,8 +72,8 @@
             <artifactId>spring-boot-starter-web</artifactId>
         </dependency>
         <dependency>
-            <groupId>org.keycloak</groupId>
-            <artifactId>keycloak-spring-boot-starter</artifactId>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-oauth2-client</artifactId>
         </dependency>
         <dependency>
             <groupId>org.keycloak</groupId>

hhn-helpdesk-backend/src/main/java/de/hhn/rz/db/AuditLogRepository.java

@@ -16,10 +16,11 @@
 package de.hhn.rz.db;
 
 import de.hhn.rz.db.entities.AuditLogEntry;
+import org.springframework.data.repository.CrudRepository;
 import org.springframework.data.repository.PagingAndSortingRepository;
 import org.springframework.stereotype.Repository;
 
 @Repository
-public interface AuditLogRepository extends PagingAndSortingRepository<AuditLogEntry, Long> {
+public interface AuditLogRepository extends PagingAndSortingRepository<AuditLogEntry, Long>, CrudRepository<AuditLogEntry, Long> {
 
 }

hhn-helpdesk-backend/src/main/java/de/hhn/rz/db/entities/AccountCredential.java

@@ -15,15 +15,18 @@
  */
 package de.hhn.rz.db.entities;
 
-import javax.persistence.CascadeType;
-import javax.persistence.Column;
-import javax.persistence.Entity;
-import javax.persistence.FetchType;
-import javax.persistence.GeneratedValue;
-import javax.persistence.Id;
-import javax.persistence.Index;
-import javax.persistence.ManyToOne;
-import javax.persistence.Table;
+import jakarta.persistence.CascadeType;
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.FetchType;
+import jakarta.persistence.GeneratedValue;
+import jakarta.persistence.GenerationType;
+import jakarta.persistence.Id;
+import jakarta.persistence.Index;
+import jakarta.persistence.ManyToOne;
+import jakarta.persistence.SequenceGenerator;
+import jakarta.persistence.Table;
+
 import java.time.LocalDateTime;
 
 @Entity
@@ -33,7 +36,8 @@
 })
 public class AccountCredential {
     @Id
-    @GeneratedValue
+    @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "hibernate_sequence")
+    @SequenceGenerator(name="hibernate_sequence", sequenceName = "hibernate_sequence", allocationSize = 1)
     private Long id;
     @Column(length = 255, nullable = false)
     private String password;

hhn-helpdesk-backend/src/main/java/de/hhn/rz/db/entities/AuditLogEntry.java

@@ -15,18 +15,22 @@
  */
 package de.hhn.rz.db.entities;
 
-import javax.persistence.Column;
-import javax.persistence.Entity;
-import javax.persistence.EnumType;
-import javax.persistence.Enumerated;
-import javax.persistence.GeneratedValue;
-import javax.persistence.Id;
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.EnumType;
+import jakarta.persistence.Enumerated;
+import jakarta.persistence.GeneratedValue;
+import jakarta.persistence.GenerationType;
+import jakarta.persistence.Id;
+import jakarta.persistence.SequenceGenerator;
+
 import java.time.LocalDateTime;
 
 @Entity
 public class AuditLogEntry {
     @Id
-    @GeneratedValue
+    @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "hibernate_sequence")
+    @SequenceGenerator(name="hibernate_sequence", sequenceName = "hibernate_sequence", allocationSize = 1)
     private Long id;
     @Column(nullable = false)
     private LocalDateTime time = LocalDateTime.now();

hhn-helpdesk-backend/src/main/java/de/hhn/rz/db/entities/Location.java

@@ -15,14 +15,18 @@
  */
 package de.hhn.rz.db.entities;
 
-import javax.persistence.Column;
-import javax.persistence.Entity;
-import javax.persistence.GeneratedValue;
-import javax.persistence.Id;
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.GeneratedValue;
+import jakarta.persistence.GenerationType;
+import jakarta.persistence.Id;
+import jakarta.persistence.SequenceGenerator;
+
 @Entity
 public class Location {
     @Id
-    @GeneratedValue
+    @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "hibernate_sequence")
+    @SequenceGenerator(name="hibernate_sequence", sequenceName = "hibernate_sequence", allocationSize = 1)
     private Long id;
     @Column(length = 255, nullable = false, unique = true)
     private String label;

hhn-helpdesk-backend/src/main/java/de/hhn/rz/dto/Account.java

@@ -18,17 +18,18 @@
 import org.keycloak.representations.idm.UserRepresentation;
 
 import java.util.List;
+import java.util.Optional;
 
 public record Account(String keycloakId, String id, String username, String firstName, String lastName, String email,
                       String type) {
 
     public Account(UserRepresentation ua) {
         this(ua.getId(),
-                ua.getAttributes().getOrDefault("employeeID", List.of("N/A")).get(0),
+                Optional.ofNullable(ua.getAttributes()).map(o -> o.get("employeeID")).orElse(List.of("N/A")).get(0),
                 ua.getUsername(),
                 ua.getFirstName(),
                 ua.getLastName(),
                 ua.getEmail(),
-                ua.getAttributes().getOrDefault("type", List.of("N/A")).get(0));
+                Optional.ofNullable(ua.getAttributes()).map(o -> o.get("type")).orElse(List.of("N/A")).get(0));
     }
 }

hhn-helpdesk-backend/src/main/java/de/hhn/rz/rest/LogoutEndpoint.java

@@ -20,8 +20,8 @@
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
-import javax.servlet.ServletException;
-import javax.servlet.http.HttpServletRequest;
+import jakarta.servlet.ServletException;
+import jakarta.servlet.http.HttpServletRequest;
 
 @RestController
 @CrossOrigin(origins = {"http://localhost:8080", "http://localhost:3000"})

hhn-helpdesk-backend/src/main/java/de/hhn/rz/rest/UserInfoEndpoint.java

@@ -24,6 +24,7 @@
 import org.springframework.security.core.Authentication;
 import org.springframework.security.core.GrantedAuthority;
 import org.springframework.security.core.context.SecurityContextHolder;
+import org.springframework.security.oauth2.core.oidc.user.OidcUser;
 import org.springframework.web.bind.annotation.CrossOrigin;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -55,6 +56,10 @@ public UserInfo user() {
             final Set<String> roles = authentication.getAuthorities().stream()
                     .map(GrantedAuthority::getAuthority).collect(Collectors.toSet());
 
+            return new UserInfo(user, roles);
+        } else if (principal instanceof OidcUser ou) {
+            final String user = ou.getPreferredUsername();
+            final Set<String> roles = authentication.getAuthorities().stream().map(GrantedAuthority::getAuthority).collect(Collectors.toSet());
             return new UserInfo(user, roles);
         } else {
             return new UserInfo("N/A", Collections.emptySet());

hhn-helpdesk-backend/src/main/java/de/hhn/rz/security/KeycloakSpringIntegration.java

@@ -16,8 +16,6 @@
 package de.hhn.rz.security;
 
 import org.keycloak.OAuth2Constants;
-import org.keycloak.adapters.KeycloakConfigResolver;
-import org.keycloak.adapters.springboot.KeycloakSpringBootConfigResolver;
 import org.keycloak.admin.client.Keycloak;
 import org.keycloak.admin.client.KeycloakBuilder;
 import org.keycloak.admin.client.resource.RealmResource;
@@ -35,11 +33,6 @@ public ServletListenerRegistrationBean<HttpSessionEventPublisher> httpSessionEve
         return new ServletListenerRegistrationBean<>(new HttpSessionEventPublisher());
     }
 
-    @Bean
-    public KeycloakConfigResolver keycloakConfigResolver() {
-        return new KeycloakSpringBootConfigResolver();
-    }
-
     @Bean
     public Keycloak keycloak(
             @Value("${hhn.keycloak.admin.url}") String url,