[jboss-cvs] JBossCache/docs/JBossCache-UserGuide/en/modules ...
Brian Stansberry
brian.stansberry at jboss.com
Tue May 29 21:14:31 EDT 2007
User: bstansberry
Date: 07/05/29 21:14:31
Modified: docs/JBossCache-UserGuide/en/modules
configuration_reference.xml
Log:
Update docs for current config options.
Revision Changes Path
1.13 +69 -48 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.12
retrieving revision 1.13
diff -u -b -r1.12 -r1.13
--- configuration_reference.xml 28 Feb 2007 12:30:58 -0000 1.12
+++ configuration_reference.xml 30 May 2007 01:14:31 -0000 1.13
@@ -18,13 +18,15 @@
<!-- ===================================================================== -->
<server>
- <classpath codebase="./lib" archives="jboss-cache.jar, jgroups.jar"/>
<!-- ==================================================================== -->
<!-- Defines JBoss Cache configuration -->
<!-- ==================================================================== -->
- <mbean code="org.jboss.cache.CacheImpl" name="jboss.cache:service=Cache">
+ <mbean code="org.jboss.cache.jmx.CacheJmxWrapper" name="jboss.cache:service=Cache">
+
+ <!-- Ensure JNDI and the TransactionManager are started before the
+ cache. Only works inside JBoss AS; ignored otherwise -->
<depends>jboss:service=Naming</depends>
<depends>jboss:service=TransactionManager</depends>
@@ -58,15 +60,17 @@
<!--Uncomment next three statements to enable JGroups multiplexer.
This configuration is dependent on the JGroups multiplexer being
- registered in an MBean server such as JBossAS. -->
+ registered in an MBean server such as JBossAS. This type of
+ dependency injection only works in the AS; outside it's up to
+ your code to inject a ChannelFactory if you want to use one. -->
<!--
- <depends>jgroups.mux:name=Multiplexer</depends>
- <attribute name="MultiplexerService">jgroups.mux:name=Multiplexer</attribute>
- <attribute name="MultiplexerStack">fc-fast-minimalthreads</attribute>
+ <depends optional-attribute-name="MultiplexerService"
+ proxy-type="attribute">jgroups.mux:name=Multiplexer</depends>
+ <attribute name="MultiplexerStack">tcp</attribute>
-->
<!-- JGroups protocol stack properties.
- ClusterConfig isn't used if the multiplexer is enabled and successfully initialized.
+ ClusterConfig isn't used if the multiplexer is enabled above.
-->
<attribute name="ClusterConfig">
<config>
@@ -159,7 +163,9 @@
<title>
Reference table of XML attributes
</title>
- <para>A list of definitions of each of the XML attributes used above.</para>
+ <para>A list of definitions of each of the XML attributes used above. If the
+ description of an attribute states that it is <emphasis>dynamic</emphasis>,
+ that means it can be changed after the cache is created and started.</para>
<informaltable frame="all">
<tgroup cols="2">
@@ -175,23 +181,24 @@
</row>
<row>
<entry>
- <para>MarshallerClass</para>
+ <para>BuddyReplicationConfig</para>
</entry>
<entry>
- <para>An instance of <literal>org.jboss.cache.marshall.Marshaller</literal> used to serialize data to byte streams.
- Defaults to <literal>org.jboss.cache.marshall.VersionAwareMarshaller</literal> if not specified.
+ <para>An XML element that contains detailed buddy replication
+ configuration. See <link linkend="br">section on Buddy Replication</link> for details.
</para>
</entry>
</row>
+
<row>
<entry>
- <para>BuddyReplicationConfig</para>
+ <para>CacheLoaderConfig</para>
</entry>
<entry>
- <para>An XML element that contains detailed buddy replication
- configuration. See <link linkend="br">section on Buddy Replication</link> for details.
+ <para>An XML element that contains detailed cache loader
+ configuration. See <link linkend="cache_loaders">chapter on Cache Loaders</link> for details.
</para>
</entry>
</row>
@@ -202,8 +209,7 @@
</entry>
<entry>
- <para>An XML element that contains detailed cache loader
- configuration. See <link linkend="cache_loaders">chapter on Cache Loaders</link> for details.
+ <para><emphasis>Deprecated</emphasis>. Use <literal>CacheLoaderConfig</literal>.
</para>
</entry>
</row>
@@ -269,6 +275,22 @@
<row>
<entry>
+ <para>ExposeManagementStatistics</para>
+ </entry>
+
+ <entry>
+ <para>Specifies whether interceptors that provide statistics should have an associated
+ mbean registered. Interceptor mbeans are used to capture statistics
+ and display them in JMX. This setting enables or disables all such interceptor
+ mbeans. Default value is
+ <emphasis>true</emphasis>
+ .
+ </para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
<para>FetchInMemoryState
</para>
</entry>
@@ -277,7 +299,7 @@
<para>Whether or not to acquire the initial in-memory state from
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>.
+ <literal>CacheLoaderConfig</literal>. Defaults to <literal>true</literal>. This property is <emphasis>dynamic</emphasis>.
</para>
</entry>
</row>
@@ -354,8 +376,21 @@
<entry>
<para>Controls whether inserting or removing a node requires a write
- lock on the node's parent (when pessimistic locking is used).
- The default value is <code>false</code>.
+ lock on the node's parent (when pessimistic locking is used) or whether
+ it results in an update of the parent node's version (when optimistic
+ locking is used). The default value is <code>false</code>.
+ </para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>MarshallerClass</para>
+ </entry>
+
+ <entry>
+ <para>An instance of <literal>org.jboss.cache.marshall.Marshaller</literal> used to serialize data to byte streams.
+ Defaults to <literal>org.jboss.cache.marshall.VersionAwareMarshaller</literal> if not specified.
</para>
</entry>
</row>
@@ -368,11 +403,16 @@
<entry>
<para>The JMX object name of the service that defines the JGroups multiplexer.
In JBoss AS 5.0 this service is normally defined in the jgroups-multiplexer.sar.
- If this attribute is defined, the cache will look up the multiplexer service
- in JMX and will use it to obtain a multiplexed JGroups channel. The configuration
+ This XML attribute can only be handled the JBoss AS MBean deployment services;
+ if it is included in a file passed to a <literal>CacheFactory</literal> the
+ factory's creation of the cache will fail. Inside JBoss AS, the attribute should
+ be specified using the "depends optional-attribute-name" syntax shown in
+ the example above. Inside the AS if this attribute
+ is defined, an instance of <literal>org.jgroups.jmx.JChannelFactoryMBean</literal>
+ will be injected into the <literal>CacheJmxWrapper</literal> which will use
+ it to obtain a multiplexed JGroups channel. The configuration
of the channel will be that associated with
- <literal>MultiplexerStack</literal>
- .
+ <literal>MultiplexerStack</literal>.
The
<literal>ClusterConfig</literal>
attribute will be ignored.
@@ -425,7 +465,8 @@
interoperate. For example, a 2.1.0 cache could have this
value set to "2.0.0", allowing it to interoperate with a 2.0.0
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".
+ any final qualifer also separated by a dot, e.g. "2.0.0" or "2.0.0.GA".
+ Values that indicate a 1.x release are not supported in the 2.x series.
</para>
</entry>
</row>
@@ -522,12 +563,7 @@
</entry>
<entry>
- <para>Specifies whether each interceptor should have an associated
- mbean registered. Interceptor mbeans are used to capture statistics
- and display them in JMX. This setting enables or disables all such interceptor
- mbeans. Default value is
- <emphasis>true</emphasis>
- .
+ <para><emphasis>Deprecated</emphasis>. Use <literal>ExposeManagementStatistics</literal>.
</para>
</entry>
</row>
@@ -538,8 +574,8 @@
</entry>
<entry>
- <para>When unmarshalling replicated data, this option specifies whether or not to use
- different classloaders (for different cache regions). This defaults to
+ <para>When unmarshalling replicated data, this option specifies whether or not to
+ support use of different classloaders for different cache regions. This defaults to
<literal>false</literal>
if unspecified.
</para>
@@ -558,21 +594,6 @@
</entry>
</row>
- <row>
- <entry>
- <para>LockParentForChildInsertRemove</para>
- </entry>
-
- <entry>
- <para>
- 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. This property is <emphasis>dynamic</emphasis>.
- </para>
- </entry>
- </row>
-
</tbody>
</tgroup>
</informaltable>
More information about the jboss-cvs-commits
mailing list