org.zalando.problem.spring.web.advice

Interface AdviceTrait

All Known Subinterfaces:

org.zalando.problem.spring.web.advice.validation.BaseValidationAdviceTrait, ConstraintViolationAdviceTrait, GeneralAdviceTrait, HttpAdviceTrait, IOAdviceTrait, MessageNotReadableAdviceTrait, MethodArgumentNotValidAdviceTrait, MethodNotAllowedAdviceTrait, MissingServletRequestParameterAdviceTrait, MissingServletRequestPartAdviceTrait, MultipartAdviceTrait, NoHandlerFoundAdviceTrait, NoSuchRequestHandlingMethodAdviceTrait, NotAcceptableAdviceTrait, ProblemAdviceTrait, ProblemHandling, RoutingAdviceTrait, ServletRequestBindingAdviceTrait, ThrowableAdviceTrait, TypeMistmatchAdviceTrait, UnsupportedMediaTypeAdviceTrait, UnsupportedOperationAdviceTrait, ValidationAdviceTrait

public interface AdviceTrait

Advice traits are simple interfaces that provide a single method with a default implementation. They are used to provide ExceptionHandler implementations to be used in Controllers and/or in a ControllerAdvice. Clients can choose which traits they what to use à la carte.

Advice traits are grouped in packages, based on they use cases. Every package has a composite advice trait that bundles all traits of that package. Additionally there is one major composite advice trait that in turn bundles all other composites.

See Also:

ControllerAdvice, ExceptionHandler, Throwable, Exception, Problem, ProblemHandling, CustomAdviceTrait, GeneralAdviceTrait, HttpAdviceTrait, IOAdviceTrait, RoutingAdviceTrait, ValidationAdviceTrait

Field Summary

Fields

Modifier and Type	Field and Description
static org.springframework.http.ResponseEntity<org.zalando.problem.Problem>	NOT_ACCEPTABLE

Method Summary

Modifier and Type	Method and Description
default org.springframework.http.ResponseEntity<org.zalando.problem.Problem>	create(javax.ws.rs.core.Response.StatusType status, Throwable throwable, org.springframework.web.context.request.NativeWebRequest request)
default org.springframework.http.ResponseEntity<org.zalando.problem.Problem>	create(javax.ws.rs.core.Response.StatusType status, Throwable throwable, org.springframework.web.context.request.NativeWebRequest request, org.springframework.http.HttpHeaders headers)
default org.springframework.http.ResponseEntity<org.zalando.problem.Problem>	entity(org.zalando.problem.Problem problem, org.springframework.web.context.request.NativeWebRequest request)
default org.springframework.http.ResponseEntity<org.zalando.problem.Problem>	entity(org.zalando.problem.Problem problem, org.springframework.web.context.request.NativeWebRequest request, org.springframework.http.HttpHeaders headers)
default boolean	isCausalChainsEnabled()
default Optional<org.springframework.http.MediaType>	negotiate(org.springframework.web.context.request.NativeWebRequest request)
default org.zalando.problem.ThrowableProblem	toProblem(Throwable throwable, javax.ws.rs.core.Response.StatusType status)

Field Detail

NOT_ACCEPTABLE

static final org.springframework.http.ResponseEntity<org.zalando.problem.Problem> NOT_ACCEPTABLE

Method Detail

create

default org.springframework.http.ResponseEntity<org.zalando.problem.Problem> create(javax.ws.rs.core.Response.StatusType status,
                                                                                    Throwable throwable,
                                                                                    org.springframework.web.context.request.NativeWebRequest request)
                                                                             throws org.springframework.web.HttpMediaTypeNotAcceptableException

Throws:

org.springframework.web.HttpMediaTypeNotAcceptableException

create

default org.springframework.http.ResponseEntity<org.zalando.problem.Problem> create(javax.ws.rs.core.Response.StatusType status,
                                                                                    Throwable throwable,
                                                                                    org.springframework.web.context.request.NativeWebRequest request,
                                                                                    org.springframework.http.HttpHeaders headers)
                                                                             throws org.springframework.web.HttpMediaTypeNotAcceptableException

Throws:

org.springframework.web.HttpMediaTypeNotAcceptableException

toProblem

default org.zalando.problem.ThrowableProblem toProblem(Throwable throwable,
                                                       javax.ws.rs.core.Response.StatusType status)

isCausalChainsEnabled

default boolean isCausalChainsEnabled()

entity

default org.springframework.http.ResponseEntity<org.zalando.problem.Problem> entity(org.zalando.problem.Problem problem,
                                                                                    org.springframework.web.context.request.NativeWebRequest request)
                                                                             throws org.springframework.web.HttpMediaTypeNotAcceptableException

Throws:

org.springframework.web.HttpMediaTypeNotAcceptableException

entity

default org.springframework.http.ResponseEntity<org.zalando.problem.Problem> entity(org.zalando.problem.Problem problem,
                                                                                    org.springframework.web.context.request.NativeWebRequest request,
                                                                                    org.springframework.http.HttpHeaders headers)
                                                                             throws org.springframework.web.HttpMediaTypeNotAcceptableException

Throws:

org.springframework.web.HttpMediaTypeNotAcceptableException

negotiate

default Optional<org.springframework.http.MediaType> negotiate(org.springframework.web.context.request.NativeWebRequest request)
                                                        throws org.springframework.web.HttpMediaTypeNotAcceptableException

Throws:

org.springframework.web.HttpMediaTypeNotAcceptableException