org.zalando.problem.spring.web.advice

Interface AdviceTrait

All Known Subinterfaces:

AccessDeniedAdviceTrait, AuthenticationAdviceTrait, BaseBindingResultAdviceTrait, org.zalando.problem.spring.web.advice.validation.BaseValidationAdviceTrait, BindAdviceTrait, ConstraintViolationAdviceTrait, GeneralAdviceTrait, HttpAdviceTrait, IOAdviceTrait, MessageNotReadableAdviceTrait, MethodArgumentNotValidAdviceTrait, MethodNotAllowedAdviceTrait, MissingServletRequestParameterAdviceTrait, MissingServletRequestPartAdviceTrait, MultipartAdviceTrait, NoHandlerFoundAdviceTrait, NotAcceptableAdviceTrait, ProblemAdviceTrait, ProblemHandling, RoutingAdviceTrait, SecurityAdviceTrait, ServletRequestBindingAdviceTrait, SpringAdviceTrait, ThrowableAdviceTrait, TypeMismatchAdviceTrait, TypeMistmatchAdviceTrait, UnsupportedMediaTypeAdviceTrait, UnsupportedOperationAdviceTrait, ValidationAdviceTrait

@API(status=STABLE)
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.slf4j.Logger	LOG

Method Summary

Modifier and Type	Method and Description
default org.springframework.http.ResponseEntity<org.zalando.problem.Problem>	create(org.zalando.problem.StatusType status, Throwable throwable, org.springframework.web.context.request.NativeWebRequest request)
default org.springframework.http.ResponseEntity<org.zalando.problem.Problem>	create(org.zalando.problem.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>	create(org.zalando.problem.StatusType status, Throwable throwable, org.springframework.web.context.request.NativeWebRequest request, org.springframework.http.HttpHeaders headers, URI type)
default org.springframework.http.ResponseEntity<org.zalando.problem.Problem>	create(org.zalando.problem.StatusType status, Throwable throwable, org.springframework.web.context.request.NativeWebRequest request, URI type)
default org.springframework.http.ResponseEntity<org.zalando.problem.Problem>	create(Throwable throwable, org.springframework.web.context.request.NativeWebRequest request) Creates a problem response for the given throwable by taking any ResponseStatus annotation on the exception type or one of the causes into account.
default org.springframework.http.ResponseEntity<org.zalando.problem.Problem>	create(org.zalando.problem.ThrowableProblem problem, org.springframework.web.context.request.NativeWebRequest request)
default org.springframework.http.ResponseEntity<org.zalando.problem.Problem>	create(Throwable throwable, org.zalando.problem.Problem problem, org.springframework.web.context.request.NativeWebRequest request)
default org.springframework.http.ResponseEntity<org.zalando.problem.Problem>	create(org.zalando.problem.ThrowableProblem problem, org.springframework.web.context.request.NativeWebRequest request, org.springframework.http.HttpHeaders headers)
default org.springframework.http.ResponseEntity<org.zalando.problem.Problem>	create(Throwable throwable, org.zalando.problem.Problem problem, org.springframework.web.context.request.NativeWebRequest request, org.springframework.http.HttpHeaders headers)
default StackTraceElement[]	createStackTrace(Throwable throwable)
default org.springframework.http.ResponseEntity<org.zalando.problem.Problem>	fallback(Throwable throwable, org.zalando.problem.Problem problem, org.springframework.web.context.request.NativeWebRequest request, org.springframework.http.HttpHeaders headers)
default boolean	isCausalChainsEnabled()
default void	log(Throwable throwable, org.zalando.problem.Problem problem, org.springframework.web.context.request.NativeWebRequest request, org.springframework.http.HttpStatus status)
default Optional<org.springframework.http.MediaType>	negotiate(org.springframework.web.context.request.NativeWebRequest request)
default org.zalando.problem.ProblemBuilder	prepare(Throwable throwable, org.zalando.problem.StatusType status, URI type)
default org.springframework.http.ResponseEntity<org.zalando.problem.Problem>	process(org.springframework.http.ResponseEntity<org.zalando.problem.Problem> entity)
default org.springframework.http.ResponseEntity<org.zalando.problem.Problem>	process(org.springframework.http.ResponseEntity<org.zalando.problem.Problem> entity, org.springframework.web.context.request.NativeWebRequest request)
default org.springframework.web.bind.annotation.ResponseStatus	resolveResponseStatus(Throwable type)
default org.zalando.problem.ThrowableProblem	toProblem(Throwable throwable)
default org.zalando.problem.ThrowableProblem	toProblem(Throwable throwable, org.zalando.problem.StatusType status)
default org.zalando.problem.ThrowableProblem	toProblem(Throwable throwable, org.zalando.problem.StatusType status, URI type)

Field Detail

LOG

static final org.slf4j.Logger LOG

Method Detail

create

default org.springframework.http.ResponseEntity<org.zalando.problem.Problem> create(Throwable throwable,
                                                                                    org.springframework.web.context.request.NativeWebRequest request)

Creates a problem response for the given throwable by taking any ResponseStatus annotation on the exception type or one of the causes into account.

Parameters:

throwable - exception being caught

request - incoming request

Returns:

the problem response

See Also:

ResponseStatusExceptionResolver

create

default org.springframework.http.ResponseEntity<org.zalando.problem.Problem> create(org.zalando.problem.StatusType status,
                                                                                    Throwable throwable,
                                                                                    org.springframework.web.context.request.NativeWebRequest request)

create

default org.springframework.http.ResponseEntity<org.zalando.problem.Problem> create(org.zalando.problem.StatusType status,
                                                                                    Throwable throwable,
                                                                                    org.springframework.web.context.request.NativeWebRequest request,
                                                                                    org.springframework.http.HttpHeaders headers)

create

default org.springframework.http.ResponseEntity<org.zalando.problem.Problem> create(org.zalando.problem.StatusType status,
                                                                                    Throwable throwable,
                                                                                    org.springframework.web.context.request.NativeWebRequest request,
                                                                                    URI type)

create

default org.springframework.http.ResponseEntity<org.zalando.problem.Problem> create(org.zalando.problem.StatusType status,
                                                                                    Throwable throwable,
                                                                                    org.springframework.web.context.request.NativeWebRequest request,
                                                                                    org.springframework.http.HttpHeaders headers,
                                                                                    URI type)

toProblem

default org.zalando.problem.ThrowableProblem toProblem(Throwable throwable)

resolveResponseStatus

@API(status=MAINTAINED)
default org.springframework.web.bind.annotation.ResponseStatus resolveResponseStatus(Throwable type)

toProblem

default org.zalando.problem.ThrowableProblem toProblem(Throwable throwable,
                                                       org.zalando.problem.StatusType status)

toProblem

default org.zalando.problem.ThrowableProblem toProblem(Throwable throwable,
                                                       org.zalando.problem.StatusType status,
                                                       URI type)

prepare

default org.zalando.problem.ProblemBuilder prepare(Throwable throwable,
                                                   org.zalando.problem.StatusType status,
                                                   URI type)

createStackTrace

default StackTraceElement[] createStackTrace(Throwable throwable)

isCausalChainsEnabled

default boolean isCausalChainsEnabled()

create

default org.springframework.http.ResponseEntity<org.zalando.problem.Problem> create(org.zalando.problem.ThrowableProblem problem,
                                                                                    org.springframework.web.context.request.NativeWebRequest request)

create

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

create

default org.springframework.http.ResponseEntity<org.zalando.problem.Problem> create(Throwable throwable,
                                                                                    org.zalando.problem.Problem problem,
                                                                                    org.springframework.web.context.request.NativeWebRequest request)

create

default org.springframework.http.ResponseEntity<org.zalando.problem.Problem> create(Throwable throwable,
                                                                                    org.zalando.problem.Problem problem,
                                                                                    org.springframework.web.context.request.NativeWebRequest request,
                                                                                    org.springframework.http.HttpHeaders headers)

log

default void log(Throwable throwable,
                 org.zalando.problem.Problem problem,
                 org.springframework.web.context.request.NativeWebRequest request,
                 org.springframework.http.HttpStatus status)

negotiate

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

fallback

default org.springframework.http.ResponseEntity<org.zalando.problem.Problem> fallback(Throwable throwable,
                                                                                      org.zalando.problem.Problem problem,
                                                                                      org.springframework.web.context.request.NativeWebRequest request,
                                                                                      org.springframework.http.HttpHeaders headers)

process

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

process

default org.springframework.http.ResponseEntity<org.zalando.problem.Problem> process(org.springframework.http.ResponseEntity<org.zalando.problem.Problem> entity)