[jbosscache-commits] JBoss Cache SVN: r5878 - core/trunk/src/main/docbook/userguide/en/modules.

[jbosscache-commits at lists.jboss.org]

Author: genman
Date: 2008-05-20 12:34:22 -0400 (Tue, 20 May 2008)
New Revision: 5878

Modified:
   core/trunk/src/main/docbook/userguide/en/modules/cache_loaders.xml
Log:
Clean up Amazon S3 documentation


Modified: core/trunk/src/main/docbook/userguide/en/modules/cache_loaders.xml
===================================================================
--- core/trunk/src/main/docbook/userguide/en/modules/cache_loaders.xml	2008-05-19 16:54:25 UTC (rev 5877)
+++ core/trunk/src/main/docbook/userguide/en/modules/cache_loaders.xml	2008-05-20 16:34:22 UTC (rev 5878)
@@ -938,6 +938,7 @@
             <literal>CacheSPI.getMarshaller()</literal>
             instance.
             Read the javadoc on how data is structured and stored.
+            Data is stored using Java serialization.
             Be aware this means data is not readily accessible over HTTP to
             non-JBoss Cache clients. Your feedback and help would be appreciated
             to extend this cache loader for that purpose.
@@ -947,9 +948,7 @@
             With this cache loader, single-key operations such as
             <literal>Node.remove(Object)</literal>
             and
-            <literal>Node.put(Object,
-               Object)
-            </literal>
+            <literal>Node.put(Object, Object)</literal>
             are the slowest as data is stored in a single Map instance.
             Use bulk operations such as
             <literal>Node.replaceAll(Map)</literal>
@@ -965,7 +964,7 @@
             <title>Amazon S3 Library</title>
             <para>The S3 cache loader is provided with the default
                distribution but requires a library to access the service
-               at runtime. This runtime library may be obtained through the Sourceforge Maven
+               at runtime. This runtime library may be obtained through a Sourceforge Maven
                Repository. Include the following sections in your pom.xml file:
             </para>
             <programlisting><![CDATA[
@@ -978,17 +977,19 @@
          <groupId>net.noderunner</groupId>
          <artifactId>amazon-s3</artifactId>
          <version>1.0.0.0</version>
+         <scope>runtime</scope>
       </dependency>
               ]]>
             </programlisting>
             If you do not use Maven, you can still download the
-            amazon-s3 library through the repository URL.
+            amazon-s3 library by navigating the repository or through
+            <ulink url="http://e-xml.sourceforge.net/maven2/repository/net/noderunner/amazon-s3/1.0.0.0/amazon-s3-1.0.0.0.jar">this URL</ulink>.
          </section>
 
          <section>
             <title>Configuration</title>
             <para>At a minimum, you must configure your Amazon S3 access key and
-               secret access key. The other configuration keys are listed in general
+               secret access key. The following configuration keys are listed in general
                order of utility.
             </para>
 
@@ -1016,7 +1017,7 @@
                      Set to
                      <literal>true</literal>
                      to use HTTPS.
-                     Note that unencrypted is obviously faster.
+                     Note that unencrypted uploads and downloads use less CPU.
                   </listitem>
 
                   <listitem>
@@ -1025,22 +1026,22 @@
                      Name of the bucket to store data.
                      For different caches using the same access key, use a different bucket name.
                      Read the S3 documentation on the definition of a bucket.
-                     The default is<literal>jboss-cache</literal>.
+                     The default value is <literal>jboss-cache</literal>.
                   </listitem>
 
                   <listitem>
                      <literal>cache.s3.callingFormat</literal>
                      -
-                     One of<literal>PATH</literal>,<literal>SUBDOMAIN</literal>, or
+                     One of <literal>PATH</literal>, <literal>SUBDOMAIN</literal>, or
                      <literal>VANITY</literal>.
                      Read the S3 documentation on the use of calling domains.
-                     The default is<literal>SUBDOMAIN</literal>.
+                     The default value is <literal>SUBDOMAIN</literal>.
                   </listitem>
 
                   <listitem>
                      <literal>cache.s3.optimize</literal>
                      -
-                     The default is<literal>false</literal>.
+                     The default is <literal>false</literal>.
                      If true,
                      <literal>put(Map)</literal>
                      operations
@@ -1052,7 +1053,7 @@
                   <listitem>
                      <literal>cache.s3.parentCache</literal>
                      -
-                     The default is<literal>true</literal>.
+                     The default is <literal>true</literal>.
                      Set this value to
                      <literal>false</literal>
                      if you are using multiple caches
@@ -1076,11 +1077,11 @@
                      <literal>cache.s3.location</literal>
                      -
                      This choses a primary storage location for your data
-                     to reduce loading and storage latency closest to you.
-                     Set to
-                     <literal>EU</literal>
-                     to store data locale to Europe.
-                     The default is<literal>null</literal>, to store in the United States.
+                     to reduce loading and retrevial latency.
+                     Set to <literal>EU</literal>
+                     to store data in Europe.
+                     The default is <literal>null</literal>, to store data in
+                     the United States.
                   </listitem>
                </itemizedlist>
             </para>