Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- addError(GlobalError) - Method in class com.broadleafcommerce.common.error.ApiError
-
Gives more information to a client about what went wrong in their request
- addFieldError(FieldValidationError) - Method in class com.broadleafcommerce.common.error.validation.ApiValidationError
- ApiError - Class in com.broadleafcommerce.common.error
-
Response object that represents some error state from the API.
- ApiError(String, String, String, OffsetDateTime, HttpStatusCode, int, List<GlobalError>) - Constructor for class com.broadleafcommerce.common.error.ApiError
- ApiError(String, String, HttpStatus) - Constructor for class com.broadleafcommerce.common.error.ApiError
- ApiError(String, String, HttpStatusCode) - Constructor for class com.broadleafcommerce.common.error.ApiError
-
Initializes a new error
- ApiError.StatusConverter - Class in com.broadleafcommerce.common.error
- ApiMvcExceptionAdvisor - Class in com.broadleafcommerce.common.error.validation.web
-
Provides default exception handling for a variety of Spring MVC Exceptions
- ApiMvcExceptionAdvisor(Environment) - Constructor for class com.broadleafcommerce.common.error.validation.web.ApiMvcExceptionAdvisor
- ApiValidationError - Class in com.broadleafcommerce.common.error.validation
- ApiValidationError() - Constructor for class com.broadleafcommerce.common.error.validation.ApiValidationError
- ApiValidationWebExceptionAdvisor - Class in com.broadleafcommerce.common.error.validation.web
-
Exception resolver for
ValidationException
along with Spring bind exceptions that are annotated with @Valid - ApiValidationWebExceptionAdvisor(MessageSource) - Constructor for class com.broadleafcommerce.common.error.validation.web.ApiValidationWebExceptionAdvisor
B
- BroadleafErrorAttributes - Class in com.broadleafcommerce.common.error.validation.web
-
Spring Boot error attributes to make default errors look like an
ApiError
. - BroadleafErrorAttributes() - Constructor for class com.broadleafcommerce.common.error.validation.web.BroadleafErrorAttributes
- BroadleafErrorAttributes(boolean) - Constructor for class com.broadleafcommerce.common.error.validation.web.BroadleafErrorAttributes
- BroadleafErrorsWebAutoConfiguration - Class in com.broadleafcommerce.common.error.validation.web.autoconfigure
-
Auto configuration for exception handling for validation
- BroadleafErrorsWebAutoConfiguration() - Constructor for class com.broadleafcommerce.common.error.validation.web.autoconfigure.BroadleafErrorsWebAutoConfiguration
- BulkValidationException - Exception in com.broadleafcommerce.common.error.validation
-
While
ValidationException
is useful for single-entity validation, this exception should be used for throwing a single exception after validating multiple entities. - BulkValidationException(List<BulkValidationException.EntityValidationFailure>) - Constructor for exception com.broadleafcommerce.common.error.validation.BulkValidationException
- BulkValidationException.EntityValidationFailure - Class in com.broadleafcommerce.common.error.validation
C
- canEqual(Object) - Method in exception com.broadleafcommerce.common.error.validation.BulkValidationException
- canEqual(Object) - Method in exception com.broadleafcommerce.common.error.validation.ValidationException
- com.broadleafcommerce.common.error - package com.broadleafcommerce.common.error
- com.broadleafcommerce.common.error.validation - package com.broadleafcommerce.common.error.validation
- com.broadleafcommerce.common.error.validation.web - package com.broadleafcommerce.common.error.validation.web
- com.broadleafcommerce.common.error.validation.web.autoconfigure - package com.broadleafcommerce.common.error.validation.web.autoconfigure
- convert(String) - Method in class com.broadleafcommerce.common.error.ApiError.StatusConverter
- convert(FieldError) - Method in class com.broadleafcommerce.common.error.validation.web.ApiValidationWebExceptionAdvisor
-
Turns a Spring
FieldError
from anErrors
into a response object to return from the API - convert(ObjectError) - Method in class com.broadleafcommerce.common.error.validation.web.ApiValidationWebExceptionAdvisor
- createValidationResponse(Set<ConstraintViolation<?>>) - Method in class com.broadleafcommerce.common.error.validation.web.ApiValidationWebExceptionAdvisor
- createValidationResponse(Errors) - Method in class com.broadleafcommerce.common.error.validation.web.ApiValidationWebExceptionAdvisor
E
- EntityValidationFailure(Object, Errors) - Constructor for class com.broadleafcommerce.common.error.validation.BulkValidationException.EntityValidationFailure
- env - Variable in class com.broadleafcommerce.common.error.validation.web.ApiMvcExceptionAdvisor
- equals(Object) - Method in class com.broadleafcommerce.common.error.validation.BulkValidationException.EntityValidationFailure
- equals(Object) - Method in exception com.broadleafcommerce.common.error.validation.BulkValidationException
- equals(Object) - Method in exception com.broadleafcommerce.common.error.validation.ValidationException
F
- FieldValidationError - Class in com.broadleafcommerce.common.error.validation
- FieldValidationError(String, String, String) - Constructor for class com.broadleafcommerce.common.error.validation.FieldValidationError
- FieldValidationError(String, String, String, Object) - Constructor for class com.broadleafcommerce.common.error.validation.FieldValidationError
- FrameworkExceptionAdvisor - Annotation Interface in com.broadleafcommerce.common.error.validation.web
-
Annotation used to apply a consistent
Order
to framework exception advisors.
G
- getCode() - Method in class com.broadleafcommerce.common.error.GlobalError
-
Can be either machine-readable or human-readable representation of the error
- getEntity() - Method in class com.broadleafcommerce.common.error.validation.BulkValidationException.EntityValidationFailure
- getErrorAttributes(WebRequest, ErrorAttributeOptions) - Method in class com.broadleafcommerce.common.error.validation.web.BroadleafErrorAttributes
- getErrors() - Method in class com.broadleafcommerce.common.error.validation.BulkValidationException.EntityValidationFailure
- getErrors() - Method in exception com.broadleafcommerce.common.error.validation.ValidationException
- getException() - Method in class com.broadleafcommerce.common.error.ApiError
-
Optional exception class name
- getFailures() - Method in exception com.broadleafcommerce.common.error.validation.BulkValidationException
-
A list of the validation failures that this exception was thrown for.
- getFieldErrors() - Method in class com.broadleafcommerce.common.error.validation.ApiValidationError
- getGlobalErrors() - Method in class com.broadleafcommerce.common.error.ApiError
-
Optionally gives additional information to the client about what was wrong with their request
- getInputType(TypeFactory) - Method in class com.broadleafcommerce.common.error.ApiError.StatusConverter
- getOutputType(TypeFactory) - Method in class com.broadleafcommerce.common.error.ApiError.StatusConverter
- getPath() - Method in class com.broadleafcommerce.common.error.validation.FieldValidationError
- getReason() - Method in class com.broadleafcommerce.common.error.GlobalError
-
Human-readable representation of the error
- getRejectedValue() - Method in class com.broadleafcommerce.common.error.validation.FieldValidationError
- getStatus() - Method in class com.broadleafcommerce.common.error.ApiError
- getStatusCode() - Method in class com.broadleafcommerce.common.error.ApiError
-
Numerical representation of
ApiError.status
- getTimestamp() - Method in class com.broadleafcommerce.common.error.ApiError
-
When the error occurred, defaults to
LocalDateTime.now()
- getTitle() - Method in class com.broadleafcommerce.common.error.ApiError
-
A human-readable representation of the type of error being returned
- getType() - Method in class com.broadleafcommerce.common.error.ApiError
-
A machine-readable representation of the type of error being returned
- GlobalError - Class in com.broadleafcommerce.common.error
-
Represents an individual global error that came back from the API.
- GlobalError(String, String) - Constructor for class com.broadleafcommerce.common.error.GlobalError
H
- handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, WebRequest) - Method in class com.broadleafcommerce.common.error.validation.web.ApiMvcExceptionAdvisor
- handleIllegalArgumentException(IllegalArgumentException, WebRequest) - Method in class com.broadleafcommerce.common.error.validation.web.IllegalArgumentExceptionAdvisor
-
Handles uncaught illegal argument exceptions by logging them and returning an
ApiError
with 400 status. - handleRuntimeException(RuntimeException, WebRequest) - Method in class com.broadleafcommerce.common.error.validation.web.RuntimeExceptionAdvisor
-
Handles uncaught runtime exceptions by logging them and returning an
ApiError
. - hashCode() - Method in class com.broadleafcommerce.common.error.validation.BulkValidationException.EntityValidationFailure
- hashCode() - Method in exception com.broadleafcommerce.common.error.validation.BulkValidationException
- hashCode() - Method in exception com.broadleafcommerce.common.error.validation.ValidationException
I
- IllegalArgumentExceptionAdvisor - Class in com.broadleafcommerce.common.error.validation.web
-
Exception advisor with a handler that handles uncaught illegal argument exceptions by logging them and returning an error response.
- IllegalArgumentExceptionAdvisor() - Constructor for class com.broadleafcommerce.common.error.validation.web.IllegalArgumentExceptionAdvisor
L
- logDebug(Exception, WebRequest) - Method in class com.broadleafcommerce.common.error.validation.web.ApiMvcExceptionAdvisor
- logDebug(Exception, WebRequest) - Method in class com.broadleafcommerce.common.error.validation.web.ApiValidationWebExceptionAdvisor
- logDebug(Throwable, WebRequest) - Method in class com.broadleafcommerce.common.error.validation.web.IllegalArgumentExceptionAdvisor
- logError(Throwable, WebRequest) - Method in class com.broadleafcommerce.common.error.validation.web.RuntimeExceptionAdvisor
M
- MessageHeaderNotFoundException - Exception in com.broadleafcommerce.common.error.validation
-
This exception can be thrown when a required message header is not found.
- MessageHeaderNotFoundException(String) - Constructor for exception com.broadleafcommerce.common.error.validation.MessageHeaderNotFoundException
O
- ORDER - Static variable in annotation interface com.broadleafcommerce.common.error.validation.web.FrameworkExceptionAdvisor
R
- RuntimeExceptionAdvisor - Class in com.broadleafcommerce.common.error.validation.web
-
Exception advisor with a handler that handles uncaught runtime exceptions by logging them and returning an error response.
- RuntimeExceptionAdvisor() - Constructor for class com.broadleafcommerce.common.error.validation.web.RuntimeExceptionAdvisor
S
- setException(String) - Method in class com.broadleafcommerce.common.error.ApiError
-
Optional exception class name
- setRejectedValue(Object) - Method in class com.broadleafcommerce.common.error.validation.FieldValidationError
- setTimestamp(OffsetDateTime) - Method in class com.broadleafcommerce.common.error.ApiError
-
When the error occurred, defaults to
LocalDateTime.now()
- StatusConverter() - Constructor for class com.broadleafcommerce.common.error.ApiError.StatusConverter
T
- toResponseEntity() - Method in class com.broadleafcommerce.common.error.ApiError
- toString() - Method in class com.broadleafcommerce.common.error.ApiError
- toString() - Method in class com.broadleafcommerce.common.error.GlobalError
- toString() - Method in class com.broadleafcommerce.common.error.validation.BulkValidationException.EntityValidationFailure
- toString() - Method in exception com.broadleafcommerce.common.error.validation.BulkValidationException
- toString() - Method in class com.broadleafcommerce.common.error.validation.FieldValidationError
- toString() - Method in exception com.broadleafcommerce.common.error.validation.ValidationException
V
- validationError(Exception, WebRequest) - Method in class com.broadleafcommerce.common.error.validation.web.ApiValidationWebExceptionAdvisor
- ValidationException - Exception in com.broadleafcommerce.common.error.validation
-
Indicates that there was a validation error
- ValidationException(Errors) - Constructor for exception com.broadleafcommerce.common.error.validation.ValidationException
W
- withException(String) - Method in class com.broadleafcommerce.common.error.ApiError
-
Optional exception class name
- withGlobalErrors(List<GlobalError>) - Method in class com.broadleafcommerce.common.error.ApiError
-
Optionally gives additional information to the client about what was wrong with their request
- withStatus(HttpStatusCode) - Method in class com.broadleafcommerce.common.error.ApiError
-
Should always match exactly the status in the response header.
- withStatusCode(int) - Method in class com.broadleafcommerce.common.error.ApiError
-
Numerical representation of
ApiError.status
- withTimestamp(OffsetDateTime) - Method in class com.broadleafcommerce.common.error.ApiError
-
When the error occurred, defaults to
LocalDateTime.now()
- withTitle(String) - Method in class com.broadleafcommerce.common.error.ApiError
-
A human-readable representation of the type of error being returned
- withType(String) - Method in class com.broadleafcommerce.common.error.ApiError
-
A machine-readable representation of the type of error being returned
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form