[jbosscache-commits] JBoss Cache SVN: r8199 - in enterprise-docs/tags/JBoss_EAP_5_0_0: Cache_Tutorial/en-US and 1 other directory.
jbosscache-commits at lists.jboss.org
jbosscache-commits at lists.jboss.org
Tue Aug 25 19:10:02 EDT 2009
Author: irooskov at redhat.com
Date: 2009-08-25 19:10:02 -0400 (Tue, 25 Aug 2009)
New Revision: 8199
Modified:
enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_FAQ/en-US/JBoss_Cache_Frequently_Asked_Questions.xml
enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_Tutorial/en-US/JBoss_Cache_Tutorial.xml
Log:
updated files
Modified: enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_FAQ/en-US/JBoss_Cache_Frequently_Asked_Questions.xml
===================================================================
--- enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_FAQ/en-US/JBoss_Cache_Frequently_Asked_Questions.xml 2009-08-24 15:19:10 UTC (rev 8198)
+++ enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_FAQ/en-US/JBoss_Cache_Frequently_Asked_Questions.xml 2009-08-25 23:10:02 UTC (rev 8199)
@@ -1,14 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "../../../../docbook-support/support/docbook-dtd/docbookx.dtd"
- >
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+]>
<book lang="en">
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<chapter id="general">
<title>General Information</title>
<qandaset>
-
<qandaentry>
<question>
<para>What is JBoss Cache?</para>
@@ -47,25 +45,21 @@
<ulink url="http://www.jboss.org/jbosscache/">documentation website</ulink>.
</para>
- <para>
+ <!-- <para>
JBoss Cache is made available in one of four different packages:
<itemizedlist>
<listitem>
<para>
- <literal>jbosscache-core</literal>
- </para>
- contains the core Cache library for users who do not wish to use the additional
- functionality
- offered by POJO Cache.
+ <literal>jbosscache-core</literal> contains the core Cache library for users who do not wish to use the additional functionality offered by POJO Cache.
+ </para>
</listitem>
<listitem>
<para>
- <literal>jbosscache-pojo</literal>
- </para>
- contains the core Cache library as well as POJO Cache extensions and dependencies.
+ <literal>jbosscache-pojo</literal> contains the core Cache library as well as POJO Cache extensions and dependencies.
+ </para>
</listitem>
</itemizedlist>
- </para>
+ </para> -->
</answer>
</qandaentry>
@@ -76,18 +70,12 @@
<answer>
<para>
- JBoss Cache has an active community of developers and contributors. The project was founded by
- Bela
- Ban
- and is currently led by Manik Surtani. Jason Greene is the lead for the POJO Cache subsystem,
- and other
- contributors both past and present include Ben Wang, Harald Gliebe, Brian Stansberry, Vladimir
- Blagojevic, Mircea Markus, Jimmy Wilson, Galder Zamarreño and Elias Ross.
+ JBoss Cache has an active community of developers and contributors. The project was founded by Bela Ban and is currently led by Manik Surtani. Jason Greene is the lead for the POJO Cache subsystem, and other contributors both past and present include Ben Wang, Harald Gliebe, Brian Stansberry, Vladimir Blagojevic, Mircea Markus, Jimmy Wilson, Galder Zamarreño and Elias Ross.
</para>
</answer>
</qandaentry>
- <qandaentry>
+ <!-- <qandaentry>
<question>
<para>What about licensing?</para>
</question>
@@ -98,9 +86,9 @@
url="http://www.opensource.org/">OSI</ulink>-approved open source license.
</para>
</answer>
- </qandaentry>
+ </qandaentry> -->
- <qandaentry>
+ <!-- <qandaentry>
<question>
<para>Where can I download JBoss Cache?</para>
</question>
@@ -115,22 +103,22 @@
wiki page for details.
</para>
</answer>
- </qandaentry>
+ </qandaentry> -->
- <qandaentry>
+ <!-- <qandaentry>
<question>
<para>How do I build JBoss Cache from sources?</para>
</question>
<answer>
<para>
- Read the README-Maven.txt file in the source root. Note that you will need a JDK >= 5.0, and
- Apache Maven >= 2.0.6.
+ Read the README-Maven.txt file in the source root. Note that you will need a JDK >= 5.0, and
+ Apache Maven >= 2.0.6.
</para>
</answer>
- </qandaentry>
+ </qandaentry> -->
- <qandaentry>
+ <!-- <qandaentry>
<question>
<para>Which versions of the JDK are supported by JBoss Cache?</para>
</question>
@@ -146,7 +134,7 @@
</ulink>.
</para>
</answer>
- </qandaentry>
+ </qandaentry> -->
<qandaentry>
<question>
@@ -221,7 +209,7 @@
</answer>
</qandaentry>
- <qandaentry>
+ <!-- <qandaentry>
<question>
<para>Where can I report bugs or problems?</para>
</question>
@@ -231,16 +219,16 @@
<ulink url="http://www.jboss.org/jbosscache">JBoss Cache User Forum</ulink>.
</para>
</answer>
- </qandaentry>
+ </qandaentry> -->
</qandaset>
</chapter>
<chapter id="TreeCache">
- <title>JBoss Cache - Core</title>
+ <title>JBoss Cache: Core</title>
<qandaset>
- <qandaentry>
+ <!-- <qandaentry>
<question>
<para>Using JBoss Cache 2 or 3 on JBoss AS 4.x</para>
</question>
@@ -252,7 +240,7 @@
url="http://www.jboss.org/community/docs/DOC-10254">this wiki page</ulink>.
</para>
</answer>
- </qandaentry>
+ </qandaentry> -->
<qandaentry>
<question>
@@ -1205,6 +1193,7 @@
</qandaentry>
</qandaset>
</chapter>
+
<chapter id="cacheloaders">
<title>Cache Loaders</title>
<qandaset>
@@ -1235,8 +1224,6 @@
<para>JBoss Cache currently ships with several cache loader
implementations, including:
</para>
-
- <para>
<itemizedlist>
<listitem>
<para>
@@ -1285,7 +1272,6 @@
</para>
</listitem>
</itemizedlist>
- </para>
</answer>
</qandaentry>
@@ -1300,26 +1286,30 @@
production
environment, or if used in such an environment, it should be used with due care and sufficient
understanding of these limitations.
+ </para>
<itemizedlist>
- <listitem>Due to the way the FileCacheLoader represents a tree structure on disk
+ <listitem><para>Due to the way the FileCacheLoader represents a tree structure on disk
(directories and
- files) traversal is inefficient for deep trees.
+ files) traversal is inefficient for deep trees.</para>
</listitem>
- <listitem>Usage on shared filesystems like NFS, Windows shares, etc. should be avoided as
+ <listitem><para>Usage on shared filesystems like NFS, Windows shares, etc. should be avoided as
these do
- not implement proper file locking and can cause data corruption.
+ not implement proper file locking and can cause data corruption.</para>
</listitem>
- <listitem>Usage with an isolation level of NONE can cause corrupt writes as multiple threads
- attempt to write to the same file.
+ <listitem><para>Usage with an isolation level of NONE can cause corrupt writes as multiple threads
+ attempt to write to the same file.</para>
</listitem>
- <listitem>File systems are inherently not transactional, so when attempting to use your
+ <listitem>
+ <para>
+ File systems are inherently not transactional, so when attempting to use your
cache in a
transactional context, failures when writing to the file (which happens during the
commit phase)
cannot be recovered.
+ </para>
</listitem>
</itemizedlist>
-
+ <para>
As a rule of thumb, it is recommended that the FileCacheLoader not be used in a highly
concurrent,
transactional or stressful environment, and its use is restricted to testing.
@@ -1444,16 +1434,12 @@
<qandaentry>
<question>
- <para>Can I migrate a JDBCacheLoader or FileCacheLoader based cache store containing data formatted
- with
- JBoss Cache 1.x.x to JBoss Cache 2.0 format?
+ <para>Can I migrate a JDBCacheLoader or FileCacheLoader based cache store containing data formatted with JBoss Cache 1.x.x to JBoss Cache 2.0 format?
</para>
</question>
<answer>
- <para>Yes. See "Transforming Cache Loaders" section within the "Cache Loaders" section located in
- the
- JBoss Cache Users' Guide.
+ <para>Yes. See "Transforming Cache Loaders" section within the "Cache Loaders" section located in the JBoss Cache Users' Guide.
</para>
</answer>
</qandaentry>
@@ -1464,7 +1450,7 @@
Is the TCPDelegatingCacheLoader resilient to TCPCacheServer restarts?
</para>
</question>
-
+
<answer>
<para>
As of JBoss Cache 2.1.0, the answer is yes. See the Users' Guide for details on how to configure
@@ -1477,8 +1463,8 @@
restarting your application that uses the cache.
</para>
</answer>
+
</qandaentry>
-
</qandaset>
</chapter>
<chapter id="troubleshooting">
@@ -1487,14 +1473,12 @@
<qandaentry>
<question>
- <para>I am having problems getting JBoss Cache to work, where can I get information on
- troubleshooting?
+ <para>I am having problems getting JBoss Cache to work, where can I get information on troubleshooting?
</para>
</question>
<answer>
<para>Troubleshooting section can be found in the following
- <ulink url="http://www.jboss.org/community/docs/DOC-10288">wiki link</ulink>
- .
+ <ulink url="http://www.jboss.org/community/docs/DOC-10288">wiki link</ulink>.
</para>
</answer>
</qandaentry>
Modified: enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_Tutorial/en-US/JBoss_Cache_Tutorial.xml
===================================================================
--- enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_Tutorial/en-US/JBoss_Cache_Tutorial.xml 2009-08-24 15:19:10 UTC (rev 8198)
+++ enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_Tutorial/en-US/JBoss_Cache_Tutorial.xml 2009-08-25 23:10:02 UTC (rev 8199)
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
<book id="JBossCache_Tutorial">
- <title>JBossCache Tutorial</title>
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<chapter id="JBossCache_Tutorial-Introduction">
<title>Introduction</title>
@@ -38,32 +37,23 @@
<title>Configuration</title>
<para>First download the JBoss Cache 3.x distribution from
- <ulink url="http://labs.jboss.org/jbosscache/download/index.html">the download page</ulink>. You will need the ALL distribution (
- <literal>jbosscache-core-3.X.Y.GA-all.zip</literal>).
- Unzip it, and you will get a directory containing the distribution, such as
- <literal>jbosscache-core-3.X.Y</literal>
- .
- For the sake of this tutorial, I will refer to this as
- <literal>${JBOSSCACHE_HOME}</literal>
- .
+ <ulink url="http://labs.jboss.org/jbosscache/download/index.html">the download page</ulink>. You will need the <emphasis>all</emphasis> distribution (<literal>jbosscache-core-3.X.Y.GA-all.zip</literal>). Unzip it, and you will get a directory containing the distribution, such as <literal>jbosscache-core-3.X.Y</literal>. For the sake of this tutorial, I will refer to this as <literal>${JBOSSCACHE_HOME}</literal>.
</para>
- <para>The configuration files are located in
- <literal>${JBOSSCACHE_HOME}/etc</literal>. You can
- modify the behavior of the cache by editing the various configuration files.
+ <para>The configuration files are located in <literal>${JBOSSCACHE_HOME}/etc</literal>. You can modify the behavior of the cache by editing the various configuration files.
</para>
<itemizedlist>
<listitem>
<para>
- <literal>log4j.xml</literal> - Logging output. You can enable logging, specify log levels or
+ <literal>log4j.xml</literal>: Logging output. You can enable logging, specify log levels or
change the name and path to the log file.
</para>
</listitem>
<listitem>
<para>
- <literal>config-samples/total-replication.xml</literal> - Cache configuration file used for this tutorial.
+ <literal>config-samples/total-replication.xml</literal>: Cache configuration file used for this tutorial.
</para>
</listitem>
</itemizedlist>
@@ -86,10 +76,10 @@
<para>
The GUI is run by:
<itemizedlist>
- <listitem>Changing to the
+ <listitem><para>Changing to the
<literal>${JBOSSCACHE_HOME}/tutorial</literal>
- directory (e.g.,<literal>cd ${JBOSSCACHE_HOME}/tutorial</literal>)</listitem>
- <listitem>And then running the ant script (e.g.,<literal>ant run</literal>)</listitem>
+ directory (e.g.,<literal>cd ${JBOSSCACHE_HOME}/tutorial</literal>)</para></listitem>
+ <listitem><para>And then running the ant script (e.g.,<literal>ant run</literal>)</para></listitem>
</itemizedlist>
</para>
@@ -98,22 +88,19 @@
view of the JVM in the lower pane.
</para>
<para>
- The BeanShell view is preset with the following variables:
+ The BeanShell view is preset with the following variables:</para>
<itemizedlist>
- <listitem>
- <literal>cache</literal>
- - a reference to the <literal>org.jboss.cache.Cache</literal> interface, used by the GUI instance.
+ <listitem><para>
+ <literal>cache</literal>: a reference to the <literal>org.jboss.cache.Cache</literal> interface, used by the GUI instance.</para>
</listitem>
- <listitem>
- <literal>root</literal>
- - a reference to the root <literal>org.jboss.cache.Node</literal> instance for the above cache.
+ <listitem><para>
+ <literal>root</literal>: a reference to the root <literal>org.jboss.cache.Node</literal> instance for the above cache.</para>
</listitem>
- <listitem>
- <literal>transactionManager</literal>
- - a reference to the registered <literal>javax.transaction.TransactionManager</literal> instance.
+ <listitem><para>
+ <literal>transactionManager</literal>: a reference to the registered <literal>javax.transaction.TransactionManager</literal> instance.</para>
</listitem>
</itemizedlist>
- The references made available to the BeanShell window point to the same cache instance used by the tree view in
+ <para> The references made available to the BeanShell window point to the same cache instance used by the tree view in
the
GUI above.
</para>
@@ -128,19 +115,18 @@
<chapter>
<title>Tutorials</title>
- Note that it is recommended that you shut down and restart the GUI for each of the following tutorials, to
- ensure clean caches every time.
+ <important><para> It is recommended that you shut down and restart the GUI for each of the following tutorials, to
+ ensure clean caches every time.</para></important>
<section>
<title>Caches and Nodes</title>
<para>
- For this tutorial, start a single instance of the GUI. In this tutorial, we will:
+ For this tutorial, start a single instance of the GUI. In this tutorial, we will:</para>
<itemizedlist>
- <listitem>Create nodes under the root node.</listitem>
- <listitem>Remove nodes under the root node, both individually and recursively.</listitem>
- <listitem>Add and remove data from nodes.</listitem>
+ <listitem><para>Create nodes under the root node.</para></listitem>
+ <listitem><para>Remove nodes under the root node, both individually and recursively.</para></listitem>
+ <listitem><para>Add and remove data from nodes.</para></listitem>
</itemizedlist>
- </para>
<para>1. Set up the Fqns you need. In the BeanShell pane, create 3 Fqn variables:</para>
<programlisting role="JAVA"><![CDATA[
More information about the jbosscache-commits
mailing list