com.atlassian.confluence.cache

Class DefaultCacheSettingsManager

java.lang.Object

com.atlassian.confluence.cache.DefaultCacheSettingsManager

All Implemented Interfaces:

com.atlassian.cache.CacheSettingsDefaultsProvider, CacheSettingsManager, org.springframework.beans.factory.InitializingBean

public class DefaultCacheSettingsManager
extends Object
implements CacheSettingsManager, org.springframework.beans.factory.InitializingBean

Implementation of CacheSettingsManager that uses a read-only Configuration file that specifies the cache defaults. The configuration file must be in the format to be parsed using the Typesafe Config Library.

The format of the file must include an entry caches which is an array of objects, that each object contains the following cacheSettingsOverridesProperties:

• name - name of the caches to match. Note that trailing wildcards are supported. E.g. "com.*" will match "com.food" and "com."
• config - object containing the cacheSettingsOverridesProperties for the cache. See below.

A config object may contain the following cacheSettingsOverridesProperties:

• expire-after-access-secs - used to set the CacheSettingsBuilder.expireAfterAccess hint
• expire-after-write-secs - used to set the CacheSettingsBuilder.expireAfterWrite hint
• flushable - used to set the CacheSettingsBuilder.flushable() hint
• local - used to set the CacheSettingsBuilder.local() hint
• max-entries - used to set the CacheSettingsBuilder.maxEntries hint
• replicate-async - used to set the CacheSettingsBuilder.replicateAsynchronously() hint
• replicate-via-copy - used to set CacheSettingsBuilder.replicateViaCopy() hint

An example minimal configuration file is:

 // Defaults for local caches
 local-defaults = {
     local = true
     flushable = true
     max-entries = 1000
     expire-after-access-secs = 360
 }

 // Defaults for replicated caches
 remote-defaults = ${local-defaults} {
     local = false
     replicate-via-copy = true
 }

 remote-big = ${remote-defaults} {
     expire-after-write-secs = 42
     flushable = false
     replicate-async = true
     replicate-via-copy = false
     max-entries = 666666
 }

 caches = [
     { name = "a.local.cache", config = ${local-defaults} }
     { name = "a.remote.cache", config = ${remote-defaults} }
     { name = "big.ones.*", config = ${remote-big} }
     { name = "reg.+exp[chars(\\", config = ${remote-big} }
     { name = "*", config = ${remote-defaults} }
 ]
 

Constructor Summary

Constructors

Constructor and Description
DefaultCacheSettingsManager(BootstrapManager bootstrapManager, com.atlassian.beehive.ClusterLockService clusterLockService, String cacheSettingsDefaults, String cacheSettingsOverrides)
DefaultCacheSettingsManager(BootstrapManager bootstrapManager, com.atlassian.beehive.ClusterLockService clusterLockService, String cacheSettingsDefaults, String cacheSettingsOverrides, List<String> ignored) Deprecated. since 5.9.1

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
com.atlassian.cache.CacheSettings	getDefaults(String name)
com.atlassian.cache.CacheSettings	obtainDefaults(String name) Deprecated.
boolean	saveSettings() Persists all changes made so far by update* methods.
com.atlassian.fugue.Option<Integer>	updateMaxEntries(String name, int newValue) Persists updates to the max entries settings for the specified cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCacheSettingsManager

public DefaultCacheSettingsManager(BootstrapManager bootstrapManager,
                                   com.atlassian.beehive.ClusterLockService clusterLockService,
                                   String cacheSettingsDefaults,
                                   String cacheSettingsOverrides)
                            throws IOException

Throws:

IOException

DefaultCacheSettingsManager

@Deprecated
public DefaultCacheSettingsManager(BootstrapManager bootstrapManager,
                                               com.atlassian.beehive.ClusterLockService clusterLockService,
                                               String cacheSettingsDefaults,
                                               String cacheSettingsOverrides,
                                               List<String> ignored)
                                        throws IOException

Deprecated. since 5.9.1

Throws:

IOException

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

updateMaxEntries

public com.atlassian.fugue.Option<Integer> updateMaxEntries(@Nonnull
                                                            String name,
                                                            int newValue)

Description copied from interface: CacheSettingsManager

Persists updates to the max entries settings for the specified cache.

Specified by:

updateMaxEntries in interface CacheSettingsManager

Parameters:

name - the name of the cache to update

Returns:

the previous value of the specified max entries if any have

saveSettings

public boolean saveSettings()

Description copied from interface: CacheSettingsManager

Persists all changes made so far by update* methods.

Specified by:

saveSettings in interface CacheSettingsManager

Returns:

true if changes were persisted successfully

obtainDefaults

@Deprecated
public com.atlassian.cache.CacheSettings obtainDefaults(@Nonnull
                                                                    String name)

Deprecated.

Description copied from interface: CacheSettingsManager

Obtains cache settings for the specified cache.

Specified by:

obtainDefaults in interface CacheSettingsManager

getDefaults

@Nonnull
public com.atlassian.cache.CacheSettings getDefaults(@Nonnull
                                                              String name)

Specified by:

getDefaults in interface com.atlassian.cache.CacheSettingsDefaultsProvider