org.craftercms.core.controller.rest

Class CacheRestController

java.lang.Object

org.craftercms.core.controller.rest.RestControllerBase

org.craftercms.core.controller.rest.CacheRestController

@Controller
 @RequestMapping(value="${crafter.core.rest.base.uri}/cache")
public class CacheRestController
extends RestControllerBase

REST service that provides several methods to handle Crafter's cache engine.

Author:

Alfonso Vásquez, hyanghee

Field Summary

Fields

Modifier and Type	Field and Description
static String	MODEL_ATTRIBUTE_MESSAGE
static String	REQUEST_PARAM_CONTEXT_ID
static String	REQUEST_PARAM_URL
static String	URL_CLEAR_ALL_SCOPES
static String	URL_CLEAR_SCOPE
static String	URL_ROOT rest URLs *

Fields inherited from class org.craftercms.core.controller.rest.RestControllerBase

MESSAGE_MODEL_ATTRIBUTE_NAME, REST_BASE_URI

Constructor Summary

Constructors

Constructor and Description
CacheRestController()

Method Summary

Modifier and Type	Method and Description
Map<String,String>	clearAllScopes()
Map<String,String>	clearScope(String contextId)
void	setCacheTemplate(CacheTemplate cacheTemplate)
void	setStoreService(ContentStoreService storeService)

Methods inherited from class org.craftercms.core.controller.rest.RestControllerBase

createMessageModel, handleAuthenticationException, handleException, handleForbiddenPathException, handleInvalidContextException, handlePathNotFoundException, handleValidationException, handleValidationRuntimeException

Methods inherited from class java.lang.Object

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

Field Detail

URL_ROOT

public static final String URL_ROOT

rest URLs *

See Also:

Constant Field Values

URL_CLEAR_ALL_SCOPES

public static final String URL_CLEAR_ALL_SCOPES

See Also:

Constant Field Values

URL_CLEAR_SCOPE

public static final String URL_CLEAR_SCOPE

See Also:

Constant Field Values

REQUEST_PARAM_CONTEXT_ID

public static final String REQUEST_PARAM_CONTEXT_ID

See Also:

Constant Field Values

REQUEST_PARAM_URL

public static final String REQUEST_PARAM_URL

See Also:

Constant Field Values

MODEL_ATTRIBUTE_MESSAGE

public static final String MODEL_ATTRIBUTE_MESSAGE

See Also:

Constant Field Values

Constructor Detail

CacheRestController

public CacheRestController()

Method Detail

setCacheTemplate

public void setCacheTemplate(CacheTemplate cacheTemplate)

setStoreService

public void setStoreService(ContentStoreService storeService)

clearAllScopes

@RequestMapping(value="/clear_all",
                method=GET)
 @ResponseBody
public Map<String,String> clearAllScopes()
                                                                                                                 throws CacheException

Throws:

CacheException

clearScope

@RequestMapping(value="/clear",
                method=GET)
 @ResponseBody
public Map<String,String> clearScope(@RequestParam(value="contextId")
                                                                                                                String contextId)
                                                                                                         throws InvalidContextException,
                                                                                                                CacheException

Throws:

InvalidContextException

CacheException