Configuring Caching of Java Objects
The Channel Islands UI caches Java objects using the Ehcache Java caching library. Caches used by a plugin are configured in entries in the properties file of the plugin. The properties include:
• <plugin name>.cacheNames: CSV list of cache names that should be initialized for use by the plugin, without the plugin name prefix.
• <plugin name>.cache.<cache name>.maxEntriesLocalHeap: Maximum number of objects that will be cached in memory (0 = no limit).
• <plugin name>.cache.<cache name>.maxEntriesLocalDisk: Maximum number of objects that will be maintained in the DiskStore (0 = no limit).
• <plugin name>.cache.<cache name>.eternal: Indicates if timeouts are ignored and the element is never expired (true/false).
• <plugin name>.cache.<cache name>.timeToIdleSeconds: Maximum amount of time between accesses before an element expires (0 = no limit).
• <plugin name>.cache.<cache name>.timeToLiveSeconds: Maximum time between creation time and when an element expires (0 = no limit).
• <plugin name>.cache.<cache name>.persistence: The persistence strategy to use. Only two options are available, localTempSwap, which configures the cache to overflow to disk, or none.
• <plugin name>.cache.<cache name>.memoryStoreEvictionPolicy: Least recently used (LRU), First in first out (FIFO), or Less frequently used (LFU).
All properties except <plugin name>.cacheNames are optional, defaulting to the corresponding values from the central ehcache.xml configuration file defined in the qad-webshell-webui plugin at: src/main/resources/com/qad/webshell/config/ehcache.xml.
The use of a particular cache can be disabled by changing the <plugin name>.cacheNames property to remove the cache name. However, any cache annotations referencing that cache must also be removed, or else an exception will be thrown at run time when the WebShell is started.