Class CacheRestController
- java.lang.Object
-
- org.craftercms.core.controller.rest.RestControllerBase
-
- org.craftercms.core.controller.rest.CacheRestController
-
@RestController @RequestMapping("${crafter.core.rest.base.uri}/cache") public class CacheRestController extends RestControllerBase
REST service that provides several methods to handle Crafter's cache engine.- Author:
- avasquez, hyanghee
-
-
Field Summary
Fields Modifier and Type Field Description static String
REQUEST_PARAM_CONTEXT_ID
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 Description CacheRestController()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Map<String,Object>
clearAllScopes(String token)
Map<String,Object>
clearScope(String contextId, String token)
void
setAuthorizationToken(String authorizationToken)
void
setCacheTemplate(CacheTemplate cacheTemplate)
void
setStoreService(ContentStoreService storeService)
protected void
validateToken(String token)
-
Methods inherited from class org.craftercms.core.controller.rest.RestControllerBase
createResponseMessage, createSingletonModifiableMap
-
-
-
-
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
-
-
Method Detail
-
setCacheTemplate
public void setCacheTemplate(CacheTemplate cacheTemplate)
-
setStoreService
public void setStoreService(ContentStoreService storeService)
-
setAuthorizationToken
public void setAuthorizationToken(String authorizationToken)
-
clearAllScopes
@RequestMapping(value="/clear_all", method=GET) public Map<String,Object> clearAllScopes(@RequestParam String token) throws CacheException, org.craftercms.commons.exceptions.InvalidManagementTokenException
- Throws:
CacheException
org.craftercms.commons.exceptions.InvalidManagementTokenException
-
clearScope
@RequestMapping(value="/clear", method=GET) public Map<String,Object> clearScope(@RequestParam("contextId") String contextId, @RequestParam String token) throws InvalidContextException, CacheException, org.craftercms.commons.exceptions.InvalidManagementTokenException
- Throws:
InvalidContextException
CacheException
org.craftercms.commons.exceptions.InvalidManagementTokenException
-
validateToken
protected void validateToken(String token) throws org.craftercms.commons.exceptions.InvalidManagementTokenException
- Throws:
org.craftercms.commons.exceptions.InvalidManagementTokenException
-
-