[jboss-cvs] JBossCache/docs/faq/en ...
Manik Surtani
msurtani at jboss.com
Tue Oct 31 21:04:59 EST 2006
User: msurtani
Date: 06/10/31 21:04:59
Modified: docs/faq/en master.xml
Log:
Updated no new format
Revision Changes Path
1.41 +1502 -1464JBossCache/docs/faq/en/master.xml
(In the diff below, changes in quantity of whitespace are not shown.)
Index: master.xml
===================================================================
RCS file: /cvsroot/jboss/JBossCache/docs/faq/en/master.xml,v
retrieving revision 1.40
retrieving revision 1.41
diff -u -b -r1.40 -r1.41
--- master.xml 23 Oct 2006 17:51:38 -0000 1.40
+++ master.xml 1 Nov 2006 02:04:59 -0000 1.41
@@ -2,8 +2,8 @@
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"../../../../docbook-support/support/docbook-dtd/docbookx.dtd"
>
-<article class="faq" lang="en">
- <articleinfo>
+<book lang="en">
+ <bookinfo>
<title>Frequently Asked Questions about JBoss Cache</title>
<releaseinfo>Release 2.0.0</releaseinfo>
<pubdate>January 2007</pubdate>
@@ -31,14 +31,28 @@
<surname>Marlow</surname>
<email>smarlow at novell.com</email>
</author>
- </articleinfo>
- <para>These are frequently asked questions regarding JBoss Cache.</para>
+ <abstract>
+ <para>This is a compilation of the most frequently asked
+ questions about JBoss Cache. Please report any bugs,
+ inconsistencies, or omissions you find in this FAQ to
+ <email>jbosscache-dev at jboss.org</email>
+ . Please do not mail your questions
+ to this list. Post them to the
+ <ulink url="http://www.jboss.org/index.html?module=bb&op=viewforum&f=157">JBoss Cache User Forum
+ </ulink>
+ instead.
+ </para>
+ </abstract>
+ </bookinfo>
+
- <qandaset defaultlabel="qanda">
+ <chapter id="general">
<title>General Information</title>
+ <qandaset>
+
<qandaentry>
- <question id="a1">
+ <question>
<para>What is JBoss Cache?</para>
</question>
@@ -83,7 +97,7 @@
</qandaentry>
<qandaentry>
- <question id="a2">
+ <question>
<para>Who are the JBoss Cache developers?</para>
</question>
@@ -96,7 +110,7 @@
</qandaentry>
<qandaentry>
- <question id="a3">
+ <question>
<para>What is the license for JBoss Cache?</para>
</question>
@@ -109,7 +123,7 @@
</qandaentry>
<qandaentry>
- <question id="a4">
+ <question>
<para>Where can I download JBoss Cache?</para>
</question>
@@ -126,7 +140,7 @@
</qandaentry>
<qandaentry>
- <question id="a5">
+ <question>
<para>How do I build JBoss Cache from CVS sources?</para>
</question>
@@ -142,13 +156,14 @@
in the
<literal>dist/lib</literal>
directory. Note that you will need to
- use JDK 5.0 to build the distribution. You can still use the binaries you build with J2SE 1.4.x though.
+ use JDK 5.0 to build the distribution. You can still use the binaries you build with J2SE 1.4.x
+ though.
</para>
</answer>
</qandaentry>
<qandaentry>
- <question id="a6">
+ <question>
<para>Which JVMs are supported by JBoss Cache?</para>
</question>
@@ -161,7 +176,7 @@
</qandaentry>
<qandaentry>
- <question id="a7">
+ <question>
<para>How do I know the version of JBoss Cache that I am using?</para>
</question>
@@ -174,7 +189,7 @@
</qandaentry>
<qandaentry>
- <question id="a9">
+ <question>
<para>Can I run JBoss Cache outside of JBoss Application
Server?
</para>
@@ -199,7 +214,7 @@
</qandaentry>
<qandaentry>
- <question id="a10">
+ <question>
<para>Where can I report bugs or problems?</para>
</question>
@@ -214,12 +229,15 @@
</answer>
</qandaentry>
</qandaset>
+ </chapter>
+
+ <chapter id="TreeCache">
+ <title>JBoss Cache - Core</title>
- <qandaset defaultlabel="qanda">
- <title>JBoss Cache in general and Cache</title>
+ <qandaset>
<qandaentry>
- <question id="a11">
+ <question>
<para>How do I deploy JBoss Cache as a MBean service?</para>
</question>
@@ -240,7 +258,7 @@
</qandaentry>
<qandaentry>
- <question id="a12">
+ <question>
<para>How do I know if my JBoss Cache MBean has been deployed?</para>
</question>
@@ -255,7 +273,7 @@
</qandaentry>
<qandaentry>
- <question id="a13">
+ <question>
<para>How do I access the JBoss Cache MBean?</para>
</question>
@@ -309,7 +327,7 @@
</qandaentry>
<qandaentry>
- <question id="a14">
+ <question>
<para>Can I run JBoss Cache on JBoss AS 3.2.x releases?</para>
</question>
@@ -322,7 +340,7 @@
</qandaentry>
<qandaentry>
- <question id="a15">
+ <question>
<para>Can I run multiple JBoss Cache instances on the same VM?</para>
</question>
@@ -337,7 +355,7 @@
</qandaentry>
<qandaentry>
- <question id="a16">
+ <question>
<para>Can TreeCache run as a second level cache inside
Hibernate?
</para>
@@ -360,7 +378,7 @@
</qandaentry>
<qandaentry>
- <question id="a17">
+ <question>
<para>What about using PojoCache as a Hibernate cache?</para>
</question>
@@ -374,7 +392,7 @@
</qandaentry>
<qandaentry>
- <question id="a18">
+ <question>
<para>How can I configure JBoss Cache?</para>
</question>
@@ -387,7 +405,7 @@
</qandaentry>
<qandaentry>
- <question id="a19">
+ <question>
<para>In the configuration xml file, there are tags such as
<literal>class</literal>
,
@@ -409,7 +427,7 @@
</qandaentry>
<qandaentry>
- <question id="a20">
+ <question>
<para>What is the difference between the different cache
modes?
</para>
@@ -436,7 +454,8 @@
.
For asynchronous replication, use
<literal>AYSNC_REPL</literal>
- . If you do not wish to replicate cached data but simply inform other caches in a cluster that data under
+ . If you do not wish to replicate cached data but simply inform other caches in a cluster that data
+ under
specific addresses are now stale and should be evicted from memory, use
<literal>INVALIDATION_SYNC</literal>
or
@@ -450,13 +469,14 @@
<literal>INVALIDATION_ASYNC</literal>
are non-blocking. This
can be useful when you want to have another JBoss Cache serving as a
- mirror or backup and you don't want to wait for confirmation that this mirror has received your messages.
+ mirror or backup and you don't want to wait for confirmation that this mirror has received your
+ messages.
</para>
</answer>
</qandaentry>
<qandaentry>
- <question id="a21">
+ <question>
<para>How does JBoss Cache's replication mechanism work?</para>
</question>
@@ -484,7 +504,7 @@
</qandaentry>
<qandaentry>
- <question id="a22">
+ <question>
<para>I run a 2 node cluster. If the network dies, do the caches continue to run?</para>
</question>
@@ -501,20 +521,21 @@
<qandaentry>
- <question id="a23">
+ <question>
<para>Can I plug in library X instead of JGroups to handle remote calls and group communications?</para>
</question>
<answer>
<para>At this stage (JBoss Cache 1.x) the answer is no. We do have an abstraction layer between the
- communication suite and JBoss Cache in the pipelines, and this may appear as a feature at some stage in
+ communication suite and JBoss Cache in the pipelines, and this may appear as a feature at some stage
+ in
the future.
</para>
</answer>
</qandaentry>
<qandaentry>
- <question id="a24">
+ <question>
<para>Does the cache need to replicate to every other instance in the cluster? Isn't this slow if the
cluster is large?
</para>
@@ -528,14 +549,15 @@
very easily with no extra impact on memory or network traffic with each node added.
</para>
<para>
- See the User Guide for more information on Buddy Replication, and how it can be used to achieve very high
+ See the User Guide for more information on Buddy Replication, and how it can be used to achieve very
+ high
scalability.
</para>
</answer>
</qandaentry>
<qandaentry>
- <question id="a25">
+ <question>
<para>If I have the need for different TreeCache properties (e.g.,
<literal>CacheMode</literal>
and
@@ -554,7 +576,7 @@
</qandaentry>
<qandaentry>
- <question id="a26">
+ <question>
<para>Does the Tree Cache config
<literal>ClusterName</literal>
have
@@ -573,7 +595,7 @@
</qandaentry>
<qandaentry>
- <question id="a27">
+ <question>
<para>When using multiple JGroups based components
[cluster-service.xml, treecache (multiple instances)], what is the
correct/valid way to configure those components to make sure my
@@ -593,7 +615,7 @@
</qandaentry>
<qandaentry>
- <question id="a28">
+ <question>
<para>Does JBoss Cache currently support cache persistence
storage?
</para>
@@ -607,7 +629,7 @@
</qandaentry>
<qandaentry>
- <question id="a29">
+ <question>
<para>Does JBoss Cache currently support cache passivation/ overflow
to a data store?
</para>
@@ -622,7 +644,7 @@
</qandaentry>
<qandaentry>
- <question id="a30">
+ <question>
<para>Is JBoss Cache thread safe?</para>
</question>
@@ -632,7 +654,7 @@
</qandaentry>
<qandaentry>
- <question id="a31">
+ <question>
<para>Does JBoss Cache support XA (2PC) transactions now?</para>
</question>
@@ -645,7 +667,7 @@
</qandaentry>
<qandaentry>
- <question id="a32">
+ <question>
<para>Which TransactionManagers are supported by
JBoss Cache?
</para>
@@ -669,7 +691,7 @@
</qandaentry>
<qandaentry>
- <question id="a33">
+ <question>
<para>How do I set up the cache to be transactional?</para>
</question>
@@ -706,7 +728,7 @@
</qandaentry>
<qandaentry>
- <question id="a34">
+ <question>
<para>How do I control the cache locking level?</para>
</question>
@@ -728,7 +750,8 @@
<literal>REPEATABLE_READ</literal>
, and
<literal>SERIALIZABLE</literal>
- . Note that these isolation levels are ignored if optimistic locking is used. For details, please refer
+ . Note that these isolation levels are ignored if optimistic locking is used. For details, please
+ refer
to the
user manual.
</para>
@@ -736,13 +759,14 @@
</qandaentry>
<qandaentry>
- <question id="a35">
+ <question>
<para>How does JBoss Cache lock data for concurrent access?</para>
</question>
<answer>
<para>By default JBoss Cache uses pessimistic locking to lock data nodes, based on the isolation level
- configured. Since JBoss Cache 1.3.0, we also offer optimistic locking to allow for greater concurrency at
+ configured. Since JBoss Cache 1.3.0, we also offer optimistic locking to allow for greater concurrency
+ at
the cost of slight processing overhead and performance. See the documentation for a more detailed
discussion on concurrency and locking in JBoss Cache.
</para>
@@ -751,7 +775,7 @@
<qandaentry>
- <question id="a36">
+ <question>
<para>How do I enable Optimistic Locking in JBoss Cache?</para>
</question>
@@ -775,7 +799,7 @@
<qandaentry>
- <question id="a37">
+ <question>
<para>How does the write lock apply to an Fqn node, say,
"/org/jboss/test"?
</para>
@@ -800,7 +824,7 @@
</qandaentry>
<qandaentry>
- <question id="a38">
+ <question>
<para>Can I use the cache locking level even without a transaction
context?
</para>
@@ -819,7 +843,7 @@
</qandaentry>
<qandaentry>
- <question id="a39">
+ <question>
<para>With replication (REPL_SYNC/REPL_ASYNC) or invalidation (INVALIDATION_SYNC/INVALIDATION_ASYNC), how
often does the cache broadcast messages over the network?
</para>
@@ -838,7 +862,7 @@
</qandaentry>
<qandaentry>
- <question id="a40">
+ <question>
<para>How can I do a mass removal?</para>
</question>
@@ -850,12 +874,13 @@
</qandaentry>
<qandaentry>
- <question id="a41">
+ <question>
<para>Can I monitor and manage the JBoss Cache?</para>
</question>
<answer>
- <para>With JBoss Cache 1.3.0, you can if you are running JBoss Cache within JBoss AS or are using JDK 5.0's
+ <para>With JBoss Cache 1.3.0, you can if you are running JBoss Cache within JBoss AS or are using JDK
+ 5.0's
<literal>jconsole</literal>
utility. See the chapter titled
<emphasis role="bold">Management Information</emphasis>
@@ -865,7 +890,7 @@
</qandaentry>
<qandaentry>
- <question id="a42">
+ <question>
<para>Can I disable JBoss Cache management attributes in JBoss Cache 1.3.0?</para>
</question>
@@ -884,7 +909,7 @@
</qandaentry>
<qandaentry>
- <question id="a43">
+ <question>
<para>What is jboss-serialization.jar, introduced in JBoss Cache 1.4.x and do I need this?</para>
</question>
<answer>
@@ -893,7 +918,8 @@
JBoss Serialization
</ulink>
library, which is much more efficient in terms
- of speed and CPU usage as well as the generated byte stream size than standard Java serialization. This
+ of speed and CPU usage as well as the generated byte stream size than standard Java serialization.
+ This
very
significantly improves replication performance of custom objects placed in the cache.
</para>
@@ -904,7 +930,7 @@
</qandaentry>
<qandaentry>
- <question id="a44">
+ <question>
<para>Can I disable JBoss Serialization and revert back to standard Java serialization?</para>
</question>
@@ -918,7 +944,7 @@
<qandaentry>
- <question id="a45">
+ <question>
<para>Does JBoss Cache support partitioning?</para>
</question>
@@ -932,7 +958,7 @@
</qandaentry>
<qandaentry>
- <question id="a46">
+ <question>
<para>Does JBoss Cache handle the concept of application classloading
inside, say, a J2EE container?
</para>
@@ -1033,21 +1059,22 @@
</qandaentry>
<qandaentry>
- <question id="a47">
+ <question>
<para>Does JBoss Cache currently support pre-event and post-event
notification?
</para>
</question>
<answer>
- <para>Yes. A boolean is passed in to each notification callback identifying whether the callback is before
+ <para>Yes. A boolean is passed in to each notification callback identifying whether the callback is
+ before
or after the event.
</para>
</answer>
</qandaentry>
<qandaentry>
- <question id="a48">
+ <question>
<para>How do I implement a custom listener to listen to
<literal>TreeCache</literal>
events?
@@ -1083,12 +1110,13 @@
</answer>
</qandaentry>
</qandaset>
+ </chapter>
- <qandaset defaultlabel="qanda">
+ <chapter id="eviction">
<title>Eviction Policies</title>
-
+ <qandaset>
<qandaentry>
- <question id="a75">
+ <question>
<para>Does JBoss Cache support eviction policies?</para>
</question>
@@ -1101,7 +1129,7 @@
</qandaentry>
<qandaentry>
- <question id="a77">
+ <question>
<para>Does JBoss Cache's eviction policy operates in
replication mode?
</para>
@@ -1140,7 +1168,7 @@
</qandaentry>
<qandaentry>
- <question id="a78">
+ <question>
<para>Does JBoss Cache support
<literal>Region</literal>
?
@@ -1172,7 +1200,7 @@
</qandaentry>
<qandaentry>
- <question id="a79">
+ <question>
<para>What are the
<literal>EvictionPolicyConfig</literal>
tag
@@ -1193,7 +1221,8 @@
<row>
<entry>eventQueueSize</entry>
- <entry>A fine-tuning parameter where you can configure the size of the eviction notification event queue. Defaults to 200,000.
+ <entry>A fine-tuning parameter where you can configure the size of the eviction notification
+ event queue. Defaults to 200,000.
</entry>
</row>
@@ -1237,7 +1266,7 @@
</qandaentry>
<qandaentry>
- <question id="a80">
+ <question>
<para>I have turned on the eviction policy, why do I still get "out
of memory" (OOM) exception?
</para>
@@ -1262,12 +1291,14 @@
</answer>
</qandaentry>
</qandaset>
-
- <qandaset defaultlabel="qanda">
+ </chapter>
+ <chapter id="cacheloaders">
<title>Cache Loaders</title>
+ <qandaset>
+
<qandaentry>
- <question id="a81">
+ <question>
<para>What is a CacheLoader?</para>
</question>
@@ -1311,13 +1342,15 @@
transactional database. It uses a single file for the entire
store. Note that if you use Sleepycat's CacheLoader with
JBoss Cache and wish to ship your product, you will have to acquire a
- <ulink url="http://www.sleepycat.com/jeforjbosscache">commercial license from Sleepycat</ulink>
+ <ulink url="http://www.sleepycat.com/jeforjbosscache">commercial license from Sleepycat
+ </ulink>
.
</para>
</listitem>
<listitem>
- <para>JDBCCacheLoader: this implementation uses the relational database as the persistent storage.
+ <para>JDBCCacheLoader: this implementation uses the relational database as the persistent
+ storage.
</para>
</listitem>
@@ -1336,7 +1369,7 @@
</qandaentry>
<qandaentry>
- <question id="a82">
+ <question>
<para>Can writing to CacheLoaders be asynchronous?</para>
</question>
@@ -1350,7 +1383,7 @@
</qandaentry>
<qandaentry>
- <question id="a83">
+ <question>
<para>Can I write my own CacheLoader ?</para>
</question>
@@ -1365,7 +1398,7 @@
</qandaentry>
<qandaentry>
- <question id="a84">
+ <question>
<para>Does a CacheLoader have to use a persistent store ?</para>
</question>
@@ -1381,7 +1414,7 @@
</qandaentry>
<qandaentry>
- <question id="a85">
+ <question>
<para>What can I use a CacheLoader for?</para>
</question>
@@ -1432,7 +1465,7 @@
</qandaentry>
<qandaentry>
- <question id="a86">
+ <question>
<para>How do I configure JBossCache with a CacheLoader?</para>
</question>
@@ -1446,7 +1479,7 @@
</qandaentry>
<qandaentry>
- <question id="a87">
+ <question>
<para>Do I have to pay to use Sleepycat's CacheLoader?</para>
</question>
@@ -1463,7 +1496,7 @@
</qandaentry>
<qandaentry>
- <question id="a88">
+ <question>
<para>Can I use more than one cache loader?</para>
</question>
@@ -1481,8 +1514,9 @@
</qandaentry>
<qandaentry>
- <question id="a89">
- <para>Why do cache loaders go into an inconsistent state when I use transactions, pessimistic locking, and I
+ <question>
+ <para>Why do cache loaders go into an inconsistent state when I use transactions, pessimistic locking,
+ and I
attempt to read a node after removing it from within the same transaction scope?
</para>
</question>
@@ -1492,7 +1526,8 @@
<ulink url="http://jira.jboss.com/jira/browse/JBCACHE-477">JBCACHE-477</ulink>
and
<ulink url="http://jira.jboss.com/jira/browse/JBCACHE-352">JBCACHE-352</ulink>
- ), which have been fixed in JBoss Cache 1.4.0. A very simple workaround if you're using JBoss Cache 1.3.x
+ ), which have been fixed in JBoss Cache 1.4.0. A very simple workaround if you're using JBoss Cache
+ 1.3.x
is to use optimistic locking.
</para>
<para>
@@ -1505,11 +1540,13 @@
</qandaset>
-
- <qandaset defaultlabel="qanda">
+ </chapter>
+ <chapter id="troubleshooting">
<title>Troubleshooting</title>
+ <qandaset>
+
<qandaentry>
- <question id="a90">
+ <question>
<para>I am having problems getting JBoss Cache to work, where can I get information on troubleshooting?
</para>
</question>
@@ -1521,4 +1558,5 @@
</answer>
</qandaentry>
</qandaset>
-</article>
+ </chapter>
+</book>
More information about the jboss-cvs-commits
mailing list