There are 2 ways to define a cache:
At CacheService initialization
By external plugin
At CacheService initialization
...
<component>
<key>org.exoplatform.services.cache.CacheService</key>
<type>org.exoplatform.services.cache.impl.CacheServiceImpl</type>
<init-params>
...
<object-param>
<name>fifocache</name>
<description>The default cache configuration</description>
<object type="org.exoplatform.services.cache.ExoCacheConfig">
<field name="name"><string>fifocache</string></field>
<field name="maxSize"><int>${my-value}</int></field>
<field name="liveTime"><long>${my-value}</long></field>
<field name="distributed"><boolean>false</boolean></field>
<field name="implementation"><string>org.exoplatform.services.cache.FIFOExoCache</string></field>
</object>
</object-param>
...
</init-params>
</component>
...
In this example, we define a new cache called fifocache.
...
<external-component-plugins>
<target-component>org.exoplatform.services.cache.CacheService</target-component>
<component-plugin>
<name>addExoCacheConfig</name>
<set-method>addExoCacheConfig</set-method>
<type>org.exoplatform.services.cache.ExoCacheConfigPlugin</type>
<description>add ExoCache configuration component plugin </description>
<init-params>
...
<object-param>
<name>fifoCache</name>
<description>The fifo cache configuration</description>
<object type="org.exoplatform.services.cache.ExoCacheConfig">
<field name="name"><string>fifocache</string></field>
<field name="maxSize"><int>${my-value}</int></field>
<field name="liveTime"><long>${my-value}</long></field>
<field name="distributed"><boolean>false</boolean></field>
<field name="implementation"><string>org.exoplatform.services.cache.FIFOExoCache</string></field>
</object>
</object-param>
...
</init-params>
</component-plugin>
</external-component-plugins>
...
In this example, we define a new cache called fifocache which is in fact the same cache as in previous example but defined in a different manner.
You can define the cache mode in your custom configuration file.
In case you use the default configuration template,
the cache mode is set by the field distributed of your
ExoCacheConfig. If the value
of this field is false (the default value), the cache will be a local
cache, otherwise it should be distributed.
In order to avoid creating several JBoss Cache instances that consume resources, it is possible to share the same JBoss Cache instance between multiple eXo Cache instances that rely on the same JBoss Cache configuration. Each eXo Cache instance will then have its own cache region with its own eviction configuration. To allow sharing JBoss Cache instances, you can set the global value at ExoCacheFactory level and if needed set the local value at ExoCacheConfig level knowing that local value will redefine the global value. Each of ExoCacheConfig described below is a sub class of AbstractExoCacheConfig that gives access to the parameter allowShareableCache, if this parameter is set, it will be effective otherwise the global value is effective. For all the old ExoCacheConfig, only the global value will be used.
New configuration
...
<object-param>
<name>lru</name>
<description>The lru cache configuration</description>
<object type="org.exoplatform.services.cache.impl.jboss.lru.LRUExoCacheConfig">
<field name="name"><string>lru</string></field>
<field name="maxNodes"><int>${my-value}</int></field>
<field name="minTimeToLive"><long>${my-value}</long></field>
<field name="maxAge"><long>${my-value}</long></field>
<field name="timeToLive"><long>${my-value}</long></field>
</object>
</object-param>
...
| maxNodes | This is the maximum number of nodes allowed in this region. 0 denotes immediate expiry, -1 denotes no limit. |
| minTimeToLive | The minimum amount of time (in milliseconds) that a node must be allowed to live after being accessed before it is allowed to be considered for eviction. 0 denotes that this feature is disabled, which is the default value. |
| maxAge | Lifespan of a node (in milliseconds) regardless of idle time before the node is swept away. 0 denotes immediate expiry, -1 denotes no limit. |
| timeToLive | The amount of time that a node is not written to or read (in milliseconds) before the node is swept away. 0 denotes immediate expiry, -1 denotes no limit. |
Old configuration
...
<object-param>
<name>lru-with-old-config</name>
<description>The lru cache configuration</description>
<object type="org.exoplatform.services.cache.ExoCacheConfig">
<field name="name"><string>lru-with-old-config</string></field>
<field name="maxSize"><int>${my-value}</int></field>
<field name="liveTime"><long>${my-value}</long></field>
<field name="implementation"><string>LRU</string></field>
</object>
</object-param>
...
| maxSize | This is the maximum number of nodes allowed in this region. 0 denotes immediate expiry, -1 denotes no limit. |
| liveTime | The minimum amount of time (in seconds) that a node must be allowed to live after being accessed before it is allowed to be considered for eviction. 0 denotes that this feature is disabled, which is the default value. |
For the fields maxAge and timeToLive needed by JBoss Cache, we will use the default values provided by the creator.
New configuration
...
<object-param>
<name>fifo</name>
<description>The fifo cache configuration</description>
<object type="org.exoplatform.services.cache.impl.jboss.fifo.FIFOExoCacheConfig">
<field name="name"><string>fifo</string></field>
<field name="maxNodes"><int>${my-value}</int></field>
<field name="minTimeToLive"><long>${my-value}</long></field>
</object>
</object-param>
...
| maxNodes | This is the maximum number of nodes allowed in this region. 0 denotes immediate expiry, -1 denotes no limit. |
| minTimeToLive | The minimum amount of time (in milliseconds) that a node must be allowed to live after being accessed before it is allowed to be considered for eviction. 0 denotes that this feature is disabled, which is the default value. |
Old configuration
...
<object-param>
<name>fifo-with-old-config</name>
<description>The fifo cache configuration</description>
<object type="org.exoplatform.services.cache.ExoCacheConfig">
<field name="name"><string>fifo-with-old-config</string></field>
<field name="maxSize"><int>${my-value}</int></field>
<field name="liveTime"><long>${my-value}</long></field>
<field name="implementation"><string>FIFO</string></field>
</object>
</object-param>
...
| maxSize | This is the maximum number of nodes allowed in this region. 0 denotes immediate expiry, -1 denotes no limit. |
| liveTime | The minimum amount of time (in seconds) that a node must be allowed to live after being accessed before it is allowed to be considered for eviction. 0 denotes that this feature is disabled, which is the default value. |
New configuration
...
<object-param>
<name>mru</name>
<description>The mru cache configuration</description>
<object type="org.exoplatform.services.cache.impl.jboss.mru.MRUExoCacheConfig">
<field name="name"><string>mru</string></field>
<field name="maxNodes"><int>${my-value}</int></field>
<field name="minTimeToLive"><long>${my-value}</long></field>
</object>
</object-param>
...
| maxNodes | This is the maximum number of nodes allowed in this region. 0 denotes immediate expiry, -1 denotes no limit. |
| minTimeToLive | The minimum amount of time (in milliseconds) that a node must be allowed to live after being accessed before it is allowed to be considered for eviction. 0 denotes that this feature is disabled, which is the default value. |
Old configuration
...
<object-param>
<name>mru-with-old-config</name>
<description>The mru cache configuration</description>
<object type="org.exoplatform.services.cache.ExoCacheConfig">
<field name="name"><string>mru-with-old-config</string></field>
<field name="maxSize"><int>${my-value}</int></field>
<field name="liveTime"><long>${my-value}</long></field>
<field name="implementation"><string>MRU</string></field>
</object>
</object-param>
...
| maxSize | This is the maximum number of nodes allowed in this region. 0 denotes immediate expiry, -1 denotes no limit. |
| liveTime | The minimum amount of time (in seconds) that a node must be allowed to live after being accessed before it is allowed to be considered for eviction. 0 denotes that this feature is disabled, which is the default value. |
New configuration
...
<object-param>
<name>lfu</name>
<description>The lfu cache configuration</description>
<object type="org.exoplatform.services.cache.impl.jboss.lfu.LFUExoCacheConfig">
<field name="name"><string>lfu</string></field>
<field name="maxNodes"><int>${my-value}</int></field>
<field name="minNodes"><int>${my-value}</int></field>
<field name="minTimeToLive"><long>${my-value}</long></field>
</object>
</object-param>
...
| maxNodes | This is the maximum number of nodes allowed in this region. 0 denotes immediate expiry, -1 denotes no limit. |
| minNodes | This is the minimum number of nodes allowed in this region. This value determines what the eviction queue should prune down to per pass. e.g. If minNodes is 10 and the cache grows to 100 nodes, the cache is pruned down to the 10 most frequently used nodes when the eviction timer makes a pass through the eviction algorithm. |
| minTimeToLive | The minimum amount of time (in milliseconds) that a node must be allowed to live after being accessed before it is allowed to be considered for eviction. 0 denotes that this feature is disabled, which is the default value. |
Old configuration
...
<object-param>
<name>lfu-with-old-config</name>
<description>The lfu cache configuration</description>
<object type="org.exoplatform.services.cache.ExoCacheConfig">
<field name="name"><string>lfu-with-old-config</string></field>
<field name="maxSize"><int>${my-value}</int></field>
<field name="liveTime"><long>${my-value}</long></field>
<field name="implementation"><string>LFU</string></field>
</object>
</object-param>
...
| maxSize | This is the maximum number of nodes allowed in this region. 0 denotes immediate expiry, -1 denotes no limit. |
| liveTime | The minimum amount of time (in milliseconds) that a node must be allowed to live after being accessed before it is allowed to be considered for eviction. 0 denotes that this feature is disabled, which is the default value. |
For the fields minNodes and timeToLive needed by JBoss Cache, we will use the default values provided by the creator.
New configuration
...
<object-param>
<name>ea</name>
<description>The ea cache configuration</description>
<object type="org.exoplatform.services.cache.impl.jboss.ea.EAExoCacheConfig">
<field name="name"><string>ea</string></field>
<field name="maxNodes"><int>${my-value}</int></field>
<field name="minTimeToLive"><long>${my-value}</long></field>
<field name="expirationTimeout"><long>${my-value}</long></field>
</object>
</object-param>
...
| maxNodes | This is the maximum number of nodes allowed in this region. 0 denotes immediate expiry, -1 denotes no limit. |
| minTimeToLive | The minimum amount of time (in milliseconds) that a node must be allowed to live after being accessed before it is allowed to be considered for eviction. 0 denotes that this feature is disabled, which is the default value. |
| expirationTimeout | This is the timeout after which the cache entry must be evicted. |
Old configuration
...
<object-param>
<name>ea-with-old-config</name>
<description>The ea cache configuration</description>
<object type="org.exoplatform.services.cache.ExoCacheConfig">
<field name="name"><string>lfu-with-old-config</string></field>
<field name="maxSize"><int>${my-value}</int></field>
<field name="liveTime"><long>${my-value}</long></field>
<field name="implementation"><string>EA</string></field>
</object>
</object-param>
...
| maxSize | This is the maximum number of nodes allowed in this region. 0 denotes immediate expiry, -1 denotes no limit. |
| liveTime | The minimum amount of time (in milliseconds) that a node must be allowed to live after being accessed before it is allowed to be considered for eviction. 0 denotes that this feature is disabled, which is the default value. |
For the fields expirationTimeout needed by JBoss cache, we will use the default values provided by the creator.