Author: laubai Date: 2009-12-09 23:47:53 -0500 (Wed, 09 Dec 2009) New Revision: 8317 Modified: enterprise-docs/tags/JBoss_EWP_5_0_0/Cache_User_Guide/en-US/basic_api.xml enterprise-docs/tags/JBoss_EWP_5_0_0/Cache_User_Guide/en-US/configuration.xml enterprise-docs/tags/JBoss_EWP_5_0_0/Cache_User_Guide/en-US/deployment.xml Log: Added first part of changes for JBPAPP-2964. Modified: enterprise-docs/tags/JBoss_EWP_5_0_0/Cache_User_Guide/en-US/basic_api.xml =================================================================== --- enterprise-docs/tags/JBoss_EWP_5_0_0/Cache_User_Guide/en-US/basic_api.xml 2009-12-10 04:47:19 UTC (rev 8316) +++ enterprise-docs/tags/JBoss_EWP_5_0_0/Cache_User_Guide/en-US/basic_api.xml 2009-12-10 04:47:53 UTC (rev 8317) @@ -21,7 +21,7 @@ </para> <para> - Note that the diagram above only depicts some of the more popular API methods. Reviewing the javadoc for the + Note that the diagram above only depicts some of the more popular API methods. Reviewing the Javadoc for the above interfaces is the best way to learn the API. Below, we cover some of the main points. </para> </section> @@ -190,7 +190,7 @@ </para> <para> - The <literal>Fqn</literal> class provides are variety of factory methods; see the javadoc for all the + The <literal>Fqn</literal> class provides are variety of factory methods; see the Javadoc for all the possibilities. The following illustrates the most commonly used approaches to creating an Fqn: </para> @@ -307,7 +307,7 @@ cache.addCacheListener(myListener); ]]></programlisting> <para> - Similar methods exist for removing or querying registered listeners. See the javadocs on the + Similar methods exist for removing or querying registered listeners. See the Javadocs on the <literal>Cache</literal> interface for more details. </para> <para> @@ -511,7 +511,7 @@ </itemizedlist> </para> <para> - Refer to the javadocs on the annotations as well as the + Refer to the Javadocs on the annotations as well as the <literal>Event</literal> subtypes for details of what is passed in to your method, and when. </para> <para> @@ -553,7 +553,7 @@ <para> By default, all notifications are synchronous, in that they happen on the thread of the caller which generated the event. As such, it is good practise to ensure cache listener implementations don't hold up the thread in - long-running tasks. Alternatively, you could set the <literal>CacheListener.sync()</literal> attribute to + long-running tasks. Alternatively, you could set the <literal>CacheListener.sync</literal> attribute to <literal>false</literal>, in which case you will not be notified in the caller's thread. See the <xref linkend="element.listeners" /> on tuning this thread pool and size of blocking queue. Modified: enterprise-docs/tags/JBoss_EWP_5_0_0/Cache_User_Guide/en-US/configuration.xml =================================================================== --- enterprise-docs/tags/JBoss_EWP_5_0_0/Cache_User_Guide/en-US/configuration.xml 2009-12-10 04:47:19 UTC (rev 8316) +++ enterprise-docs/tags/JBoss_EWP_5_0_0/Cache_User_Guide/en-US/configuration.xml 2009-12-10 04:47:53 UTC (rev 8317) @@ -102,14 +102,16 @@ </para> <programlisting role="JAVA"><![CDATA[ - Configuration config = new Configuration(); - config.setTransactionManagerLookupClass( GenericTransactionManagerLookup.class.getName() ); - config.setIsolationLevel(IsolationLevel.READ_COMMITTED); - config.setCacheMode(CacheMode.LOCAL); - config.setLockAcquisitionTimeout(15000); +Configuration config = new Configuration(); +config.setTransactionManagerLookupClass( + GenericTransactionManagerLookup.class.getName() + ); +config.setIsolationLevel(IsolationLevel.READ_COMMITTED); +config.setCacheMode(CacheMode.LOCAL); +config.setLockAcquisitionTimeout(15000); - CacheFactory factory = new DefaultCacheFactory(); - Cache cache = factory.createCache(config); +CacheFactory factory = new DefaultCacheFactory(); +Cache cache = factory.createCache(config); ]]></programlisting> <para> @@ -143,8 +145,8 @@ <literal>Configuration</literal> class and its <xref linkend="configuration.elements" /> - are all Java Beans that expose all config elements via simple setters - and getters. Therefore, any good IOC framework such as Spring, Google Guice, JBoss Microcontainer, etc. should be able to + are all Java Beans that expose all configuration elements via simple setters + and getters. Therefore, any good IOC framework such as JBoss Microcontainer should be able to build up a <literal>Configuration</literal> from an XML file in @@ -177,7 +179,7 @@ <para> Following is a brief overview of the components of a <literal>Configuration</literal> - . See the javadoc and the linked + . See the Javadoc and the linked chapters in this book for a more complete explanation of the configurations associated with each component. @@ -299,7 +301,7 @@ <section id="configuration.options"> <title>Overriding the Configuration via the Option API</title> <para> - The Option API allows you to override certain behaviours of the cache on a per invocation basis. + The Option API allows you to override certain behaviors of the cache on a per invocation basis. This involves creating an instance of <literal>org.jboss.cache.config.Option</literal> , setting the options @@ -330,7 +332,7 @@ node.put("localCounter", new Integer(2)); ]]></programlisting> <para> - See the javadocs on the + See the Javadocs on the <literal>Option</literal> class for details on the options available. </para> Modified: enterprise-docs/tags/JBoss_EWP_5_0_0/Cache_User_Guide/en-US/deployment.xml =================================================================== --- enterprise-docs/tags/JBoss_EWP_5_0_0/Cache_User_Guide/en-US/deployment.xml 2009-12-10 04:47:19 UTC (rev 8316) +++ enterprise-docs/tags/JBoss_EWP_5_0_0/Cache_User_Guide/en-US/deployment.xml 2009-12-10 04:47:53 UTC (rev 8317) @@ -28,7 +28,7 @@ <para> After creation, you could share your cache instance among different application components either by using an - IOC container such as Spring, JBoss Microcontainer, etc., or by binding it to JNDI, or simply + IOC container such as JBoss Microcontainer, or by binding it to JNDI, or simply holding a static reference to the cache. </para> @@ -140,7 +140,7 @@ ]]></programlisting> <para> - See <ulink url="http://www.jboss.org/jbossmc/docs">the JBoss Microcontainer documentation</ulink> + See <ulink url="http://www.jboss.org/jbossmc">the JBoss Microcontainer documentation</ulink> for details on the above syntax. Basically, each <literal>bean</literal> element represents an object and is used to create a @@ -198,7 +198,7 @@ cache has already been started.</para> </listitem> </itemizedlist> - See the <literal>CacheJmxWrapperMBean</literal> javadoc for more details. + See the <literal>CacheJmxWrapperMBean</literal> Javadoc for more details. </para> <para> If a <literal>CacheJmxWrapper</literal> is registered, JBoss Cache also provides MBeans @@ -219,11 +219,8 @@ deploying your cache. </para> - <section id="jmx.registration.programatic"> - <title>Programatic Registration</title> - <section id="jmx.registration.programatic.construct"> - <title>With a Cache instance</title> + <title>Programatic Registration with a Cache instance</title> <para> Simplest way to do this is to create your <literal>Cache</literal> and pass it to the <literal>JmxRegistrationManager</literal> constructor. @@ -252,7 +249,7 @@ </section> <section id="jmx.registration.programatic.cfg"> - <title>With a Configuration instance</title> + <title>Programatic Registration with a Configuration instance</title> <para> Alternatively, build a <literal>Configuration</literal> object and pass it to the <literal>CacheJmxWrapper</literal>. The wrapper will construct the <literal>Cache</literal> on your @@ -282,7 +279,6 @@ wrapper.destroy(); ]]></programlisting> </section> - </section> <section> <title>JMX-Based Deployment in JBoss AS (JBoss AS 5.x)</title> @@ -395,7 +391,7 @@ <para> If a <literal>CacheJmxWrapper</literal> is registered with JMX, the wrapper also ensures that an MBean is registered in JMX for each interceptor and component that exposes statistics. - <footnote> + <note> <para> Note that if the <literal>CacheJmxWrapper</literal> @@ -408,7 +404,7 @@ that this sort of "discovery" of the JMX environment was beyond the proper scope of a caching library, so we removed this functionality. </para> - </footnote>. + </note>. Management tools can then access those MBeans to examine the statistics. See the section in the <xref linkend="jmx_reference.statistics" /> pertaining to the statistics that are made available via JMX.