com.communote.plugins.api.rest.service.exception

Class AbstractExceptionMapper<E extends Throwable>

java.lang.Object

com.communote.plugins.api.rest.service.exception.AbstractExceptionMapper<E>

Type Parameters:

E - Type of the Exception this mapper works for.

All Implemented Interfaces:

javax.ws.rs.ext.ExceptionMapper<E>

Direct Known Subclasses:

AuthenticationExceptionMapper, AuthorizationExceptionMapper, BlogAccessExceptionMapper, BlogIdentifierValidationExceptionMapper, BlogNotFoundExceptionMapper, BlogValidationExceptionMapper, CommunoteEntityNotFoundExceptionMapper, ExceptionMapper, ExtensionNotSupportedExceptionMapper, IllegalArgumentExceptionMapper, IllegalRequestParameterExceptionMapper, JsonMappingExceptionMapper, JsonParseExceptionMapper, MaxLengthReachedExceptionMapper, NoBlogManagerLeftExceptionMapper, NonUniqueBlogIdentifierExceptionMapper, NoteManagementAuthorizationExceptionMapper, NoteManagementExceptionMapper, NoteNotFoundExceptionMapper, NotePreProcessorExceptionMapper, NotFoundExceptionMapper, ParameterValidationExceptionMapper, ResponseBuildExceptionMapper, RestApiIllegalRequestParameterExceptionMapper

public abstract class AbstractExceptionMapper<E extends Throwable>
extends Object
implements javax.ws.rs.ext.ExceptionMapper<E>

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
AbstractExceptionMapper()

Method Summary

Modifier and Type	Method and Description
protected Locale	getCurrentUserLocale(org.restlet.Request request) Get the locale of the current user
abstract String	getErrorMessage(E exception) Get the message of the exception in mapper.
protected String	getLocalizedMessage(String messageKey, Object... arguments)
abstract int	getStatusCode()
ApiResult<Object>	handle(E exception, ApiResult<Object> apiResult) Subclass can override this method to add more detailed information to the response via the api result.
javax.ws.rs.core.Response	toResponse(E exception)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractExceptionMapper

public AbstractExceptionMapper()

Method Detail

getCurrentUserLocale

protected Locale getCurrentUserLocale(org.restlet.Request request)

Get the locale of the current user

Parameters:

request - Request

Returns:

Locale

getErrorMessage

public abstract String getErrorMessage(E exception)

Get the message of the exception in mapper.

Parameters:

exception - thrown

Returns:

message of exception

getLocalizedMessage

protected String getLocalizedMessage(String messageKey,
                                     Object... arguments)

Parameters:

messageKey - key of the message

arguments - arguments

Returns:

localized message

getStatusCode

public abstract int getStatusCode()

Returns:

The status code of the response.

handle

public ApiResult<Object> handle(E exception,
                                ApiResult<Object> apiResult)

Subclass can override this method to add more detailed information to the response via the api result. This implementation will write the message of the exception as message of the api result.

Parameters:

exception - The exception.

apiResult - The api result this mapper can handle with.

Returns:

The ApiResult which should be used for the response.

toResponse

public javax.ws.rs.core.Response toResponse(E exception)

Specified by:

toResponse in interface javax.ws.rs.ext.ExceptionMapper<E extends Throwable>