Index
All Classes and Interfaces|All Packages|Serialized Form
A
- ApiException - Exception Class 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 ApiResponse instances.
- 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
B
- build() - Method in class io.github.og4dev.dto.ApiResponse.ApiResponseBuilder
-
Builds the ApiResponse instance.
C
- content(T) - Method in class io.github.og4dev.dto.ApiResponse.ApiResponseBuilder
-
Sets the response content.
- created(String, T) - Static method in class io.github.og4dev.dto.ApiResponse
-
Creates a CREATED (201) response with a message and content.
D
- Disabling Auto-Configuration: - Search tag in class io.github.og4dev.config.ApiResponseAutoConfiguration
- Section
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 class 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.
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.
- How It Works: - Search tag in class io.github.og4dev.config.ApiResponseAutoConfiguration
- Section
I
- io.github.og4dev - package io.github.og4dev
-
Root package for the OG4Dev Spring API Response Library.
- 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
-
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(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.
- 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.
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.
W
- What Gets Auto-Configured: - Search tag in class io.github.og4dev.config.ApiResponseAutoConfiguration
- Section
All Classes and Interfaces|All Packages|Serialized Form