io.micronaut.problem

Class ProblemErrorResponseProcessor

java.lang.Object

io.micronaut.problem.ProblemErrorResponseProcessor

All Implemented Interfaces:

io.micronaut.http.server.exceptions.response.ErrorResponseProcessor<org.zalando.problem.Problem>

@Singleton
public class ProblemErrorResponseProcessor
extends java.lang.Object
implements io.micronaut.http.server.exceptions.response.ErrorResponseProcessor<org.zalando.problem.Problem>

Error Response processor to respond Problem responses.

• Adds application/problem+json content type
• If the cause is a ThrowableProblem, it returns as the body.
• If the cause is not a ThrowableProblem , it generates a default Problem based on the ErrorContext and returns it as the HTTP Body.

Since:

1.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APPLICATION_PROBLEM_JSON

Constructor Summary

Constructors

Constructor and Description
ProblemErrorResponseProcessor() Deprecated.
ProblemErrorResponseProcessor(ProblemConfiguration config) Constructor.

Method Summary

Modifier and Type	Method and Description
protected org.zalando.problem.ThrowableProblem	defaultProblem(io.micronaut.http.server.exceptions.response.ErrorContext errorContext, io.micronaut.http.HttpStatus httpStatus) Creates a ThrowableProblem when the root cause was not an exception of type ThrowableProblem.
protected boolean	includeErrorMessage(io.micronaut.http.server.exceptions.response.ErrorContext errorContext) Whether ThrowableProblem, created when the root cause is not an exception of type ThrowableProblem, should contain Error::getMessage in the problem detail.
io.micronaut.http.MutableHttpResponse<org.zalando.problem.Problem>	processResponse(io.micronaut.http.server.exceptions.response.ErrorContext errorContext, io.micronaut.http.MutableHttpResponse<?> baseResponse)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

APPLICATION_PROBLEM_JSON

public static final java.lang.String APPLICATION_PROBLEM_JSON

See Also:

Constant Field Values

Constructor Detail

ProblemErrorResponseProcessor

@Deprecated
public ProblemErrorResponseProcessor()

Deprecated.

Constructor. Use ProblemErrorResponseProcessor(ProblemConfiguration) instead.

ProblemErrorResponseProcessor

@Inject
public ProblemErrorResponseProcessor(ProblemConfiguration config)

Constructor.

Parameters:

config - Problem configuration

Method Detail

processResponse

@NonNull
public io.micronaut.http.MutableHttpResponse<org.zalando.problem.Problem> processResponse(@NonNull
                                                                                                   io.micronaut.http.server.exceptions.response.ErrorContext errorContext,
                                                                                                   @NonNull
                                                                                                   io.micronaut.http.MutableHttpResponse<?> baseResponse)

Specified by:

processResponse in interface io.micronaut.http.server.exceptions.response.ErrorResponseProcessor<org.zalando.problem.Problem>

defaultProblem

@NonNull
protected org.zalando.problem.ThrowableProblem defaultProblem(@NonNull
                                                                       io.micronaut.http.server.exceptions.response.ErrorContext errorContext,
                                                                       @NonNull
                                                                       io.micronaut.http.HttpStatus httpStatus)

Creates a ThrowableProblem when the root cause was not an exception of type ThrowableProblem.

Parameters:

errorContext - Error Context

httpStatus - HTTP Status

Returns:

Default problem

includeErrorMessage

protected boolean includeErrorMessage(@NonNull
                                      io.micronaut.http.server.exceptions.response.ErrorContext errorContext)

Whether ThrowableProblem, created when the root cause is not an exception of type ThrowableProblem, should contain Error::getMessage in the problem detail. To avoid accidental information leakage defaults to false unless the root cause is of type UnsatisfiedRouteException which contains helpful information to diagnose the issue (e.g. missing required query value) in the details.

Parameters:

errorContext - Error Context

Returns:

To avoid accidental information leakage defaults to false unless the root cause is of type UnsatisfiedRouteException