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>
@Deprecated(forRemoval=true) public class HateoasErrorResponseProcessor extends Object implements ErrorResponseProcessor<io.micronaut.http.hateoas.JsonError>
Deprecated, for removal: This API element is subject to removal in a future version.
use DefaultErrorResponseProcessor instead
Creates Hateoas JSON error responses.
Since:
2.4.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    HateoasErrorResponseProcessor(io.micronaut.json.JsonConfiguration jacksonConfiguration)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull io.micronaut.http.MutableHttpResponse<io.micronaut.http.hateoas.JsonError>
    processResponse(@NonNull ErrorContext errorContext, @NonNull io.micronaut.http.MutableHttpResponse<?> response)
    Deprecated, for removal: This API element is subject to removal in a future version.
    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 Details

    • HateoasErrorResponseProcessor

      public HateoasErrorResponseProcessor(io.micronaut.json.JsonConfiguration jacksonConfiguration)
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • processResponse

      @NonNull public @NonNull io.micronaut.http.MutableHttpResponse<io.micronaut.http.hateoas.JsonError> processResponse(@NonNull @NonNull ErrorContext errorContext, @NonNull @NonNull io.micronaut.http.MutableHttpResponse<?> response)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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