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

jbosscache-commits at lists.jboss.org jbosscache-commits at lists.jboss.org
Sun Nov 1 01:45:59 EST 2009


Author: laubai
Date: 2009-11-01 01:45:59 -0500 (Sun, 01 Nov 2009)
New Revision: 8281

Modified:
   enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_FAQ/en-US/CacheLoader_FAQ.xml
   enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_FAQ/en-US/Eviction_FAQ.xml
   enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_FAQ/en-US/General_FAQ.xml
   enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_FAQ/en-US/TreeCache_FAQ.xml
Log:
Added changes for JBPAPP-2977.

Modified: enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_FAQ/en-US/CacheLoader_FAQ.xml
===================================================================
--- enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_FAQ/en-US/CacheLoader_FAQ.xml	2009-11-01 06:20:35 UTC (rev 8280)
+++ enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_FAQ/en-US/CacheLoader_FAQ.xml	2009-11-01 06:45:59 UTC (rev 8281)
@@ -133,7 +133,7 @@
                 <answer>
                     <para>Yes. Set the
                         <literal>async</literal>
-                        attrobute to true. See the JBoss Cache Users' Guide for a more
+                        attribute to true. See the JBoss Cache Users' Guide for a more
                         detailed discussion. By default though, all cache loader writes are
                         synchronous and will block.
                     </para>
@@ -142,15 +142,14 @@
 
             <qandaentry>
                 <question>
-                    <para>Can I write my own cache loader ?</para>
+                    <para>Can I write my own cache loader?</para>
                 </question>
 
                 <answer>
                     <para>Yes. A cache loader is a class implementing
                         <literal>org.jboss.cache.loader.CacheLoader</literal>
                         or extending
-                        <literal>org.jboss.cache.loader.AbstractCacheLoader</literal>
-                        . It is
+                        <literal>org.jboss.cache.loader.AbstractCacheLoader</literal>. It is
                         configured via the XML file (see JBoss Cache Users' Guide).
                     </para>
                 </answer>
@@ -158,7 +157,7 @@
 
             <qandaentry>
                 <question>
-                    <para>Does a cache loader have to use a persistent store ?</para>
+                    <para>Does a cache loader have to use a persistent store?</para>
                 </question>
 
                 <answer>
@@ -180,11 +179,7 @@
                 <answer>
                     <para>Not if you use it only for personal use. As soon as you
                         distribute your product with BdbjeCacheLoader, you have to purchase
-                        a commercial license from Oracle. See details at
-                        <ulink
-                                url="http://www.sleepycat.com/jeforjbosscache">http://www.sleepycat.com/jeforjbosscache
-                        </ulink>
-                        .
+                        a commercial license from Oracle.
                     </para>
                 </answer>
             </qandaentry>
@@ -196,12 +191,8 @@
 
                 <answer>
                     <para>
-                        Yes. Oracle ships a JMX-based monitoring tool, called
-                        <ulink
-                                url="http://www.oracle.com/technology/documentation/berkeley-db/je/java/com/sleepycat/je/jmx/JEMonitor.html">
-                            JEMonitor
-                        </ulink>
-                        which can be downloaded from the Oracle website.
+                        Yes. Oracle ships a JMX-based monitoring tool, called <ulink
+                                url="http://www.oracle.com/technology/documentation/berkeley-db/je/java/com/sleepycat/je/jmx/JEMonitor.html">JEMonitor</ulink> which can be downloaded from the Oracle website.
                     </para>
                 </answer>
             </qandaentry>
@@ -235,7 +226,7 @@
                         configured, until it finds a valid, non-null element of data. When
                         performing writes, all cache loaders are written to (except if the
                         ignoreModifications element has been set to true for a specific
-                        cache loader.
+                        cache loader).
                     </para>
                 </answer>
             </qandaentry>

Modified: enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_FAQ/en-US/Eviction_FAQ.xml
===================================================================
--- enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_FAQ/en-US/Eviction_FAQ.xml	2009-11-01 06:20:35 UTC (rev 8280)
+++ enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_FAQ/en-US/Eviction_FAQ.xml	2009-11-01 06:45:59 UTC (rev 8281)
@@ -12,8 +12,7 @@
 
                 <answer>
                     <para>Yes. JBoss Cache currently supports multiple eviction policies such as LRU, MRU, and FIFO.
-                        Users can also plug in their own eviction policy algorithms. See user
-                        guide for details.
+                        Users can also plug in their own eviction policy algorithms. See the JBoss Cache User Guide for details.
                     </para>
                 </answer>
             </qandaentry>
@@ -26,7 +25,7 @@
                 </question>
 
                 <answer>
-                    <para>Yes and no. :-)</para>
+                    <para>Yes and no.</para>
 
                     <para>The eviction policy only operates in local mode. That is, nodes are
                         only evicted locally. This may cause the cache contents not to be
@@ -43,8 +42,7 @@
                         set to either
                         <literal>REPL_SYNC</literal>
                         or
-                        <literal>REPL_ASYNC</literal>
-                        . Depending on your use case, you can
+                        <literal>REPL_ASYNC</literal>. Depending on your use case, you can
                         set multiple cache instances to have their own eviction policy
                         (which are applied locally) or just have selected instances with
                         eviction policies activated.
@@ -60,8 +58,7 @@
             <qandaentry>
                 <question>
                     <para>Does JBoss Cache support
-                        <literal>Region</literal>
-                        ?
+                        <literal>Region</literal>?
                     </para>
                 </question>
 
@@ -70,15 +67,11 @@
                         configure the eviction policy parameters (e.g.,
                         <literal>maxNodes</literal>
                         or
-                        <literal>timeToIdleSeconds</literal>
-                        )
+                        <literal>timeToIdleSeconds</literal>)
                     </para>
 
                     <para>A region in JBoss Cache denotes a portion of tree hierarchy,
-                        e.g., a fully qualified name (
-                        <literal>org.jboss.cache.Fqn</literal>
-                        ). For example,
-                        a user can define
+                        e.g., a fully qualified name (<literal>org.jboss.cache.Fqn</literal>). For example, a user can define
                         <literal>/org/jboss</literal>
                         and
                         <literal>/org/foocom</literal>

Modified: enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_FAQ/en-US/General_FAQ.xml
===================================================================
--- enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_FAQ/en-US/General_FAQ.xml	2009-11-01 06:20:35 UTC (rev 8280)
+++ enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_FAQ/en-US/General_FAQ.xml	2009-11-01 06:45:59 UTC (rev 8281)
@@ -142,7 +142,7 @@
                 <answer>
                     <para>
                         <literal>java -jar jbosscache-core.jar</literal>
-                        will spit out version details.
+                        will print version details.
                     </para>
                 </answer>
             </qandaentry>
@@ -196,7 +196,7 @@
                         3.x
                         distribution to migrate configuration files (see
                         <literal>config2to3.sh</literal>
-                        and<literal>config2to3.bat</literal>).
+                        and <literal>config2to3.bat</literal>).
                     </para>
                     <para>
                         Note that to take advantage of some of the new features in JBoss Cache 3.x, you need to be using

Modified: enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_FAQ/en-US/TreeCache_FAQ.xml
===================================================================
--- enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_FAQ/en-US/TreeCache_FAQ.xml	2009-11-01 06:20:35 UTC (rev 8280)
+++ enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_FAQ/en-US/TreeCache_FAQ.xml	2009-11-01 06:45:59 UTC (rev 8281)
@@ -141,7 +141,7 @@
                     </para>
 
                     <para>Note that
-                        <literal>ASYNC_REPL</literal>
+                        <literal>REPL_ASYNC</literal>
                         and
                         <literal>INVALIDATION_ASYNC</literal>
                         are non-blocking. This
@@ -166,9 +166,7 @@
                     <para>
                         A user
                         can configure the cluster of JBoss Cache instances by sharing the
-                        same cluster name (
-                        <literal>cluster name</literal>
-                        ). There is also
+                        same cluster name (<literal>cluster name</literal>). There is also
                         an option of whether to populate the cache data upon starting a new
                         instance in the
                         <literal>ClusterConfig</literal>
@@ -187,7 +185,7 @@
 
             <qandaentry>
                 <question>
-                    <para>I run a 2 node cluster. If the network dies, do the caches continue to run?</para>
+                    <para>I run a 2-node cluster. If the network dies, do the caches continue to run?</para>
                 </question>
 
                 <answer>
@@ -308,8 +306,7 @@
                         <literal>ClusterName</literal>
                         configuration element have
                         any relation to the JBoss AS cluster
-                        <literal>PartitionName</literal>
-                        ?
+                        <literal>PartitionName</literal>?
                     </para>
                 </question>
 
@@ -324,7 +321,7 @@
             <qandaentry>
                 <question>
                     <para>When using multiple JGroups based components
-                        [cluster-service.xml, cache (multiple instances)], what is the
+                        (cluster-service.xml, cache [multiple instances]), what is the
                         correct/valid way to configure those components to make sure my
                         multicast addresses don't conflict?
                     </para>
@@ -357,8 +354,7 @@
 
             <qandaentry>
                 <question>
-                    <para>Does JBoss Cache support cache passivation/ overflow
-                        to a data store?
+                    <para>Does JBoss Cache support cache passivation/overflow to a data store?
                     </para>
                 </question>
 
@@ -403,7 +399,7 @@
                 <answer>
                     <para>JBoss Cache supports any TransactionManager that is
                         <ulink url="http://java.sun.com/products/jta/">JTA</ulink>
-                        compliant such as<ulink url="http://www.jboss.org/jbosstm/">JBoss Transactions</ulink>.
+                        compliant such as <ulink url="http://www.jboss.org/jbosstm/">JBoss Transactions</ulink>.
                     </para>
                     <para>
                         While JBoss Cache does ships with a
@@ -444,7 +440,7 @@
                         class that ships
                         with JBoss Cache is able to detect and bind to most popular transaction managers. See the
                         <literal>GenericTransactionManagerLookup</literal>
-                        javadocs for more information.
+                        Javadocs for more information.
                     </para>
                 </answer>
             </qandaentry>
@@ -458,20 +454,14 @@
                     <para>JBoss Cache lets you control the cache locking level through
                         the transaction isolation level. This is configured through the
                         attribute
-                        <literal>IsolationLevel</literal>
-                        . The transaction
+                        <literal>IsolationLevel</literal>. The transaction
                         isolation levels correspond to database
                         isolation levels, namely,
-                        <literal>NONE</literal>
-                        ,
-                        <literal>READ_UNCOMMITTED</literal>
-                        ,
-                        <literal>READ_COMMITTED</literal>
-                        ,
-                        <literal>REPEATABLE_READ</literal>
-                        , and
-                        <literal>SERIALIZABLE</literal>
-                        . Note that these isolation levels are ignored if optimistic locking is used. For details,
+                        <literal>NONE</literal>, 
+                        <literal>READ_UNCOMMITTED</literal>, 
+                        <literal>READ_COMMITTED</literal>, 
+                        <literal>REPEATABLE_READ</literal>, and
+                        <literal>SERIALIZABLE</literal>. Note that these isolation levels are ignored if optimistic locking is used. For details,
                         please
                         refer
                         to the
@@ -509,7 +499,7 @@
                         detailed discussion on
                         our MVCC implementation, see
                         <ulink url="http://jbosscache.blogspot.com/2008/07/mvcc-has-landed.html">this blog entry</ulink>
-                        and<ulink url="http://www.jboss.org/community/docs/DOC-10272">this wiki page</ulink>.
+                        and <ulink url="http://www.jboss.org/community/docs/DOC-10272">this wiki page</ulink>.
                     </para>
                 </answer>
             </qandaentry>
@@ -610,7 +600,7 @@
                 </question>
 
                 <answer>
-                    <para>If you do a<literal>cache.removeNode("/myroot")</literal>, it will recursively remove
+                    <para>If you do a <literal>cache.removeNode("/myroot")</literal>, it will recursively remove
                         all the entries under "/myroot".
                     </para>
                 </answer>
@@ -622,7 +612,7 @@
                 </question>
 
                 <answer>
-                    <para>Yes, using a JMX console such as the one shipped with JBoss AS or Java 5's
+                    <para>Yes, using a JMX console such as the one shipped with JBoss AS or JDK 5's
                         <literal>jconsole</literal>
                         utility. See the chapter titled
                         <emphasis role="bold">Management Information</emphasis>
@@ -635,7 +625,7 @@
                 <question>
                     <para>
                         JBoss Cache uses a
-                        <literal>:</literal>
+                        "<literal>:</literal>"
                         character in its object name. This causes problems with
                         my MBean server. What can I do about it?
                     </para>
@@ -690,11 +680,6 @@
                         different cache instances while still participating as a replication
                         group.
                     </para>
-                    <para>
-                        This is on the roadmap though, so do keep an eye on
-                        <ulink url="http://jira.jboss.org/jira/browse/JBCACHE-60">JBCACHE-60</ulink>
-                        if you are interested.
-                    </para>
                 </answer>
             </qandaentry>
 
@@ -730,8 +715,7 @@
                                 accessed by thread 2 (with two different classloaders).
                                 JBoss Cache has no notion of the different classloaders involved.
                                 As a result, you will have a
-                                <literal>ClassCastException</literal>
-                                . This is a standard
+                                <literal>ClassCastException</literal>. This is a standard
                                 problem in passing an object from one application space to
                                 another; JBoss Cache just adds a level of indirection in passing
                                 the object.
@@ -740,9 +724,7 @@
                     </itemizedlist>
 
                     <para>To solve the first kind of issue JBoss Cache uses a
-                        <literal>CacheMarshaller</literal>
-                        .
-                        Basically, this allows application code to register a classloader
+                        <literal>CacheMarshaller</literal>. Basically, this allows application code to register a classloader
                         with a portion of the cache tree for use in handling objects
                         replicated to that portion. See the
                         <literal>CacheMarshaller</literal>
@@ -840,14 +822,12 @@
 
                     <para>To implement this feature, please follow the instructions indicated in the example located
                         in the CacheMarshaller section of the Users' Guide. It's worth noting that instead of a
-                        <literal>ServletContextListener</literal>
-                        , you could add this code into an
+                        <literal>ServletContextListener</literal>, you could add this code into an
                         <literal>MBean</literal>
                         that contained lifecycle methods, such as
                         <literal>start()</literal>
                         and
-                        <literal>stop()</literal>
-                        .
+                        <literal>stop()</literal>. 
                         The key would be for this MBean to depend on the target cache, so that it can operate as long as
                         the
                         cache is up and running.



More information about the jbosscache-commits mailing list