[jbosscache-commits] JBoss Cache SVN: r8214 - enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US.

Author: irooskov(a)redhat.com Date: 2009-08-30 21:48:16 -0400 (Sun, 30 Aug 2009) New Revision: 8214 Modified: enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/JBoss_Cache_User_Guide.xml enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/architecture.xml enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/basic_api.xml enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/cache_loaders.xml enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/configuration.xml enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/configuration_reference.xml enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/deployment.xml enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/eviction_policies.xml enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/introduction.xml enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/replication.xml enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/transactions.xml Log: updated book so it builds but no images appear at present Modified: enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/JBoss_Cache_User_Guide.xml =================================================================== --- enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/JBoss_Cache_User_Guide.xml 2009-08-27 14:23:46 UTC (rev 8213) +++ enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/JBoss_Cache_User_Guide.xml 2009-08-31 01:48:16 UTC (rev 8214) @@ -1,22 +1,8 @@ <?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN" - "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ - <!ENTITY preface SYSTEM "modules/preface.xml"> - <!ENTITY introduction SYSTEM "modules/introduction.xml"> - <!ENTITY architecture SYSTEM "modules/architecture.xml"> - <!ENTITY basic_api SYSTEM "modules/basic_api.xml"> - <!ENTITY replication SYSTEM "modules/replication.xml"> - <!ENTITY transactions SYSTEM "modules/transactions.xml"> - <!ENTITY eviction_policies SYSTEM "modules/eviction_policies.xml"> - <!ENTITY cache_loaders SYSTEM "modules/cache_loaders.xml"> - <!ENTITY compatibility SYSTEM "modules/compatibility.xml"> - <!ENTITY configuration SYSTEM "modules/configuration.xml"> - <!ENTITY deployment SYSTEM "modules/deployment.xml"> - <!ENTITY configuration_reference SYSTEM "modules/configuration_reference.xml"> - <!ENTITY jmx_reference SYSTEM "modules/jmx_reference.xml"> - <!ENTITY batching SYSTEM "modules/batching.xml"> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ ]> -<book lang="en"> +<book> <xi:include href="preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> Modified: enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/architecture.xml =================================================================== --- enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/architecture.xml 2009-08-27 14:23:46 UTC (rev 8213) +++ enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/architecture.xml 2009-08-31 01:48:16 UTC (rev 8214) @@ -1,3 +1,6 @@ +<?xml version='1.0'?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ +]> <chapter id="architecture"> <title>Architecture</title> <section id="architecture.tree_structure"> @@ -109,18 +112,18 @@ JBoss Cache ships with several interceptors, representing different behavioral aspects, some of which are: <itemizedlist> - <listitem> + <listitem><para> <literal>TxInterceptor</literal> - looks for ongoing transactions and registers with transaction managers to participate in - synchronization events + synchronization events</para> </listitem> - <listitem> + <listitem><para> <literal>ReplicationInterceptor</literal> - - replicates state across a cluster using the RpcManager class + - replicates state across a cluster using the RpcManager class</para> </listitem> - <listitem> + <listitem><para> <literal>CacheLoaderInterceptor</literal> - - loads data from a persistent store if the data requested is not available in memory + - loads data from a persistent store if the data requested is not available in memory</para> </listitem> </itemizedlist> The interceptor chain configured for your cache instance can be obtained and inspected by calling Modified: enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/basic_api.xml =================================================================== --- enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/basic_api.xml 2009-08-27 14:23:46 UTC (rev 8213) +++ enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/basic_api.xml 2009-08-31 01:48:16 UTC (rev 8214) @@ -1,3 +1,6 @@ +<?xml version='1.0'?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ +]> <chapter id="api"> <title>User API</title> <section> @@ -34,17 +37,17 @@ The <literal>CacheFactory</literal> provides a number of overloaded methods for creating a <literal>Cache</literal>, but they all fundamentally do the same thing: <itemizedlist> - <listitem> + <listitem><para> Gain access to a <literal>Configuration</literal>, either by having one passed in as a method parameter or by parsing XML content and constructing one. The XML content can come from a provided input stream, from a classpath or filesystem location. See the <xref linkend="configuration" /> - for more on obtaining a <literal>Configuration</literal>. + for more on obtaining a <literal>Configuration</literal>.</para> </listitem> - <listitem> - Instantiate the <literal>Cache</literal> and provide it with a reference to the <literal>Configuration</literal>. + <listitem><para> + Instantiate the <literal>Cache</literal> and provide it with a reference to the <literal>Configuration</literal>.</para> </listitem> - <listitem> - Optionally invoke the cache's <literal>create()</literal> and <literal>start()</literal> methods. + <listitem><para> + Optionally invoke the cache's <literal>create()</literal> and <literal>start()</literal> methods.</para> </listitem> </itemizedlist> </para> @@ -253,35 +256,35 @@ JBoss Cache modes are denoted by the <literal>org.jboss.cache.config.Configuration.CacheMode</literal> enumeration. They consist of: <itemizedlist> - <listitem> + <listitem><para> <emphasis>LOCAL</emphasis> - local, non-clustered cache. Local caches don't join a cluster and don't - communicate with other caches in a cluster. + communicate with other caches in a cluster.</para> </listitem> - <listitem> + <listitem><para> <emphasis>REPL_SYNC</emphasis> - synchronous replication. Replicated caches replicate all changes to the other caches in the cluster. Synchronous replication means that changes are replicated and the caller blocks - until replication acknowledgements are received. + until replication acknowledgements are received.</para> </listitem> - <listitem> + <listitem><para> <emphasis>REPL_ASYNC</emphasis> - asynchronous replication. Similar to REPL_SYNC above, replicated caches replicate all changes to the other caches in the cluster. Being asynchronous, the caller does not block until - replication acknowledgements are received. + replication acknowledgements are received.</para> </listitem> - <listitem> + <listitem><para> <emphasis>INVALIDATION_SYNC</emphasis> - if a cache is configured for invalidation rather than replication, every time data is changed in a cache other caches in the cluster receive a message informing them that their data is now stale and should be evicted from memory. This reduces replication overhead while still being able to invalidate stale data - on remote caches. + on remote caches.</para> </listitem> - <listitem> + <listitem><para> <emphasis>INVALIDATION_ASYNC</emphasis> - as above, except this invalidation mode causes invalidation messages - to be broadcast asynchronously. + to be broadcast asynchronously.</para> </listitem> </itemizedlist> </para> @@ -566,35 +569,35 @@ to perform 'warm starts', where in-memory state can be preloaded from persistent storage. JBoss Cache ships with a number of cache loader implementations. <itemizedlist> - <listitem> + <listitem><para> <literal>org.jboss.cache.loader.FileCacheLoader</literal> - a basic, filesystem based cache loader that persists data to disk. Non-transactional and not very - performant, but a very simple solution. Used mainly for testing and not recommended for production use. + performant, but a very simple solution. Used mainly for testing and not recommended for production use.</para> </listitem> - <listitem> + <listitem><para> <literal>org.jboss.cache.loader.JDBCCacheLoader</literal> - uses a JDBC connection to store data. Connections could be created and maintained in an internal pool (uses the c3p0 pooling library) or from a configured DataSource. The database this CacheLoader connects to could be local or remotely - located. + located.</para> </listitem> - <listitem> + <listitem><para> <literal>org.jboss.cache.loader.BdbjeCacheLoader</literal> - uses Oracle's BerkeleyDB file-based transactional database to persist data. Transactional and very - performant, but potentially restrictive license. + performant, but potentially restrictive license.</para> </listitem> - <listitem> + <listitem><para> <literal>org.jboss.cache.loader.JdbmCacheLoader</literal> - - an open source alternative to the BerkeleyDB. + - an open source alternative to the BerkeleyDB.</para> </listitem> - <listitem> + <listitem><para> <literal>org.jboss.cache.loader.tcp.TcpCacheLoader</literal> - - uses a TCP socket to "persist" data to a remote cluster, using <ulink url="http://www.jboss.org/community/docs/DOC-10292">a "far cache" pattern</ulink>. + - uses a TCP socket to "persist" data to a remote cluster, using <ulink url="http://www.jboss.org/community/docs/DOC-10292">a "far cache" pattern</ulink>.</para> </listitem> - <listitem> + <listitem><para> <literal>org.jboss.cache.loader.ClusteredCacheLoader</literal> - used as a "read-only" cache loader, where other nodes in the cluster are queried for state. Useful when full - state transfer is too expensive and it is preferred that state is lazily loaded. + state transfer is too expensive and it is preferred that state is lazily loaded.</para> </listitem> </itemizedlist> These cache loaders, along with advanced aspects and tuning issues, are discussed in the @@ -616,32 +619,32 @@ JBoss Cache ships with several eviction policies: <itemizedlist> - <listitem> + <listitem><para> <literal>org.jboss.cache.eviction.LRUPolicy</literal> - - an eviction policy that evicts the least recently used nodes when thresholds are hit. + - an eviction policy that evicts the least recently used nodes when thresholds are hit.</para> </listitem> - <listitem> + <listitem><para> <literal>org.jboss.cache.eviction.LFUPolicy</literal> - - an eviction policy that evicts the least frequently used nodes when thresholds are hit. + - an eviction policy that evicts the least frequently used nodes when thresholds are hit.</para> </listitem> - <listitem> + <listitem><para> <literal>org.jboss.cache.eviction.MRUPolicy</literal> - - an eviction policy that evicts the most recently used nodes when thresholds are hit. + - an eviction policy that evicts the most recently used nodes when thresholds are hit.</para> </listitem> - <listitem> + <listitem><para> <literal>org.jboss.cache.eviction.FIFOPolicy</literal> - an eviction policy that creates a first-in-first-out queue and evicts the oldest nodes when thresholds - are hit. + are hit.</para> </listitem> - <listitem> + <listitem><para> <literal>org.jboss.cache.eviction.ExpirationPolicy</literal> - an eviction policy that selects nodes for eviction based on an expiry time each node is configured - with. + with.</para> </listitem> - <listitem> + <listitem><para> <literal>org.jboss.cache.eviction.ElementSizePolicy</literal> - an eviction policy that selects nodes for eviction based on the number of key/value pairs held in the - node. + node.</para> </listitem> </itemizedlist> Detailed configuration and implementing custom eviction policies are discussed in the Modified: enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/cache_loaders.xml =================================================================== --- enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/cache_loaders.xml 2009-08-27 14:23:46 UTC (rev 8213) +++ enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/cache_loaders.xml 2009-08-31 01:48:16 UTC (rev 8214) @@ -1,3 +1,6 @@ +<?xml version='1.0'?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ +]> <chapter id="cache_loaders"> <title>Cache Loaders</title> <para>JBoss Cache can use a @@ -5,19 +8,19 @@ to back up the in-memory cache to a backend datastore. If JBoss Cache is configured with a cache loader, then the following features are provided: <itemizedlist> - <listitem>Whenever a cache element is accessed, and that element is not in + <listitem><para>Whenever a cache element is accessed, and that element is not in the cache (e.g. due to eviction or due to server restart), then the cache loader transparently loads the element into the cache if found in the backend - store. + store.</para> </listitem> - <listitem>Whenever an element is modified, added or removed, then that + <listitem><para>Whenever an element is modified, added or removed, then that modification is persisted in the backend store via the cache loader. If transactions are used, all modifications created within a transaction are persisted. To this end, the <literal>CacheLoader</literal> takes part in the two - phase commit protocol run by the transaction manager, although it does not do so explicitly. + phase commit protocol run by the transaction manager, although it does not do so explicitly.</para> </listitem> </itemizedlist> </para> @@ -469,27 +472,27 @@ <para> The FileCacheLoader has some severe limitations which restrict its use in a production environment, or if used in such an environment, it should be used with due care and sufficient - understanding of these limitations. + understanding of these limitations.</para> <itemizedlist> - <listitem>Due to the way the FileCacheLoader represents a tree structure on disk + <listitem><para>Due to the way the FileCacheLoader represents a tree structure on disk (directories and - files) traversal is inefficient for deep trees. + files) traversal is inefficient for deep trees.</para> </listitem> - <listitem>Usage on shared filesystems like NFS, Windows shares, etc. should be avoided as + <listitem><para>Usage on shared filesystems like NFS, Windows shares, etc. should be avoided as these do - not implement proper file locking and can cause data corruption. + not implement proper file locking and can cause data corruption.</para> </listitem> - <listitem>Usage with an isolation level of NONE can cause corrupt writes as multiple threads - attempt to write to the same file. + <listitem><para>Usage with an isolation level of NONE can cause corrupt writes as multiple threads + attempt to write to the same file.</para> </listitem> - <listitem>File systems are inherently not transactional, so when attempting to use your + <listitem><para>File systems are inherently not transactional, so when attempting to use your cache in a transactional context, failures when writing to the file (which happens during the commit phase) - cannot be recovered. + cannot be recovered.</para> </listitem> </itemizedlist> - +<para> As a rule of thumb, it is recommended that the FileCacheLoader not be used in a highly concurrent, transactional or stressful environment, and its use is restricted to testing. @@ -572,18 +575,18 @@ <para>The current implementation uses just one table. Each row in the table represents one node and contains three columns: <itemizedlist> - <listitem>column for + <listitem><para>column for <literal>Fqn</literal> (which is also a primary key - column) + column)</para> </listitem> - <listitem>column for node contents (attribute/value - pairs) + <listitem><para>column for node contents (attribute/value + pairs)</para> </listitem> - <listitem>column for parent - <literal>Fqn</literal> + <listitem><para>column for parent + <literal>Fqn</literal></para> </listitem> </itemizedlist> </para> @@ -625,59 +628,59 @@ <para>Table and column names as well as column types are configurable with the following properties. <itemizedlist> - <listitem> + <listitem><para> <emphasis>cache.jdbc.table.name</emphasis> - the name of the table. Can be prepended with schema name for the given table: <literal>{schema_name}.{table_name}</literal>. - The default value is 'jbosscache'. + The default value is 'jbosscache'.</para> </listitem> - <listitem> + <listitem><para> <emphasis>cache.jdbc.table.primarykey</emphasis> - the name of the primary key for the table. The default value is - 'jbosscache_pk'. + 'jbosscache_pk'.</para> </listitem> - <listitem> + <listitem><para> <emphasis>cache.jdbc.table.create</emphasis> - can be true or false. Indicates whether to create the table during startup. If true, the table is created if it doesn't already exist. The - default value is true. + default value is true.</para> </listitem> - <listitem> + <listitem><para> <emphasis>cache.jdbc.table.drop</emphasis> - can be true or false. Indicates whether to drop the table during shutdown. The - default value is true. + default value is true.</para> </listitem> - <listitem> + <listitem><para> <emphasis>cache.jdbc.fqn.column</emphasis> - FQN - column name. The default value is 'fqn'. + column name. The default value is 'fqn'.</para> </listitem> - <listitem> + <listitem><para> <emphasis>cache.jdbc.fqn.type</emphasis> - FQN column - type. The default value is 'varchar(255)'. + type. The default value is 'varchar(255)'.</para> </listitem> - <listitem> + <listitem><para> <emphasis>cache.jdbc.node.column</emphasis> - node - contents column name. The default value is 'node'. + contents column name. The default value is 'node'.</para> </listitem> - <listitem> + <listitem><para> <emphasis>cache.jdbc.node.type</emphasis> - node contents column type. The default value is 'blob'. This type must specify - a valid binary data type for the database being used. + a valid binary data type for the database being used.</para> </listitem> </itemizedlist> </para> @@ -690,12 +693,12 @@ application server) you can specify the JNDI name of the DataSource you want to use. <itemizedlist> - <listitem> + <listitem><para> <emphasis>cache.jdbc.datasource</emphasis> - JNDI name of the DataSource. The default value is <literal>java:/DefaultDS</literal> - . + .</para> </listitem> </itemizedlist> </para> @@ -710,28 +713,28 @@ the following properties to configure database access using a JDBC driver. <itemizedlist> - <listitem> + <listitem><para> <emphasis>cache.jdbc.driver</emphasis> - fully - qualified JDBC driver name. + qualified JDBC driver name.</para> </listitem> - <listitem> + <listitem><para> <emphasis>cache.jdbc.url</emphasis> - URL to connect - to the database. + to the database.</para> </listitem> - <listitem> + <listitem><para> <emphasis>cache.jdbc.user</emphasis> - user name to - connect to the database. + connect to the database.</para> </listitem> - <listitem> + <listitem><para> <emphasis>cache.jdbc.password</emphasis> - password to - connect to the database. + connect to the database.</para> </listitem> </itemizedlist> </para> @@ -745,13 +748,13 @@ the c3p0:JDBC DataSources/Resource Pools library. In order to enable it, just edit the following property: <itemizedlist> - <listitem> + <listitem><para> <emphasis>cache.jdbc.connection.factory</emphasis> - Connection factory class name. If not set, it defaults to standard non-pooled implementation. To enable c3p0 pooling, just set the - connection factory class for c3p0. See example below. + connection factory class for c3p0. See example below.</para> </listitem> </itemizedlist> </para> @@ -946,11 +949,11 @@ <scope>runtime</scope> </dependency> ]]> - </programlisting> + </programlisting><para> If you do not use Maven, you can still download the amazon-s3 library by navigating the repository or through <ulink url="http://e-xml.sourceforge.net/maven2/repository/net/noderunner/a... - this URL</ulink>. + this URL</ulink>.</para> </section> <section> @@ -962,21 +965,21 @@ <para> <itemizedlist> - <listitem> + <listitem><para> <literal>cache.s3.accessKeyId</literal> - - Amazon S3 Access Key, available from your account profile. + Amazon S3 Access Key, available from your account profile.</para> </listitem> - <listitem> + <listitem><para> <literal>cache.s3.secretAccessKey</literal> - Amazon S3 Secret Access Key, available from your account profile. As this is a password, be careful not to distribute it or include - this secret key in built software. + this secret key in built software.</para> </listitem> - <listitem> + <listitem><para> <literal>cache.s3.secure</literal> - The default is<literal>false</literal>: @@ -984,28 +987,28 @@ Set to <literal>true</literal> to use HTTPS. - Note that unencrypted uploads and downloads use less CPU. + Note that unencrypted uploads and downloads use less CPU.</para> </listitem> - <listitem> + <listitem><para> <literal>cache.s3.bucket</literal> - Name of the bucket to store data. For different caches using the same access key, use a different bucket name. Read the S3 documentation on the definition of a bucket. - The default value is<literal>jboss-cache</literal>. + The default value is<literal>jboss-cache</literal>.</para> </listitem> - <listitem> + <listitem><para> <literal>cache.s3.callingFormat</literal> - One of<literal>PATH</literal>,<literal>SUBDOMAIN</literal>, or <literal>VANITY</literal>. Read the S3 documentation on the use of calling domains. - The default value is<literal>SUBDOMAIN</literal>. + The default value is<literal>SUBDOMAIN</literal>.</para> </listitem> - <listitem> + <listitem><para> <literal>cache.s3.optimize</literal> - The default is<literal>false</literal>. @@ -1014,10 +1017,10 @@ operations replace the data stored at an Fqn rather than attempt to fetch and merge. (This option is fairly experimental - at the moment.) + at the moment.)</para> </listitem> - <listitem> + <listitem><para> <literal>cache.s3.parentCache</literal> - The default is<literal>true</literal>. @@ -1025,7 +1028,7 @@ <literal>false</literal> if you are using multiple caches sharing the same S3 bucket, that remove parent nodes of nodes being created - in other caches. (This is not a common use case.) + in other caches. (This is not a common use case.)</para> <para> JBoss Cache stores nodes in a tree format and automatically creates intermediate parent nodes as necessary. @@ -1040,7 +1043,7 @@ </para> </listitem> - <listitem> + <listitem><para> <literal>cache.s3.location</literal> - This choses a primary storage location for your data @@ -1049,7 +1052,7 @@ <literal>EU</literal> to store data in Europe. The default is<literal>null</literal>, to store data in - the United States. + the United States.</para> </listitem> </itemizedlist> </para> @@ -1263,12 +1266,12 @@ </para> <orderedlist> - <listitem>Insert /A</listitem> - <listitem>Insert /B</listitem> - <listitem>Eviction thread runs, evicts /A</listitem> - <listitem>Read /A</listitem> - <listitem>Eviction thread runs, evicts /B</listitem> - <listitem>Remove /B</listitem> + <listitem><para>Insert /A</para></listitem> + <listitem><para>Insert /B</para></listitem> + <listitem><para>Eviction thread runs, evicts /A</para></listitem> + <listitem><para>Read /A</para></listitem> + <listitem><para>Eviction thread runs, evicts /B</para></listitem> + <listitem><para>Remove /B</para></listitem> </orderedlist> <para>When passivation is disabled:</para> Modified: enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/configuration.xml =================================================================== --- enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/configuration.xml 2009-08-27 14:23:46 UTC (rev 8213) +++ enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/configuration.xml 2009-08-31 01:48:16 UTC (rev 8214) @@ -1,3 +1,6 @@ +<?xml version='1.0'?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ +]> <chapter id="configuration"> <title>Configuration</title> @@ -179,22 +182,22 @@ configurations associated with each component. <itemizedlist> - <listitem> + <listitem><para> <literal>Configuration</literal> : top level object in the hierarchy; exposes the configuration properties listed in the - <xref linkend="configuration_reference" /> section of this book. + <xref linkend="configuration_reference" /> section of this book.</para> </listitem> - <listitem> + <listitem><para> <literal>BuddyReplicationConfig</literal> : only relevant if <xref linkend="br" /> is used. General - buddy replication configuration options. Must include a: + buddy replication configuration options. Must include a:</para> </listitem> - <listitem> + <listitem><para> <literal>BuddyLocatorConfig</literal> : implementation-specific configuration object for the @@ -203,24 +206,24 @@ being used. What configuration elements are exposed depends on the needs of the <literal>BuddyLocator</literal> - implementation. + implementation.</para> </listitem> - <listitem> + <listitem><para> <literal>EvictionConfig</literal> : only relevant if <xref linkend="eviction_policies" /> is used. General - eviction configuration options. Must include at least one: + eviction configuration options. Must include at least one:</para> </listitem> - <listitem> + <listitem><para> <literal>EvictionRegionConfig</literal> : one for each - eviction region; names the region, etc. Must include a: + eviction region; names the region, etc. Must include a:</para> </listitem> - <listitem> + <listitem><para> <literal>EvictionAlgorithmConfig</literal> : implementation-specific configuration object for the @@ -229,18 +232,18 @@ being used. What configuration elements are exposed depends on the needs of the <literal>EvictionAlgorithm</literal> - implementation. + implementation.</para> </listitem> - <listitem> + <listitem><para> <literal>CacheLoaderConfig</literal> : only relevant if a <xref linkend="cache_loaders" /> is used. General - cache loader configuration options. Must include at least one: + cache loader configuration options. Must include at least one:</para> </listitem> - <listitem> + <listitem><para> <literal>IndividualCacheLoaderConfig</literal> : implementation-specific configuration object for the @@ -249,10 +252,10 @@ being used. What configuration elements are exposed depends on the needs of the <literal>CacheLoader</literal> - implementation. + implementation.</para> </listitem> - <listitem> + <listitem><para> <literal>RuntimeConfig</literal> : exposes to cache clients certain information about the cache's runtime environment (e.g. membership @@ -264,7 +267,7 @@ <literal>TransactionManager</literal> or a JGroups <literal>ChannelFactory</literal> - . + .</para> </listitem> </itemizedlist> </para> Modified: enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/configuration_reference.xml =================================================================== --- enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/configuration_reference.xml 2009-08-27 14:23:46 UTC (rev 8213) +++ enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/configuration_reference.xml 2009-08-31 01:48:16 UTC (rev 8214) @@ -1,3 +1,6 @@ +<?xml version='1.0'?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ +]> <chapter id="configuration_reference_chapter"> <title>Configuration References</title> <section id="sample_xml_file"> @@ -244,7 +247,7 @@ <tgroup cols="2" align="left"> <colspec colname="name" /> <colspec colname="desc" /> - <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> + <!-- <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> --> <thead valign="top"> <row> @@ -319,7 +322,7 @@ <colspec colname="c3" /> <colspec colname="c4" /> <colspec colname="c5" /> - <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> + <!-- <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> --> <thead valign="top"> <row><entry spanname="hspan"><literal><![CDATA[<jbosscache />]]></literal> Attributes</entry></row> <row> @@ -355,7 +358,7 @@ <tgroup cols="2" align="left"> <colspec colname="name" /> <colspec colname="desc" /> - <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> + <!-- <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> --> <thead valign="top"> <row> @@ -417,7 +420,7 @@ <colspec colname="c4" /> <colspec colname="c5" /> - <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> + <!-- <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> --> <thead valign="top"> <row><entry spanname="hspan"><literal><![CDATA[<locking />]]></literal> Attributes</entry></row> <row> @@ -510,7 +513,7 @@ <tgroup cols="2" align="left"> <colspec colname="name" /> <colspec colname="desc" /> - <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> + <!-- <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> --> <thead valign="top"> <row> @@ -572,7 +575,7 @@ <colspec colname="c4" /> <colspec colname="c5" /> - <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> + <!-- <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> --> <thead valign="top"> <row><entry spanname="hspan"><literal><![CDATA[<transaction />]]></literal> Attributes</entry></row> <row> @@ -630,7 +633,7 @@ <tgroup cols="2" align="left"> <colspec colname="name" /> <colspec colname="desc" /> - <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> + <!-- <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> --> <thead valign="top"> <row> @@ -692,7 +695,7 @@ <colspec colname="c4" /> <colspec colname="c5" /> - <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> + <!-- <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> --> <thead valign="top"> <row><entry spanname="hspan"><literal><![CDATA[<jmxStatistics />]]></literal> Attributes</entry></row> <row> @@ -723,7 +726,7 @@ <tgroup cols="2" align="left"> <colspec colname="name" /> <colspec colname="desc" /> - <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> + <!-- <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> --> <thead valign="top"> <row> @@ -785,7 +788,7 @@ <colspec colname="c4" /> <colspec colname="c5" /> - <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> + <!-- <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> --> <thead valign="top"> <row><entry spanname="hspan"><literal><![CDATA[<startup />]]></literal> Attributes</entry></row> <row> @@ -817,7 +820,7 @@ <tgroup cols="2" align="left"> <colspec colname="name" /> <colspec colname="desc" /> - <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> + <!-- <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> --> <thead valign="top"> <row> @@ -879,7 +882,7 @@ <colspec colname="c4" /> <colspec colname="c5" /> - <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> + <!-- <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> --> <thead valign="top"> <row><entry spanname="hspan"><literal><![CDATA[<shutdown />]]></literal> Attributes</entry></row> <row> @@ -916,7 +919,7 @@ <tgroup cols="2" align="left"> <colspec colname="name" /> <colspec colname="desc" /> - <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> + <!-- <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> --> <thead valign="top"> <row> @@ -978,7 +981,7 @@ <colspec colname="c4" /> <colspec colname="c5" /> - <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> + <!-- <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> --> <thead valign="top"> <row><entry spanname="hspan"><literal><![CDATA[<listeners />]]></literal> Attributes</entry></row> <row> @@ -1026,7 +1029,7 @@ <tgroup cols="2" align="left"> <colspec colname="name" /> <colspec colname="desc" /> - <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> + <!-- <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> --> <thead valign="top"> <row> @@ -1088,7 +1091,7 @@ <colspec colname="c4" /> <colspec colname="c5" /> - <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> + <!-- <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> --> <thead valign="top"> <row><entry spanname="hspan"><literal><![CDATA[<invocationBatching />]]></literal> Attributes</entry></row> <row> @@ -1122,7 +1125,7 @@ <tgroup cols="2" align="left"> <colspec colname="name" /> <colspec colname="desc" /> - <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> + <!-- <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> --> <thead valign="top"> <row> @@ -1184,7 +1187,7 @@ <colspec colname="c4" /> <colspec colname="c5" /> - <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> + <!-- <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> --> <thead valign="top"> <row><entry spanname="hspan"><literal><![CDATA[<serialization />]]></literal> Attributes</entry></row> <row> @@ -1275,7 +1278,7 @@ <tgroup cols="2" align="left"> <colspec colname="name" /> <colspec colname="desc" /> - <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> + <!-- <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> --> <thead valign="top"> <row> @@ -1340,7 +1343,7 @@ <colspec colname="c4" /> <colspec colname="c5" /> - <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> + <!-- <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> --> <thead valign="top"> <row><entry spanname="hspan"><literal><![CDATA[<eviction />]]></literal> Attributes</entry></row> <row> @@ -1374,7 +1377,7 @@ <tgroup cols="2" align="left"> <colspec colname="name" /> <colspec colname="desc" /> - <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> + <!-- <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> --> <thead valign="top"> <row> @@ -1438,7 +1441,7 @@ <colspec colname="c4" /> <colspec colname="c5" /> - <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> + <!-- <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> --> <thead valign="top"> <row><entry spanname="hspan"><literal><![CDATA[<default />]]></literal> Attributes</entry></row> <row> @@ -1491,7 +1494,7 @@ <tgroup cols="2" align="left"> <colspec colname="name" /> <colspec colname="desc" /> - <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> + <!-- <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> --> <thead valign="top"> <row> @@ -1556,7 +1559,7 @@ <colspec colname="c4" /> <colspec colname="c5" /> - <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> + <!-- <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> --> <thead valign="top"> <row><entry spanname="hspan"><literal><![CDATA[<region />]]></literal> Attributes</entry></row> <row> @@ -1619,7 +1622,7 @@ <tgroup cols="2" align="left"> <colspec colname="name" /> <colspec colname="desc" /> - <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> + <!-- <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> --> <thead valign="top"> <row> @@ -1683,7 +1686,7 @@ <colspec colname="c4" /> <colspec colname="c5" /> - <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> + <!-- <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> --> <thead valign="top"> <row><entry spanname="hspan"><literal><![CDATA[<property />]]></literal> Attributes</entry></row> <row> @@ -1723,7 +1726,7 @@ <tgroup cols="2" align="left"> <colspec colname="name" /> <colspec colname="desc" /> - <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> + <!-- <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> --> <thead valign="top"> <row> @@ -1788,7 +1791,7 @@ <colspec colname="c4" /> <colspec colname="c5" /> - <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> + <!-- <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> --> <thead valign="top"> <row><entry spanname="hspan"><literal><![CDATA[<loaders />]]></literal> Attributes</entry></row> <row> @@ -1830,7 +1833,7 @@ <tgroup cols="2" align="left"> <colspec colname="name" /> <colspec colname="desc" /> - <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> + <!-- <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> --> <thead valign="top"> <row> @@ -1890,7 +1893,7 @@ <tgroup cols="2" align="left"> <colspec colname="name" /> <colspec colname="desc" /> - <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> + <!-- <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> --> <thead valign="top"> <row> @@ -1954,7 +1957,7 @@ <colspec colname="c4" /> <colspec colname="c5" /> - <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> + <!-- <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> --> <thead valign="top"> <row><entry spanname="hspan"><literal><![CDATA[<node />]]></literal> Attributes</entry></row> <row> @@ -1987,7 +1990,7 @@ <tgroup cols="2" align="left"> <colspec colname="name" /> <colspec colname="desc" /> - <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> + <!-- <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> --> <thead valign="top"> <row> @@ -2053,7 +2056,7 @@ <colspec colname="c4" /> <colspec colname="c5" /> - <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> + <!-- <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> --> <thead valign="top"> <row><entry spanname="hspan"><literal><![CDATA[<loader />]]></literal> Attributes</entry></row> <row> @@ -2118,7 +2121,7 @@ <tgroup cols="2" align="left"> <colspec colname="name" /> <colspec colname="desc" /> - <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> + <!-- <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> --> <thead valign="top"> <row> @@ -2180,7 +2183,7 @@ <tgroup cols="2" align="left"> <colspec colname="name" /> <colspec colname="desc" /> - <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> + <!-- <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> --> <thead valign="top"> <row> @@ -2244,7 +2247,7 @@ <colspec colname="c4" /> <colspec colname="c5" /> - <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> + <!-- <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> --> <thead valign="top"> <row><entry spanname="hspan"><literal><![CDATA[<singletonStore />]]></literal> Attributes</entry></row> <row> @@ -2285,7 +2288,7 @@ <tgroup cols="2" align="left"> <colspec colname="name" /> <colspec colname="desc" /> - <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> + <!-- <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> --> <thead valign="top"> <row> @@ -2346,7 +2349,7 @@ <tgroup cols="2" align="left"> <colspec colname="name" /> <colspec colname="desc" /> - <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> + <!-- <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> --> <thead valign="top"> <row> @@ -2373,7 +2376,7 @@ <entry> <para> - <xref linkend="element.customInterceptor" /> + <xref linkend="element.customInterceptors" /> </para> </entry> </row> @@ -2411,7 +2414,7 @@ <colspec colname="c4" /> <colspec colname="c5" /> - <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> + <!-- <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> --> <thead valign="top"> <row><entry spanname="hspan"><literal><![CDATA[<interceptor />]]></literal> Attributes</entry></row> <row> @@ -2491,7 +2494,7 @@ <tgroup cols="2" align="left"> <colspec colname="name" /> <colspec colname="desc" /> - <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> + <!-- <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> --> <thead valign="top"> <row> @@ -2560,7 +2563,7 @@ <colspec colname="c4" /> <colspec colname="c5" /> - <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> + <!-- <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> --> <thead valign="top"> <row><entry spanname="hspan"><literal><![CDATA[<clustering />]]></literal> Attributes</entry></row> <row> @@ -2603,7 +2606,7 @@ <tgroup cols="2" align="left"> <colspec colname="name" /> <colspec colname="desc" /> - <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> + <!-- <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> --> <thead valign="top"> <row> @@ -2669,7 +2672,7 @@ <colspec colname="c4" /> <colspec colname="c5" /> - <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> + <!-- <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> --> <thead valign="top"> <row><entry spanname="hspan"><literal><![CDATA[<sync />]]></literal> Attributes</entry></row> <row> @@ -2701,7 +2704,8 @@ <tgroup cols="2" align="left"> <colspec colname="name" /> <colspec colname="desc" /> - <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> + <!-- <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> --> + <thead valign="top"> <row> @@ -2767,7 +2771,7 @@ <colspec colname="c4" /> <colspec colname="c5" /> - <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> + <!-- <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> --> <thead valign="top"> <row><entry spanname="hspan"><literal><![CDATA[<async />]]></literal> Attributes</entry></row> <row> @@ -2842,7 +2846,7 @@ <tgroup cols="2" align="left"> <colspec colname="name" /> <colspec colname="desc" /> - <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> + <!-- <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> --> <thead valign="top"> <row> @@ -2905,7 +2909,7 @@ <colspec colname="c4" /> <colspec colname="c5" /> - <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> + <!-- <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> --> <thead valign="top"> <row><entry spanname="hspan"><literal><![CDATA[<stateRetrieval />]]></literal> Attributes</entry></row> <row> @@ -2958,7 +2962,7 @@ <tgroup cols="2" align="left"> <colspec colname="name" /> <colspec colname="desc" /> - <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> + <!-- <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> --> <thead valign="top"> <row> @@ -3026,7 +3030,7 @@ <colspec colname="c4" /> <colspec colname="c5" /> - <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> + <!-- <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> --> <thead valign="top"> <row><entry spanname="hspan"><literal><![CDATA[<buddy />]]></literal> Attributes</entry></row> <row> @@ -3077,7 +3081,7 @@ <tgroup cols="2" align="left"> <colspec colname="name" /> <colspec colname="desc" /> - <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> + <!-- <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> --> <thead valign="top"> <row> @@ -3141,7 +3145,7 @@ <colspec colname="c4" /> <colspec colname="c5" /> - <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> + <!-- <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> --> <thead valign="top"> <row><entry spanname="hspan"><literal><![CDATA[<dataGravitation />]]></literal> Attributes</entry></row> <row> @@ -3195,7 +3199,7 @@ <tgroup cols="2" align="left"> <colspec colname="name" /> <colspec colname="desc" /> - <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> + <!-- <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> --> <thead valign="top"> <row> @@ -3259,7 +3263,7 @@ <colspec colname="c4" /> <colspec colname="c5" /> - <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> + <!-- <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> --> <thead valign="top"> <row><entry spanname="hspan"><literal><![CDATA[<locator />]]></literal> Attributes</entry></row> <row> @@ -3291,7 +3295,7 @@ <tgroup cols="2" align="left"> <colspec colname="name" /> <colspec colname="desc" /> - <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> + <!-- <spanspec spanname="hspan" namest="name" nameend="desc" align="left" /> --> <thead valign="top"> <row> @@ -3359,7 +3363,7 @@ <colspec colname="c4" /> <colspec colname="c5" /> - <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> + <!-- <spanspec spanname="hspan" namest="c1" nameend="c5" align="left" /> --> <thead valign="top"> <row><entry spanname="hspan"><literal><![CDATA[<jgroupsConfig />]]></literal> Attributes</entry></row> <row> Modified: enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/deployment.xml =================================================================== --- enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/deployment.xml 2009-08-27 14:23:46 UTC (rev 8213) +++ enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/deployment.xml 2009-08-31 01:48:16 UTC (rev 8214) @@ -1,3 +1,6 @@ +<?xml version='1.0'?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ +]> <chapter id="deployment"> <title>Deploying JBoss Cache</title> <section id="deployment.standalone"> @@ -180,19 +183,19 @@ It is a StandardMBean, so its MBean interface is <literal>org.jboss.cache.jmx.CacheJmxWrapperMBean</literal>. This MBean can be used to: <itemizedlist> - <listitem> - Get a reference to the underlying <literal>Cache</literal>. + <listitem><para> + Get a reference to the underlying <literal>Cache</literal>.</para> </listitem> - <listitem> - Invoke create/start/stop/destroy lifecycle operations on the underlying <literal>Cache</literal>. + <listitem><para> + Invoke create/start/stop/destroy lifecycle operations on the underlying <literal>Cache</literal>.</para> </listitem> - <listitem> - Inspect various details about the cache's current state (number of nodes, lock information, etc.) + <listitem><para> + Inspect various details about the cache's current state (number of nodes, lock information, etc.)</para> </listitem> - <listitem> + <listitem><para> See numerous details about the cache's configuration, and change those configuration items that can be changed when the - cache has already been started. + cache has already been started.</para> </listitem> </itemizedlist> See the <literal>CacheJmxWrapperMBean</literal> javadoc for more details. @@ -518,17 +521,17 @@ </para> <para> <orderedlist> - <listitem> + <listitem><para> Set the system property <literal>-Dcom.sun.management.jmxremote</literal> - when starting the JVM where the cache will run. + when starting the JVM where the cache will run.</para> </listitem> - <listitem> + <listitem><para> Once the JVM is running, start the <literal>jconsole</literal> utility, located in your JDK's - <literal>/bin</literal> directory. + <literal>/bin</literal> directory.</para> </listitem> - <listitem> + <listitem><para> When the utility loads, you will be able to select your running JVM and connect to it. The - JBoss Cache MBeans will be available on the MBeans panel. + JBoss Cache MBeans will be available on the MBeans panel.</para> </listitem> </orderedlist> </para> Modified: enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/eviction_policies.xml =================================================================== --- enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/eviction_policies.xml 2009-08-27 14:23:46 UTC (rev 8213) +++ enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/eviction_policies.xml 2009-08-31 01:48:16 UTC (rev 8214) @@ -1,3 +1,6 @@ +<?xml version='1.0'?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ +]> <chapter id="eviction_policies"> <title>Eviction</title> @@ -12,10 +15,10 @@ <para> Eviction in JBoss Cache is designed around four concepts: <itemizedlist> - <listitem>1. Collecting statistics</listitem> - <listitem>2. Determining which nodes to evict</listitem> - <listitem>3. How nodes are evicted</listitem> - <listitem>4. Eviction threads.</listitem> + <listitem><para>1. Collecting statistics</para></listitem> + <listitem><para>2. Determining which nodes to evict</para></listitem> + <listitem><para>3. How nodes are evicted</para></listitem> + <listitem><para>4. Eviction threads.</para></listitem> </itemizedlist> In addition, Regions play a key role in eviction, as eviction is always configured on a per-region basis so that different subtrees in the cache can have different eviction characteristics. @@ -186,26 +189,26 @@ ]]></programlisting> <para> <itemizedlist> - <listitem> + <listitem><para> <literal>wakeUpInterval</literal> - - this required parameter defines how often the eviction thread runs, in milliseconds. + - this required parameter defines how often the eviction thread runs, in milliseconds.</para> </listitem> - <listitem> + <listitem><para> <literal>eventQueueSize</literal> - this optional parameter defines the size of the bounded queue which holds eviction events. If your eviction thread does not run often enough, you may find that the event queue fills up. It may then be necessary to get your eviction thread to run more frequently, or increase the size of your event queue. This configuration is just the <emphasis>default</emphasis> event queue size, and can be overridden - in specific eviction regions. If not specified, this defaults to <literal>200000</literal>. + in specific eviction regions. If not specified, this defaults to <literal>200000</literal>.</para> </listitem> - <listitem> + <listitem><para> <literal>algorithmClass</literal> - this is required, unless you set individual <literal>algorithmClass</literal> attributes on each and every region. This - defines the default eviction algorithm to use if one is not defined for a region. + defines the default eviction algorithm to use if one is not defined for a region.</para> </listitem> - <listitem> + <listitem><para> Algorithm configuration attributes - these are specific to the algorithm specified in <literal>algorithmClass</literal>. - See the section specific to the algorithm you are interested in for details. + See the section specific to the algorithm you are interested in for details.</para> </listitem> </itemizedlist> </para> @@ -257,9 +260,9 @@ <section id="eviction.shipped"> <title>Shipped Eviction Policies</title> - +<para> This section details the different algorithms shipped with JBoss Cache, and the various configuration parameters - used for each algorithm. + used for each algorithm.</para> <section> <title>LRUAlgorithm - Least Recently Used</title> @@ -274,26 +277,26 @@ </para> <itemizedlist> - <listitem> + <listitem><para> <literal>maxNodes</literal> - - This is the maximum number of nodes allowed in this region. 0 denotes immediate expiry, -1 denotes no limit. + - This is the maximum number of nodes allowed in this region. 0 denotes immediate expiry, -1 denotes no limit.</para> </listitem> - <listitem> + <listitem><para> <literal>timeToLive</literal> - The amount of time a node is not written to or read (in milliseconds) before the node is swept away. 0 - denotes immediate expiry, -1 denotes no limit. + denotes immediate expiry, -1 denotes no limit.</para> </listitem> - <listitem> + <listitem><para> <literal>maxAge</literal> - Lifespan of a node (in milliseconds) regardless of idle time before the node is swept away. 0 - denotes immediate expiry, -1 denotes no limit. + denotes immediate expiry, -1 denotes no limit.</para> </listitem> - <listitem> + <listitem><para> <literal>minTimeToLive</literal> - the minimum amount of time 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. + be considered for eviction. 0 denotes that this feature is disabled, which is the default value.</para> </listitem> </itemizedlist> </section> @@ -311,14 +314,14 @@ </para> <itemizedlist> - <listitem> + <listitem><para> <literal>maxNodes</literal> - - This is the maximum number of nodes allowed in this region. 0 denotes immediate expiry, -1 denotes no limit. + - This is the maximum number of nodes allowed in this region. 0 denotes immediate expiry, -1 denotes no limit.</para> </listitem> - <listitem> + <listitem><para> <literal>minTimeToLive</literal> - the minimum amount of time 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. + be considered for eviction. 0 denotes that this feature is disabled, which is the default value.</para> </listitem> </itemizedlist> </section> @@ -339,15 +342,15 @@ </para> <itemizedlist> - <listitem> + <listitem><para> <literal>maxNodes</literal> - This is the maximum number of nodes allowed in this region. 0 - denotes immediate expiry, -1 denotes no limit. + denotes immediate expiry, -1 denotes no limit.</para> </listitem> - <listitem> + <listitem><para> <literal>minTimeToLive</literal> - the minimum amount of time 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. + be considered for eviction. 0 denotes that this feature is disabled, which is the default value.</para> </listitem> </itemizedlist> </section> @@ -380,24 +383,24 @@ </para> <itemizedlist> - <listitem> + <listitem><para> <literal>maxNodes</literal> - This is the maximum number of nodes allowed in this region. 0 - denotes immediate expiry, -1 denotes no limit. + denotes immediate expiry, -1 denotes no limit.</para> </listitem> - <listitem> + <listitem><para> <literal>minNodes</literal> - 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. + algorithm.</para> </listitem> - <listitem> + <listitem><para> <literal>minTimeToLive</literal> - the minimum amount of time 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. + be considered for eviction. 0 denotes that this feature is disabled, which is the default value.</para> </listitem> </itemizedlist> @@ -436,17 +439,17 @@ </para> <itemizedlist> - <listitem> + <listitem><para> <literal>expirationKeyName</literal> - This is the Node key name used in the eviction algorithm. The configuration default is <literal>expiration</literal> - . + .</para> </listitem> - <listitem> + <listitem><para> <literal>maxNodes</literal> - This is the maximum number of nodes allowed in this region. 0 - denotes immediate expiry, -1 denotes no limit. + denotes immediate expiry, -1 denotes no limit.</para> </listitem> </itemizedlist> @@ -487,20 +490,20 @@ </para> <itemizedlist> - <listitem> + <listitem><para> <literal>maxNodes</literal> - This is the maximum number of nodes allowed in this region. 0 - denotes immediate expiry, -1 denotes no limit. + denotes immediate expiry, -1 denotes no limit.</para> </listitem> - <listitem> + <listitem><para> <literal>maxElementsPerNode</literal> - This is the trigger number of attributes per node for the node to be selected for eviction. 0 - denotes immediate expiry, -1 denotes no limit. + denotes immediate expiry, -1 denotes no limit.</para> </listitem> - <listitem> + <listitem><para> <literal>minTimeToLive</literal> - the minimum amount of time 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. + be considered for eviction. 0 denotes that this feature is disabled, which is the default value.</para> </listitem> </itemizedlist> </section> Modified: enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/introduction.xml =================================================================== --- enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/introduction.xml 2009-08-27 14:23:46 UTC (rev 8213) +++ enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/introduction.xml 2009-08-31 01:48:16 UTC (rev 8214) @@ -1,4 +1,6 @@ -<?xml version="1.0" encoding="UTF-8"?> +<?xml version='1.0'?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ +]> <chapter id="introduction"> <title>Overview</title> @@ -32,9 +34,9 @@ <para> POJO Cache is an extension of the core JBoss Cache API. POJO Cache offers additional functionality such as: <itemizedlist> - <listitem>maintaining object references even after replication or persistence.</listitem> - <listitem>fine grained replication, where only modified object fields are replicated.</listitem> - <listitem>"API-less" clustering model where POJOs are simply annotated as being clustered.</listitem> + <listitem><para>maintaining object references even after replication or persistence.</para></listitem> + <listitem><para>fine grained replication, where only modified object fields are replicated.</para></listitem> + <listitem><para>"API-less" clustering model where POJOs are simply annotated as being clustered.</para></listitem> </itemizedlist> </para> <para> @@ -56,19 +58,19 @@ JBoss Cache offers a simple and straightforward API, where data - simple Java objects - can be placed in the cache. Based on configuration options selected, this data may be one or all of: <itemizedlist> - <listitem>cached in-memory for efficient, thread-safe retrieval.</listitem> - <listitem>replicated to some or all cache instances in a cluster.</listitem> - <listitem>persisted to disk and/or a remote, in-memory cache cluster ("far-cache").</listitem> - <listitem>garbage collected from memory when memory runs low, and passivated to disk so state isn't lost. + <listitem><para>cached in-memory for efficient, thread-safe retrieval.</para></listitem> + <listitem><para>replicated to some or all cache instances in a cluster.</para></listitem> + <listitem><para>persisted to disk and/or a remote, in-memory cache cluster ("far-cache").</para></listitem> + <listitem><para>garbage collected from memory when memory runs low, and passivated to disk so state isn't lost.</para> </listitem> </itemizedlist> In addition, JBoss Cache offers a rich set of enterprise-class features: <itemizedlist> - <listitem>being able to participate in <ulink url="http://java.sun.com/products/jta">JTA</ulink> transactions - (works with most Java EE compliant transaction managers).</listitem> - <listitem>attach to JMX consoles and provide runtime statistics on the state of the cache.</listitem> - <listitem>allow client code to attach listeners and receive notifications on cache events.</listitem> - <listitem>allow grouping of cache operations into batches, for efficient replication</listitem> + <listitem><para>being able to participate in <ulink url="http://java.sun.com/products/jta">JTA</ulink> transactions + (works with most Java EE compliant transaction managers).</para></listitem> + <listitem><para>attach to JMX consoles and provide runtime statistics on the state of the cache.</para></listitem> + <listitem><para>allow client code to attach listeners and receive notifications on cache events.</para></listitem> + <listitem><para>allow grouping of cache operations into batches, for efficient replication</para></listitem> </itemizedlist> </para> </section> Modified: enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/replication.xml =================================================================== --- enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/replication.xml 2009-08-27 14:23:46 UTC (rev 8213) +++ enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/replication.xml 2009-08-31 01:48:16 UTC (rev 8214) @@ -1,4 +1,6 @@ -<?xml version="1.0" encoding="UTF-8"?> +<?xml version='1.0'?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ +]> <chapter id="clustering"> <title>Cache Modes and Clustering</title> @@ -191,16 +193,16 @@ takes in 2 parameters, both optional. <itemizedlist> - <listitem> + <listitem><para> <literal>numBuddies</literal> - specifies how many buddies each instance should pick to back its data onto. This defaults to - 1. + 1.</para> </listitem> - <listitem> + <listitem><para> <literal>ignoreColocatedBuddies</literal> @@ -214,7 +216,7 @@ <literal>true</literal> - . + .</para> </listitem> </itemizedlist> </para> @@ -288,7 +290,7 @@ following (all optional) configuration properties pertain to data gravitation. <itemizedlist> - <listitem> + <listitem><para> <literal>dataGravitationRemoveOnFind</literal> @@ -304,10 +306,10 @@ <literal>true</literal> - . + .</para> </listitem> - <listitem> + <listitem><para> <literal>dataGravitationSearchBackupTrees</literal> @@ -320,10 +322,10 @@ <literal>true</literal> - then backup nodes can respond to data gravitation requests in addition to data owners. + then backup nodes can respond to data gravitation requests in addition to data owners.</para> </listitem> - <listitem> + <listitem><para> <literal>autoDataGravitation</literal> @@ -349,7 +351,7 @@ <literal>Option</literal> - is unnecessary. + is unnecessary.</para> </listitem> </itemizedlist> </para> @@ -357,8 +359,8 @@ <section> <title>Configuration</title> - - See the <xref linkend="configuration_reference_chapter" /> for details on configuring buddy replication. +<para> + See the <xref linkend="configuration_reference_chapter" /> for details on configuring buddy replication.</para> </section> </section> </section> Modified: enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/transactions.xml =================================================================== --- enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/transactions.xml 2009-08-27 14:23:46 UTC (rev 8213) +++ enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/transactions.xml 2009-08-31 01:48:16 UTC (rev 8214) @@ -1,3 +1,6 @@ +<?xml version='1.0'?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ +]> <chapter id="transactions"> <title>Transactions and Concurrency</title> <section id="transactions.concurrent"> @@ -19,11 +22,12 @@ <section id="mvcc.concepts"> <title>MVCC Concepts</title> <para> - MVCC is designed to provide the following features for concurrent access: + MVCC is designed to provide the following features for concurrent access:</para> <itemizedlist> - <listitem>Readers that don't block writers</listitem> - <listitem>Writers that fail fast</listitem> + <listitem><para>Readers that don't block writers</para></listitem> + <listitem><para>Writers that fail fast</para></listitem> </itemizedlist> + <para> and achieves this by using data versioning and copying for concurrent writers. The theory is that readers continue reading shared state, while writers copy the shared state, increment a version id, and write that shared state back after verifying that the version is still valid (i.e., another concurrent writer has not @@ -37,12 +41,12 @@ <section id="mvcc.impl"> <title>MVCC Implementation</title> <para> - JBoss Cache's implementation of MVCC is based on a few features: + JBoss Cache's implementation of MVCC is based on a few features:</para> <itemizedlist> - <listitem>Readers don't acquire any locks</listitem> - <listitem>Only one additional version is maintained for shared state, for a single writer</listitem> - <listitem>All writes happen sequentially, to provide fail-fast semantics</listitem> - </itemizedlist> + <listitem><para>Readers don't acquire any locks</para></listitem> + <listitem><para>Only one additional version is maintained for shared state, for a single writer</para></listitem> + <listitem><para>All writes happen sequentially, to provide fail-fast semantics</para></listitem> + </itemizedlist><para> The extremely high performance of JBoss Cache's MVCC implementation for reading threads is achieved by not requiring any synchronization or locking for readers. For each reader thread, the <literal>MVCCLockingInterceptor</literal> wraps state in a lightweight container object, which is placed @@ -131,13 +135,13 @@ <para> <itemizedlist> - <listitem><literal>nodeLockingScheme</literal> - the node locking scheme used. Defaults to MVCC if + <listitem><para><literal>nodeLockingScheme</literal> - the node locking scheme used. Defaults to MVCC if not provided, deprecated schemes such as <literal>pessimistic</literal> or <literal>optimistic</literal> - may be used but is not encouraged.</listitem> - <listitem><literal>isolationLevel</literal> - transaction isolation level. Defaults to REPEATABLE_READ if not provided.</listitem> - <listitem><literal>writeSkewCheck</literal> - defaults to <literal>true</literal> if not provided.</listitem> - <listitem><literal>concurrencyLevel</literal> - defaults to 500 if not provided.</listitem> - <listitem><literal>lockAcquisitionTimeout</literal> - only applies to writers when using MVCC. Defaults to 10000 if not provided.</listitem> + may be used but is not encouraged.</para></listitem> + <listitem><para><literal>isolationLevel</literal> - transaction isolation level. Defaults to REPEATABLE_READ if not provided.</para></listitem> + <listitem><para><literal>writeSkewCheck</literal> - defaults to <literal>true</literal> if not provided.</para></listitem> + <listitem><para><literal>concurrencyLevel</literal> - defaults to 500 if not provided.</para></listitem> + <listitem><para><literal>lockAcquisitionTimeout</literal> - only applies to writers when using MVCC. Defaults to 10000 if not provided.</para></listitem> </itemizedlist> </para> </section>