Package com.totvs.tjf.api.response.error.converter

Class ErrorExceptionConverter

java.lang.Object

com.totvs.tjf.api.response.error.converter.ErrorExceptionConverter

Direct Known Subclasses:

ErrorAccessDeniedExceptionConverter, ErrorConstraintViolationExceptionConverter, ErrorHttpClientPermissionErrorExceptionConverter

public class ErrorExceptionConverter
extends Object

Exception and ApiError converter to ApiErrorResponse.

Author:

Thiago A. de Souza Weber

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ErrorExceptionConverter.ExceptionErrorMap	Error representation with HttpStatus and ApiErrorResponse.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	API_ERROR_NULL_ERROR_MESSAGE
protected static final String	EXCEPTION_NULL_ERROR_MESSAGE

Constructor Summary

Constructors

Constructor	Description
ErrorExceptionConverter(com.totvs.tjf.core.i18n.I18nService i18nService)

Method Summary

Modifier and Type	Method	Description
ErrorExceptionConverter.ExceptionErrorMap	convert(Exception exception)	Converts the given Exception to an ErrorExceptionConverter.ExceptionErrorMap containing the HttpStatus and the ApiErrorResponse.
ErrorExceptionConverter.ExceptionErrorMap	convertAsError(com.totvs.tjf.api.context.stereotype.ApiError error, Exception exception)	Converts the given Exception to an ErrorExceptionConverter.ExceptionErrorMap containing the HttpStatus and the ApiErrorResponse with: HttpStatus: ApiError.status(); ApiErrorMessage: Code: ApiError.value(); Message: a localized and interpolated message for the given code; Detailed message: a localized an interpolated detailment message for the given code.
ErrorExceptionConverter.ExceptionErrorMap	convertAsError(ApiValidated error, Exception exception)	Converts the given Exception to an ErrorExceptionConverter.ExceptionErrorMap containing the HttpStatus and the ApiErrorResponse with: HttpStatus: ApiValidated.status(); ApiErrorMessage: Code: ApiValidated.value(); Message: a localized and interpolated message for the given code; Detailed message: a localized an interpolated detailment message for the given code.
ErrorExceptionConverter.ExceptionErrorMap	convertAsGeneric(Exception exception)	Converts the given Exception to an ErrorExceptionConverter.ExceptionErrorMap containing the HttpStatus and the ApiErrorResponse with: HttpStatus: INTERNAL_SERVER_ERROR; ApiErrorMessage: Code: exception.getClass().getSimpleName(); Message: exception.getLocalizedMessage(); and Detailed message: exception.getCause().getLocalizedMessage(), if a cause exist.

Methods inherited from class java.lang.Object

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

Field Details

EXCEPTION_NULL_ERROR_MESSAGE

protected static final String EXCEPTION_NULL_ERROR_MESSAGE

See Also:

• Constant Field Values

API_ERROR_NULL_ERROR_MESSAGE

protected static final String API_ERROR_NULL_ERROR_MESSAGE

See Also:

• Constant Field Values

Constructor Details

ErrorExceptionConverter

public ErrorExceptionConverter(com.totvs.tjf.core.i18n.I18nService i18nService)

Method Details

convert

public ErrorExceptionConverter.ExceptionErrorMap convert(Exception exception)

Converts the given Exception to an ErrorExceptionConverter.ExceptionErrorMap containing the HttpStatus and the ApiErrorResponse.

When annotated with ApiError the Exception is mapped as a response error. Otherwise, the Exception is mapped as a generic response error.

Parameters:

exception - generic exception to be converted

Returns:

instance of ErrorExceptionConverter.ExceptionErrorMap

Throws:

NullPointerException - in case the given exception be null

See Also:

• convertAsError(ApiError, Exception)
• convertAsGeneric(Exception)

convertAsGeneric

public ErrorExceptionConverter.ExceptionErrorMap convertAsGeneric(Exception exception)

Converts the given Exception to an ErrorExceptionConverter.ExceptionErrorMap containing the HttpStatus and the ApiErrorResponse with:

• HttpStatus: INTERNAL_SERVER_ERROR;
• ApiErrorMessage:
  • Code: exception.getClass().getSimpleName();
  • Message: exception.getLocalizedMessage(); and
  • Detailed message: exception.getCause().getLocalizedMessage(), if a cause exist.

Parameters:

exception - generic exception to be converted

Returns:

instance of ErrorExceptionConverter.ExceptionErrorMap

Throws:

NullPointerException - in case the given exception be null

convertAsError

public ErrorExceptionConverter.ExceptionErrorMap convertAsError(ApiValidated error,
 Exception exception)

Converts the given Exception to an ErrorExceptionConverter.ExceptionErrorMap containing the HttpStatus and the ApiErrorResponse with:

• HttpStatus: ApiValidated.status();
• ApiErrorMessage:
  • Code: ApiValidated.value();
  • Message: a localized and interpolated message for the given code;
  • Detailed message: a localized an interpolated detailment message for the given code. and
  • Detail Title: a localized and interpolated detail title for the given code;

Note: when the ApiValidated does not have any specified value for code, the converter, following convention, will use the Exception simple name as the code.

Parameters:

error - api error stereotype.

exception - generic exception to be converted

Returns:

instance of ErrorExceptionConverter.ExceptionErrorMap

Throws:

IllegalArgumentException - in case the given error or exception be null

convertAsError

public ErrorExceptionConverter.ExceptionErrorMap convertAsError(com.totvs.tjf.api.context.stereotype.ApiError error,
 Exception exception)

Converts the given Exception to an ErrorExceptionConverter.ExceptionErrorMap containing the HttpStatus and the ApiErrorResponse with:

• HttpStatus: ApiError.status();
• ApiErrorMessage:
  • Code: ApiError.value();
  • Message: a localized and interpolated message for the given code;
  • Detailed message: a localized an interpolated detailment message for the given code. and
  • Detail Title: a localized and interpolated detail title for the given code;

Note: when the ApiError does not have any specified value for code, the converter, following convention, will use the Exception simple name as the code.

Parameters:

error - api error stereotype.

exception - generic exception to be converted

Returns:

instance of ErrorExceptionConverter.ExceptionErrorMap

Throws:

IllegalArgumentException - in case the given error or exception be null