Package io.micronaut.http.server.exceptions.response

Class HateoasErrorResponseProcessor

java.lang.Object

io.micronaut.http.server.exceptions.response.HateoasErrorResponseProcessor

All Implemented Interfaces:

ErrorResponseProcessor<io.micronaut.http.hateoas.JsonError>

@Singleton
@Secondary
public class HateoasErrorResponseProcessor
extends java.lang.Object
implements ErrorResponseProcessor<io.micronaut.http.hateoas.JsonError>

Creates Hateoas JSON error responses.

Since:

2.4.0

Constructor Summary

Constructors

Constructor	Description
HateoasErrorResponseProcessor(io.micronaut.jackson.JacksonConfiguration jacksonConfiguration)	Deprecated. Use HateoasErrorResponseProcessor(JsonConfiguration) instead.
HateoasErrorResponseProcessor(io.micronaut.json.JsonConfiguration jacksonConfiguration)

Method Summary

Modifier and Type	Method	Description
io.micronaut.http.MutableHttpResponse<io.micronaut.http.hateoas.JsonError>	processResponse(ErrorContext errorContext, io.micronaut.http.MutableHttpResponse<?> response)	Modifies the http response representing the error.

Methods inherited from class java.lang.Object

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

Constructor Detail

HateoasErrorResponseProcessor

public HateoasErrorResponseProcessor(io.micronaut.json.JsonConfiguration jacksonConfiguration)

HateoasErrorResponseProcessor

@Deprecated
public HateoasErrorResponseProcessor(io.micronaut.jackson.JacksonConfiguration jacksonConfiguration)

Deprecated.

Use HateoasErrorResponseProcessor(JsonConfiguration) instead.

Constructor for binary compatibility. Equivalent to HateoasErrorResponseProcessor(JsonConfiguration)

Parameters:

jacksonConfiguration - the configuration to use for processing.

Method Detail

processResponse

@NonNull
public io.micronaut.http.MutableHttpResponse<io.micronaut.http.hateoas.JsonError> processResponse(@NonNull
                                                                                                  ErrorContext errorContext,
                                                                                                  @NonNull
                                                                                                  io.micronaut.http.MutableHttpResponse<?> response)

Description copied from interface: ErrorResponseProcessor

Modifies the http response representing the error. Callers of this method should return the response that was passed in baseResponse parameter, however that isn't required. Error response processors should not set the body or content type if the request method is HEAD.

Specified by:

processResponse in interface ErrorResponseProcessor<io.micronaut.http.hateoas.JsonError>

Parameters:

errorContext - The error context

response - The base response to retrieve information or mutate

Returns:

An error response