Included some examples

examples/pom.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <artifactId>base-error-handler</artifactId>
+        <groupId>com.nibado.example</groupId>
+        <version>1.0-SNAPSHOT</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>examples</artifactId>
+
+
+</project>

examples/src/main/java/com/nibado/example/errorhandlers/example1/UserNotFoundException.java

@@ -0,0 +1,8 @@
+package com.nibado.example.errorhandlers.example1;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.ResponseStatus;
+
+@ResponseStatus(value = HttpStatus.NOT_FOUND, reason = "User not found")
+public class UserNotFoundException extends RuntimeException {
+}

examples/src/main/java/com/nibado/example/errorhandlers/example2/ExceptionHandlers.java

@@ -0,0 +1,35 @@
+package com.nibado.example.errorhandlers.example2;
+
+import lombok.Data;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.ControllerAdvice;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.ResponseBody;
+import org.springframework.web.bind.annotation.ResponseStatus;
+
+@ControllerAdvice
+@Slf4j
+public class ExceptionHandlers {
+    @ExceptionHandler(UserNotFoundException.class)
+    @ResponseStatus(HttpStatus.NOT_FOUND)
+    @ResponseBody
+    public ErrorResponse handleUserNotFoundException(final UserNotFoundException ex) {
+        log.error("User not found thrown", ex);
+        return new ErrorResponse("USER_NOT_FOUND", "The user was not found");
+    }
+
+    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
+    @ExceptionHandler(Throwable.class)
+    @ResponseBody
+    public ErrorResponse handleThrowable(final Throwable ex) {
+        log.error("Unexpected error", ex);
+        return new ErrorResponse("INTERNAL_SERVER_ERROR", "An unexpected internal server error occured");
+    }
+
+    @Data
+    public static class ErrorResponse {
+        private final String code;
+        private final String message;
+    }
+}

examples/src/main/java/com/nibado/example/errorhandlers/example2/UserNotFoundException.java

@@ -0,0 +1,4 @@
+package com.nibado.example.errorhandlers.example2;
+
+public class UserNotFoundException extends RuntimeException {
+}

examples/src/main/java/com/nibado/example/errorhandlers/example3/BaseExceptionHandler.java

@@ -0,0 +1,30 @@
+package com.nibado.example.errorhandlers.example3;
+
+import lombok.Data;
+import org.slf4j.Logger;
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.ResponseBody;
+import org.springframework.web.bind.annotation.ResponseStatus;
+
+public abstract class BaseExceptionHandler {
+    private final Logger log;
+
+    protected BaseExceptionHandler(final Logger log) {
+        this.log = log;
+    }
+
+    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
+    @ExceptionHandler(Throwable.class)
+    @ResponseBody
+    public ExceptionHandlers.ErrorResponse handleThrowable(final Throwable ex) {
+        log.error("Unexpected error", ex);
+        return new ErrorResponse("INTERNAL_SERVER_ERROR", "An unexpected internal server error occured");
+    }
+
+    @Data
+    public static class ErrorResponse {
+        private final String code;
+        private final String message;
+    }
+}

examples/src/main/java/com/nibado/example/errorhandlers/example3/ExceptionHandlers.java

@@ -0,0 +1,24 @@
+package com.nibado.example.errorhandlers.example3;
+
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.ControllerAdvice;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.ResponseBody;
+import org.springframework.web.bind.annotation.ResponseStatus;
+
+@ControllerAdvice
+@Slf4j
+public class ExceptionHandlers extends BaseExceptionHandler {
+    public ExceptionHandlers() {
+        super(log);
+    }
+
+    @ExceptionHandler(UserNotFoundException.class)
+    @ResponseStatus(HttpStatus.NOT_FOUND)
+    @ResponseBody
+    public ErrorResponse handleUserNotFoundException(final UserNotFoundException ex) {
+        log.error("User not found thrown", ex);
+        return new ErrorResponse("USER_NOT_FOUND", "The user was not found");
+    }
+}

examples/src/main/java/com/nibado/example/errorhandlers/example3/UserNotFoundException.java

@@ -0,0 +1,4 @@
+package com.nibado.example.errorhandlers.example3;
+
+public class UserNotFoundException extends RuntimeException {
+}

examples/src/main/java/com/nibado/example/errorhandlers/example4/BaseExceptionHandler.java

@@ -0,0 +1,86 @@
+package com.nibado.example.errorhandlers.example4;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import org.slf4j.Logger;
+import org.springframework.http.HttpStatus;
+import org.springframework.web.HttpRequestMethodNotSupportedException;
+import org.springframework.web.bind.MissingServletRequestParameterException;
+import org.springframework.web.bind.ServletRequestBindingException;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.ResponseBody;
+import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException;
+
+import javax.servlet.http.HttpServletResponse;
+import java.util.HashMap;
+import java.util.Map;
+
+import static org.springframework.http.HttpStatus.*;
+
+public abstract class BaseExceptionHandler {
+    private static final ExceptionMapping DEFAULT_ERROR = new ExceptionMapping(
+            "SERVER_ERROR",
+            "Internal server error",
+            INTERNAL_SERVER_ERROR);
+
+    private final Logger log;
+    private final Map<Class, ExceptionMapping> exceptionMappings = new HashMap<>();
+
+    public BaseExceptionHandler(final Logger log) {
+        this.log = log;
+
+        registerMapping(
+                MissingServletRequestParameterException.class,
+                "MISSING_PARAMETER",
+                "Missing request parameter",
+                BAD_REQUEST);
+        registerMapping(
+                MethodArgumentTypeMismatchException.class,
+                "ARGUMENT_TYPE_MISMATCH",
+                "Argument type mismatch",
+                BAD_REQUEST);
+        registerMapping(
+                HttpRequestMethodNotSupportedException.class,
+                "METHOD_NOT_SUPPORTED",
+                "HTTP method not supported",
+                METHOD_NOT_ALLOWED);
+        registerMapping(
+                ServletRequestBindingException.class,
+                "MISSING_HEADER",
+                "Missing header in request",
+                BAD_REQUEST);
+    }
+
+    @ExceptionHandler(Throwable.class)
+    @ResponseBody
+    public ErrorResponse handleThrowable(final Throwable ex, final HttpServletResponse response) {
+        ExceptionMapping mapping = exceptionMappings.getOrDefault(ex.getClass(), DEFAULT_ERROR);
+
+        response.setStatus(mapping.status.value());
+
+        log.error("{} ({}): {}", mapping.message, mapping.code, ex.getMessage(), ex);
+
+        return new ErrorResponse(mapping.code, mapping.message);
+    }
+
+    protected void registerMapping(
+            final Class<?> clazz,
+            final String code,
+            final String message,
+            final HttpStatus status) {
+        exceptionMappings.put(clazz, new ExceptionMapping(code, message, status));
+    }
+
+    @Data
+    public static class ErrorResponse {
+        private final String code;
+        private final String message;
+    }
+
+    @AllArgsConstructor
+    private static class ExceptionMapping {
+        private final String message;
+        private final String code;
+        private final HttpStatus status;
+    }
+}

examples/src/main/java/com/nibado/example/errorhandlers/example4/ExceptionHandlers.java

@@ -0,0 +1,14 @@
+package com.nibado.example.errorhandlers.example4;
+
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.ControllerAdvice;
+
+@ControllerAdvice
+@Slf4j
+public class ExceptionHandlers extends BaseExceptionHandler {
+    public ExceptionHandlers() {
+        super(log);
+        registerMapping(UserNotFoundException.class, "USER_NOT_FOUND", "User not found", HttpStatus.NOT_FOUND);
+    }
+}

examples/src/main/java/com/nibado/example/errorhandlers/example4/UserNotFoundException.java

@@ -0,0 +1,4 @@
+package com.nibado.example.errorhandlers.example4;
+
+public class UserNotFoundException extends RuntimeException {
+}

my-lib/src/main/java/com/nibado/example/baseerrorhandler/lib/BaseErrorHandler.java → my-lib/src/main/java/com/nibado/example/errorhandlers/lib/BaseExceptionHandler.java

@@ -1,4 +1,4 @@
-package com.nibado.example.baseerrorhandler.lib;
+package com.nibado.example.errorhandlers.lib;
 
 import org.slf4j.Logger;
 import org.springframework.http.HttpStatus;
@@ -15,7 +15,7 @@
 
 import static org.springframework.http.HttpStatus.*;
 
-public abstract class BaseErrorHandler {
+public abstract class BaseExceptionHandler {
     private static final ExceptionMapping DEFAULT_ERROR = new ExceptionMapping(
             "SERVER_ERROR",
             "Internal server error",
@@ -24,7 +24,7 @@ public abstract class BaseErrorHandler {
     private final Logger log;
     private final Map<Class, ExceptionMapping> exceptionMappings = new HashMap<>();
 
-    public BaseErrorHandler(final Logger log) {
+    public BaseExceptionHandler(final Logger log) {
         this.log = log;
 
         registerMapping(MissingServletRequestParameterException.class, "MISSING_PARAMETER", "Missing request parameter", BAD_REQUEST);

my-lib/src/main/java/com/nibado/example/baseerrorhandler/lib/ErrorDTO.java → my-lib/src/main/java/com/nibado/example/errorhandlers/lib/ErrorDTO.java

@@ -1,4 +1,4 @@
-package com.nibado.example.baseerrorhandler.lib;
+package com.nibado.example.errorhandlers.lib;
 
 import lombok.Data;
 

my-service/src/main/java/com/nibado/example/baseerrorhandler/service/Application.java → my-service/src/main/java/com/nibado/example/errorhandlers/service/Application.java

@@ -1,4 +1,4 @@
-package com.nibado.example.baseerrorhandler.service;
+package com.nibado.example.errorhandlers.service;
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;

my-service/src/main/java/com/nibado/example/baseerrorhandler/service/configuration/ApplicationConfiguration.java → my-service/src/main/java/com/nibado/example/errorhandlers/service/configuration/ApplicationConfiguration.java

@@ -1,4 +1,4 @@
-package com.nibado.example.baseerrorhandler.service.configuration;
+package com.nibado.example.errorhandlers.service.configuration;
 
 import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.core.JsonProcessingException;

my-service/src/main/java/com/nibado/example/baseerrorhandler/service/controller/ErrorHandler.java → my-service/src/main/java/com/nibado/example/errorhandlers/service/controller/ErrorHandler.java

@@ -1,16 +1,16 @@
-package com.nibado.example.baseerrorhandler.service.controller;
+package com.nibado.example.errorhandlers.service.controller;
 
-import com.nibado.example.baseerrorhandler.lib.BaseErrorHandler;
-import com.nibado.example.baseerrorhandler.service.controller.exception.NotImplementedException;
-import com.nibado.example.baseerrorhandler.service.controller.exception.UserNotFoundException;
-import com.nibado.example.baseerrorhandler.service.service.exception.InvalidSearchParamException;
+import com.nibado.example.errorhandlers.lib.BaseExceptionHandler;
+import com.nibado.example.errorhandlers.service.controller.exception.NotImplementedException;
+import com.nibado.example.errorhandlers.service.controller.exception.UserNotFoundException;
+import com.nibado.example.errorhandlers.service.service.exception.InvalidSearchParamException;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.http.HttpStatus;
 import org.springframework.web.bind.annotation.ControllerAdvice;
 
 @ControllerAdvice
 @Slf4j
-public class ErrorHandler extends BaseErrorHandler {
+public class ErrorHandler extends BaseExceptionHandler {
     public ErrorHandler() {
         super(log);
 

my-service/src/main/java/com/nibado/example/baseerrorhandler/service/controller/UserController.java → my-service/src/main/java/com/nibado/example/errorhandlers/service/controller/UserController.java

@@ -1,8 +1,8 @@
-package com.nibado.example.baseerrorhandler.service.controller;
+package com.nibado.example.errorhandlers.service.controller;
 
-import com.nibado.example.baseerrorhandler.service.controller.exception.NotImplementedException;
-import com.nibado.example.baseerrorhandler.service.service.domain.User;
-import com.nibado.example.baseerrorhandler.service.service.UserService;
+import com.nibado.example.errorhandlers.service.controller.exception.NotImplementedException;
+import com.nibado.example.errorhandlers.service.service.domain.User;
+import com.nibado.example.errorhandlers.service.service.UserService;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.MediaType;
@@ -13,7 +13,7 @@
 import java.util.UUID;
 import java.util.concurrent.Callable;
 
-import static com.nibado.example.baseerrorhandler.service.controller.exception.UserNotFoundException.supplier;
+import static com.nibado.example.errorhandlers.service.controller.exception.UserNotFoundException.supplier;
 
 @RestController
 @Slf4j

my-service/src/main/java/com/nibado/example/errorhandlers/service/controller/exception/NotImplementedException.java

@@ -0,0 +1,4 @@
+package com.nibado.example.errorhandlers.service.controller.exception;
+
+public class NotImplementedException extends RuntimeException {
+}

my-service/src/main/java/com/nibado/example/baseerrorhandler/service/controller/exception/UserNotFoundException.java → my-service/src/main/java/com/nibado/example/errorhandlers/service/controller/exception/UserNotFoundException.java

@@ -1,4 +1,4 @@
-package com.nibado.example.baseerrorhandler.service.controller.exception;
+package com.nibado.example.errorhandlers.service.controller.exception;
 
 import java.util.UUID;
 import java.util.function.Supplier;

my-service/src/main/java/com/nibado/example/errorhandlers/service/example/UserNotFoundException.java

@@ -0,0 +1,8 @@
+package com.nibado.example.errorhandlers.service.example;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.ResponseStatus;
+
+@ResponseStatus(value = HttpStatus.NOT_FOUND, reason = "User not found")
+public class UserNotFoundException extends RuntimeException {
+}

my-service/src/main/java/com/nibado/example/baseerrorhandler/service/service/UserService.java → my-service/src/main/java/com/nibado/example/errorhandlers/service/service/UserService.java

@@ -1,7 +1,7 @@
-package com.nibado.example.baseerrorhandler.service.service;
+package com.nibado.example.errorhandlers.service.service;
 
-import com.nibado.example.baseerrorhandler.service.service.exception.InvalidSearchParamException;
-import com.nibado.example.baseerrorhandler.service.service.domain.User;
+import com.nibado.example.errorhandlers.service.service.exception.InvalidSearchParamException;
+import com.nibado.example.errorhandlers.service.service.domain.User;
 import org.springframework.stereotype.Service;
 
 import javax.annotation.PostConstruct;

my-service/src/main/java/com/nibado/example/baseerrorhandler/service/service/domain/User.java → my-service/src/main/java/com/nibado/example/errorhandlers/service/service/domain/User.java

@@ -1,4 +1,4 @@
-package com.nibado.example.baseerrorhandler.service.service.domain;
+package com.nibado.example.errorhandlers.service.service.domain;
 
 import lombok.Data;
 

my-service/src/main/java/com/nibado/example/baseerrorhandler/service/service/exception/InvalidSearchParamException.java → my-service/src/main/java/com/nibado/example/errorhandlers/service/service/exception/InvalidSearchParamException.java

@@ -1,4 +1,4 @@
-package com.nibado.example.baseerrorhandler.service.service.exception;
+package com.nibado.example.errorhandlers.service.service.exception;
 
 import java.util.function.Supplier;
 

my-service/src/test/java/com/nibado/example/baseerrorhandler/service/controller/UserControllerTest.java → my-service/src/test/java/com/nibado/example/errorhandlers/service/controller/UserControllerTest.java

@@ -1,4 +1,4 @@
-package com.nibado.example.baseerrorhandler.service.controller;
+package com.nibado.example.errorhandlers.service.controller;
 
 import org.junit.Before;
 import org.junit.Test;

pom.xml

@@ -12,6 +12,7 @@
     <modules>
         <module>my-lib</module>
         <module>my-service</module>
+        <module>examples</module>
     </modules>
 
     <properties>