Package org.hawaiiframework.web.exception

Class ApiErrorResponseEnricher

java.lang.Object

org.hawaiiframework.web.exception.ApiErrorResponseEnricher

All Implemented Interfaces:

ErrorResponseEnricher

public class ApiErrorResponseEnricher
extends Object
implements ErrorResponseEnricher

This enricher adds api error information to the error response resource. It only applies to an ApiException.

Since:

2.0.0

Author:

Paul Klos

Constructor Summary

Constructors

Constructor	Description
ApiErrorResponseEnricher()

Method Summary

Modifier and Type	Method	Description
void	doEnrich(ErrorResponseResource errorResponseResource, Throwable throwable, org.springframework.web.context.request.WebRequest request, org.springframework.http.HttpStatus httpStatus)	Performs the enrichment of the error response resource.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hawaiiframework.web.exception.ErrorResponseEnricher

enrich

Constructor Detail

ApiErrorResponseEnricher

public ApiErrorResponseEnricher()

Method Detail

doEnrich

public void doEnrich(ErrorResponseResource errorResponseResource,
                     Throwable throwable,
                     org.springframework.web.context.request.WebRequest request,
                     org.springframework.http.HttpStatus httpStatus)

Performs the enrichment of the error response resource. Note that the http status is a given, it is assumed to be determined in the exception handler.

NOTE: This enricher only applies if throwable is an ApiException and #errorResponseResource is an ApiErrorResponseResource.

Specified by:

doEnrich in interface ErrorResponseEnricher

Parameters:

errorResponseResource - the error response resource

throwable - the exception that was raised

request - the original web request

httpStatus - the http status that will be returned