You can override the default configuration of ExoCacheFactory like any other component.

The default configuration of ExoCacheFactory is:

<configuration>  

  <component>

    <key>org.exoplatform.services.cache.ExoCacheFactory</key>

    <type>org.exoplatform.services.cache.impl.jboss.ExoCacheFactoryImpl</type>

    <init-params>

      <value-param>

        <name>cache.config.template</name>

        <value>jar:/conf/portal/cache-configuration-template.xml</value>

      </value-param>

      <value-param>

        <name>allow.shareable.cache</name>

        <value>true</value>

      </value-param>

    </init-params>

  </component>   

</configuration>

If you need to use your own cache configuration, you can register an "external plugin", see an example below:

<configuration>

  ...

  <external-component-plugins>

    <target-component>org.exoplatform.services.cache.ExoCacheFactory</target-component>

    <component-plugin>

      <name>addConfig</name>

      <set-method>addConfig</set-method>

      <type>org.exoplatform.services.cache.impl.jboss.ExoCacheFactoryConfigPlugin</type>

      <description>add Custom Configurations</description>

      <init-params>

        <value-param>

          <name>myCustomCache</name>

          <value>jar:/conf/portal/custom-cache-configuration.xml</value>

        </value-param>         

      </init-params>

    </component-plugin>    

  </external-component-plugins> 

  ...   

</configuration>

In this example, the method addConfig(ExoCacheFactoryConfigPlugin plugin) is called on the current implementation of ExoCacheFactory which is actually the JBoss Cache implementation.

In the init-params block, you can define a set of value-param blocks and for each value-param, you provide your cache name in name tag and path of your custom configuration file in value tag.

In the example, the cache name is myCustomCache and configuration file is jar:/conf/portal/custom-cache-configuration.xml.

Understanding a cache creator

ExoCacheFactory delegates the cache creation to ExoCacheCreator that is defined as below:

package org.exoplatform.services.cache.impl.jboss;

        ...

        public interface ExoCacheCreator {


        /**

        * Creates an eXo cache according to the given configuration {@link

        org.exoplatform.services.cache.ExoCacheConfig}

        * @param config the configuration of the cache to apply

        * @param cache the cache to initialize

        * @exception ExoCacheInitException if an exception happens while initializing the cache

        */

        public ExoCache create(ExoCacheConfig config, Cache<Serializable, Object> cache) throws

        ExoCacheInitException;


        /**

        * Returns the type of {@link org.exoplatform.services.cache.ExoCacheConfig} expected by the creator

        * @return the expected type

        */

        public Class<? extends ExoCacheConfig> getExpectedConfigType();


        /**

        * Returns the name of the implementation expected by the creator. This is mainly used to be backward compatible

        * @return the expected by the creator

        */

        public String getExpectedImplementation();

        }

      

The ExoCacheCreator allows you to define any kind of JBoss Cache instance that you would like to have. It has been designed to give you the ability to have your own type of configuration and to always be backward compatible.

To implement ExoCacheCreator, you need to implement 3 methods which are:

Registering a cache creator

You can register any cache creator that you want thanks to an "external plugin", see an example below:

<external-component-plugins>

    <target-component>org.exoplatform.services.cache.ExoCacheFactory</target-component>

    <component-plugin>

        <name>addCreator</name>

        <set-method>addCreator</set-method>

        <type>org.exoplatform.services.cache.impl.jboss.ExoCacheCreatorPlugin</type>

        <description>add Exo Cache Creator</description>

        <init-params>

            <object-param>

                <name>LRU</name>

                <description>The lru cache creator</description>

                <object type="org.exoplatform.services.cache.impl.jboss.lru.LRUExoCacheCreator">

                    <field name="defaultTimeToLive"><long>1500</long></field>

                    <field name="defaultMaxAge"><long>2000</long></field>

                </object>

            </object-param>

        </init-params>

    </component-plugin>

</external-component-plugins>

In this example, the method addCreator(ExoCacheCreatorPlugin plugin) is called on the current implementation of ExoCacheFactory which is actually the JBoss Cache implementation.

In the init-params block, you can define a set of object-param blocks and for each object-param, we expect any object definition of typeExoCacheCreator. It is org.exoplatform.services.cache.impl.jboss.lru.LRUExoCacheCreator in the example.

The availabe cache creators

By default, no cache creator are defined, so you need to add them in your configuration files. The following is available cache creators: