Package org.craftercms.engine.controller.rest

Class SiteCacheRestController

java.lang.Object

org.craftercms.core.controller.rest.RestControllerBase

org.craftercms.engine.controller.rest.SiteCacheRestController

@CrafterRestController
@RequestMapping("${crafter.core.rest.base.uri}/site/cache")
public class SiteCacheRestController
extends org.craftercms.core.controller.rest.RestControllerBase

REST controller for site cache operations. The controller uses a map of cache types mapped to SiteCacheRestOperations, which allows REST operation implementations for different types of caches.

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,SiteCacheRestOperations>	cacheRestOperationsPerCacheType
protected String	configuredToken
protected String	defaultCacheType
static final String	URL_CLEAR
static final String	URL_ROOT
static final String	URL_STATS

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

MESSAGE_MODEL_ATTRIBUTE_NAME, REST_BASE_URI

Constructor Summary

Constructors

Constructor	Description
SiteCacheRestController(Map<String,SiteCacheRestOperations> cacheRestOperationsPerCacheType, String defaultCacheType, String configuredToken)

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	clear(jakarta.servlet.http.HttpServletRequest request, String token, String cacheType)
protected SiteCacheRestOperations	getCacheRestOperations(String cacheType)
org.craftercms.core.cache.CacheStatistics	getStatistics(String token, String cacheType)
org.springframework.http.ResponseEntity<Map<String,Object>>	handleInvalidCacheTypeException(InvalidCacheTypeException ex)
protected final void	validateToken(String requestToken)

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

createResponseMessage, createSingletonModifiableMap

Methods inherited from class java.lang.Object

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

Field Details

URL_ROOT

public static final String URL_ROOT

See Also:

• Constant Field Values

URL_CLEAR

public static final String URL_CLEAR

See Also:

• Constant Field Values

URL_STATS

public static final String URL_STATS

See Also:

• Constant Field Values

cacheRestOperationsPerCacheType

protected Map<String,SiteCacheRestOperations> cacheRestOperationsPerCacheType

defaultCacheType

protected String defaultCacheType

configuredToken

protected String configuredToken

Constructor Details

SiteCacheRestController

@ConstructorProperties({"cacheRestOperationsPerCacheType","defaultCacheType","configuredToken"})
public SiteCacheRestController(Map<String,SiteCacheRestOperations> cacheRestOperationsPerCacheType,
 String defaultCacheType,
 String configuredToken)

Method Details

clear

@RequestMapping(value="/clear",
                method=GET)
public Map<String,Object> clear(jakarta.servlet.http.HttpServletRequest request,
 @RequestParam
 String token,
 @RequestParam(required=false)
 String cacheType)
                         throws org.craftercms.commons.exceptions.InvalidManagementTokenException

Throws:

org.craftercms.commons.exceptions.InvalidManagementTokenException

getStatistics

@RequestMapping(value="/statistics",
                method=GET)
public org.craftercms.core.cache.CacheStatistics getStatistics(@RequestParam
 String token,
 @RequestParam(required=false)
 String cacheType)
                                                        throws org.craftercms.commons.exceptions.InvalidManagementTokenException

Throws:

org.craftercms.commons.exceptions.InvalidManagementTokenException

handleInvalidCacheTypeException

@ExceptionHandler(InvalidCacheTypeException.class)
public org.springframework.http.ResponseEntity<Map<String,Object>> handleInvalidCacheTypeException(InvalidCacheTypeException ex)

getCacheRestOperations

protected SiteCacheRestOperations getCacheRestOperations(String cacheType)

validateToken

protected final void validateToken(String requestToken)
                            throws org.craftercms.commons.exceptions.InvalidManagementTokenException

Throws:

org.craftercms.commons.exceptions.InvalidManagementTokenException