com.atlassian.confluence.cache.ehcache

Class EhCacheManager

java.lang.Object

com.atlassian.confluence.cache.ehcache.EhCacheManager

All Implemented Interfaces:

com.atlassian.cache.CacheFactory, com.atlassian.cache.CacheManager

public class EhCacheManager
extends Object
implements com.atlassian.cache.CacheManager

Confluence-specific implementation of CacheManager which delegates to an atlassian-cache com.atlassian.cache.ehcache.EhCacheManager, decorating it with Confluence-specific functionality.

Constructor Summary

Constructors

Constructor and Description
EhCacheManager(Collection<String> nonFlushableCacheNames, ConfluenceMonitoring confluenceMonitoring) Deprecated. since 5.9.1. Use EhCacheManager(ConfluenceMonitoring, CacheSettingsDefaultsProvider) instead.
EhCacheManager(ConfluenceMonitoring confluenceMonitoring, com.atlassian.cache.CacheSettingsDefaultsProvider cacheSettingsDefaultsProvider) Deprecated. since 7.5 Use EhCacheManager(ConfluenceMonitoring, CacheSettingsDefaultsProvider, CacheOperationsWhitelistService)
EhCacheManager(ConfluenceMonitoring confluenceMonitoring, com.atlassian.cache.CacheSettingsDefaultsProvider cacheSettingsDefaultsProvider, CacheOperationsWhitelistService cacheOperationsWhitelistService)

Method Summary

Modifier and Type	Method and Description
void	flushCaches()
<K,V> @NonNull com.atlassian.cache.Cache<K,V>	getCache(@NonNull Class<?> owningClass, @NonNull String name)
<K,V> @NonNull com.atlassian.confluence.cache.ehcache.ConfluenceEhCache<K,V>	getCache(@NonNull String name)
<K,V> @NonNull com.atlassian.cache.Cache<K,V>	getCache(@NonNull String name, com.atlassian.cache.CacheLoader<K,V> loader)
<K,V> @NonNull com.atlassian.confluence.cache.ehcache.ConfluenceEhCache<K,V>	getCache(@NonNull String name, com.atlassian.cache.CacheLoader<K,V> loader, @NonNull com.atlassian.cache.CacheSettings settings)
<K,V> @NonNull com.atlassian.cache.Cache<K,V>	getCache(@NonNull String name, @NonNull Class<K> keyType, @NonNull Class<V> valueType) Deprecated. since 5.7, since it's deprecated in atlassian-cache library 2.5.0
<V> @NonNull com.atlassian.cache.CachedReference<V>	getCachedReference(@NonNull Class<?> owningClass, @NonNull String fieldName, @NonNull com.atlassian.cache.Supplier<V> supplier)
<V> @NonNull com.atlassian.cache.CachedReference<V>	getCachedReference(@NonNull Class<?> owningClass, @NonNull String fieldName, @NonNull com.atlassian.cache.Supplier<V> supplier, @NonNull com.atlassian.cache.CacheSettings settings)
<V> @NonNull com.atlassian.cache.CachedReference<V>	getCachedReference(@NonNull String name, @NonNull com.atlassian.cache.Supplier<V> supplier)
<V> @NonNull com.atlassian.cache.CachedReference<V>	getCachedReference(@NonNull String name, @NonNull com.atlassian.cache.Supplier<V> supplier, @NonNull com.atlassian.cache.CacheSettings settings)
@NonNull Collection<com.atlassian.cache.Cache<?,?>>	getCaches() Deprecated. since 7.2. Use getManagedCaches() instead.
net.sf.ehcache.CacheManager	getEhCacheManager()
com.atlassian.cache.ManagedCache	getManagedCache(@NonNull String name)
@NonNull Collection<com.atlassian.cache.ManagedCache>	getManagedCaches()
void	shutdown()
void	shutdownCacheManager()

Methods inherited from class java.lang.Object

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

Constructor Detail

EhCacheManager

@Deprecated
public EhCacheManager(Collection<String> nonFlushableCacheNames,
                                  ConfluenceMonitoring confluenceMonitoring)
                           throws IOException

Deprecated. since 5.9.1. Use EhCacheManager(ConfluenceMonitoring, CacheSettingsDefaultsProvider) instead.

Throws:

IOException

EhCacheManager

@Deprecated
public EhCacheManager(ConfluenceMonitoring confluenceMonitoring,
                                  com.atlassian.cache.CacheSettingsDefaultsProvider cacheSettingsDefaultsProvider)

Deprecated. since 7.5 Use EhCacheManager(ConfluenceMonitoring, CacheSettingsDefaultsProvider, CacheOperationsWhitelistService)

EhCacheManager

public EhCacheManager(ConfluenceMonitoring confluenceMonitoring,
                      com.atlassian.cache.CacheSettingsDefaultsProvider cacheSettingsDefaultsProvider,
                      CacheOperationsWhitelistService cacheOperationsWhitelistService)

Since:

7.5

Method Detail

shutdownCacheManager

@PreDestroy
public void shutdownCacheManager()

flushCaches

public void flushCaches()

Specified by:

flushCaches in interface com.atlassian.cache.CacheManager

getCaches

@Deprecated
public @NonNull Collection<com.atlassian.cache.Cache<?,?>> getCaches()

Deprecated. since 7.2. Use getManagedCaches() instead.

Specified by:

getCaches in interface com.atlassian.cache.CacheManager

getCache

public <K,V> @NonNull com.atlassian.confluence.cache.ehcache.ConfluenceEhCache<K,V> getCache(@NonNull String name)

Specified by:

getCache in interface com.atlassian.cache.CacheFactory

getCache

@Deprecated
public <K,V> @NonNull com.atlassian.cache.Cache<K,V> getCache(@NonNull String name,
                                                                          @NonNull Class<K> keyType,
                                                                          @NonNull Class<V> valueType)

Deprecated. since 5.7, since it's deprecated in atlassian-cache library 2.5.0

Specified by:

getCache in interface com.atlassian.cache.CacheFactory

getManagedCaches

public @NonNull Collection<com.atlassian.cache.ManagedCache> getManagedCaches()

Specified by:

getManagedCaches in interface com.atlassian.cache.CacheManager

getManagedCache

public com.atlassian.cache.ManagedCache getManagedCache(@NonNull String name)

Specified by:

getManagedCache in interface com.atlassian.cache.CacheManager

shutdown

public void shutdown()

Specified by:

shutdown in interface com.atlassian.cache.CacheManager

getCachedReference

public <V> @NonNull com.atlassian.cache.CachedReference<V> getCachedReference(@NonNull String name,
                                                                              @NonNull com.atlassian.cache.Supplier<V> supplier)

Specified by:

getCachedReference in interface com.atlassian.cache.CacheFactory

getCachedReference

public <V> @NonNull com.atlassian.cache.CachedReference<V> getCachedReference(@NonNull String name,
                                                                              @NonNull com.atlassian.cache.Supplier<V> supplier,
                                                                              @NonNull com.atlassian.cache.CacheSettings settings)

Specified by:

getCachedReference in interface com.atlassian.cache.CacheFactory

getCachedReference

public <V> @NonNull com.atlassian.cache.CachedReference<V> getCachedReference(@NonNull Class<?> owningClass,
                                                                              @NonNull String fieldName,
                                                                              @NonNull com.atlassian.cache.Supplier<V> supplier)

Specified by:

getCachedReference in interface com.atlassian.cache.CacheFactory

getCachedReference

public <V> @NonNull com.atlassian.cache.CachedReference<V> getCachedReference(@NonNull Class<?> owningClass,
                                                                              @NonNull String fieldName,
                                                                              @NonNull com.atlassian.cache.Supplier<V> supplier,
                                                                              @NonNull com.atlassian.cache.CacheSettings settings)

Specified by:

getCachedReference in interface com.atlassian.cache.CacheFactory

getCache

public <K,V> @NonNull com.atlassian.cache.Cache<K,V> getCache(@NonNull Class<?> owningClass,
                                                              @NonNull String name)

Specified by:

getCache in interface com.atlassian.cache.CacheFactory

getCache

public <K,V> @NonNull com.atlassian.cache.Cache<K,V> getCache(@NonNull String name,
                                                              com.atlassian.cache.CacheLoader<K,V> loader)

Specified by:

getCache in interface com.atlassian.cache.CacheFactory

getCache

public <K,V> @NonNull com.atlassian.confluence.cache.ehcache.ConfluenceEhCache<K,V> getCache(@NonNull String name,
                                                                                             com.atlassian.cache.CacheLoader<K,V> loader,
                                                                                             @NonNull com.atlassian.cache.CacheSettings settings)

Specified by:

getCache in interface com.atlassian.cache.CacheFactory

getEhCacheManager

public net.sf.ehcache.CacheManager getEhCacheManager()