Merge branch 'master' of https://github.com/europeana/api-commons.git

commons-error/pom.xml

@@ -10,28 +10,23 @@
     <artifactId>commons-error</artifactId>
     <name>Api Commons - Error</name>
 
-    <properties>
-        <spring-boot.version>2.5.7</spring-boot.version>
-        <spring.version>5.3.18</spring.version>
-    </properties>
-
     <dependencies>
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-autoconfigure</artifactId>
-            <version>${spring-boot.version}</version>
+            <version>${version.springBoot}</version>
             <scope>provided</scope>
         </dependency>
         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-web</artifactId>
-            <version>${spring.version}</version>
+            <version>${version.spring}</version>
             <scope>provided</scope>
         </dependency>
         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-webmvc</artifactId>
-            <version>${spring.version}</version>
+            <version>${version.spring}</version>
             <scope>provided</scope>
         </dependency>
         <dependency>
@@ -61,7 +56,7 @@
             <groupId>jakarta.validation</groupId>
             <artifactId>jakarta.validation-api</artifactId>
             <version>2.0.2</version>
-            <scope>provided</scope>
+<!--             <scope>provided</scope> -->
         </dependency>
         <dependency>
             <groupId>io.micrometer</groupId>

commons-error/src/main/java/eu/europeana/api/commons/error/EuropeanaApiErrorAttributes.java

@@ -54,7 +54,7 @@ private void addPathRequestParameters(Map<String, Object> errorAttributes, WebRe
             String paramName = it.next();
             s.append(paramName);
             String paramValue = webRequest.getParameter(paramName);
-            if (!StringUtils.isEmpty(paramValue)) {
+            if (StringUtils.hasText(paramValue)) {
                 s.append("=").append(paramValue);
             }
         }

commons-web/pom.xml

@@ -18,12 +18,18 @@
 
 	<dependencies>
 
-	<dependency>
-		<groupId>eu.europeana.api.commons</groupId>
+		<dependency>
+			<groupId>eu.europeana.api.commons</groupId>
 			<artifactId>commons-definitions</artifactId>
 			<version>0.3.21-SNAPSHOT</version>
 		</dependency>
 
+		<dependency>
+			<groupId>eu.europeana.api.commons</groupId>
+			<artifactId>commons-error</artifactId>
+			<version>0.3.21-SNAPSHOT</version>
+		</dependency>		
+
 		<dependency>
 			<groupId>eu.europeana.api.commons</groupId>
 			<artifactId>commons-net</artifactId>
@@ -62,6 +68,13 @@
 			<version>${version.spring}</version>
 		</dependency>
 
+		<dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-autoconfigure</artifactId>
+            <version>${version.springBoot}</version>
+            <scope>provided</scope>
+        </dependency>
+
 		<dependency>
 			<groupId>org.apache.logging.log4j</groupId>
 			<artifactId>log4j-core</artifactId>

commons-web/src/main/java/eu/europeana/api/commons/web/controller/BaseRestController.java

@@ -89,10 +89,13 @@ public String generateETag(Date timestamp, String format, String version) {
    */
   protected String getMethodsForRequestPattern(HttpServletRequest request,
       AbstractRequestPathMethodService requestMethodService) {
-    Optional<String> methodsForRequestPattern =
+    if(requestMethodService != null) {
+      Optional<String> methodsForRequestPattern =
         requestMethodService.getMethodsForRequestPattern(request);
-
-    return methodsForRequestPattern.orElse(request.getMethod());
+      return methodsForRequestPattern.orElse(request.getMethod());
+    }else {
+      return request.getMethod();
+    }
   }
 
 }

commons-error/src/main/java/eu/europeana/api/commons/error/EuropeanaGlobalExceptionHandler.java → commons-web/src/main/java/eu/europeana/api/commons/web/exception/EuropeanaGlobalExceptionHandler.java

@@ -1,4 +1,4 @@
-package eu.europeana.api.commons.error;
+package eu.europeana.api.commons.web.exception;
 
 import java.util.List;
 import java.util.Set;
@@ -21,6 +21,9 @@
 import org.springframework.web.bind.MethodArgumentNotValidException;
 import org.springframework.web.bind.MissingServletRequestParameterException;
 import org.springframework.web.bind.annotation.ExceptionHandler;
+import eu.europeana.api.commons.error.EuropeanaApiErrorResponse;
+import eu.europeana.api.commons.error.EuropeanaApiException;
+import eu.europeana.api.commons.web.service.AbstractRequestPathMethodService;
 
 /**
  * Global exception handler that catches all errors and logs the interesting ones
@@ -35,6 +38,8 @@ public class EuropeanaGlobalExceptionHandler {
 
     private static final Logger LOG = LogManager.getLogger(EuropeanaGlobalExceptionHandler.class);
 
+    protected AbstractRequestPathMethodService requestPathMethodService;
+
     /**
      * Checks if {@link EuropeanaApiException} instances should be logged or not
      *
@@ -76,7 +81,7 @@ public ResponseEntity<EuropeanaApiErrorResponse> handleEuropeanaBaseException(Eu
 
         return ResponseEntity
                 .status(e.getResponseStatus())
-                .contentType(MediaType.APPLICATION_JSON)
+                .headers(createHttpHeaders(httpRequest))
                 .body(response);
     }
 
@@ -96,7 +101,7 @@ public ResponseEntity<EuropeanaApiErrorResponse> handleOtherExceptionTypes(Excep
 
         return ResponseEntity
                 .status(responseStatus)
-                .contentType(MediaType.APPLICATION_JSON)
+                .headers(createHttpHeaders(httpRequest))
                 .body(response);
     }
 
@@ -141,7 +146,7 @@ public ResponseEntity<EuropeanaApiErrorResponse> handleInputValidationError(Cons
 
         return ResponseEntity
                 .status(responseStatus)
-                .contentType(MediaType.APPLICATION_JSON)
+                .headers(createHttpHeaders(httpRequest))
                 .body(response);
     }
 
@@ -159,7 +164,7 @@ public ResponseEntity<EuropeanaApiErrorResponse> handleInputValidationError(Miss
 
         return ResponseEntity
                 .status(responseStatus)
-                .contentType(MediaType.APPLICATION_JSON)
+                .headers(createHttpHeaders(httpRequest))
                 .body(response);
     }
 
@@ -179,7 +184,7 @@ public ResponseEntity<EuropeanaApiErrorResponse> handleMediaTypeNotAcceptableExc
 
         return ResponseEntity
             .status(responseStatus)
-            .contentType(MediaType.APPLICATION_JSON)
+            .headers(createHttpHeaders(httpRequest))
             .body(response);
     }
 
@@ -205,7 +210,29 @@ public ResponseEntity<EuropeanaApiErrorResponse> handleMethodArgNotValidExceptio
 
         return ResponseEntity
             .status(responseStatus)
-            .contentType(MediaType.APPLICATION_JSON)
+            .headers(createHttpHeaders(httpRequest))
             .body(response);
     }
+
+    protected HttpHeaders createHttpHeaders(HttpServletRequest httpRequest) {
+      HttpHeaders headers = new HttpHeaders();
+      //enforce application/json as content type, it is the only serialization supported for exceptions
+      headers.setContentType(MediaType.APPLICATION_JSON);
+
+      //autogenerate allow header if the service is configured
+      if(getRequestPathMethodService()!=null) {
+        String allowHeaderValue = getRequestPathMethodService().getMethodsForRequestPattern(httpRequest).orElse(httpRequest.getMethod());
+        headers.add(HttpHeaders.ALLOW, allowHeaderValue);
+      }
+      return headers;
+    }
+
+    /**
+     * The bean needs to be defined in the individual APIs
+     * 
+     * @return
+     */
+    AbstractRequestPathMethodService getRequestPathMethodService() {
+      return requestPathMethodService;
+    }
 }

commons-web/src/main/java/eu/europeana/api/commons/web/service/AbstractRequestPathMethodService.java

@@ -32,7 +32,7 @@ public abstract class AbstractRequestPathMethodService implements InitializingBe
    */
   private final Map<String, Set<String>> requestPathMethodMap = new HashMap<>();
 
-  private final WebApplicationContext applicationContext;
+  protected final WebApplicationContext applicationContext;
 
   protected AbstractRequestPathMethodService(
       WebApplicationContext applicationContext) {

pom.xml

@@ -40,7 +40,7 @@
 		<maven.compiler.target>${java.version}</maven.compiler.target>
 		<sonar.organization>europeana</sonar.organization>
 
-		<version.spring>5.3.13</version.spring>
+		<version.spring>5.3.18</version.spring>
 		<version.springBoot>2.6.1</version.springBoot>
 		<version.springSecurityJwt>1.1.1.RELEASE</version.springSecurityJwt>
 		<version.springSecurityOauth>2.5.1.RELEASE</version.springSecurityOauth>