org.apache.geode.rest.internal.web.controllers

Class BaseControllerAdvice

java.lang.Object

org.apache.geode.rest.internal.web.controllers.AbstractBaseController

org.apache.geode.rest.internal.web.controllers.BaseControllerAdvice

@ControllerAdvice
public class BaseControllerAdvice
extends AbstractBaseController

The CrudControllerAdvice class handles exception thrown while serving the REST request

Since:

GemFire 8.0

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	REST_API_VERSION

Fields inherited from class org.apache.geode.rest.internal.web.controllers.AbstractBaseController

DEFAULT_ENCODING, NEW_META_DATA_PROPERTY, OLD_META_DATA_PROPERTY, securityService, TYPE_META_DATA_PROPERTY, UTF_8

Constructor Summary

Constructors

Constructor and Description
BaseControllerAdvice()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getRestApiVersion()
java.lang.String	handle(java.lang.RuntimeException e) Handles both ResourceNotFoundExceptions and specifically, RegionNotFoundExceptions, occurring when a resource or a Region (a.k.a.
java.lang.String	handleException(org.springframework.security.access.AccessDeniedException cause) Handles an AccessDenied Exception thrown by a REST API web service endpoint, HTTP request handler method.
java.lang.String	handleException(org.apache.shiro.authc.AuthenticationException cause) Handles an AuthenticationException thrown by a REST API web service endpoint, HTTP request handler method.
java.lang.String	handleException(org.apache.geode.security.AuthenticationFailedException cause) Handles an AuthenticationFailedException thrown by a REST API web service endpoint, HTTP request handler method.
java.lang.String	handleException(DataTypeNotSupportedException tns) Handles any DataTypeNotSupportedException thrown by a REST API web service endpoint, HTTP request handler method.
java.lang.String	handleException(GemfireRestException ge) Handles any GemfireRestException thrown by a REST API web service endpoint, HTTP request handler method.
java.lang.String	handleException(org.springframework.web.HttpRequestMethodNotSupportedException e) Handles HttpRequestMethodNotSupportedException thrown by a REST API web service when request is received with unsupported HTTP method.
java.lang.String	handleException(org.apache.geode.security.NotAuthorizedException cause) Handles an NotAuthorized Exception thrown by a GeodeSecurityUtil.
java.lang.String	handleException(java.lang.RuntimeException e) Handles MalformedJsonFoundException, occurring when REST service encounters incorrect or malformed JSON document
java.lang.String	handleException(java.lang.Throwable cause) Handles any Exception thrown by a REST API web service endpoint, HTTP request handler method.

Methods inherited from class org.apache.geode.rest.internal.web.controllers.AbstractBaseController

casValue, casValue, checkForKeyExist, checkForMultipleKeysExist, checkForQueryIdExist, convert, convert, convert, convertErrorAsJson, convertErrorAsJson, convertJsonArrayIntoPdxCollection, convertJsonToMap, createNamedQuery, decode, decode, deleteNamedQuery, deleteQueryId, deleteValue, deleteValues, deleteValues, generateKey, generateKey, getActualTypeValue, getAllMembersInDS, getCache, getKeys, getMembers, getPdxValues, getQueryIdValue, getQueryService, getQueryStore, getRegion, getValue, getValues, getValues, introspectAndConvert, jsonToObject, jsonToObjectArray, postValue, processQueryResponse, putPdxValues, putValue, putValues, putValues, replaceValue, replaceValue, toUri, updateMultipleKeys, updateNamedQuery, updateSingleKey, validateJsonAndFindType, validateQuery

Methods inherited from class java.lang.Object

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

Field Detail

REST_API_VERSION

protected static final java.lang.String REST_API_VERSION

See Also:

Constant Field Values

Constructor Detail

BaseControllerAdvice

public BaseControllerAdvice()

Method Detail

getRestApiVersion

protected java.lang.String getRestApiVersion()

Specified by:

getRestApiVersion in class AbstractBaseController

handle

@ExceptionHandler(value={RegionNotFoundException.class,ResourceNotFoundException.class})
 @ResponseBody
 @ResponseStatus(value=NOT_FOUND)
public java.lang.String handle(java.lang.RuntimeException e)

Handles both ResourceNotFoundExceptions and specifically, RegionNotFoundExceptions, occurring when a resource or a Region (a.k.a. resource) does not exist in GemFire.

Parameters:

e - the RuntimeException thrown when the accessed/requested resource does not exist in GemFire.

Returns:

the String message from the RuntimeException.

handleException

@ExceptionHandler(value=MalformedJsonException.class)
 @ResponseBody
 @ResponseStatus(value=BAD_REQUEST)
public java.lang.String handleException(java.lang.RuntimeException e)

Handles MalformedJsonFoundException, occurring when REST service encounters incorrect or malformed JSON document

Parameters:

e - the RuntimeException thrown when malformed JSON is encounterd.

Returns:

the String message from the RuntimeException.

handleException

@ExceptionHandler(value=GemfireRestException.class)
 @ResponseBody
 @ResponseStatus(value=INTERNAL_SERVER_ERROR)
public java.lang.String handleException(GemfireRestException ge)

Handles any GemfireRestException thrown by a REST API web service endpoint, HTTP request handler method.

Parameters:

ge - the GemfireRestException thrown when it found problem processing REST request.

Returns:

the String message from the RuntimeException.

handleException

@ExceptionHandler(value=DataTypeNotSupportedException.class)
 @ResponseBody
 @ResponseStatus(value=NOT_ACCEPTABLE)
public java.lang.String handleException(DataTypeNotSupportedException tns)

Handles any DataTypeNotSupportedException thrown by a REST API web service endpoint, HTTP request handler method.

Parameters:

tns - the DataTypeNotSupportedException thrown if problem occurs in cache values to JSON conversion.

Returns:

the String message from the RuntimeException.

handleException

@ExceptionHandler(value=org.springframework.web.HttpRequestMethodNotSupportedException.class)
 @ResponseBody
 @ResponseStatus(value=METHOD_NOT_ALLOWED)
public java.lang.String handleException(org.springframework.web.HttpRequestMethodNotSupportedException e)

Handles HttpRequestMethodNotSupportedException thrown by a REST API web service when request is received with unsupported HTTP method.

Parameters:

e - the HttpRequestMethodNotSupportedException thrown when REST request is received with NOT support methods.

Returns:

the String message from the RuntimeException.

handleException

@ExceptionHandler(value=org.apache.geode.security.AuthenticationFailedException.class)
 @ResponseBody
 @ResponseStatus(value=UNAUTHORIZED)
public java.lang.String handleException(org.apache.geode.security.AuthenticationFailedException cause)

Handles an AuthenticationFailedException thrown by a REST API web service endpoint, HTTP request handler method.

Parameters:

cause - the Exception causing the error.

Returns:

a ResponseEntity with an appropriate HTTP status code (403 - Forbidden)

handleException

@ExceptionHandler(value=org.apache.shiro.authc.AuthenticationException.class)
 @ResponseBody
 @ResponseStatus(value=UNAUTHORIZED)
public java.lang.String handleException(org.apache.shiro.authc.AuthenticationException cause)

Handles an AuthenticationException thrown by a REST API web service endpoint, HTTP request handler method.

Parameters:

cause - the Exception causing the error.

Returns:

a ResponseEntity with an appropriate HTTP status code (403 - Forbidden)

handleException

@ExceptionHandler(value=org.springframework.security.access.AccessDeniedException.class)
 @ResponseBody
 @ResponseStatus(value=FORBIDDEN)
public java.lang.String handleException(org.springframework.security.access.AccessDeniedException cause)

Handles an AccessDenied Exception thrown by a REST API web service endpoint, HTTP request handler method.

Parameters:

cause - the Exception causing the error.

Returns:

a ResponseEntity with an appropriate HTTP status code (403 - Forbidden)

handleException

@ExceptionHandler(value=org.apache.geode.security.NotAuthorizedException.class)
 @ResponseBody
 @ResponseStatus(value=FORBIDDEN)
public java.lang.String handleException(org.apache.geode.security.NotAuthorizedException cause)

Handles an NotAuthorized Exception thrown by a GeodeSecurityUtil.

Parameters:

cause - the Exception causing the error.

Returns:

a ResponseEntity with an appropriate HTTP status code (403 - Forbidden)

handleException

@ExceptionHandler(value=java.lang.Throwable.class)
 @ResponseBody
 @ResponseStatus(value=INTERNAL_SERVER_ERROR)
public java.lang.String handleException(java.lang.Throwable cause)

Handles any Exception thrown by a REST API web service endpoint, HTTP request handler method.

Parameters:

cause - the Exception causing the error.

Returns:

a ResponseEntity with an appropriate HTTP status code (500 - Internal Server Error) and HTTP response body containing the stack trace of the Exception.