[jboss-cvs] JBossCache/docs/TreeCache/en/modules ...
Manik Surtani
msurtani at jboss.com
Tue Nov 28 23:12:18 EST 2006
User: msurtani
Date: 06/11/28 23:12:18
Modified: docs/TreeCache/en/modules configuration.xml
Log:
JBCACHE-878
Revision Changes Path
1.13 +606 -547 JBossCache/docs/TreeCache/en/modules/configuration.xml
(In the diff below, changes in quantity of whitespace are not shown.)
Index: configuration.xml
===================================================================
RCS file: /cvsroot/jboss/JBossCache/docs/TreeCache/en/modules/configuration.xml,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -b -r1.12 -r1.13
--- configuration.xml 29 Nov 2006 04:02:48 -0000 1.12
+++ configuration.xml 29 Nov 2006 04:12:18 -0000 1.13
@@ -1,9 +1,11 @@
- <chapter id="configuration">
+<chapter id="configuration">
<title>Configuration</title>
<para>All properties of the cache are configured via setters and can be
retrieved via getters. This can be done either manually, or via the
- <literal>PropertyConfigurator</literal> and an XML file.</para>
+ <literal>PropertyConfigurator</literal>
+ and an XML file.
+ </para>
<section>
<title>Sample XML-Based Configuration</title>
<para>
@@ -11,7 +13,7 @@
below:
</para>
<programlisting><?xml version="1.0" encoding="UTF-8" ?>
-<server>
+ <server>~/
<classpath codebase="./lib" archives="jboss-cache.jar, jgroups.jar" />
<!-- ==================================================================== -->
@@ -188,19 +190,21 @@
</mbean>
-</server> </programlisting>
+ </server> </programlisting>
<para>The PropertyConfigurator.configure() method needs to have as
argument a filename which is located on the classpath; it will use be used
to configure JBoss Cache from the properties defined in it. Note that
this configuration file is used to configure JBoss Cache both as a
standalone cache, and as an MBean if run inside the JBoss
- container.<footnote>
+ container.
+ <footnote>
<para>We will switch to using an XMBean in a future release.</para>
- </footnote></para>
-</section>
+ </footnote>
+ </para>
+ </section>
-<section>
+ <section>
<title>
Definition of XML attributes
</title>
@@ -225,7 +229,8 @@
<entry>
<para>An XML element that contains detailed buddy replication
- configuration. See section above on Buddy Replication.</para>
+ configuration. See section above on Buddy Replication.
+ </para>
</entry>
</row>
@@ -236,7 +241,8 @@
<entry>
<para>An XML element that contains detailed cache loader
- configuration. See section above on Cache Loaders.</para>
+ configuration. See section above on Cache Loaders.
+ </para>
</entry>
</row>
@@ -247,7 +253,8 @@
<entry>
<para>LOCAL, REPL_SYNC, REPL_ASYNC, INVALIDATION_SYNC or
- INVALIDATION_ASYNC</para>
+ INVALIDATION_ASYNC
+ </para>
</entry>
</row>
@@ -258,7 +265,8 @@
<entry>
<para>Name of cluster. Needs to be the same for all nodes in a
- cluster in order to find each other.</para>
+ cluster in order to find each other.
+ </para>
</entry>
</row>
@@ -285,7 +293,8 @@
<para>The name of the JGroups stack to be used with the TreeCache cluster.
Stacks are defined in jgroups-multiplexer.sar\META-INF\multiplexer-stacks.xml.
The default stack is fc-fast-minimalthreads. This attribute is used in conjunction with
- MultiplexerService.</para>
+ MultiplexerService.
+ </para>
</entry>
</row>
@@ -297,7 +306,8 @@
<entry>
<para>The configuration of the underlying JGroups stack. See
cluster-service.xml for an example. This attribute isn't used when
- MultiplexerService is defined.</para>
+ MultiplexerService is defined.
+ </para>
</entry>
</row>
@@ -308,7 +318,8 @@
<entry>
<para>The name of a class implementing EvictionPolicy. If empty,
- no eviction policy is enabled.</para>
+ no eviction policy is enabled.
+ </para>
</entry>
</row>
@@ -319,21 +330,24 @@
<entry>
<para>Configuration parameter for the specified eviction policy.
- Note that the content is provider specific.</para>
+ Note that the content is provider specific.
+ </para>
</entry>
</row>
<row>
<entry>
<para>FetchInMemoryState (renamed from
- FetchStateOnStartup)</para>
+ FetchStateOnStartup)
+ </para>
</entry>
<entry>
<para>Whether or not to acquire the initial in-memory state from
existing members. Allows for warm/hot caches (true/false). Also
see the fetchPersistentState element in
- CacheLoaderConfiguration.</para>
+ CacheLoaderConfiguration.
+ </para>
</entry>
</row>
@@ -345,9 +359,11 @@
<entry>
<para>Time in milliseconds to wait for initial state
retrieval. This should be longer than
- <literal>LockAcquisitionTimeout</literal> as the node
+ <literal>LockAcquisitionTimeout</literal>
+ as the node
providing state may need to wait that long to acquire
- necessary read locks on the cache.</para>
+ necessary read locks on the cache.
+ </para>
</entry>
</row>
@@ -359,11 +375,17 @@
<entry>
<para>Whether or not the entire tree is inactive upon startup,
only responding to replication messages after
- <literal>activateRegion()</literal> is called to activate one or
+ <literal>activateRegion()</literal>
+ is called to activate one or
more parts of the tree. If true, property
- <literal>FetchInMemoryState</literal> is ignored. This property
- should only be set to true if <literal>UseRegionBasedMarshalling</literal>
- is also <literal>true</literal>.</para>
+ <literal>FetchInMemoryState</literal>
+ is ignored. This property
+ should only be set to true if
+ <literal>UseRegionBasedMarshalling</literal>
+ is also
+ <literal>true</literal>
+ .
+ </para>
</entry>
</row>
@@ -373,7 +395,9 @@
</entry>
<entry>
- <para>May be PESSIMISTIC (default) or OPTIMISTIC. See documentation on Transactions and Concurrency for more details.</para>
+ <para>May be PESSIMISTIC (default) or OPTIMISTIC. See documentation on Transactions and Concurrency
+ for more details.
+ </para>
</entry>
</row>
@@ -385,7 +409,10 @@
<entry>
<para>Node locking isolation level : SERIALIZABLE, REPEATABLE_READ
- (default), READ_COMMITTED, READ_UNCOMMITTED, and NONE. Note that this is ignored if NodeLockingScheme is OPTIMISTIC. Case doesn't matter. See documentation on Transactions and Concurrency for more details.</para>
+ (default), READ_COMMITTED, READ_UNCOMMITTED, and NONE. Note that this is ignored if
+ NodeLockingScheme is OPTIMISTIC. Case doesn't matter. See documentation on Transactions and
+ Concurrency for more details.
+ </para>
</entry>
</row>
@@ -396,13 +423,17 @@
<entry>
<para>Time in milliseconds to wait for a lock to be acquired. If
- a lock cannot be acquired an exception will be thrown.</para>
+ a lock cannot be acquired an exception will be thrown.
+ </para>
</entry>
</row>
<row>
- <entry><para>ReplicationVersion</para></entry>
- <entry><para>Tells the cache to serialize replication traffic
+ <entry>
+ <para>ReplicationVersion</para>
+ </entry>
+ <entry>
+ <para>Tells the cache to serialize replication traffic
in a format consistent with that used by the given release
of JBoss Cache. Different JBoss Cache versions use different
wire formats; setting this attribute tells a cache from a later
@@ -412,7 +443,8 @@
value set to "1.2.3", allowing it to interoperate with a 1.2.3
cache. Valid values are a dot-separated release number, with
any SP qualifer also separated by a dot, e.g. "1.2.3" or "1.2.4.SP2".
- </para></entry>
+ </para>
+ </entry>
</row>
<row>
@@ -422,7 +454,8 @@
<entry>
<para>Time in milliseconds for elements from the replication
- queue to be replicated.</para>
+ queue to be replicated.
+ </para>
</entry>
</row>
@@ -434,7 +467,8 @@
<entry>
<para>For synchronous replication: time in milliseconds to wait
until replication acks have been received from all nodes in the
- cluster.</para>
+ cluster.
+ </para>
</entry>
</row>
@@ -445,7 +479,8 @@
<entry>
<para>Max number of elements in the replication queue until
- replication kicks in.</para>
+ replication kicks in.
+ </para>
</entry>
</row>
@@ -460,7 +495,8 @@
attribute is set a later release will use an earlier release's
format, allowing interoperability. Valid values are "124" for
JBossCache 1.2.4, "130" for release 1.3.0, etc. Earliest valid
- version is 124.</para>
+ version is 124.
+ </para>
</entry>
</row>
@@ -473,7 +509,8 @@
<para>The fully qualified name of a class implementing
TransactionManagerLookup. Default is
JBossTransactionManagerLookup. There is also an option of
- DummyTransactionManagerLookup for example.</para>
+ DummyTransactionManagerLookup for example.
+ </para>
</entry>
</row>
@@ -483,10 +520,13 @@
</entry>
<entry>
- <para> Specifies whether each interceptor should have an associated
+ <para>Specifies whether each interceptor should have an associated
mbean registered. Interceptor mbeans are used to capture and display
statistics. This setting enables or disables all such interceptor
- mbeans. Default value is <emphasis>true</emphasis>.</para>
+ mbeans. Default value is
+ <emphasis>true</emphasis>
+ .
+ </para>
</entry>
</row>
@@ -497,7 +537,10 @@
<entry>
<para>When unmarshalling replicated data, this option specifies whether or not to use
- different classloaders (for different cache regions). This defaults to <literal>false</literal> if unspecified.</para>
+ different classloaders (for different cache regions). This defaults to
+ <literal>false</literal>
+ if unspecified.
+ </para>
</entry>
</row>
@@ -508,7 +551,8 @@
<entry>
<para>For asynchronous replication: whether or not to use a
- replication queue (true/false).</para>
+ replication queue (true/false).
+ </para>
</entry>
</row>
@@ -518,9 +562,11 @@
</entry>
<entry>
- <para>This option is used to control the behaviour of the commit part of a 2-phase commit protocol, when
+ <para>This option is used to control the behaviour of the commit part of a 2-phase commit protocol,
+ when
using REPL_SYNC (does not apply to other cache modes). By default this is set to
- <literal>false</literal>. There is a performance penalty to enabling this, especially when running
+ <literal>false</literal>
+ . There is a performance penalty to enabling this, especially when running
in a large cluster, but the upsides are greater cluster-wide data integrity. See the chapter on
Clustered Caches for more information on this.
</para>
@@ -533,9 +579,11 @@
</entry>
<entry>
- <para>This option is used to control the behaviour of the rollback part of a 2-phase commit protocol, when
+ <para>This option is used to control the behaviour of the rollback part of a 2-phase commit
+ protocol, when
using REPL_SYNC (does not apply to other cache modes). By default this is set to
- <literal>false</literal>. There is a performance penalty to enabling this, especially when running
+ <literal>false</literal>
+ . There is a performance penalty to enabling this, especially when running
in a large cluster, but the upsides are greater cluster-wide data integrity. See the chapter on
Clustered Caches for more information on this.
</para>
@@ -545,14 +593,25 @@
</tbody>
</tgroup>
</informaltable>
-</section>
+ </section>
<section>
<title>Overriding options</title>
<para>
- As of JBoss Cache 1.3.0, a new API has been introduced, to allow you to override certain behaviour of the cache on a per invocation basis.
- This involves creating an instance of <literal>org.jboss.cache.config.Option</literal>, setting the options you wish to override on the
- <literal>Option</literal> object and passing it in as a parameter to overloaded versions of <literal>get()</literal>, <literal>put()</literal> and
- <literal>remove()</literal>. See the javadocs on the <literal>Option</literal> class for details on these options.
+ As of JBoss Cache 1.3.0, a new API has been introduced, to allow you to override certain behaviour of the cache
+ on a per invocation basis.
+ This involves creating an instance of
+ <literal>org.jboss.cache.config.Option</literal>
+ , setting the options you wish to override on the
+ <literal>Option</literal>
+ object and passing it in as a parameter to overloaded versions of
+ <literal>get()</literal>
+ ,
+ <literal>put()</literal>
+ and
+ <literal>remove()</literal>
+ . See the javadocs on the
+ <literal>Option</literal>
+ class for details on these options.
</para>
</section>
- </chapter>
\ No newline at end of file
+</chapter>
\ No newline at end of file
More information about the jboss-cvs-commits
mailing list