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

Class ParameterValidationExceptionMapper

java.lang.Object

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

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

All Implemented Interfaces:

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

@Provider
public class ParameterValidationExceptionMapper
extends AbstractExceptionMapper<ParameterValidationException>

Author:

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

Constructor Summary

Constructors

Constructor and Description
ParameterValidationExceptionMapper()

Method Summary

Modifier and Type	Method and Description
String	getErrorMessage(ParameterValidationException exception) Get the message of the exception in mapper.
int	getStatusCode()
ApiResult<Object>	handle(ParameterValidationException exception, ApiResult<Object> apiResult) Subclass can override this method to add more detailed information to the response via the api result.

Methods inherited from class com.communote.plugins.api.rest.service.exception.AbstractExceptionMapper

getCurrentUserLocale, getLocalizedMessage, toResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterValidationExceptionMapper

public ParameterValidationExceptionMapper()

Method Detail

getErrorMessage

public String getErrorMessage(ParameterValidationException exception)

Description copied from class: AbstractExceptionMapper

Get the message of the exception in mapper.

Specified by:

getErrorMessage in class AbstractExceptionMapper<ParameterValidationException>

Parameters:

exception - thrown

Returns:

message of exception

getStatusCode

public int getStatusCode()

Specified by:

getStatusCode in class AbstractExceptionMapper<ParameterValidationException>

Returns:

The status code of the response.

handle

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

Description copied from class: AbstractExceptionMapper

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.

Overrides:

handle in class AbstractExceptionMapper<ParameterValidationException>

Parameters:

exception - The exception.

apiResult - The api result this mapper can handle with.

Returns:

The ApiResult which should be used for the response.