Author: manik.surtani(a)jboss.com Date: 2008-10-14 08:01:12 -0400 (Tue, 14 Oct 2008) New Revision: 6930 Modified: core/trunk/src/main/docbook/tutorial/en/master.xml Log: Updated tutorial for 3.0 Modified: core/trunk/src/main/docbook/tutorial/en/master.xml =================================================================== --- core/trunk/src/main/docbook/tutorial/en/master.xml 2008-10-14 11:19:00 UTC (rev 6929) +++ core/trunk/src/main/docbook/tutorial/en/master.xml 2008-10-14 12:01:12 UTC (rev 6930) @@ -71,29 +71,26 @@ <literal>jbosscache-core-3.X.Y</literal> . For the sake of this tutorial, I will refer to this as - <literal>JBossCache</literal> + <literal>${JBOSSCACHE_HOME}</literal> . </para> - <para>The configuration files are located in the - <literal>etc</literal> - directory of the distribution. You can + <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> @@ -103,47 +100,44 @@ <title>Script</title> <para>The only script needed for this tutorial is the - <literal>JBossCache/tutorial/build.xml</literal> + <literal>${JBOSSCACHE_HOME}/tutorial/build.xml</literal> ant script. You also need to have - <ulink url="http://ant.apache.org/">ant</ulink> - installed for running the demo. + <ulink url="http://ant.apache.org/">Apache Ant</ulink> + installed for running the tutorial GUI. </para> </section> <section> - <title>Running The Demo GUI</title> + <title>Running The Tutorial GUI</title> <para> - The demo is run by: - <ol> - <li>Changing to the - <literal>tutorial</literal> - directory (e.g.,<literal>cd tutorial</literal>) - </li> - <li>And then running the ant script (e.g.,<literal>ant run</literal>) - </li> - </ol> + The GUI is run by: + <itemizedlist> + <listitem>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> + </itemizedlist> </para> <para> This will cause a GUI window to appear, giving you a tree view of the cache in the top pane and a BeanShell - view - of the JVM in the lower pane. + view of the JVM in the lower pane. </para> <para> The BeanShell view is preset with the following variables: <itemizedlist> <listitem> <literal>cache</literal> - - a reference to the Cache interface, used by the GUI instance. + - a reference to the <literal>org.jboss.cache.Cache</literal> interface, used by the GUI instance. </listitem> <listitem> <literal>root</literal> - - a reference to the root Node instance for the above cache. + - a reference to the root <literal>org.jboss.cache.Node</literal> instance for the above cache. </listitem> <listitem> <literal>transactionManager</literal> - - a reference to the registered transaction manager. + - a reference to the registered <literal>javax.transaction.TransactionManager</literal> instance. </listitem> </itemizedlist> The references made available to the BeanShell window point to the same cache instance used by the tree view in @@ -152,22 +146,21 @@ </para> <para> - To run the demo as a replicated demo, it is useful to start another command line window and run the ant script + To run the GUI as a replicated tutorial, it is useful to start another command line window and run the ant script again as you did above. Now you will have two cache instances running in two separate GUIs, replicating state - to - each other. + to each other. </para> </section> <section> <title>Tutorials</title> - Note that it is recommended that you shut down and restart the demo GUI for each of the following tutorials, to + 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. <section> <title>Caches and Nodes</title> <para> - For this tutorial, start a single instance of the demo GUI. In this tutorial, we will: + For this tutorial, start a single instance of the GUI. In this tutorial, we will: <itemizedlist> <listitem>Create nodes under the root node.</listitem> @@ -238,9 +231,7 @@ <literal>Cache</literal> and <literal>Node</literal> - <ulink - url="http://labs.jboss.org/portal/jbosscache/docs/index.html"&g... docs - </ulink> + <ulink url="http://labs.jboss.org/portal/jbosscache/docs/index.html"&g... docs</ulink> and try out the APIs in the BeanShell script. </para> </section> @@ -248,7 +239,7 @@ <section> <title>Replication</title> <para> - For this tutorial, start two instances instance of the demo GUI. Repeat the exercises in the previous + For this tutorial, start two instances instance of the GUI. Repeat the exercises in the previous tutorial, only alternating between the two GUI windows when creating/removing nodes or adding/removing data. This demonstrates @@ -259,7 +250,7 @@ <section> <title>Transactions</title> <para> - For this tutorial, start two instances instance of the demo GUI. Repeat the exercises in the previous + For this tutorial, start two instances instance of the GUI. Repeat the exercises in the previous tutorial, only starting transactions before creating/removing nodes or adding/removing data. This will depict how replication only occurs on transaction boundaries. Try rolling back a few transactions as well, to see how @@ -270,7 +261,7 @@ tm = cache.getTransactionManager(); tm.begin(); // do operations here - tm.commit(); // tm.rollback(); + tm.commit(); // or tm.rollback(); ]]></programlisting> </section>