Index
All Classes and Interfaces|All Packages|Serialized Form
A
- ApiException - Exception in io.github.og4dev.exception
-
Base abstract exception class for custom API-related business logic exceptions.
- ApiResponse<T> - Class in io.github.og4dev.dto
-
Standard API Response wrapper for Spring Boot applications.
- ApiResponse.ApiResponseBuilder<T> - Class in io.github.og4dev.dto
-
Builder class for constructing
ApiResponseinstances. - apiResponseAdvisor() - Method in class io.github.og4dev.config.ApiResponseAutoConfiguration
-
Registers the
GlobalExceptionHandleras a Spring bean for automatic exception handling. - ApiResponseAutoConfiguration - Class in io.github.og4dev.config
-
Autoconfiguration class for the OG4Dev Spring API Response Library.
- ApiResponseAutoConfiguration() - Constructor for class io.github.og4dev.config.ApiResponseAutoConfiguration
-
Default constructor for ApiResponseAutoConfiguration.
- ApiResponseBuilder() - Constructor for class io.github.og4dev.dto.ApiResponse.ApiResponseBuilder
-
Default constructor for creating an empty builder.
- AutoResponse - Annotation Interface in io.github.og4dev.annotation
-
Opt-in annotation to enable automatic API response wrapping for Spring REST controllers.
- AutoTrim - Annotation Interface in io.github.og4dev.annotation
-
Annotation to explicitly enable automatic string trimming during JSON deserialization.
B
- beforeBodyWrite(Object, MethodParameter, MediaType, Class<? extends HttpMessageConverter<?>>, ServerHttpRequest, ServerHttpResponse) - Method in class io.github.og4dev.advice.GlobalResponseWrapper
-
Intercepts the response body before it is written to the output stream and encapsulates it within an
ApiResponse. - build() - Method in class io.github.og4dev.dto.ApiResponse.ApiResponseBuilder
-
Builds the
ApiResponseinstance.
C
- content(T) - Method in class io.github.og4dev.dto.ApiResponse.ApiResponseBuilder
-
Sets the response content.
- created(String) - Static method in class io.github.og4dev.dto.ApiResponse
-
Creates a CREATED (201) response with a message.
- created(String, T) - Static method in class io.github.og4dev.dto.ApiResponse
-
Creates a CREATED (201) response with a message and content.
E
- error(String, HttpStatus) - Static method in class io.github.og4dev.dto.ApiResponse
-
Creates a response with a custom HTTP status and error message only.
- error(String, T, HttpStatus) - Static method in class io.github.og4dev.dto.ApiResponse
-
Creates a response with a custom HTTP status, error message, and content.
G
- getContent() - Method in class io.github.og4dev.dto.ApiResponse
-
Gets the response content.
- getMessage() - Method in class io.github.og4dev.dto.ApiResponse
-
Gets the response message.
- getStatus() - Method in class io.github.og4dev.dto.ApiResponse
-
Gets the HTTP status code.
- getStatus() - Method in exception io.github.og4dev.exception.ApiException
-
Gets the HTTP status code associated with this exception.
- getTimestamp() - Method in class io.github.og4dev.dto.ApiResponse
-
Gets the response timestamp.
- GlobalExceptionHandler - Class in io.github.og4dev.exception
-
Global exception handler for Spring Boot REST APIs with comprehensive error coverage.
- GlobalExceptionHandler() - Constructor for class io.github.og4dev.exception.GlobalExceptionHandler
-
Default constructor for Spring bean instantiation.
- globalResponseWrapper(ObjectMapper) - Method in class io.github.og4dev.config.ApiResponseAutoConfiguration
-
Registers the
GlobalResponseWrapperas a Spring bean for automatic API response wrapping. - GlobalResponseWrapper - Class in io.github.og4dev.advice
-
Global response interceptor that automatically wraps REST controller outputs into the standardized
ApiResponseformat. - GlobalResponseWrapper(ObjectMapper) - Constructor for class io.github.og4dev.advice.GlobalResponseWrapper
-
Constructs a new
GlobalResponseWrapperwith the providedObjectMapper.
H
- handleAllExceptions(Exception) - Method in class io.github.og4dev.exception.GlobalExceptionHandler
-
Handles all unhandled exceptions.
- handleApiException(ApiException) - Method in class io.github.og4dev.exception.GlobalExceptionHandler
-
Handles custom API exceptions.
- handleHttpMediaTypeNotSupportedException(HttpMediaTypeNotSupportedException) - Method in class io.github.og4dev.exception.GlobalExceptionHandler
-
Handles unsupported media type exceptions.
- handleHttpMessageNotReadableException(HttpMessageNotReadableException) - Method in class io.github.og4dev.exception.GlobalExceptionHandler
-
Handles malformed JSON request exceptions.
- handleHttpRequestMethodNotSupportedException(HttpRequestMethodNotSupportedException) - Method in class io.github.og4dev.exception.GlobalExceptionHandler
-
Handles HTTP method not supported exceptions.
- handleMethodArgumentTypeMismatchException(MethodArgumentTypeMismatchException) - Method in class io.github.og4dev.exception.GlobalExceptionHandler
-
Handles method argument type mismatch exceptions.
- handleMissingServletRequestParameterException(MissingServletRequestParameterException) - Method in class io.github.og4dev.exception.GlobalExceptionHandler
-
Handles missing required request parameter exceptions.
- handleNoResourceFoundException(NoResourceFoundException) - Method in class io.github.og4dev.exception.GlobalExceptionHandler
-
Handles 404 Not Found exceptions.
- handleNullPointerExceptions(NullPointerException) - Method in class io.github.og4dev.exception.GlobalExceptionHandler
-
Handles null pointer exceptions.
- handleValidationExceptions(MethodArgumentNotValidException) - Method in class io.github.og4dev.exception.GlobalExceptionHandler
-
Handles validation exceptions from @Valid annotations.
I
- io.github.og4dev - package io.github.og4dev
-
Root package for the OG4Dev Spring API Response Library.
- io.github.og4dev.advice - package io.github.og4dev.advice
-
Provides global advisory components for the OG4Dev Spring API Response Library.
- io.github.og4dev.annotation - package io.github.og4dev.annotation
-
Field-level annotations for opt-in JSON deserialization security and data processing features.
- io.github.og4dev.config - package io.github.og4dev.config
-
Configuration classes for the OG4Dev Spring API Response Library.
- io.github.og4dev.dto - package io.github.og4dev.dto
-
Provides Data Transfer Object (DTO) classes for standardized API responses.
- io.github.og4dev.exception - package io.github.og4dev.exception
-
Exception handling classes for comprehensive API error management.
- io.github.og4dev.filter - package io.github.og4dev.filter
-
Servlet filter classes for request processing and distributed tracing.
M
- message(String) - Method in class io.github.og4dev.dto.ApiResponse.ApiResponseBuilder
-
Sets the response message.
S
- status(Integer) - Method in class io.github.og4dev.dto.ApiResponse.ApiResponseBuilder
-
Sets the HTTP status code.
- status(String, HttpStatus) - Static method in class io.github.og4dev.dto.ApiResponse
-
Creates a response with a custom HTTP status and message only.
- status(String, T, HttpStatus) - Static method in class io.github.og4dev.dto.ApiResponse
-
Creates a response with a custom HTTP status, message, and content.
- strictJsonCustomizer() - Method in class io.github.og4dev.config.ApiResponseAutoConfiguration
-
Configures strict JSON deserialization with opt-in security features via field-level and class-level annotations.
- success(String) - Static method in class io.github.og4dev.dto.ApiResponse
-
Creates a SUCCESS (200) response with only a message.
- success(String, T) - Static method in class io.github.og4dev.dto.ApiResponse
-
Creates a SUCCESS (200) response with a message and content.
- supports(MethodParameter, Class<? extends HttpMessageConverter<?>>) - Method in class io.github.og4dev.advice.GlobalResponseWrapper
-
Determines whether the current response should be intercepted and wrapped.
T
- TraceIdFilter - Class in io.github.og4dev.filter
-
Servlet filter that generates and manages trace IDs for distributed tracing.
- TraceIdFilter() - Constructor for class io.github.og4dev.filter.TraceIdFilter
-
Default constructor for Spring filter registration.
X
- XssCheck - Annotation Interface in io.github.og4dev.annotation
-
Annotation to explicitly enable XSS (Cross-Site Scripting) validation for string fields during JSON deserialization.
All Classes and Interfaces|All Packages|Serialized Form