StandardCacheManager (thymeleaf 2.0.2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.thymeleaf.cache
Class StandardCacheManager

Object
  org.thymeleaf.cache.AbstractCacheManager
      org.thymeleaf.cache.StandardCacheManager

All Implemented Interfaces:: ICacheManager

public class StandardCacheManager
extends AbstractCacheManager
extends AbstractCacheManager

Standard implementation of ICacheManager, returning configurable instances of StandardCache for each of the default caches defined at the cache manager interface.

Each cache allows the configuration of the following parameters:

Its name (will be displayed in logs).
Its initial size: the size the cache will be initialized with.
Its maximum size: the maximum size the cache will be allowed to reach. Some special values:
- -1 means no limit in size.
- 0 means this cache will not be used at all (getXCache() will return null).
Whether the cache should use soft references or not (java.lang.ref.SoftReference). Using Soft References allows the cache to be memory-sensitive, allowing the garbage collector to dispose cache entries if memory is critical, before raising an OutOfMemoryError.
The name of the logger that will output trace information for the cache object. Configuring this allows a finer-grained log configuration that allows the more effective inspection of cache behaviour. If not specifically set, org.thymeleaf.TemplateEngine.cache.${cacheName} will be used.
An (optional) validity checker implementing ICacheEntryValidityChecker, which will be applied on each entry upon retrieval from cache in order to ensure it is still valid and can be used.

Since:: 2.0.0
Author:: Daniel Fernández

Field Summary
`static int`	`DEFAULT_EXPRESSION_CACHE_INITIAL_SIZE` Default expression cache initial size: 100
`static String`	`DEFAULT_EXPRESSION_CACHE_LOGGER_NAME` Default expression cache logger name: null (default behaviour = org.thymeleaf.TemplateEngine.cache.EXPRESSION_CACHE)
`static int`	`DEFAULT_EXPRESSION_CACHE_MAX_SIZE` Default expression cache maximum size: 500
`static String`	`DEFAULT_EXPRESSION_CACHE_NAME` Default expression cache name: "EXPRESSION_CACHE"
`static boolean`	`DEFAULT_EXPRESSION_CACHE_USE_SOFT_REFERENCES` Default expression cache "use soft references" flag: true
`static ICacheEntryValidityChecker<String,Object>`	`DEFAULT_EXPRESSION_CACHE_VALIDITY_CHECKER` Default expression cache validity checker: null
`static int`	`DEFAULT_FRAGMENT_CACHE_INITIAL_SIZE` Default fragment cache initial size: 20
`static String`	`DEFAULT_FRAGMENT_CACHE_LOGGER_NAME` Default fragment cache logger name: null (default behaviour = org.thymeleaf.TemplateEngine.cache.FRAGMENT_CACHE)
`static int`	`DEFAULT_FRAGMENT_CACHE_MAX_SIZE` Default fragment cache maximum size: 300
`static String`	`DEFAULT_FRAGMENT_CACHE_NAME` Default fragment cache name: "FRAGMENT_CACHE"
`static boolean`	`DEFAULT_FRAGMENT_CACHE_USE_SOFT_REFERENCES` Default fragment cache "use soft references" flag: true
`static ICacheEntryValidityChecker<String,java.util.List<Node>>`	`DEFAULT_FRAGMENT_CACHE_VALIDITY_CHECKER` Default fragment cache validity checker: null
`static int`	`DEFAULT_MESSAGE_CACHE_INITIAL_SIZE` Default message cache initial size: 20
`static String`	`DEFAULT_MESSAGE_CACHE_LOGGER_NAME` Default message cache logger name: null (default behaviour = org.thymeleaf.TemplateEngine.cache.MESSAGE_CACHE)
`static int`	`DEFAULT_MESSAGE_CACHE_MAX_SIZE` Default message cache maximum size: 300
`static String`	`DEFAULT_MESSAGE_CACHE_NAME` Default message cache name: "MESSAGE_CACHE"
`static boolean`	`DEFAULT_MESSAGE_CACHE_USE_SOFT_REFERENCES` Default message cache "use soft references" flag: true
`static ICacheEntryValidityChecker<String,java.util.Properties>`	`DEFAULT_MESSAGE_CACHE_VALIDITY_CHECKER` Default message cache validity checker: null
`static int`	`DEFAULT_TEMPLATE_CACHE_INITIAL_SIZE` Default template cache initial size: 10
`static String`	`DEFAULT_TEMPLATE_CACHE_LOGGER_NAME` Default template cache logger name: null (default behaviour = org.thymeleaf.TemplateEngine.cache.TEMPLATE_CACHE)
`static int`	`DEFAULT_TEMPLATE_CACHE_MAX_SIZE` Default template cache maximum size: 50
`static String`	`DEFAULT_TEMPLATE_CACHE_NAME` Default template cache name: "TEMPLATE_CACHE"
`static boolean`	`DEFAULT_TEMPLATE_CACHE_USE_SOFT_REFERENCES` Default template cache "use soft references" flag: true
`static ICacheEntryValidityChecker<String,Template>`	`DEFAULT_TEMPLATE_CACHE_VALIDITY_CHECKER` Default template cache validity checker: an instance of `StandardParsedTemplateEntryValidator`.

Constructor Summary
`StandardCacheManager()`

Method Summary
`int`	`getExpressionCacheInitialSize()`
`org.slf4j.Logger`	`getExpressionCacheLogger()`
`String`	`getExpressionCacheLoggerName()`
`int`	`getExpressionCacheMaxSize()`
`String`	`getExpressionCacheName()`
`boolean`	`getExpressionCacheUseSoftReferences()`
`ICacheEntryValidityChecker<String,Object>`	`getExpressionCacheValidityChecker()`
`int`	`getFragmentCacheInitialSize()`
`org.slf4j.Logger`	`getFragmentCacheLogger()`
`String`	`getFragmentCacheLoggerName()`
`int`	`getFragmentCacheMaxSize()`
`String`	`getFragmentCacheName()`
`boolean`	`getFragmentCacheUseSoftReferences()`
`ICacheEntryValidityChecker<String,java.util.List<Node>>`	`getFragmentCacheValidityChecker()`
`int`	`getMessageCacheInitialSize()`
`org.slf4j.Logger`	`getMessageCacheLogger()`
`String`	`getMessageCacheLoggerName()`
`int`	`getMessageCacheMaxSize()`
`String`	`getMessageCacheName()`
`boolean`	`getMessageCacheUseSoftReferences()`
`ICacheEntryValidityChecker<String,java.util.Properties>`	`getMessageCacheValidityChecker()`
`int`	`getTemplateCacheInitialSize()`
`org.slf4j.Logger`	`getTemplateCacheLogger()`
`String`	`getTemplateCacheLoggerName()`
`int`	`getTemplateCacheMaxSize()`
`String`	`getTemplateCacheName()`
`boolean`	`getTemplateCacheUseSoftReferences()`
`ICacheEntryValidityChecker<String,Template>`	`getTemplateCacheValidityChecker()`
`protected ICache<String,Object>`	`initializeExpressionCache()`
`protected ICache<String,java.util.List<Node>>`	`initializeFragmentCache()`
`protected ICache<String,java.util.Properties>`	`initializeMessageCache()`
`protected ICache<String,Template>`	`initializeTemplateCache()`
`void`	`setExpressionCacheInitialSize(int expressionCacheInitialSize)`
`void`	`setExpressionCacheLoggerName(String expressionCacheLoggerName)`
`void`	`setExpressionCacheMaxSize(int expressionCacheMaxSize)`
`void`	`setExpressionCacheName(String expressionCacheName)`
`void`	`setExpressionCacheUseSoftReferences(boolean expressionCacheUseSoftReferences)`
`void`	`setExpressionCacheValidityChecker(ICacheEntryValidityChecker<String,Object> expressionCacheValidityChecker)`
`void`	`setFragmentCacheInitialSize(int fragmentCacheInitialSize)`
`void`	`setFragmentCacheLoggerName(String fragmentCacheLoggerName)`
`void`	`setFragmentCacheMaxSize(int fragmentCacheMaxSize)`
`void`	`setFragmentCacheName(String fragmentCacheName)`
`void`	`setFragmentCacheUseSoftReferences(boolean fragmentCacheUseSoftReferences)`
`void`	`setFragmentCacheValidityChecker(ICacheEntryValidityChecker<String,java.util.List<Node>> fragmentCacheValidityChecker)`
`void`	`setMessageCacheInitialSize(int messageCacheInitialSize)`
`void`	`setMessageCacheLoggerName(String messageCacheLoggerName)`
`void`	`setMessageCacheMaxSize(int messageCacheMaxSize)`
`void`	`setMessageCacheName(String messageCacheName)`
`void`	`setMessageCacheUseSoftReferences(boolean messageCacheUseSoftReferences)`
`void`	`setMessageCacheValidityChecker(ICacheEntryValidityChecker<String,java.util.Properties> messageCacheValidityChecker)`
`void`	`setTemplateCacheInitialSize(int templateCacheInitialSize)`
`void`	`setTemplateCacheLoggerName(String templateCacheLoggerName)`
`void`	`setTemplateCacheMaxSize(int templateCacheMaxSize)`
`void`	`setTemplateCacheName(String templateCacheName)`
`void`	`setTemplateCacheUseSoftReferences(boolean templateCacheUseSoftReferences)`
`void`	`setTemplateCacheValidityChecker(ICacheEntryValidityChecker<String,Template> templateCacheValidityChecker)`

Methods inherited from class org.thymeleaf.cache.AbstractCacheManager
`getExpressionCache, getFragmentCache, getMessageCache, getSpecificCache, getTemplateCache`

Methods inherited from class Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

DEFAULT_TEMPLATE_CACHE_NAME

public static final String DEFAULT_TEMPLATE_CACHE_NAME

Default template cache name: "TEMPLATE_CACHE"

See Also:: Constant Field Values

DEFAULT_TEMPLATE_CACHE_INITIAL_SIZE

public static final int DEFAULT_TEMPLATE_CACHE_INITIAL_SIZE

Default template cache initial size: 10

See Also:: Constant Field Values

DEFAULT_TEMPLATE_CACHE_MAX_SIZE

public static final int DEFAULT_TEMPLATE_CACHE_MAX_SIZE

Default template cache maximum size: 50

See Also:: Constant Field Values

DEFAULT_TEMPLATE_CACHE_USE_SOFT_REFERENCES

public static final boolean DEFAULT_TEMPLATE_CACHE_USE_SOFT_REFERENCES

Default template cache "use soft references" flag: true

See Also:: Constant Field Values

DEFAULT_TEMPLATE_CACHE_LOGGER_NAME

public static final String DEFAULT_TEMPLATE_CACHE_LOGGER_NAME

Default template cache logger name: null (default behaviour = org.thymeleaf.TemplateEngine.cache.TEMPLATE_CACHE)

DEFAULT_TEMPLATE_CACHE_VALIDITY_CHECKER

public static final ICacheEntryValidityChecker<String,Template> DEFAULT_TEMPLATE_CACHE_VALIDITY_CHECKER

Default template cache validity checker: an instance of StandardParsedTemplateEntryValidator.

DEFAULT_FRAGMENT_CACHE_NAME

public static final String DEFAULT_FRAGMENT_CACHE_NAME

Default fragment cache name: "FRAGMENT_CACHE"

See Also:: Constant Field Values

DEFAULT_FRAGMENT_CACHE_INITIAL_SIZE

public static final int DEFAULT_FRAGMENT_CACHE_INITIAL_SIZE

Default fragment cache initial size: 20

See Also:: Constant Field Values

DEFAULT_FRAGMENT_CACHE_MAX_SIZE

public static final int DEFAULT_FRAGMENT_CACHE_MAX_SIZE

Default fragment cache maximum size: 300

See Also:: Constant Field Values

DEFAULT_FRAGMENT_CACHE_USE_SOFT_REFERENCES

public static final boolean DEFAULT_FRAGMENT_CACHE_USE_SOFT_REFERENCES

Default fragment cache "use soft references" flag: true

See Also:: Constant Field Values

DEFAULT_FRAGMENT_CACHE_LOGGER_NAME

public static final String DEFAULT_FRAGMENT_CACHE_LOGGER_NAME

Default fragment cache logger name: null (default behaviour = org.thymeleaf.TemplateEngine.cache.FRAGMENT_CACHE)

DEFAULT_FRAGMENT_CACHE_VALIDITY_CHECKER

public static final ICacheEntryValidityChecker<String,java.util.List<Node>> DEFAULT_FRAGMENT_CACHE_VALIDITY_CHECKER

Default fragment cache validity checker: null

DEFAULT_MESSAGE_CACHE_NAME

public static final String DEFAULT_MESSAGE_CACHE_NAME

Default message cache name: "MESSAGE_CACHE"

See Also:: Constant Field Values

DEFAULT_MESSAGE_CACHE_INITIAL_SIZE

public static final int DEFAULT_MESSAGE_CACHE_INITIAL_SIZE

Default message cache initial size: 20

See Also:: Constant Field Values

DEFAULT_MESSAGE_CACHE_MAX_SIZE

public static final int DEFAULT_MESSAGE_CACHE_MAX_SIZE

Default message cache maximum size: 300

See Also:: Constant Field Values

DEFAULT_MESSAGE_CACHE_USE_SOFT_REFERENCES

public static final boolean DEFAULT_MESSAGE_CACHE_USE_SOFT_REFERENCES

Default message cache "use soft references" flag: true

See Also:: Constant Field Values

DEFAULT_MESSAGE_CACHE_LOGGER_NAME

public static final String DEFAULT_MESSAGE_CACHE_LOGGER_NAME

Default message cache logger name: null (default behaviour = org.thymeleaf.TemplateEngine.cache.MESSAGE_CACHE)

DEFAULT_MESSAGE_CACHE_VALIDITY_CHECKER

public static final ICacheEntryValidityChecker<String,java.util.Properties> DEFAULT_MESSAGE_CACHE_VALIDITY_CHECKER

Default message cache validity checker: null

DEFAULT_EXPRESSION_CACHE_NAME

public static final String DEFAULT_EXPRESSION_CACHE_NAME

Default expression cache name: "EXPRESSION_CACHE"

See Also:: Constant Field Values

DEFAULT_EXPRESSION_CACHE_INITIAL_SIZE

public static final int DEFAULT_EXPRESSION_CACHE_INITIAL_SIZE

Default expression cache initial size: 100

See Also:: Constant Field Values

DEFAULT_EXPRESSION_CACHE_MAX_SIZE

public static final int DEFAULT_EXPRESSION_CACHE_MAX_SIZE

Default expression cache maximum size: 500

See Also:: Constant Field Values

DEFAULT_EXPRESSION_CACHE_USE_SOFT_REFERENCES

public static final boolean DEFAULT_EXPRESSION_CACHE_USE_SOFT_REFERENCES

Default expression cache "use soft references" flag: true

See Also:: Constant Field Values

DEFAULT_EXPRESSION_CACHE_LOGGER_NAME

public static final String DEFAULT_EXPRESSION_CACHE_LOGGER_NAME

Default expression cache logger name: null (default behaviour = org.thymeleaf.TemplateEngine.cache.EXPRESSION_CACHE)

DEFAULT_EXPRESSION_CACHE_VALIDITY_CHECKER

public static final ICacheEntryValidityChecker<String,Object> DEFAULT_EXPRESSION_CACHE_VALIDITY_CHECKER

Default expression cache validity checker: null

Constructor Detail