org.craftercms.core.controller.rest

Class RestControllerBase

java.lang.Object

org.craftercms.core.controller.rest.RestControllerBase

Direct Known Subclasses:

CacheRestController, ContentStoreRestController

public class RestControllerBase
extends Object

Base class for all Crafter REST services. Handles exceptions thrown by service methods.

Author:

Alfonso Vásquez

Field Summary

Fields

Modifier and Type	Field and Description
static String	MESSAGE_MODEL_ATTRIBUTE_NAME
static String	REST_BASE_URI

Constructor Summary

Constructors

Constructor and Description
RestControllerBase()

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	createMessageModel(String attributeName, Object attributeValue)
Map<String,Object>	handleAuthenticationException(javax.servlet.http.HttpServletRequest request, AuthenticationException e)
Map<String,Object>	handleException(javax.servlet.http.HttpServletRequest request, Exception e)
Map<String,Object>	handleForbiddenPathException(javax.servlet.http.HttpServletRequest request, ForbiddenPathException e)
Map<String,Object>	handleInvalidContextException(javax.servlet.http.HttpServletRequest request, InvalidContextException e)
Map<String,Object>	handlePathNotFoundException(javax.servlet.http.HttpServletRequest request, PathNotFoundException e)
org.craftercms.commons.validation.ValidationResult	handleValidationException(javax.servlet.http.HttpServletRequest request, org.craftercms.commons.validation.ValidationException e)
org.craftercms.commons.validation.ValidationResult	handleValidationRuntimeException(javax.servlet.http.HttpServletRequest request, org.craftercms.commons.validation.ValidationRuntimeException e)

Methods inherited from class java.lang.Object

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

Field Detail

REST_BASE_URI

public static final String REST_BASE_URI

See Also:

Constant Field Values

MESSAGE_MODEL_ATTRIBUTE_NAME

public static final String MESSAGE_MODEL_ATTRIBUTE_NAME

See Also:

Constant Field Values

Constructor Detail

RestControllerBase

public RestControllerBase()

Method Detail

handleInvalidContextException

@ExceptionHandler(value=InvalidContextException.class)
 @ResponseStatus(value=BAD_REQUEST)
 @ResponseBody
public Map<String,Object> handleInvalidContextException(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                  InvalidContextException e)

handleAuthenticationException

@ExceptionHandler(value=AuthenticationException.class)
 @ResponseStatus(value=UNAUTHORIZED)
 @ResponseBody
public Map<String,Object> handleAuthenticationException(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                   AuthenticationException e)

handlePathNotFoundException

@ExceptionHandler(value=PathNotFoundException.class)
 @ResponseStatus(value=NOT_FOUND)
 @ResponseBody
public Map<String,Object> handlePathNotFoundException(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                            PathNotFoundException e)

handleForbiddenPathException

@ExceptionHandler(value=ForbiddenPathException.class)
 @ResponseStatus(value=FORBIDDEN)
 @ResponseBody
public Map<String,Object> handleForbiddenPathException(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                              ForbiddenPathException e)

handleValidationException

@ExceptionHandler(value=org.craftercms.commons.validation.ValidationException.class)
 @ResponseStatus(value=BAD_REQUEST)
 @ResponseBody
public org.craftercms.commons.validation.ValidationResult handleValidationException(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                                                            org.craftercms.commons.validation.ValidationException e)

handleValidationRuntimeException

@ExceptionHandler(value=org.craftercms.commons.validation.ValidationRuntimeException.class)
 @ResponseStatus(value=BAD_REQUEST)
 @ResponseBody
public org.craftercms.commons.validation.ValidationResult handleValidationRuntimeException(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                                                                          org.craftercms.commons.validation.ValidationRuntimeException e)

handleException

@ExceptionHandler(value=java.lang.Exception.class)
 @ResponseStatus(value=INTERNAL_SERVER_ERROR)
 @ResponseBody
public Map<String,Object> handleException(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                          Exception e)

createMessageModel

protected Map<String,Object> createMessageModel(String attributeName,
                                                Object attributeValue)