Author: irooskov(a)redhat.com
Date: 2009-08-25 21:29:39 -0400 (Tue, 25 Aug 2009)
New Revision: 8203
Removed:
enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/master.xml
Modified:
enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/Author_Group.xml
enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/Book_Info.xml
enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/deployment.xml
enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/eviction_policies.xml
enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/introduction.xml
enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/replication.xml
enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/transactions.xml
Log:
updated book for build
Modified: enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/Author_Group.xml
===================================================================
---
enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/Author_Group.xml 2009-08-26
00:45:20 UTC (rev 8202)
+++
enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/Author_Group.xml 2009-08-26
01:29:39 UTC (rev 8203)
@@ -3,6 +3,28 @@
]>
<authorgroup>
- <author><firstname>Manik Surtani, Galder
Zamarreño</firstname></author>
+ <author>
+ <firstname>Manik</firstname>
+ <surname>Surtani</surname>
+ <email>manik AT jboss DOT org</email>
+ </author>
+
+ <author>
+ <firstname>Brian</firstname>
+ <surname>Stansberry</surname>
+ <email>brian DOT stansberry AT jboss DOT com</email>
+ </author>
+
+ <author>
+ <firstname>Galder</firstname>
+ <surname>Zamarreño</surname>
+ <email>galder DOT zamarreno AT jboss DOT com</email>
+ </author>
+
+ <author>
+ <firstname>Mircea</firstname>
+ <surname>Markus</surname>
+ <email>mircea DOT markus AT jboss DOT com</email>
+ </author>
</authorgroup>
Modified: enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/Book_Info.xml
===================================================================
--- enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/Book_Info.xml 2009-08-26
00:45:20 UTC (rev 8202)
+++ enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/Book_Info.xml 2009-08-26
01:29:39 UTC (rev 8203)
@@ -2,7 +2,7 @@
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
<bookinfo id="JBoss_Cache">
- <title>JBoss Cache Tutorial</title>
+ <title>JBoss Cache User Guide</title>
<subtitle>for Use with JBoss Enterprise Application Platform 5.0</subtitle>
<edition>2.0</edition>
<pubsnumber>1</pubsnumber>
@@ -10,7 +10,7 @@
<productnumber>5.0</productnumber>
<abstract>
<para>
- This book is a TreeCache and JBossCache Tutorial.
+ This book is the User Guide for Cache of the JBoss Enterprise Application Platform.
</para>
</abstract>
<isbn>N/A</isbn>
Modified: enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/deployment.xml
===================================================================
--- enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/deployment.xml 2009-08-26
00:45:20 UTC (rev 8202)
+++ enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/deployment.xml 2009-08-26
01:29:39 UTC (rev 8203)
@@ -9,9 +9,9 @@
<literal>Configuration</literal>
instance or an XML file, as discussed
in the
- <link linkend="api.create_start">User API</link>
+ <xref linkend="api.create_start" />
and
- <link
linkend="configuration.creation">Configuration</link>
+ <xref linkend="configuration.creation" />
chapters.
</para>
@@ -32,7 +32,7 @@
<para>
If, after deploying your cache you wish to expose a management interface
to it in JMX, see the
- <link linkend="jmx.registration.programatic">section on
Programatic Registration in JMX</link>.
+ <xref linkend="jmx.registration.programatic" />.
</para>
</section>
<section id="deployment.microcontainer">
@@ -142,10 +142,10 @@
<literal>bean</literal>
element represents an object and is used to create a
<literal>Configuration</literal>
- and its <link linkend="configuration.elements">constituent
parts</link>
+ and its <xref linkend="configuration.elements" />
The <literal>DefaultCacheFactory</literal> bean constructs the
cache,
conceptually doing the same thing as is shown in the
- <link linkend="api.create_start">User API</link> chapter.
+ <xref linkend="api.create_start" /> chapter.
</para>
<para>
An interesting thing to note in the above example is the use of the
@@ -338,7 +338,7 @@
]]></programlisting>
<para>
- As discussed in the <link
linkend="jmx.registration.programatic">Programatic Registration</link>
+ As discussed in the <xref
linkend="jmx.registration.programatic" />
section, <literal>CacheJmxWrapper</literal> can do the work of
building, creating and starting the
<literal>Cache</literal> if it is provided with a
<literal>Configuration</literal>. With the
microcontainer, this is the preferred approach, as it saves the
boilerplate XML
@@ -406,7 +406,7 @@
</para>
</footnote>.
Management tools can then access those MBeans to examine the statistics. See
the section in the
- <link linkend="jmx_reference.statistics">JMX Reference
chapter</link>
+ <xref linkend="jmx_reference.statistics" />
pertaining to the statistics that are made available via JMX.
</para>
</section>
@@ -415,14 +415,14 @@
<title>Receiving JMX Notifications</title>
<para>
JBoss Cache users can register a listener to receive cache events described
earlier in the
- <link linkend="api.listener">User API</link>
+ <xref linkend="api.listener" />
chapter. Users can alternatively utilize the cache's management
information infrastructure to receive these
events via JMX notifications. Cache events are accessible as notifications by
registering a
<literal>NotificationListener</literal> for the
<literal>CacheJmxWrapper</literal>.
</para>
<para>
- See the section in the <link
linkend="jmx_reference.notifications">JMX Reference chapter</link>
+ See the section in the <xref
linkend="jmx_reference.notifications" />
pertaining to JMX notifications for a list of notifications that can be
received through the
<literal>CacheJmxWrapper</literal>.
</para>
Modified:
enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/eviction_policies.xml
===================================================================
---
enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/eviction_policies.xml 2009-08-26
00:45:20 UTC (rev 8202)
+++
enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/eviction_policies.xml 2009-08-26
01:29:39 UTC (rev 8203)
@@ -4,7 +4,7 @@
<para>
Eviction controls JBoss Cache's memory management by restricting how many nodes
are allowed to be stored in
memory, and for how long. Memory constraints on servers mean caches cannot grow
indefinitely, so eviction
- needs to occur to prevent out of memory errors. Eviction is most often used
alongside <link linkend="cache_loaders">cache loaders</link>.
+ needs to occur to prevent out of memory errors. Eviction is most often used
alongside <xref linkend="cache_loaders" />.
</para>
<section id="eviction.design">
@@ -91,7 +91,7 @@
<title>Eviction Regions</title>
<para>
The concept of regions and the <literal>Region</literal> class
were
- <link linkend="architecture.regions">visited
earlier</link> when talking about marshalling. Regions are also
+ <xref linkend="architecture.regions" /> when talking about
marshalling. Regions are also
used to define the eviction behavior for nodes within that region. In
addition to using a region-specific
configuration, you can also configure default, cache-wide eviction behavior
for nodes that do not fall into
predefined regions or if you do not wish to define specific regions. It is
important to note that when
@@ -220,7 +220,7 @@
<literal>org.jboss.cache.config.EvictionConfig</literal>
bean, which is passed into
<literal>Configuration.setEvictionConfig()</literal>. See the
- <link linkend="configuration">chapter on
Configuration</link>
+ <xref linkend="configuration" />
for more on building a
<literal>Configuration</literal>
programatically.
Modified: enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/introduction.xml
===================================================================
---
enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/introduction.xml 2009-08-26
00:45:20 UTC (rev 8202)
+++
enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/introduction.xml 2009-08-26
01:29:39 UTC (rev 8203)
@@ -138,7 +138,7 @@
</para>
<para>
The JBoss Cache MVCC implementation only supports READ_COMMITTED and
REPEATABLE_READ isolation levels, corresponding
- to their database equivalents. See the section on <link
linkend="transactions">transactions and concurrency</link> for details
on MVCC.
+ to their database equivalents. See the section on <xref
linkend="transactions" /> for details on MVCC.
</para>
</section>
</section>
Deleted: enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/master.xml
===================================================================
--- enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/master.xml 2009-08-26
00:45:20 UTC (rev 8202)
+++ enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/master.xml 2009-08-26
01:29:39 UTC (rev 8203)
@@ -1,114 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN"
- "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
- <!ENTITY preface SYSTEM "modules/preface.xml">
- <!ENTITY introduction SYSTEM "modules/introduction.xml">
- <!ENTITY architecture SYSTEM "modules/architecture.xml">
- <!ENTITY basic_api SYSTEM "modules/basic_api.xml">
- <!ENTITY replication SYSTEM "modules/replication.xml">
- <!ENTITY transactions SYSTEM "modules/transactions.xml">
- <!ENTITY eviction_policies SYSTEM "modules/eviction_policies.xml">
- <!ENTITY cache_loaders SYSTEM "modules/cache_loaders.xml">
- <!ENTITY compatibility SYSTEM "modules/compatibility.xml">
- <!ENTITY configuration SYSTEM "modules/configuration.xml">
- <!ENTITY deployment SYSTEM "modules/deployment.xml">
- <!ENTITY configuration_reference SYSTEM
"modules/configuration_reference.xml">
- <!ENTITY jmx_reference SYSTEM "modules/jmx_reference.xml">
- <!ENTITY batching SYSTEM "modules/batching.xml">
- ]>
-<book lang="en">
- <bookinfo>
- <title>JBoss Cache Users' Guide</title>
- <subtitle>A clustered, transactional cache</subtitle>
-
- <!-- Release version and date -->
- <releaseinfo>Release 3.1.0 Cascabel</releaseinfo>
- <pubdate>April 2009</pubdate>
-
- <!-- Authors/contributors -->
- <author>
- <firstname>Manik</firstname>
- <surname>Surtani</surname>
- <email>manik AT jboss DOT org</email>
- </author>
-
- <author>
- <firstname>Brian</firstname>
- <surname>Stansberry</surname>
- <email>brian DOT stansberry AT jboss DOT com</email>
- </author>
-
- <author>
- <firstname>Galder</firstname>
- <surname>Zamarreño</surname>
- <email>galder DOT zamarreno AT jboss DOT com</email>
- </author>
-
- <author>
- <firstname>Mircea</firstname>
- <surname>Markus</surname>
- <email>mircea DOT markus AT jboss DOT com</email>
- </author>
-
- <!-- copyright info -->
- <copyright>
- <year>2004</year>
- <year>2005</year>
- <year>2006</year>
- <year>2007</year>
- <year>2008</year>
- <year>2009</year>
- <holder>JBoss, a division of Red Hat Inc., and all authors as
named.</holder>
- </copyright>
-
- </bookinfo>
-
- <!-- Adds a table of contents here -->
- <toc/>
-
- &preface;
-
- <part label="I">
- <title>Introduction to JBoss Cache</title>
- <partintro>
- <para>
- This section covers what developers would need to quickly start using JBoss
Cache in their projects. It
- covers an overview of the concepts and API, configuration and deployment
information.
- </para>
- </partintro>
- &introduction;
- &basic_api;
- &configuration;
- &batching;
- &deployment;
- &compatibility;
- </part>
-
- <part label="II">
- <title>JBoss Cache Architecture</title>
- <partintro>
- <para>
- This section digs deeper into the JBoss Cache architecture, and is meant for
developers wishing to use the more
- advanced cache features,extend or enhance the cache, write plugins, or are
just looking for detailed knowledge
- of how things work under the hood.
- </para>
- </partintro>
- &architecture;
- &replication;
- &cache_loaders;
- &eviction_policies;
- &transactions;
- </part>
-
- <part label="III">
- <title>JBoss Cache Configuration References</title>
- <partintro>
- <para>
- This section contains technical references for easy looking up.
- </para>
- </partintro>
-
- &configuration_reference;
- &jmx_reference;
- </part>
-</book>
\ No newline at end of file
Modified: enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/replication.xml
===================================================================
--- enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/replication.xml 2009-08-26
00:45:20 UTC (rev 8202)
+++ enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/replication.xml 2009-08-26
01:29:39 UTC (rev 8203)
@@ -358,7 +358,7 @@
<section>
<title>Configuration</title>
- See the <link
linkend="configuration_reference_chapter">configuration reference
section</link> for details on configuring buddy replication.
+ See the <xref linkend="configuration_reference_chapter" />
for details on configuring buddy replication.
</section>
</section>
</section>
@@ -371,7 +371,7 @@
every time data is changed in a cache other caches in the cluster receive
a message informing them that their data is now stale and should be
evicted from memory. Invalidation, when used with a shared cache loader
- (see chapter on <link linkend="cache_loaders">cache
loaders</link>) would cause remote caches to refer to the
+ (see chapter on <xref linkend="cache_loaders" />) would cause
remote caches to refer to the
shared cache loader to retrieve modified data. The benefit of this is
twofold: network traffic is minimized as invalidation messages are very
small compared to replicating updated data, and also that other caches in
Modified: enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/transactions.xml
===================================================================
---
enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/transactions.xml 2009-08-26
00:45:20 UTC (rev 8202)
+++
enterprise-docs/tags/JBoss_EAP_5_0_0/Cache_User_Guide/en-US/transactions.xml 2009-08-26
01:29:39 UTC (rev 8203)
@@ -54,7 +54,7 @@
Writer threads, on the other hand, need to acquire a lock before any
writing can commence. Currently,
we use lock striping to improve the memory performance of the cache, and
the size of the shared lock pool
can be tuned using the <literal>concurrencyLevel</literal>
attribute of the <literal>locking</literal>
- element. See the <link
linkend="configuration_reference_chapter">configuration
reference</link>
+ element. See the <xref
linkend="configuration_reference_chapter" />
for details. After acquiring an exclusive lock on an Fqn, the writer
thread then wraps the state to be
modified in a container as well, just like with reader threads, and then
copies this state for writing.
When copying, a reference to the original version is still maintained in
the container (for rollbacks).
@@ -69,7 +69,7 @@
If a writer is unable to acquire the write lock after some time, a
<literal>TimeoutException</literal> is
thrown. This lock acquisition timeout defaults to 10000 millis and can be
configured using the
<literal>lockAcquisitionTimeout</literal> attribute of the
<literal>locking</literal> element. See the
- <link
linkend="configuration_reference_chapter">configuration
reference</link> for details.
+ <xref linkend="configuration_reference_chapter" /> for
details.
</para>
<section id="mvcc.iso">
<title>Isolation Levels</title>
@@ -107,7 +107,7 @@
be an issue (for example, if the state written has no relationship to
the state originally read) and
should be allowed. If your application does not care about write
skews, you can allow them to happen
by setting the <literal>writeSkewCheck</literal>
configuration attribute to <literal>false</literal>.
- See the <link
linkend="configuration_reference_chapter">configuration
reference</link> for details.
+ See the <xref linkend="configuration_reference_chapter"
/> for details.
</para>
<para>
Note that write skews cannot happen when using READ_COMMITTED since
threads always work off committed
@@ -147,7 +147,7 @@
<title>Pessimistic and Optimistic Locking Schemes</title>
<para>
From JBoss Cache 3.x onwards, pessimistic and optimistic locking schemes are
deprecated in favor of
- <link linkend="transactions.locks.mvcc">MVCC</link>.
It is recommended that existing applications
+ <xref linkend="transactions.locks.mvcc" />. It is
recommended that existing applications
move off these legacy locking schemes as support for them will eventually be
dropped altogether in future
releases.
</para>
@@ -227,7 +227,7 @@
</para>
<para>When the transaction commits, we initiate either a one- two-phase
commit
- protocol. See <link linkend="replication.tx">replicated caches
and transactions</link> for details.
+ protocol. See <xref linkend="replication.tx" /> for details.
</para>
</section>