You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@turbine.apache.org by jt...@apache.org on 2002/02/16 21:32:41 UTC
cvs commit: jakarta-turbine-stratum/xdocs JCSPackageInformation.xml
jtaylor 02/02/16 12:32:41
Modified: xdocs JCSPackageInformation.xml
Log:
Adding the the JCS package docs.
Revision Changes Path
1.2 +43 -58 jakarta-turbine-stratum/xdocs/JCSPackageInformation.xml
Index: JCSPackageInformation.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-stratum/xdocs/JCSPackageInformation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- JCSPackageInformation.xml 16 Feb 2002 13:35:29 -0000 1.1
+++ JCSPackageInformation.xml 16 Feb 2002 20:32:41 -0000 1.2
@@ -5,6 +5,7 @@
<title>JCS Package Information</title>
<author email="pete@kazmier.com">Pete Kazmier</author>
<author email="ASmuts@therealm.com">Aaron Smuts</author>
+ <author email="james@jamestaylor.org">James Taylor</author>
</properties>
<body>
@@ -22,12 +23,16 @@
<tr><th>Package</th><th>Description</th></tr>
<tr><td>org.apache.stratum.jcs</td>
<td>
-
+ Root package of JCS. Currently this package only contains the
+ class JCS which provides a simple interface for clients to use
+ JCS.
</td>
</tr>
<tr><td>org.apache.stratum.jcs.access</td>
<td>
-
+ Contains classes for accessing the cache. The CacheAccess
+ interface, which all classes in this package implement, provides
+ all the methods a client should need to use a Cache.
</td>
</tr>
</table>
@@ -40,7 +45,10 @@
<tr><th>Package</th><th>Description</th></tr>
<tr><td>org.apache.stratum.jcs.config</td>
<td>
-
+ This package contains utility classes that are used when
+ configuring the cache. NOTE: It is likely that these classes
+ will be removed in the future in favor of the configuration code
+ in stratum and BeanUtils.
</td>
</tr>
</table>
@@ -80,12 +88,15 @@
</tr>
<tr><td>org.apache.stratum.jcs.engine.memory.lru</td>
<td>
- The primary memory plugin.
+ The primary memory plugin using a 'least recently used' removal
+ policy.
</td>
</tr>
<tr><td>org.apache.stratum.jcs.engine.memory.mru</td>
<td>
-
+ A memory plugin implemented using a 'most recently used' removal
+ policy. In general this is <bold>slow</bold> and should not be
+ used.
</td>
</tr>
</table>
@@ -100,32 +111,41 @@
<tr><th>Package</th><th>Description</th></tr>
<tr><td>org.apache.stratum.jcs.auxiliary</td>
<td>
-
+ Root package for auxiliary caches.
</td>
</tr>
<tr><td>org.apache.stratum.jcs.auxiliary.behavior</td>
<td>
-
+ Auxilliary cache interfaces.
</td>
</tr>
<tr><td>org.apache.stratum.jcs.auxiliary.disk</td>
<td>
-
+ The primary disk auxiliary. Objects are serialized to a file on
+ disk. This implementation uses memory keys and performs quite
+ well. Recomended for most cases.
</td>
</tr>
<tr><td>org.apache.stratum.jcs.auxiliary.disk.jisp</td>
<td>
-
+ Disk cache implemented with the <a href="http://www.coyotegulch.com/jisp/">
+ Java Indexed Serialization Package</a>, which allows serialization
+ of objects to B-Tree indexed tables on disk. This is quite
+ <u>slow</u> currently.
</td>
</tr>
<tr><td>org.apache.stratum.jcs.auxiliary.disk.hsql</td>
<td>
-
+ A disk cache using Hypersonic SQL to serialize the contained
+ objects.
</td>
</tr>
<tr><td>org.apache.stratum.jcs.auxiliary.lateral</td>
<td>
-
+ Root package for the lateral cache family. Lateral caches
+ broadcast puts and removals to other local caches. See
+ <a href="LateralTCPAuxCache.html">this</a> explanation for more
+ information.
</td>
</tr>
<tr><td>org.apache.stratum.jcs.auxiliary.lateral.socket</td>
@@ -175,7 +195,9 @@
</tr>
<tr><td>org.apache.stratum.jcs.auxiliary.remote</td>
<td>
-
+ Root package for the remote auxiliary cache. See
+ <a href="RemoteAuxCache.html">this</a> explanation
+ of the remote cache for more information.
</td>
</tr>
<tr><td>org.apache.stratum.jcs.auxiliary.remote.server</td>
@@ -214,52 +236,19 @@
<tr><th>Package</th><th>Description</th></tr>
<tr><td>org.apache.stratum.jcs.utils</td>
<td>
-
+ Root package for utils.
</td>
</tr>
<tr><td>org.apache.stratum.jcs.utils.config</td>
<td>
-
- </td>
- </tr>
- <tr><td>org.apache.stratum.jcs.utils.data</td>
- <td>
-
- </td>
- </tr>
- <tr><td>org.apache.stratum.jcs.utils.date</td>
- <td>
-
+ Contains a file with constants used by the utils.servlet package.
+ Will be removed.
</td>
</tr>
- <tr><td>org.apache.stratum.jcs.utils.email</td>
+ <tr><td>org.apache.stratum.jcs.utils.locking</td>
<td>
-
- </td>
- </tr>
- <tr><td>org.apache.stratum.jcs.utils.file</td>
- <td>
-
- </td>
- </tr>
- <tr><td>org.apache.stratum.jcs.utils.html</td>
- <td>
-
- </td>
- </tr>
- <tr><td>org.apache.stratum.jcs.utils.log</td>
- <td>
-
- </td>
- </tr>
- <tr><td>org.apache.stratum.jcs.utils.net</td>
- <td>
-
- </td>
- </tr>
- <tr><td>org.apache.stratum.jcs.utils.reuse</td>
- <td>
-
+ Implementation of a read write lock which maintains FIFO ordering
+ for write lock requests, but no ordering for read lock requests.
</td>
</tr>
<tr><td>org.apache.stratum.jcs.utils.servlet</td>
@@ -269,17 +258,13 @@
</tr>
<tr><td>org.apache.stratum.jcs.utils.servlet.session</td>
<td>
- Contains distributed session code.
- </td>
- </tr>
- <tr><td>org.apache.stratum.jcs.utils.text</td>
- <td>
-
+ Contains distributed http session code.
</td>
</tr>
<tr><td>org.apache.stratum.jcs.utils.threads</td>
<td>
-
+ Contains a thread pool implementation, some of which is originally
+ from Tomcat.
</td>
</tr>
</table>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>