3.2.1. Parsing an XML-based Configuration File

The most convenient way to configure JBoss Cache is via an XML file. The JBoss Cache distribution ships with a number of configuration files for common use cases. It is recommended that these files be used as a starting point, and tweaked to meet specific needs.

Here is a simple example configuration file:




<?xml version="1.0" encoding="UTF-8"?>



<!-- ===================================================================== -->

<!--                                                                       -->

<!--  Sample JBoss Cache Service Configuration                             -->

<!--                                                                       -->

<!-- ===================================================================== -->



<server>

   

   <mbean code="org.jboss.cache.jmx.CacheJmxWrapper" name="jboss.cache:service=Cache">

   

      <!-- Configure the TransactionManager -->

      <attribute name="TransactionManagerLookupClass">

         org.jboss.cache.transaction.GenericTransactionManagerLookup

      </attribute>



      <!-- Node locking level : SERIALIZABLE

                                REPEATABLE_READ (default)

                                READ_COMMITTED

                                READ_UNCOMMITTED

                                NONE             -->

      <attribute name="IsolationLevel">READ_COMMITTED</attribute>



      <!-- Lock parent before doing node additions/removes -->

      <attribute name="LockParentForChildInsertRemove">true</attribute>



      <!-- Valid modes are LOCAL (default)

                           REPL_ASYNC

                           REPL_SYNC

                           INVALIDATION_ASYNC

                           INVALIDATION_SYNC   -->

      <attribute name="CacheMode">LOCAL</attribute>



      <!-- Max number of milliseconds to wait for a lock acquisition -->

      <attribute name="LockAcquisitionTimeout">15000</attribute>





      <!-- Specific eviction policy configurations. This is LRU -->

      <attribute name="EvictionConfig">

         <config>

            <attribute name="wakeUpIntervalSeconds">5</attribute>

            <attribute name="policyClass">org.jboss.cache.eviction.LRUPolicy</attribute>



            <!-- Cache wide default -->

            <region name="/_default_">

               <attribute name="maxNodes">5000</attribute>

               <attribute name="timeToLiveSeconds">1000</attribute>

            </region>

         </config>

      </attribute>

   </mbean>

</server>

Another, more complete, sample XML file is included in the configuration reference section of this book, along with a handy look-up table explaining the various options.

For historical reasons, the format of the JBoss Cache configuraton file follows that of a JBoss AS Service Archive (SAR) deployment descriptor (and still can be used as such inside JBoss AS ). Because of this dual usage, you may see elements in some configuration files (such as depends or classpath ) that are not relevant outside JBoss AS. These can safely be ignored.

Here's how you tell the CacheFactory to create and start a cache by finding and parsing a configuration file on the classpath:




   CacheFactory factory = DefaultCacheFactory.getInstance();

   Cache cache = factory.createCache("cache-configuration.xml");