feature : can customize the knife error payload

Author: patternhelloworld

README.md

@@ -23,7 +23,7 @@
            }
         ```
 
-        * Error Payload 
+        * Error Payload (Customizable) 
         ```json
           {
               "timestamp": 1719470948370,
@@ -71,10 +71,9 @@ mvnw clean install # Integration tests are done here, which creates docs by Spri
 - The client module definitely consumes the API module, but not vice versa.
 
 ## API Guide
-#### The implementation method is shown in the client source code.
 
 ### **Registration**
-  - As the Api module consumes JPA, adding it to Beans is required.
+  - See the `client` folder. As the Api module consumes JPA, adding it to Beans is required.
 
 ```java
 
@@ -117,16 +116,23 @@ public class CommonDataSourceConfiguration {
 }
 ```
 
-### **Implementation**
+### **Implementation of...**
+
+#### "Mandatory" settings
   - The only mandatory setting is ``client.config.securityimpl.service.userdetail.CustomUserDetailsServiceFactory``. The rest depend on your specific situation.
-  
-    - **Use PointCut when events happen such as tokens created**
-      - ``SecurityPointCut``
-      - See the source code in ``client.config.securityimpl.aop`` 
-    - **Register error user messages as desired**
-      - ``ISecurityUserExceptionMessageService``
-      - See the source code in ``client.config.securityimpl.message``
-    
+
+#### "Customizable" settings
+
+  - **Use PointCut when events happen such as tokens created**
+    - ``SecurityPointCut``
+    - See the source code in ``client.config.securityimpl.aop`` 
+  - **Register error user messages as desired**
+    - ``ISecurityUserExceptionMessageService``
+    - See the source code in ``client.config.securityimpl.message``
+  - **Customize the whole error payload as desired**
+    - Customize only two points in
+      - ``client.config.securityimpl.errorhandler.CustomAuthenticationFailureHandlerImpl``
+      - ``client.config.response.error.GlobalExceptionHandler``
 ## Running this App with Docker
 * Use the following module for Blue-Green deployment:
   * https://github.com/patternknife/docker-blue-green-runner

client/pom.xml

@@ -7,7 +7,7 @@ http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.patternknife.securityhelper.oauth2.client</groupId>
     <artifactId>spring-security-oauth2-password-jpa-implementation-client</artifactId>
-    <version>2.4.0</version>
+    <version>2.5.0</version>
     <packaging>jar</packaging>
 
     <properties>
@@ -41,7 +41,7 @@ http://maven.apache.org/xsd/maven-4.0.0.xsd">
         <dependency>
             <groupId>io.github.patternknife.securityhelper.oauth2.api</groupId>
             <artifactId>spring-security-oauth2-password-jpa-implementation</artifactId>
-            <version>2.4.0</version>
+            <version>2.5.0</version>
         </dependency>
 
         <!-- DB -->

client/src/main/java/com/patternknife/securityhelper/oauth2/client/config/response/error/GlobalExceptionHandler.java

@@ -2,184 +2,60 @@
 
 
 import com.patternknife.securityhelper.oauth2.client.config.response.error.dto.CustomErrorResponsePayload;
-import com.patternknife.securityhelper.oauth2.client.config.response.error.exception.auth.*;
-import com.patternknife.securityhelper.oauth2.client.config.response.error.exception.data.*;
-
-import com.patternknife.securityhelper.oauth2.client.config.response.error.exception.payload.SearchFilterException;
 
 import com.patternknife.securityhelper.oauth2.client.config.response.error.message.GeneralErrorMessage;
-import jakarta.servlet.http.HttpServletRequest;
-import jakarta.validation.ConstraintViolationException;
+import io.github.patternknife.securityhelper.oauth2.api.config.response.error.ExceptionKnifeUtils;
+import io.github.patternknife.securityhelper.oauth2.api.config.response.error.dto.ErrorResponsePayload;
+import io.github.patternknife.securityhelper.oauth2.api.config.response.error.exception.auth.KnifeOauth2AuthenticationException;
+import io.github.patternknife.securityhelper.oauth2.api.config.security.message.DefaultSecurityUserExceptionMessage;
+import io.github.patternknife.securityhelper.oauth2.api.config.security.message.ISecurityUserExceptionMessageService;
+import lombok.RequiredArgsConstructor;;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
-import org.springframework.http.converter.HttpMessageNotReadableException;
-import org.springframework.validation.BindException;
-import org.springframework.validation.FieldError;
-import org.springframework.web.bind.MethodArgumentNotValidException;
-import org.springframework.web.bind.MissingServletRequestParameterException;
+import org.springframework.security.access.AccessDeniedException;
+import org.springframework.security.core.AuthenticationException;
 import org.springframework.web.bind.annotation.ControllerAdvice;
 import org.springframework.web.bind.annotation.ExceptionHandler;
-import org.springframework.web.client.ResourceAccessException;
-import org.springframework.web.context.request.WebRequest;
 
-import java.util.HashMap;
-import java.util.Map;
+import org.springframework.web.context.request.WebRequest;
 
 
+/*
+ *
+ *   Customize the exception payload by implementing this, which replaces
+ *          'io.github.patternknife.securityhelper.oauth2.api.config.response.error.SecurityKnifeExceptionHandler'
+ *
+ *   Once you create 'GlobalExceptionHandler', you should insert the following two as default. Otherwise, 'unhandledExceptionHandler' is prior to 'io.github.patternknife.securityhelper.oauth2.api.config.response.error.SecurityKnifeExceptionHandler'.
+ *
+ * */
 @ControllerAdvice
+@RequiredArgsConstructor
 public class GlobalExceptionHandler {
 
-
-    // UserDeletedException : caused by the process of user deactivation
-    // UserRestoredException : caused by the process of user reactivation
-    @ExceptionHandler({UserDeletedException.class, UserRestoredException.class})
-    public ResponseEntity<?> activationException(Exception ex, WebRequest request) {
-        CustomErrorResponsePayload customErrorResponsePayload = new CustomErrorResponsePayload(ex.getMessage() != null ? ex.getMessage() : CustomExceptionUtils.getAllCauses(ex),
-                request.getDescription(false),ex.getMessage() , ex.getStackTrace()[0].toString());
-        return new ResponseEntity<>(customErrorResponsePayload, HttpStatus.FORBIDDEN);
-    }
-
-
-    // 2. data
-    @ExceptionHandler(ResourceNotFoundException.class)
-    public ResponseEntity<?> resourceNotFoundException(ResourceNotFoundException ex, WebRequest request) {
-
-        CustomErrorResponsePayload customErrorResponsePayload;
-        if(ex.getErrorMessages() != null){
-
-            customErrorResponsePayload = new CustomErrorResponsePayload(ex.getErrorMessages(),
-                    ex, request.getDescription(false), CustomExceptionUtils.getAllStackTraces(ex),
-                    CustomExceptionUtils.getAllCauses(ex), null);
-
-        }else{
-            customErrorResponsePayload = new CustomErrorResponsePayload(ex.getMessage(), request.getDescription(false),
-                    ex.getMessage(), CustomExceptionUtils.getAllStackTraces(ex),
-                    CustomExceptionUtils.getAllCauses(ex));
+    private final ISecurityUserExceptionMessageService iSecurityUserExceptionMessageService;
+
+    // 401 : Authentication
+    @ExceptionHandler({AuthenticationException.class})
+    public ResponseEntity<?> authenticationException(Exception ex, WebRequest request) {
+        ErrorResponsePayload errorResponsePayload;
+        if(ex instanceof KnifeOauth2AuthenticationException && ((KnifeOauth2AuthenticationException) ex).getErrorMessages() != null) {
+            errorResponsePayload = new ErrorResponsePayload(((KnifeOauth2AuthenticationException) ex).getErrorMessages(),
+                    ex, request.getDescription(false), ExceptionKnifeUtils.getAllStackTraces(ex),
+                    ExceptionKnifeUtils.getAllCauses(ex), null);
+        }else {
+            errorResponsePayload = new ErrorResponsePayload(ExceptionKnifeUtils.getAllCauses(ex), request.getDescription(false), iSecurityUserExceptionMessageService.getUserMessage(DefaultSecurityUserExceptionMessage.AUTHENTICATION_LOGIN_FAILURE),
+                    ex.getMessage(), ex.getStackTrace()[0].toString());
         }
-        return new ResponseEntity<>(customErrorResponsePayload, HttpStatus.NOT_FOUND);
-
-    }
-    
-
-
-    @ExceptionHandler(SearchFilterException.class)
-    public ResponseEntity<?> searchFilterException(SearchFilterException ex, WebRequest request) {
-
-        //logger.error(ex.getMessage());
-        CustomErrorResponsePayload customErrorResponsePayload = new CustomErrorResponsePayload(ex.getCause().getMessage(), request.getDescription(false),
-                ex.getMessage(), ex.getStackTrace()[0].toString());
-        return new ResponseEntity<>(customErrorResponsePayload, HttpStatus.BAD_REQUEST);
+        return new ResponseEntity<>(errorResponsePayload, HttpStatus.UNAUTHORIZED);
     }
 
-
-
-    @ExceptionHandler(NullPointerException.class)
-    public ResponseEntity<?> nullPointerException(NullPointerException ex, WebRequest request) {
-        CustomErrorResponsePayload customErrorResponsePayload = new CustomErrorResponsePayload(ex.getMessage(), request.getDescription(false),
-                GeneralErrorMessage.NULL_VALUE_FOUND.getUserMessage(), CustomExceptionUtils.getAllStackTraces(ex), CustomExceptionUtils.getAllCauses(ex));
-        return new ResponseEntity<>(customErrorResponsePayload, HttpStatus.NOT_FOUND);
+    // 403 : Authorization
+    @ExceptionHandler({ AccessDeniedException.class })
+    public ResponseEntity<?> authorizationException(Exception ex, WebRequest request) {
+        ErrorResponsePayload errorResponsePayload = new ErrorResponsePayload(ex.getMessage() != null ? ex.getMessage() : ExceptionKnifeUtils.getAllCauses(ex), request.getDescription(false),
+                ex.getMessage() == null || ex.getMessage().equals("Access Denied") ? iSecurityUserExceptionMessageService.getUserMessage(DefaultSecurityUserExceptionMessage.AUTHORIZATION_FAILURE) : ex.getMessage(), ex.getStackTrace()[0].toString());
+        return new ResponseEntity<>(errorResponsePayload, HttpStatus.FORBIDDEN);
     }
-    
-
-
-
-
-    // 3. Request @Valid
-    /* 1. Validating the request body (when not using @RequestParam): Error thrown by @Valid. */
-    @ExceptionHandler(MethodArgumentNotValidException.class)
-    public ResponseEntity<?> methodArgumentNotValidException(MethodArgumentNotValidException ex, WebRequest request) {
-
-        Map<String, String> userValidationMessages = CustomExceptionUtils.extractMethodArgumentNotValidErrors(ex);
-
-        CustomErrorResponsePayload customErrorResponsePayload = new CustomErrorResponsePayload(ex.getMessage(), request.getDescription(false),
-                null,
-                userValidationMessages,
-                CustomExceptionUtils.getAllStackTraces(ex), CustomExceptionUtils.getAllCauses(ex));
-        return new ResponseEntity<>(customErrorResponsePayload, HttpStatus.UNPROCESSABLE_ENTITY);
-    }
-    //
-    //The types of individual parameters in the request body (String, Date, Integer) are different, or there is a JSON format error.
-    @ExceptionHandler(HttpMessageNotReadableException.class)
-    public ResponseEntity<?> httpMessageNotReadableExceptionHandler(HttpMessageNotReadableException ex, WebRequest request) {
-
-        CustomErrorResponsePayload customErrorResponsePayload = new CustomErrorResponsePayload(ex.getMessage(), request.getDescription(false),
-                "The received form does not match. Please contact the administrator with the following information. (Error details: " + ex.getMostSpecificCause().getMessage() + ")",
-                null,
-                CustomExceptionUtils.getAllStackTraces(ex), CustomExceptionUtils.getAllCauses(ex));
-        return new ResponseEntity<>(customErrorResponsePayload, HttpStatus.BAD_REQUEST);
-    }
-
-    /* 2-1. In the case of @RequestParam: Validity check thrown by @Validated. */
-    @ExceptionHandler(ConstraintViolationException.class)
-    public ResponseEntity<?> missingServletRequestParameterException(ConstraintViolationException ex, WebRequest request, HttpServletRequest h) {
-
-        CustomErrorResponsePayload customErrorResponsePayload = new CustomErrorResponsePayload(ex.getMessage(), request.getDescription(false),
-                ex.getMessage(), CustomExceptionUtils.getAllStackTraces(ex), CustomExceptionUtils.getAllCauses(ex));
-        return new ResponseEntity<>(customErrorResponsePayload, HttpStatus.UNPROCESSABLE_ENTITY);
-    }
-    /* 2-2. In the case of @RequestParam: The error thrown when @RequestParam is completely missing in the Controller. */
-    @ExceptionHandler(MissingServletRequestParameterException.class)
-    public ResponseEntity<?> missingServletRequestParameterException(MissingServletRequestParameterException ex, WebRequest request, HttpServletRequest h) {
-
-        CustomErrorResponsePayload customErrorResponsePayload = new CustomErrorResponsePayload(ex.getMessage(), request.getDescription(false),
-                "Required parameter (" + ex.getParameterName() + ") is missing.", CustomExceptionUtils.getAllStackTraces(ex), CustomExceptionUtils.getAllCauses(ex));
-        return new ResponseEntity<>(customErrorResponsePayload, HttpStatus.UNPROCESSABLE_ENTITY);
-    }
-
-    /* 3. Other Custom Validation: For example, search in the source with @ValidPart.  */
-    @ExceptionHandler(BindException.class)
-    public ResponseEntity<?> bindExceptionHandler(BindException ex, WebRequest request) {
-
-        Map<String, String> errorMessages = new HashMap<>();
-
-        for (FieldError fieldError : ex.getBindingResult().getFieldErrors()) {
-            errorMessages.put(fieldError.getField(), fieldError.getDefaultMessage());
-        }
-
-        CustomErrorResponsePayload customErrorResponsePayload = new CustomErrorResponsePayload(ex.getMessage(), request.getDescription(false), null,
-                errorMessages,
-                CustomExceptionUtils.getAllStackTraces(ex), CustomExceptionUtils.getAllCauses(ex));
-        return new ResponseEntity<>(customErrorResponsePayload, HttpStatus.UNPROCESSABLE_ENTITY);
-    }
-
-
-    // 4. Custom Validation using DB(select)
-
-    @ExceptionHandler(AlreadyExistsException.class)
-    public ResponseEntity<?> alreadyExistsException(AlreadyExistsException ex, WebRequest request) {
-
-        CustomErrorResponsePayload customErrorResponsePayload = new CustomErrorResponsePayload(ex.getMessage(), request.getDescription(false),
-                ex.getMessage(), CustomExceptionUtils.getAllStackTraces(ex), CustomExceptionUtils.getAllCauses(ex));
-        return new ResponseEntity<>(customErrorResponsePayload, HttpStatus.UNPROCESSABLE_ENTITY);
-    }
-
-    @ExceptionHandler(IllegalStateException.class)
-    public ResponseEntity<?> illegalStateException(IllegalStateException ex, WebRequest request) {
-
-        CustomErrorResponsePayload customErrorResponsePayload = new CustomErrorResponsePayload(ex.getMessage(), request.getDescription(false),
-                ex.getMessage(), CustomExceptionUtils.getAllStackTraces(ex), CustomExceptionUtils.getAllCauses(ex));
-        return new ResponseEntity<>(customErrorResponsePayload, HttpStatus.BAD_REQUEST);
-    }
-
-
-    @ExceptionHandler(AlreadyInProgressException.class)
-    public ResponseEntity<?> alreadyInProgressException(AlreadyInProgressException ex, WebRequest request) {
-
-        CustomErrorResponsePayload customErrorResponsePayload = new CustomErrorResponsePayload(ex.getMessage(), request.getDescription(false),
-                ex.getMessage(), CustomExceptionUtils.getAllStackTraces(ex), CustomExceptionUtils.getAllCauses(ex));
-        return new ResponseEntity<>(customErrorResponsePayload, HttpStatus.UNPROCESSABLE_ENTITY);
-    }
-
-
-    // config/resttemplate
-    @ExceptionHandler(ResourceAccessException.class)
-    public ResponseEntity<?> restTemplateAccessException(ResourceAccessException ex, WebRequest request) {
-
-        CustomErrorResponsePayload customErrorResponsePayload = new CustomErrorResponsePayload(ex.getMessage(), request.getDescription(false),
-                "We apologize for the inconvenience. The call to the 3rd Party API provider has failed. If the problem persists, please contact customer service.", CustomExceptionUtils.getAllStackTraces(ex), CustomExceptionUtils.getAllCauses(ex));
-        return new ResponseEntity<>(customErrorResponsePayload, HttpStatus.REQUEST_TIMEOUT);
-    }
-
 
     // Unhandled
     @ExceptionHandler(Exception.class)
@@ -189,6 +65,4 @@ public ResponseEntity<?> unhandledExceptionHandler(Exception ex, WebRequest requ
         return new ResponseEntity<>(customErrorResponsePayload, HttpStatus.INTERNAL_SERVER_ERROR);
     }
 
-
-
 }