CacheHelper (Jahia Server Implementation 8.0.0.0 API)

java.lang.Object
- org.jahia.services.cache.CacheHelper

public final class CacheHelper
extends Object

Cache manager utility.

Author:: Sergiy Shyrkov

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CMD_FLUSH_ALL_CACHES`
`static String`	`CMD_FLUSH_CHILDREN`
`static String`	`CMD_FLUSH_CHILDS` Deprecated. in favour of `CMD_FLUSH_CHILDREN`
`static String`	`CMD_FLUSH_MATCHINGPERMISSIONS`
`static String`	`CMD_FLUSH_OUTPUT_CACHES`
`static String`	`CMD_FLUSH_PATH`
`static String`	`CMD_FLUSH_REGEXP`
`static String`	`CMD_FLUSH_REGEXPDEP`
`static String`	`CMD_FLUSH_URLRESOLVER`
`static String`	`CMD_FLUSH_VANITYURL`

Constructor Summary

Constructors
Constructor and Description

CacheHelper()

Constructors
Constructor and Description
`CacheHelper()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`flushAllCaches()` Flushes all back-end and front-end Jahia caches on the current cluster node only.
`static void`	`flushAllCaches(boolean propagateInCluster)` Flushes all back-end and front-end Jahia caches.
`static void`	`flushCachesForManager(String cacheManagerName, boolean propagateInCluster)` Flushes the caches of the specified cache manager.
`static void`	`flushEhcacheByName(String cacheName)` Flushes the specified Ehcache on the current cluster node only.
`static void`	`flushEhcacheByName(String cacheName, boolean propagateInCluster)` Flushes the specified Ehcache.
`static void`	`flushOutputCaches()` Flushes front-end Jahia caches (module HTML output caches) on the current cluster node only.
`static void`	`flushOutputCaches(boolean propagateInCluster)` Flushes front-end Jahia caches (module HTML output caches).
`static void`	`flushOutputCachesForPath(String path, boolean flushSubtree)`
`static void`	`flushOutputCachesForPaths(Set<String> paths, boolean flushSubtree)`
`static net.sf.ehcache.CacheManager`	`getCacheManager(String cacheManagerName)`
`static Map<String,CacheManagerInfo>`	`getCacheManagerInfos(boolean withConfig, boolean withSizeInBytes)` Returns the configuration and statistics information for all the available cache managers.
`static Object`	`getObjectValue(net.sf.ehcache.Ehcache cache, String key)` Returns a value of the specified cache element (by key), considering also classloader-aware deserialization if required.
`static Object`	`getObjectValue(net.sf.ehcache.Element cacheElement)` Returns a value of the specified cache element, considering also classloader-aware deserialization if required.
`static void`	`registerMBeans(String cacheManagerName)`
`static void`	`sendCacheFlushCommandToCluster(String command)` Sends the specified cache flush command to other cluster nodes (if clustering is activated).
`static void`	`sendCacheFlushCommandToCluster(String command, String eventMessage)` Sends the specified cache flush command with a message to other cluster nodes (if clustering is activated).
`static void`	`sendMultipleCacheFlushCommandsToCluster(String command, Collection<String> eventMessages)` Sends the specified cache flush commands to other cluster nodes (if clustering is activated).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CMD_FLUSH_ALL_CACHES
```
public static final String CMD_FLUSH_ALL_CACHES
```
    See Also:
    
    Constant Field Values
  - CMD_FLUSH_CHILDREN
```
public static final String CMD_FLUSH_CHILDREN
```
    See Also:
    
    Constant Field Values
  - CMD_FLUSH_CHILDS
```
@Deprecated
public static final String CMD_FLUSH_CHILDS
```
    Deprecated. in favour of CMD_FLUSH_CHILDREN
    
    See Also:
    
    Constant Field Values
  - CMD_FLUSH_MATCHINGPERMISSIONS
```
public static final String CMD_FLUSH_MATCHINGPERMISSIONS
```
    See Also:
    
    Constant Field Values
  - CMD_FLUSH_OUTPUT_CACHES
```
public static final String CMD_FLUSH_OUTPUT_CACHES
```
    See Also:
    
    Constant Field Values
  - CMD_FLUSH_PATH
```
public static final String CMD_FLUSH_PATH
```
    See Also:
    
    Constant Field Values
  - CMD_FLUSH_REGEXP
```
public static final String CMD_FLUSH_REGEXP
```
    See Also:
    
    Constant Field Values
  - CMD_FLUSH_REGEXPDEP
```
public static final String CMD_FLUSH_REGEXPDEP
```
    See Also:
    
    Constant Field Values
  - CMD_FLUSH_URLRESOLVER
```
public static final String CMD_FLUSH_URLRESOLVER
```
    See Also:
    
    Constant Field Values
  - CMD_FLUSH_VANITYURL
```
public static final String CMD_FLUSH_VANITYURL
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CacheHelper
```
public CacheHelper()
```
- Method Detail
  - flushAllCaches
```
public static void flushAllCaches()
```
    Flushes all back-end and front-end Jahia caches on the current cluster node only.
  - flushAllCaches
```
public static void flushAllCaches(boolean propagateInCluster)
```
    Flushes all back-end and front-end Jahia caches. If propagateInCluster is set to true also propagates the flush to other cluster nodes.
    
    Parameters:
    
    propagateInCluster - if set to true the flush is propagated to other cluster nodes
  - flushCachesForManager
```
public static void flushCachesForManager(String cacheManagerName,
                                         boolean propagateInCluster)
```
    Flushes the caches of the specified cache manager.
    
    Parameters:
    
    cacheManagerName - the cache manager name to flush caches for
    
    propagateInCluster - if set to true the flush is propagated to other cluster nodes
  - flushEhcacheByName
```
public static void flushEhcacheByName(String cacheName)
```
    Flushes the specified Ehcache on the current cluster node only.
    
    Parameters:
    
    cacheName - the name of the cache to flush
  - flushEhcacheByName
```
public static void flushEhcacheByName(String cacheName,
                                      boolean propagateInCluster)
```
    Flushes the specified Ehcache. If propagateInCluster is set to true also propagates the flush to other cluster nodes.
    
    Parameters:
    
    cacheName - the name of the cache to flush
    
    propagateInCluster - if set to true the flush is propagated to other cluster nodes
  - flushOutputCaches
```
public static void flushOutputCaches()
```
    Flushes front-end Jahia caches (module HTML output caches) on the current cluster node only.
  - flushOutputCaches
```
public static void flushOutputCaches(boolean propagateInCluster)
```
    Flushes front-end Jahia caches (module HTML output caches). If propagateInCluster is set to true also propagates the flush to other cluster nodes.
    
    Parameters:
    
    propagateInCluster - if set to true the flush is propagated to other cluster nodes
  - flushOutputCachesForPath
```
public static void flushOutputCachesForPath(String path,
                                            boolean flushSubtree)
```
  - flushOutputCachesForPaths
```
public static void flushOutputCachesForPaths(Set<String> paths,
                                             boolean flushSubtree)
```
  - getCacheManager
```
public static net.sf.ehcache.CacheManager getCacheManager(String cacheManagerName)
```
  - getCacheManagerInfos
```
public static Map<String,CacheManagerInfo> getCacheManagerInfos(boolean withConfig,
                                                                boolean withSizeInBytes)
```
    Returns the configuration and statistics information for all the available cache managers.
    
    Parameters:
    
    withConfig - if true the configuration information will be also available
    
    withSizeInBytes - if true the calculation of the cache sizes (bytes) will be also available
    
    Returns:
    
    the configuration and statistics information for all the available cache managers
  - getObjectValue
```
public static Object getObjectValue(net.sf.ehcache.Ehcache cache,
                                    String key)
```
    Returns a value of the specified cache element (by key), considering also classloader-aware deserialization if required.
    
    Parameters:
    
    cache - the target cache
    
    key - the element key
    
    Returns:
    
    a value of the specified cache element (by key), considering also classloader-aware deserialization if required
  - getObjectValue
```
public static Object getObjectValue(net.sf.ehcache.Element cacheElement)
```
    Returns a value of the specified cache element, considering also classloader-aware deserialization if required.
    
    Parameters:
    
    cacheElement - the cache element
    
    Returns:
    
    a value of the specified cache element (by key), considering also classloader-aware deserialization if required
  - registerMBeans
```
public static void registerMBeans(String cacheManagerName)
```
  - sendCacheFlushCommandToCluster
```
public static void sendCacheFlushCommandToCluster(String command)
```
    Sends the specified cache flush command to other cluster nodes (if clustering is activated). The event will be processed considering current cluster revision.
    
    Parameters:
    
    command - the command to be sent
  - sendCacheFlushCommandToCluster
```
public static void sendCacheFlushCommandToCluster(String command,
                                                  String eventMessage)
```
    Sends the specified cache flush command with a message to other cluster nodes (if clustering is activated). The event will be processed considering current cluster revision.
    
    Parameters:
    
    command - the command to be sent
    
    eventMessage - custom event message
  - sendMultipleCacheFlushCommandsToCluster
```
public static void sendMultipleCacheFlushCommandsToCluster(String command,
                                                           Collection<String> eventMessages)
```
    Sends the specified cache flush commands to other cluster nodes (if clustering is activated). The events will be processed considering current cluster revision.
    
    Parameters:
    
    command - the command to be sent
    
    eventMessages - a collection of event messages to send

Class CacheHelper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CMD_FLUSH_ALL_CACHES

CMD_FLUSH_CHILDREN

CMD_FLUSH_CHILDS

CMD_FLUSH_MATCHINGPERMISSIONS

CMD_FLUSH_OUTPUT_CACHES

CMD_FLUSH_PATH

CMD_FLUSH_REGEXP

CMD_FLUSH_REGEXPDEP

CMD_FLUSH_URLRESOLVER

CMD_FLUSH_VANITYURL

Constructor Detail

CacheHelper

Method Detail

flushAllCaches

flushAllCaches

flushCachesForManager

flushEhcacheByName

flushEhcacheByName

flushOutputCaches

flushOutputCaches

flushOutputCachesForPath

flushOutputCachesForPaths

getCacheManager

getCacheManagerInfos

getObjectValue

getObjectValue

registerMBeans

sendCacheFlushCommandToCluster

sendCacheFlushCommandToCluster

sendMultipleCacheFlushCommandsToCluster