Merge pull request #47 from wcm-io-caravan/feature/upgrade_to_spring_…

…boot_3

Upgrade to spring boot 3

examples/spring-hello-world/README.md

@@ -8,13 +8,13 @@ to render and consume [HAL+JSON](https://stateless.group/hal_specification.html)
 
 # Build and Run
 
-Using **JDK 8, 11 or 17** and **Apache Maven 3.6.3** (or higher) you should be able to build and run the example like this:
+Using **JDK 17** and **Apache Maven 3.6.3** (or higher) you should be able to build and run the example like this:
 
 ```
 git clone https://github.com/wcm-io-caravan/caravan-rhyme.git
 cd caravan-rhyme
 git checkout master
-mvn -f examples/spring-helloworld/ clean verify spring-boot:run
+mvn -f examples/spring-hello-world/ clean verify spring-boot:run
 ```
 
 If there are any failures during the build or integration tests, then please open an issue on github!

examples/spring-hello-world/pom.xml

@@ -25,8 +25,8 @@
   </scm>
 
   <properties>
-    <java.version>11</java.version>
-    <spring-boot.version>2.5.8</spring-boot.version>
+    <java.version>17</java.version>
+    <spring-boot.version>3.1.3</spring-boot.version>
   </properties>
 
   <dependencyManagement>
@@ -45,6 +45,10 @@
   <dependencies>
 
     <!-- Spring dependencies -->
+      <dependency>
+          <groupId>org.springframework.boot</groupId>
+          <artifactId>spring-boot-starter-webflux</artifactId>
+      </dependency>
     <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-hateoas</artifactId>
@@ -58,7 +62,7 @@
     <dependency>
       <groupId>io.wcm.caravan</groupId>
       <artifactId>io.wcm.caravan.rhyme.spring</artifactId>
-      <version>1.0.0</version>
+      <version>2.0.0-SNAPSHOT</version>
     </dependency>
 
     <!-- Test dependencies -->
@@ -156,4 +160,4 @@
       </plugins>
     </pluginManagement>
   </build>
-</project>
+</project>

examples/spring-hello-world/src/main/resources/application.yml

@@ -3,5 +3,6 @@ server:
 spring:
   mvc:
     throw-exception-if-no-handler-found: true
-  resources:
-    add-mappings: false
+  web:
+    resources:
+      add-mappings: false

examples/spring-hypermedia/README.md

@@ -22,7 +22,7 @@ Make sure not to miss loading a `company:detailedEmployee` link when you run the
 # Build and Run
 
 
-Using **JDK 8, 11 or 17** and **Apache Maven 3.6.3** (or higher) you should be able to build and run the example like this:
+Using **JDK 17** and **Apache Maven 3.6.3** (or higher) you should be able to build and run the example like this:
 
 ```
 git clone https://github.com/wcm-io-caravan/caravan-rhyme.git

examples/spring-hypermedia/pom.xml

@@ -27,8 +27,8 @@
   </scm>
 
   <properties>
-    <java.version>11</java.version>
-    <spring-boot.version>2.5.8</spring-boot.version>
+    <java.version>17</java.version>
+    <spring-boot.version>3.1.3</spring-boot.version>
   </properties>
 
   <dependencyManagement>
@@ -80,7 +80,7 @@
     <dependency>
       <groupId>io.wcm.caravan</groupId>
       <artifactId>io.wcm.caravan.rhyme.spring</artifactId>
-      <version>1.0.1-SNAPSHOT</version>
+      <version>2.0.0-SNAPSHOT</version>
     </dependency>
 
     <!-- Test dependencies -->
@@ -190,4 +190,4 @@
       </plugins>
     </pluginManagement>
   </build>
-</project>
+</project>

examples/spring-hypermedia/src/main/java/io/wcm/caravan/rhyme/examples/spring/hypermedia/CompanyApiController.java

@@ -24,6 +24,7 @@
 import static org.springframework.hateoas.server.mvc.WebMvcLinkBuilder.methodOn;
 
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Lazy;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RestController;
 
@@ -48,10 +49,13 @@ class CompanyApiController implements CompanyApi {
 
   // inject the controllers for all resources that are linked from the entry point
   @Autowired
+  @Lazy
   private EmployeeController employees;
   @Autowired
+  @Lazy
   private ManagerController managers;
   @Autowired
+  @Lazy
   private DetailedEmployeeController detailedEmployees;
 
   @Autowired
@@ -108,7 +112,6 @@ public ManagerResource getManagerById(Long id) {
   }
 
   @Override
-
   public DetailedEmployeeResource getDetailedEmployeeById(Long id) {
     return detailedEmployees.findById(id);
   }

examples/spring-hypermedia/src/main/java/io/wcm/caravan/rhyme/examples/spring/hypermedia/CompanyApiLinkBuilder.java

@@ -27,8 +27,6 @@
 
 import java.time.Duration;
 
-import javax.servlet.http.HttpServletRequest;
-
 import org.apache.commons.lang3.BooleanUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -41,6 +39,7 @@
 import io.wcm.caravan.rhyme.spring.api.RhymeLinkBuilder;
 import io.wcm.caravan.rhyme.spring.api.SpringRhyme;
 import io.wcm.caravan.rhyme.spring.api.UrlFingerprinting;
+import jakarta.servlet.http.HttpServletRequest;
 
 /**
  * Defines common logic (e.g. URL fingerprinting) for building any link to your resources in this project .
@@ -126,9 +125,9 @@ boolean hasClientPreferences() {
    * by the {@link WebMvcLinkBuilder} class, but additional query parameters that are not directly
    * present in the API and controller signatures can be appended by {@link UrlFingerprinting}.
    * @param webMvcLinkBuilder created with {@link WebMvcLinkBuilder#linkTo(Class)} and
-   *          {@link WebMvcLinkBuilder#methodOn(Class, Object...)}
+   *     {@link WebMvcLinkBuilder#methodOn(Class, Object...)}
    * @return a {@link RhymeLinkBuilder} that you can use to decorate the link with name and title attributes, and
-   *         then finally build it
+   *     then finally build it
    * @see WebMvcLinkBuilder
    */
   RhymeLinkBuilder create(WebMvcLinkBuilder webMvcLinkBuilder) {

examples/spring-hypermedia/src/main/java/io/wcm/caravan/rhyme/examples/spring/hypermedia/Employee.java

@@ -15,14 +15,14 @@
  */
 package io.wcm.caravan.rhyme.examples.spring.hypermedia;
 
-import javax.persistence.Entity;
-import javax.persistence.EntityListeners;
-import javax.persistence.GeneratedValue;
-import javax.persistence.Id;
-import javax.persistence.OneToOne;
-
 import com.fasterxml.jackson.annotation.JsonIgnore;
 
+import jakarta.persistence.Entity;
+import jakarta.persistence.EntityListeners;
+import jakarta.persistence.GeneratedValue;
+import jakarta.persistence.Id;
+import jakarta.persistence.ManyToOne;
+
 /**
  * @author Greg Turnquist
  */
@@ -46,7 +46,7 @@ public class Employee {
    * To break the recursive, bidirectional relationship, don't serialize {@literal manager}.
    */
   @JsonIgnore
-  @OneToOne
+  @ManyToOne
   private Manager manager;
 
   Employee(String name, String role, Manager manager) {

examples/spring-hypermedia/src/main/java/io/wcm/caravan/rhyme/examples/spring/hypermedia/EmployeeController.java

@@ -46,10 +46,13 @@ class EmployeeController {
 
   // inject the controllers for all related resources
   @Autowired
+  @org.springframework.context.annotation.Lazy
   private CompanyApiController api;
   @Autowired
+  @org.springframework.context.annotation.Lazy
   private ManagerController managers;
   @Autowired
+  @org.springframework.context.annotation.Lazy
   private DetailedEmployeeController detailedEmployees;
 
   @Autowired

examples/spring-hypermedia/src/main/java/io/wcm/caravan/rhyme/examples/spring/hypermedia/Manager.java

@@ -18,14 +18,14 @@
 import java.util.ArrayList;
 import java.util.List;
 
-import javax.persistence.Entity;
-import javax.persistence.EntityListeners;
-import javax.persistence.GeneratedValue;
-import javax.persistence.Id;
-import javax.persistence.OneToMany;
-
 import com.fasterxml.jackson.annotation.JsonIgnore;
 
+import jakarta.persistence.Entity;
+import jakarta.persistence.EntityListeners;
+import jakarta.persistence.GeneratedValue;
+import jakarta.persistence.Id;
+import jakarta.persistence.OneToMany;
+
 /**
  * @author Greg Turnquist
  */

examples/spring-hypermedia/src/main/java/io/wcm/caravan/rhyme/examples/spring/hypermedia/ManagerController.java

@@ -47,8 +47,10 @@ class ManagerController {
 
   // inject the controllers for all related resources
   @Autowired
+  @org.springframework.context.annotation.Lazy
   private CompanyApiController api;
   @Autowired
+  @org.springframework.context.annotation.Lazy
   private EmployeeController employees;
 
   @Autowired

examples/spring-hypermedia/src/main/java/io/wcm/caravan/rhyme/examples/spring/hypermedia/RepositoryModificationListener.java

@@ -21,15 +21,14 @@
 
 import java.time.Instant;
 
-import javax.persistence.PostPersist;
-import javax.persistence.PostRemove;
-import javax.persistence.PostUpdate;
-
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.stereotype.Component;
 
 import io.wcm.caravan.rhyme.spring.api.UrlFingerprinting;
+import jakarta.persistence.PostPersist;
+import jakarta.persistence.PostRemove;
+import jakarta.persistence.PostUpdate;
 
 /**
  * Keeps track of any modifications to the repositories for {@link Employee} and {@link Manager} entities, so that

examples/spring-hypermedia/src/main/resources/application.yml

@@ -3,5 +3,6 @@ server:
 spring:
   mvc:
     throw-exception-if-no-handler-found: true
-  resources:
-    add-mappings: false
+  web:
+    resources:
+      add-mappings: false

examples/spring-hypermedia/src/test/java/io/wcm/caravan/rhyme/examples/spring/hypermedia/AbstractCompanyApiIT.java

@@ -30,10 +30,11 @@
 import org.assertj.core.api.ThrowableAssert.ThrowingCallable;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
-import org.mockito.internal.util.collections.Iterables;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.MediaType;
 
+import com.google.common.collect.Iterables;
+
 import io.wcm.caravan.hal.resource.Link;
 import io.wcm.caravan.rhyme.api.exceptions.HalApiClientException;
 import io.wcm.caravan.rhyme.api.exceptions.HalApiServerException;
@@ -75,12 +76,12 @@ void setUp() {
 
   protected Long getIdOfFirstEmployee() {
 
-    return Iterables.firstOf(employeeRepository.findAll()).getId();
+    return Iterables.get(employeeRepository.findAll(), 0).getId();
   }
 
   protected Long getIdOfFirstManager() {
 
-    return Iterables.firstOf(managerRepository.findAll()).getId();
+    return Iterables.get(managerRepository.findAll(), 0).getId();
   }
 
   @Test

examples/spring-hypermedia/src/test/java/io/wcm/caravan/rhyme/examples/spring/hypermedia/ExternalClientIT.java

@@ -71,7 +71,7 @@ protected CompanyApi getApiImplementationOrClientProxy() {
   // since we don't have access to the repository in this test, the IDs need to be hard-coded
   @Override
   protected Long getIdOfFirstEmployee() {
-    return 2L;
+    return 1L;
   }
 
   @Override

examples/spring-hypermedia/src/test/java/io/wcm/caravan/rhyme/spring/impl/SpringErrorHandlingIT.java

@@ -54,7 +54,8 @@
  * there are a few error cases in this test where {@link WebEnvironment#MOCK} doesn't work the same way
  * as if the application is serving requests on an actual network socket.
  */
-@SpringBootTest(classes = SpringRhymeHypermediaApplication.class, webEnvironment = WebEnvironment.RANDOM_PORT)
+@SpringBootTest(classes = SpringRhymeHypermediaApplication.class, webEnvironment = WebEnvironment.RANDOM_PORT,
+properties = {"spring.mvc.throwExceptionIfNoHandlerFound=true", "spring.web.resources.add-mappings=false"})
 class SpringErrorHandlingIT {
 
   private final String baseUri;

integration/spring/changes.xml

@@ -23,6 +23,12 @@
     xsi:schemaLocation="http://maven.apache.org/changes/1.0.0 http://maven.apache.org/plugins/maven-changes-plugin/xsd/changes-1.0.0.xsd">
   <body>
 
+    <release version="2.0.0">
+      <action type="add" dev="ckumpe">
+        Migrate to Java 17 and Spring Boot 3
+      </action>
+    </release>
+
     <release version="1.0.2" date="not released">
       <action type="add" dev="ssauder">
         Reduced expectations in AbstractHalResourceLoaderTest on how exactly malformed responses are handled by client implementations. 

integration/spring/pom.xml

@@ -30,7 +30,7 @@
   </parent>
 
   <artifactId>io.wcm.caravan.rhyme.spring</artifactId>
-  <version>1.0.1-SNAPSHOT</version>
+  <version>2.0.0-SNAPSHOT</version>
   <packaging>bundle</packaging>
 
   <name>Rhyme - Spring Integration</name>
@@ -45,8 +45,8 @@
 
   <properties>
     <site.url.module.prefix>rhyme/spring</site.url.module.prefix>
-    <java.version>11</java.version>
-    <spring-boot.version>2.5.8</spring-boot.version>
+    <java.version>17</java.version>
+    <spring-boot.version>3.1.3</spring-boot.version>
   </properties>
 
   <dependencyManagement>
@@ -64,10 +64,9 @@
 
   <dependencies>
     <dependency>
-      <groupId>javax.servlet</groupId>
-      <artifactId>javax.servlet-api</artifactId>
+      <groupId>jakarta.servlet</groupId>
+      <artifactId>jakarta.servlet-api</artifactId>
       <scope>provided</scope>
-      <version>4.0.1</version>
     </dependency>
 
     <!-- Spring Dependencies -->
@@ -147,6 +146,14 @@
       <plugin>
         <groupId>org.apache.felix</groupId>
         <artifactId>maven-bundle-plugin</artifactId>
+        <dependencies>
+            <!-- this is needed for Java 17 support until there's new release of the plugin with a newer version of ASM -->
+          <dependency>
+              <groupId>org.ow2.asm</groupId>
+              <artifactId>asm</artifactId>
+              <version>9.1</version>
+          </dependency>
+        </dependencies>
         <executions>
           <execution>
             <id>baseline</id>

integration/spring/src/main/java/io/wcm/caravan/rhyme/spring/impl/SpringExceptionStatusAndLoggingStrategy.java

@@ -41,8 +41,8 @@ class SpringExceptionStatusAndLoggingStrategy implements ExceptionStatusAndLoggi
   @Override
   public Integer extractStatusCode(Throwable error) {
 
-    if (error instanceof ResponseStatusException) {
-      return ((ResponseStatusException)error).getStatus().value();
+    if (error instanceof ResponseStatusException responsestatusexception) {
+      return responsestatusexception.getStatusCode().value();
     }
 
     if (error.getClass().isAnnotationPresent(ResponseStatus.class)) {