Package io.github.pasinduog.exception

Class GlobalExceptionHandler

java.lang.Object
io.github.pasinduog.exception.GlobalExceptionHandler
@RestControllerAdvice public class GlobalExceptionHandler extends Object
Global Exception Handler for the application.

This class intercepts exceptions thrown by any controller across the application and transforms them into a standard ProblemDetail format (RFC 7807). This ensures a consistent error response structure for API clients.

Version:
1.2.0
Author:
Pasindu OG
See Also:
  • ProblemDetail

  • Constructor Details

    • GlobalExceptionHandler

      public GlobalExceptionHandler()

  • Method Details

    • handleAllExceptions

      @ExceptionHandler(java.lang.Exception.class) public org.springframework.http.ProblemDetail handleAllExceptions(Exception ex)
      Handles all unexpected exceptions (catch-all handler).

      This method acts as a safety net for any error not explicitly handled by other methods. It returns a generic 500 Internal Server Error to avoid leaking sensitive stack traces to the client, while logging the full error details for debugging.

      Parameters:
      ex - The exception that was thrown.
      Returns:
      A ProblemDetail with HTTP 500 status and a generic error message.

    • handleValidationExceptions

      @ExceptionHandler(org.springframework.web.bind.MethodArgumentNotValidException.class) public org.springframework.http.ProblemDetail handleValidationExceptions(org.springframework.web.bind.MethodArgumentNotValidException ex)
      Handles bean validation errors (e.g., @NotNull, @Size failures).

      Triggers when a RequestBody fails validation. It collects all field-level errors and returns them in a map under the "errors" property. If a field has multiple errors, they are joined by a semicolon.

      Parameters:
      ex - The validation exception containing the list of field errors.
      Returns:
      A ProblemDetail with HTTP 400 status and a map of validation errors.

    • handleNullPointerExceptions

      @ExceptionHandler(java.lang.NullPointerException.class) public org.springframework.http.ProblemDetail handleNullPointerExceptions(NullPointerException ex)
      Handles NullPointerExceptions explicitly.

      While strictly not necessary (as the catch-all handler covers this), having a specific handler allows for distinct logging or custom messaging for NPEs if required in the future.

      Parameters:
      ex - The NullPointerException that was thrown.
      Returns:
      A ProblemDetail with HTTP 500 status.

    • handleApiException

      @ExceptionHandler(ApiException.class) public org.springframework.http.ProblemDetail handleApiException(ApiException ex)
      Handles all custom exceptions that extend ApiException.

      This method dynamically extracts the HTTP status and message from the thrown exception, providing a standardized RFC 7807 response for any domain-specific error created by the library user.

      Parameters:
      ex - The custom API exception instance.
      Returns:
      A ProblemDetail with the status and message defined in the exception.