Index
All Classes and Interfaces|All Packages|Serialized Form
A
- Accepted - Annotation Interface in pro.nikolaev.restutils.annotations.swagger.success
-
A convenience annotation that is itself annotated with
@ApiResponse. - ApiError - Record Class in pro.nikolaev.restutils.dto
-
DTO type that is used to populate
@ResponseBodyof@ExceptionHandlermethods inExceptionHandlingAdvice. - ApiError(String, String) - Constructor for record class pro.nikolaev.restutils.dto.ApiError
-
Creates an instance of a
ApiErrorrecord class. - ApiException - Exception Class in pro.nikolaev.restutils.exceptions
-
RuntimeExceptionintended to use to expose an HTTP status and reason to@ExceptionHandler. - ApiException(HttpStatusCode, String) - Constructor for exception class pro.nikolaev.restutils.exceptions.ApiException
-
Constructor with a response status and a reason.
- ApiException(HttpStatusCode, String, String) - Constructor for exception class pro.nikolaev.restutils.exceptions.ApiException
-
Constructor with a response status, reason and message as explanation.
- ApiException(HttpStatusCode, String, String, Throwable) - Constructor for exception class pro.nikolaev.restutils.exceptions.ApiException
-
Constructor with a response status, reason and message as explanation, as well as a nested exception.
- ApiException(HttpStatusCode, String, String, Throwable, boolean, boolean) - Constructor for exception class pro.nikolaev.restutils.exceptions.ApiException
-
Constructor with a response status, reason and message as explanation, as well as a nested exception, suppression enabled or disabled, and writable stack trace enabled or disabled.
- ApiException(HttpStatusCode, String, Throwable) - Constructor for exception class pro.nikolaev.restutils.exceptions.ApiException
-
Constructor with a response status and reason as well as a nested exception.
B
- BadRequest - Annotation Interface in pro.nikolaev.restutils.annotations.swagger.clienterrors
-
A convenience annotation that is itself annotated with
@ApiResponse.
C
- Conflict - Annotation Interface in pro.nikolaev.restutils.annotations.swagger.clienterrors
-
A convenience annotation that is itself annotated with
@ApiResponse. - content() - Element in annotation interface pro.nikolaev.restutils.annotations.swagger.success.Ok
- Created - Annotation Interface in pro.nikolaev.restutils.annotations.swagger.success
-
A convenience annotation that is itself annotated with
@ApiResponse.
D
- details() - Method in record class pro.nikolaev.restutils.dto.ApiError
-
Returns the value of the
detailsrecord component.
E
- EnableRestExceptionHandler - Annotation Interface in pro.nikolaev.restutils.annotations
-
A convenience annotation that creates a bean annotated with
@RestControllerAdvice. - equals(Object) - Method in record class pro.nikolaev.restutils.dto.ApiError
-
Indicates whether some other object is "equal to" this one.
- ExceptionHandlingAdvice - Class in pro.nikolaev.restutils.components
-
Class representing
RestControllerAdvicebean for handling MVC exception. - ExceptionHandlingAdvice(MultipartConfigElement) - Constructor for class pro.nikolaev.restutils.components.ExceptionHandlingAdvice
F
- Forbidden - Annotation Interface in pro.nikolaev.restutils.annotations.swagger.clienterrors
-
A convenience annotation that is itself annotated with
@ApiResponse.
G
- getReason() - Method in exception class pro.nikolaev.restutils.exceptions.ApiException
-
The reason explaining the exception (potentially
nullor empty). - getStatus() - Method in exception class pro.nikolaev.restutils.exceptions.ApiException
-
Return the HTTP status code to use for the response.
- Gone - Annotation Interface in pro.nikolaev.restutils.annotations.swagger.clienterrors
-
A convenience annotation that is itself annotated with
@ApiResponse.
H
- handel401(AuthenticationException) - Method in class pro.nikolaev.restutils.components.ExceptionHandlingAdvice
-
ExceptionHandlerto handle anyAuthenticationExceptionexcept ofBadCredentialsException,UsernameNotFoundException,AccountExpiredException,DisabledExceptionandLockedException. - handle400(HttpMessageNotReadableException) - Method in class pro.nikolaev.restutils.components.ExceptionHandlingAdvice
-
ExceptionHandlerto handleHttpMessageNotReadableException. - handle400(MethodArgumentNotValidException) - Method in class pro.nikolaev.restutils.components.ExceptionHandlingAdvice
-
ExceptionHandlerto handleMethodArgumentNotValidException. - handle400(MethodArgumentTypeMismatchException) - Method in class pro.nikolaev.restutils.components.ExceptionHandlingAdvice
-
ExceptionHandlerto handleMethodArgumentTypeMismatchException. - handle403(AccessDeniedException) - Method in class pro.nikolaev.restutils.components.ExceptionHandlingAdvice
-
ExceptionHandlerto handleAccessDeniedException. - handle404(NoResourceFoundException) - Method in class pro.nikolaev.restutils.components.ExceptionHandlingAdvice
-
ExceptionHandlerto handleNoResourceFoundException. - handle405(HttpRequestMethodNotSupportedException) - Method in class pro.nikolaev.restutils.components.ExceptionHandlingAdvice
-
ExceptionHandlerto handleHttpRequestMethodNotSupportedException. - handle406(HttpMediaTypeNotAcceptableException) - Method in class pro.nikolaev.restutils.components.ExceptionHandlingAdvice
-
ExceptionHandlerto handleHttpMediaTypeNotAcceptableException. - handle413(MaxUploadSizeExceededException) - Method in class pro.nikolaev.restutils.components.ExceptionHandlingAdvice
-
ExceptionHandlerto handleMaxUploadSizeExceededException. - handle415(HttpMediaTypeNotSupportedException) - Method in class pro.nikolaev.restutils.components.ExceptionHandlingAdvice
-
ExceptionHandlerto handleHttpMediaTypeNotSupportedException. - handle423(AuthenticationException) - Method in class pro.nikolaev.restutils.components.ExceptionHandlingAdvice
-
ExceptionHandlerto handleAccountExpiredException,DisabledExceptionandLockedExceptionexceptions. - handleApiException(ApiException) - Method in class pro.nikolaev.restutils.components.ExceptionHandlingAdvice
-
ExceptionHandlerto handleApiException. - handleBadCredentials(AuthenticationException) - Method in class pro.nikolaev.restutils.components.ExceptionHandlingAdvice
-
ExceptionHandlerto handleBadCredentialsException, andUsernameNotFoundExceptionexceptions. - handleStatusException(ResponseStatusException) - Method in class pro.nikolaev.restutils.components.ExceptionHandlingAdvice
-
ExceptionHandlerto handleResponseStatusException. - handleUnexpectedException(Exception) - Method in class pro.nikolaev.restutils.components.ExceptionHandlingAdvice
-
ExceptionHandlerto handle any exception not specified in other handlers ofExceptionHandlingAdvicethrown while executing aRestControllermethod. - hashCode() - Method in record class pro.nikolaev.restutils.dto.ApiError
-
Returns a hash code value for this object.
I
- InternalServerError - Annotation Interface in pro.nikolaev.restutils.annotations.swagger.servererrors
-
A convenience annotation that is itself annotated with
@ApiResponse.
L
- Locked - Annotation Interface in pro.nikolaev.restutils.annotations.swagger.clienterrors
-
A convenience annotation that is itself annotated with
@ApiResponse.
M
- message() - Method in record class pro.nikolaev.restutils.dto.ApiError
-
Returns the value of the
messagerecord component.
N
- NoContent - Annotation Interface in pro.nikolaev.restutils.annotations.swagger.success
-
A convenience annotation that is itself annotated with
@ApiResponse. - NotFound - Annotation Interface in pro.nikolaev.restutils.annotations.swagger.clienterrors
-
A convenience annotation that is itself annotated with
@ApiResponse. - NotImplemented - Annotation Interface in pro.nikolaev.restutils.annotations.swagger.servererrors
-
A convenience annotation that is itself annotated with
@ApiResponse.
O
- Ok - Annotation Interface in pro.nikolaev.restutils.annotations.swagger.success
-
A convenience annotation that is itself annotated with
@ApiResponse. - OkWithResource - Annotation Interface in pro.nikolaev.restutils.annotations.swagger.success
-
A convenience annotation that is itself annotated with
@ApiResponse.
P
- PayloadTooLarge - Annotation Interface in pro.nikolaev.restutils.annotations.swagger.clienterrors
-
A convenience annotation that is itself annotated with
@ApiResponse. - pro.nikolaev.restutils.annotations - package pro.nikolaev.restutils.annotations
- pro.nikolaev.restutils.annotations.swagger.clienterrors - package pro.nikolaev.restutils.annotations.swagger.clienterrors
- pro.nikolaev.restutils.annotations.swagger.servererrors - package pro.nikolaev.restutils.annotations.swagger.servererrors
- pro.nikolaev.restutils.annotations.swagger.success - package pro.nikolaev.restutils.annotations.swagger.success
- pro.nikolaev.restutils.components - package pro.nikolaev.restutils.components
- pro.nikolaev.restutils.dto - package pro.nikolaev.restutils.dto
- pro.nikolaev.restutils.exceptions - package pro.nikolaev.restutils.exceptions
T
- TooManyRequests - Annotation Interface in pro.nikolaev.restutils.annotations.swagger.clienterrors
-
A convenience annotation that is itself annotated with
@ApiResponse. - toString() - Method in record class pro.nikolaev.restutils.dto.ApiError
-
Returns a string representation of this record class.
U
- Unauthorized - Annotation Interface in pro.nikolaev.restutils.annotations.swagger.clienterrors
-
A convenience annotation that is itself annotated with
@ApiResponse. - UnprocessableContent - Annotation Interface in pro.nikolaev.restutils.annotations.swagger.clienterrors
-
A convenience annotation that is itself annotated with
@ApiResponse.
All Classes and Interfaces|All Packages|Serialized Form