org.finra.herd.service.helper

Class HerdErrorInformationExceptionHandler

java.lang.Object

org.finra.herd.service.helper.HerdErrorInformationExceptionHandler

Direct Known Subclasses:

HerdRestControllerAdvice

@Component
public class HerdErrorInformationExceptionHandler
extends Object

A class that handles various types of exceptions and returns summary error information containing the HTTP status, HTTP status description, and the error message that provides details about the error. Note that all "ExceptionHandler" annotated method that take additional parameters besides the exception itself should ensure that the method can handle cases when the other parameters are null. This is due to the isReportableError method which will invoke the exception handler methods to get the error information which is needed to determine if the exception is reportable.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ORACLE_DATA_TOO_LARGE_ERROR_CODE The Oracle database specific error code for data too large.
static int	ORACLE_LONG_DATA_IN_LONG_COLUMN_ERROR_CODE The Oracle database specific error code for "can bind a LONG value only for insert into a LONG column".
static String	ORACLE_SQL_STATE_CODE_ERROR Oracle specific SQL state code for generic SQL statement execution errors.
static String	POSTGRES_SQL_STATE_CODE_FOREIGN_KEY_VIOLATION
static String	POSTGRES_SQL_STATE_CODE_TRUNCATION_ERROR PostgreSQL specific SQL state code for string data truncation errors.
static String	POSTGRES_SQL_STATE_CODE_UNIQUE_INDEX_OR_PRIMARY_KEY_VIOLATION

Constructor Summary

Constructors

Constructor and Description
HerdErrorInformationExceptionHandler()

Method Summary

Modifier and Type	Method and Description
ErrorInformation	handleAccessDeniedException(Exception exception) Handle access denied exceptions.
ErrorInformation	handleActivitiException(Exception exception, javax.servlet.http.HttpServletResponse response) Handle Activiti exceptions.
ErrorInformation	handleBadRequestException(Exception exception) Handle exceptions that result in a "bad request" status.
ErrorInformation	handleConflictException(Exception exception) Handle exceptions that result in a "conflict" status.
ErrorInformation	handleHttpMessageNotReadableException(org.springframework.http.converter.HttpMessageNotReadableException exception) Handle Spring HttpMessageNotReadableException.
ErrorInformation	handleInternalServerErrorException(Exception exception) Handle exceptions that result in an "internal server error" status.
ErrorInformation	handleNotFoundException(RuntimeException exception) Handle exceptions that result in a "not found" status.
ErrorInformation	handleOperationNotAllowedException(RuntimeException exception) Handle exceptions that result in a "operation not allowed" status.
ErrorInformation	handlePersistenceException(Exception exception, javax.servlet.http.HttpServletResponse response) Handle persistence exceptions thrown by handlers.
boolean	isLoggingEnabled()
boolean	isReportableError(Throwable exception) Returns whether the specified exception is one that should be reported (i.e.
protected void	logError(String message, Exception exception) Logs an error if logging is enabled.
void	setLoggingEnabled(boolean loggingEnabled)

Methods inherited from class java.lang.Object

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

Field Detail

ORACLE_DATA_TOO_LARGE_ERROR_CODE

public static final int ORACLE_DATA_TOO_LARGE_ERROR_CODE

The Oracle database specific error code for data too large.

See Also:

Constant Field Values

ORACLE_LONG_DATA_IN_LONG_COLUMN_ERROR_CODE

public static final int ORACLE_LONG_DATA_IN_LONG_COLUMN_ERROR_CODE

The Oracle database specific error code for "can bind a LONG value only for insert into a LONG column". This could happen when the user enters a value that is > 4000 bytes for a VARCHAR.

See Also:

Constant Field Values

ORACLE_SQL_STATE_CODE_ERROR

public static final String ORACLE_SQL_STATE_CODE_ERROR

Oracle specific SQL state code for generic SQL statement execution errors. https://docs.oracle.com/cd/E15817_01/appdev.111/b31228/appd.htm

See Also:

Constant Field Values

POSTGRES_SQL_STATE_CODE_FOREIGN_KEY_VIOLATION

public static final String POSTGRES_SQL_STATE_CODE_FOREIGN_KEY_VIOLATION

See Also:

Constant Field Values

POSTGRES_SQL_STATE_CODE_UNIQUE_INDEX_OR_PRIMARY_KEY_VIOLATION

public static final String POSTGRES_SQL_STATE_CODE_UNIQUE_INDEX_OR_PRIMARY_KEY_VIOLATION

See Also:

Constant Field Values

POSTGRES_SQL_STATE_CODE_TRUNCATION_ERROR

public static final String POSTGRES_SQL_STATE_CODE_TRUNCATION_ERROR

PostgreSQL specific SQL state code for string data truncation errors. http://www.postgresql.org/docs/9.3/static/errcodes-appendix.html

See Also:

Constant Field Values

Constructor Detail

HerdErrorInformationExceptionHandler

public HerdErrorInformationExceptionHandler()

Method Detail

handleAccessDeniedException

@ExceptionHandler(value=org.springframework.security.access.AccessDeniedException.class)
 @ResponseStatus(value=FORBIDDEN)
 @ResponseBody
public ErrorInformation handleAccessDeniedException(Exception exception)

Handle access denied exceptions.

Parameters:

exception - the exception.

Returns:

the error information.

handleActivitiException

@ExceptionHandler(value=org.activiti.engine.ActivitiException.class)
 @ResponseBody
public ErrorInformation handleActivitiException(Exception exception,
                                                                                                                                    javax.servlet.http.HttpServletResponse response)

Handle Activiti exceptions. Note that this method properly handles a null response being passed in.

Parameters:

exception - the exception.

response - the response.

Returns:

the error information.

handleBadRequestException

@ExceptionHandler(value={java.lang.IllegalArgumentException.class,org.springframework.web.bind.MissingServletRequestParameterException.class,org.springframework.beans.TypeMismatchException.class,java.io.UnsupportedEncodingException.class})
 @ResponseStatus(value=BAD_REQUEST)
 @ResponseBody
public ErrorInformation handleBadRequestException(Exception exception)

Handle exceptions that result in a "bad request" status.

Parameters:

exception - the exception.

Returns:

the error information.

handleHttpMessageNotReadableException

@ExceptionHandler(value=org.springframework.http.converter.HttpMessageNotReadableException.class)
 @ResponseStatus(value=BAD_REQUEST)
 @ResponseBody
public ErrorInformation handleHttpMessageNotReadableException(org.springframework.http.converter.HttpMessageNotReadableException exception)

Handle Spring HttpMessageNotReadableException.

Parameters:

exception - the exception.

Returns:

the error information.

handleConflictException

@ExceptionHandler(value={AlreadyExistsException.class,org.quartz.ObjectAlreadyExistsException.class,javax.persistence.OptimisticLockException.class})
 @ResponseStatus(value=CONFLICT)
 @ResponseBody
public ErrorInformation handleConflictException(Exception exception)

Handle exceptions that result in a "conflict" status.

handleInternalServerErrorException

@ExceptionHandler(value=java.lang.Exception.class)
 @ResponseStatus(value=INTERNAL_SERVER_ERROR)
 @ResponseBody
public ErrorInformation handleInternalServerErrorException(Exception exception)

Handle exceptions that result in an "internal server error" status.

handleNotFoundException

@ExceptionHandler(value={org.hibernate.ObjectNotFoundException.class,ObjectNotFoundException.class})
 @ResponseStatus(value=NOT_FOUND)
 @ResponseBody
public ErrorInformation handleNotFoundException(RuntimeException exception)

Handle exceptions that result in a "not found" status.

handleOperationNotAllowedException

@ExceptionHandler(value=MethodNotAllowedException.class)
 @ResponseStatus(value=METHOD_NOT_ALLOWED)
 @ResponseBody
public ErrorInformation handleOperationNotAllowedException(RuntimeException exception)

Handle exceptions that result in a "operation not allowed" status.

handlePersistenceException

@ExceptionHandler(value={org.springframework.orm.jpa.JpaSystemException.class,javax.persistence.PersistenceException.class})
 @ResponseBody
public ErrorInformation handlePersistenceException(Exception exception,
                                                                                                                                                                                               javax.servlet.http.HttpServletResponse response)

Handle persistence exceptions thrown by handlers. Note that this method properly handles a null response being passed in.

Parameters:

exception - the exception

response - the HTTP servlet response.

Returns:

the error information.

isLoggingEnabled

public boolean isLoggingEnabled()

setLoggingEnabled

public void setLoggingEnabled(boolean loggingEnabled)

isReportableError

public boolean isReportableError(Throwable exception)

Returns whether the specified exception is one that should be reported (i.e. a support team should be notified in some way).

Parameters:

exception - the exception to analyze.

Returns:

true if the exception is reportable or false if not.

logError

protected void logError(String message,
                        Exception exception)

Logs an error if logging is enabled. Otherwise, no logging is performed.

Parameters:

message - the message to log.

exception - the exception to log along with the message.