[jboss-cvs] JBossCache/docs/JBossCache-UserGuide/en/modules ...
Manik Surtani
msurtani at jboss.com
Tue Jan 30 16:43:32 EST 2007
User: msurtani
Date: 07/01/30 16:43:32
Modified: docs/JBossCache-UserGuide/en/modules configuration.xml
configuration_reference.xml
Log:
Documented dynamic elements
Revision Changes Path
1.8 +5 -1 JBossCache/docs/JBossCache-UserGuide/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/JBossCache-UserGuide/en/modules/configuration.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -b -r1.7 -r1.8
--- configuration.xml 30 Jan 2007 02:06:03 -0000 1.7
+++ configuration.xml 30 Jan 2007 21:43:32 -0000 1.8
@@ -34,7 +34,11 @@
When constructed, the
<literal>Configuration</literal>
object is preset with JBoss Cache defaults and can even
- be used as-is for a quick start.
+ be used as-is for a quick start. Configuration values may not be changed programmatically when a cache is running,
+ except those annotated as <literal>@Dynamic</literal>. Dynamic properties are also marked as such in the
+ <link linkend="configuration_reference">configuration reference</link> table. Attempting to change a non-dynamic
+ property will result in a <literal>ConfigurationException</literal>.
+
</para>
</section>
1.9 +12 -24 JBossCache/docs/JBossCache-UserGuide/en/modules/configuration_reference.xml
(In the diff below, changes in quantity of whitespace are not shown.)
Index: configuration_reference.xml
===================================================================
RCS file: /cvsroot/jboss/JBossCache/docs/JBossCache-UserGuide/en/modules/configuration_reference.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -b -r1.8 -r1.9
--- configuration_reference.xml 30 Jan 2007 21:34:25 -0000 1.8
+++ configuration_reference.xml 30 Jan 2007 21:43:32 -0000 1.9
@@ -262,7 +262,7 @@
<entry>
<para>Configuration parameter for the specified eviction policy.
- See <link linkend="eviction_policies">chapter on eviction policies</link> for details.
+ See <link linkend="eviction_policies">chapter on eviction policies</link> for details. This property is <emphasis>dynamic</emphasis>.
</para>
</entry>
</row>
@@ -275,9 +275,9 @@
<entry>
<para>Whether or not to acquire the initial in-memory state from
- existing members. Allows for hot/cold caches (true/false). Also
- see the fetchPersistentState element in
- CacheLoaderConfiguration.
+ existing members. Allows for hot caches when enabled. Also
+ see the <literal>fetchPersistentState</literal> element in
+ <literal>CacheLoaderConfiguration</literal>. Defaults to <literal>true</literal>. This property is <emphasis>dynamic</emphasis>.
</para>
</entry>
</row>
@@ -342,20 +342,7 @@
<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>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>LockParentForChildInsertRemove</para>
- </entry>
-
- <entry>
- <para>Whether inserting or removing a node requires a write lock
- on the node's parent (when pessimistic locking is used.) Default
- is <literal>true</literal>
+ a lock cannot be acquired an exception will be thrown. This property is <emphasis>dynamic</emphasis>.
</para>
</entry>
</row>
@@ -437,7 +424,7 @@
<entry>
<para>Time in milliseconds for elements from the replication
- queue to be replicated. Only used if <literal>UseReplQueue</literal> is enabled.
+ queue to be replicated. Only used if <literal>UseReplQueue</literal> is enabled. This property is <emphasis>dynamic</emphasis>.
</para>
</entry>
</row>
@@ -449,7 +436,7 @@
<entry>
<para>Max number of elements in the replication queue until
- replication kicks in. Only used if <literal>UseReplQueue</literal> is enabled.
+ replication kicks in. Only used if <literal>UseReplQueue</literal> is enabled. This property is <emphasis>dynamic</emphasis>.
</para>
</entry>
</row>
@@ -466,7 +453,7 @@
<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.
+ clustered caches for more information on this. This property is <emphasis>dynamic</emphasis>.
</para>
</entry>
</row>
@@ -479,7 +466,8 @@
<entry>
<para>For synchronous replication: time in milliseconds to wait
until replication acks have been received from all nodes in the
- cluster. It is usually best that this is greater than the LockAcquisitionTimeout.
+ cluster. It is usually best that this is greater than <literal>LockAcquisitionTimeout</literal>.
+ This property is <emphasis>dynamic</emphasis>.
</para>
</entry>
</row>
@@ -496,7 +484,7 @@
<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.
+ clustered caches for more information on this. This property is <emphasis>dynamic</emphasis>.
</para>
</entry>
</row>
@@ -567,7 +555,7 @@
When used with pessimistic locking and <literal>IsolationLevel</literal> of <literal>REPEATABLE_READ</literal>,
this parameter specifies whether parent nodes need to be locked for writing when adding or removing child nodes.
This prevents phantom reads, providing "stronger-than-repeatable-read" data integrity. This defaults to <literal>false</literal>
- and is ignored if used with optimistic locking or other isolation levels.
+ and is ignored if used with optimistic locking or other isolation levels. This property is <emphasis>dynamic</emphasis>.
</para>
</entry>
</row>
More information about the jboss-cvs-commits
mailing list