Update of /cvsroot/opensymphony/website/web/oscache
In directory sc8-pr-cvs1:/tmp/cvs-serv25697/web/oscache
Modified Files:
changelog.jsp clustering.jsp configuration.jsp default.jsp
install.jsp requirements.jsp
Log Message:
Updates for the 2.0 final release
Index: changelog.jsp
===================================================================
RCS file: /cvsroot/opensymphony/website/web/oscache/changelog.jsp,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- changelog.jsp 4 Aug 2003 11:55:50 -0000 1.2
+++ changelog.jsp 22 Sep 2003 23:08:41 -0000 1.3
@@ -5,6 +5,25 @@
<body bgcolor="#FFFFFF">
+<h3>OSCache 2.0</h3>
+<p><i>(10th August 2003 - by <a href="mailto:chris@swebtec.com">Chris Miller</a>)</i></p>
+<b>Bug Fixes:</b>
+<ul>
+ <li>[CACHE-52] Fixed a problem that caused no output on Tomcat for small JSP files.</li>
+ <li>[CACHE-53] Updated documentation to explain that a PersistenceListener must
+ be specified to enable caching to disk.</li>
+ <li>[CACHE-55] JMS was throwing an exception on Weblogic.</li>
+ <li>Altering the cache capacity on the fly using the administrator classes wasn't
+ working correctly.</li>
+</ul>
+<b>Improvements:</b>
+<ul>
+ <li>Minor FastCronParser speedup.</li>
+ <li>Made ClusterNotification constants public.</li>
+ <li>Dropped some of the logging levels from INFO down to DEBUG.</li>
+ <li>Release has been split into two - a binary release and a full release (includes source).</li>
+</ul>
+
<h3>OSCache 2.0 (beta 2)</h3>
<p><i>(4th August 2003 - by <a href="mailto:chris@swebtec.com">Chris Miller</a>)</i></p>
Index: clustering.jsp
===================================================================
RCS file: /cvsroot/opensymphony/website/web/oscache/clustering.jsp,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- clustering.jsp 5 Aug 2003 07:57:32 -0000 1.3
+++ clustering.jsp 22 Sep 2003 23:08:41 -0000 1.4
@@ -62,7 +62,9 @@
<p><code>cache.event.listeners=com.opensymphony.oscache.plugins.clustersupport.JavaGroupsBroadcastingListener</code></p>
-<p>In most cases, that's it! OSCache will now broadcast any cache flush events across the LAN.</p>
+<p>In most cases, that's it! OSCache will now broadcast any cache flush events across the LAN. The javagroups-all.jar
+library is not included with the binary distribution due to its size, however you can obtain it either by downloading
+the full oscache distribution, or by visiting the <a href="http://www.javagroups.com">JavaGroups</a> website.</p>
<p>If you want to run more than one OSCache cluster on the same LAN, you will need to use different
multicast IP addresses. This allows the caches to exist in separate multicast groups and therefore
Index: configuration.jsp
===================================================================
RCS file: /cvsroot/opensymphony/website/web/oscache/configuration.jsp,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- configuration.jsp 4 Aug 2003 11:34:18 -0000 1.2
+++ configuration.jsp 22 Sep 2003 23:08:41 -0000 1.3
@@ -1 +1,109 @@
-<html>
<head>
<title>OSCache Configuration Guide</title>
</head>
<body bgcolor="#FFFFFF">
<p>This guide only covers the configuration of OSCache by using the <code>oscache.properties</code> file.
To see how to install OSCache and where to place the <code>oscache.properties</code> file, see the
<a href="install.jsp">Installation Guide</a>.</p>
The following properties are able to be set in the <code>oscache.properties</code> file:
<h3>cache.path</h3>
<p>This specifies the directory on disk where caches will be stored. The directory will be created
if it doesn't already exist, but remember that OSCache must have permission to write to this location.</p>
<p>If you want to disable file caching, just comment out or remove this property.</p>
<p>Note: for Windows machines, the backslash character '\' needs to be escaped. ie in Windows:</p>
<p><code>cache.path=c:\\myapp\\cache</code></p>
<p>or *ix:</p>
<p><code>cache.path=/opt/myapp/cache</code></p>
<h3>cache.memory</h3>
<p>Valid values are <code>true</code> or <code>false</code>, with <code>true</code> being the default value.
If you want to disable memory caching, just comment out or remove this line.</p>
<p>Note: disabling memory AND disk caching is possible but fairly stupid ;)</p>
<h3>cache.capacity</h3>
<p>The maximum number of items that a cache will hold. By default the capacity is unlimited - the cache will
never remove any items. Negative values will also be treated as meaning unlimited capacity.</p>
<h3>cache.algorithm</h3>
<p>The default cache algorithm to use. Note that in order to use an algorithm the cache size must also
be specified. If the cache size is not specified, the cache algorithm will be Unlimited cache regardless
of the value of this property. If you specify a size but not an algorithm, the cache algorithm used will be
<code>com.opensymphony.oscache.base.algorithm.LRUCache</code>.</p>
<p>OSCache currently comes with three algorithms:
<ul>
<li><code>com.opensymphony.oscache.base.algorithm.LRUCache</code> - Least Recently Used. This is the
default when a <code>cache.capacity</code> is set.</li>
<li><code>com.opensymphony.oscache.base.algorithm.FIFOCache</code> - First In First Out.</li>
<li><code>com.opensymphony.oscache.base.algorithm.UnlimitedCache</code> - Content that is added to
the cache will never be discarded. This is the default when no value is set for the <code>cache.capacity</code>
property.</li>
</ul>
</p>
<h3>cache.unlimited.disk</h3>
<p>Indicates whether the disk cache should be treated as unlimited or not. The default value is
<code>false</code>.</p>
<h3>cache.persistence.class</h3>
<p>Specifies the class to use for persisting cache entries. If no persistence class is specified but the
<code>cache.path</code> property has been set, this will default to <code>com.opensymphony.oscache.plugins.diskpersistence.DiskPersistenceListener</code>.
By specifying your own class here you should be able to persist cache data using say JDBC or LDAP.</p>
<h3>cache.event.listeners</h3>
<p>This takes a comma-delimited list of fully-qualified class names. Each class in the list <em>must</em>
implement one (or more) of the following interfaces:
<ul>
<li><b>CacheEntryEventListener</b> - Receives cache add/update/flush and remove events.</li>
<li><b>CacheMapAccessEventListener</b> - Receives cache access events. This allows you to keep statistical
information to track how effectively the cache is working.</li>
</ul>
No listeners are configured by default, however some ship with OSCache that you may wish to enable:
<ul>
<li><b>com.opensymphony.oscache.plugins.clustersupport.BroadcastingCacheEventListener</b>
- provides clustering support for OSCache. Enabling this will cause cache flush events to be broadcast to
other instances of OSCache running on your LAN. See <a href="clustering.jsp">Clustering OSCache</a> for
further information about this event listener.</li>
<li><b>com.opensymphony.oscache.extra.CacheEntryEventListenerImpl</b> - a simple listener implementation
that maintains a running count of all of the entry events that occur during a cache's lifetime.</li>
<li><b>com.opensymphony.oscache.extra.CacheMapAccessEventListenerImpl</b> - a simple listener implementation
that keeps count of all the cache map events (cache hits and misses, and stale hits) that occur on a cache
instance.</li>
</ul>
It is also of course quite straightforward to write your own event listener. See the
<a href="api">JavaDoc API</a> for further details.</p>
<h3>cache.key</h3>
<p>This is the key that will be used by the ServletCacheAdministrator (and hence the custom tags) to
store the cache object in the application and session scope. The default value when this property is
not specified is <code>"__oscache_cache"</code>. If you want to access this default value in your code,
it is available as <code>com.opensymphony.oscache.base.Const.DEFAULT_CACHE_KEY</code>.</p>
<h3>cache.use.host.domain.in.key</h3>
<p>If your server is configured with multiple hosts, you may wish to add host name information to
automatically generated cache keys. If so, set this property to <code>true</code>. The default value
is <code>false</code>.</p>
<h3>Additional Properties</h3>
<p>In additon to the above basic options, any other properties that are specified in this file will still be
loaded and can be made available to your event handlers. For example, the <code>JavaGroupsBroadcastingListener</code>
supports the following additional properties:</p>
<p><b>cache.cluster.multicast.ip</b></p>
<p>The multicast IP to use for this cache cluster. Defaults to <code>231.12.21.132</code>.
<p><b>cache.cluster.properties</b></p>
<p>Specifies additional configuration options for the clustering. The default setting is</p>
<p><code>UDP(mcast_addr=231.12.21.132;mcast_port=45566;ip_ttl=32;mcast_send_buf_size=150000;mcast_recv_buf_size=80000):PING(timeout=2000;num_initial_members=3):MERGE2(min_interval=5000;max_interval=10000):FD_SOCK:VERIFY_SUSPECT(timeout=1500):pbcast.NAKACK(gc_lag=50;retransmit_timeout=300,600,1200,2400,4800):pbcast.STABLE(desired_avg_gossip=20000):UNICAST(timeout=5000):FRAG(frag_size=8096;down_thread=false;up_thread=false):pbcast.GMS(join_timeout=5000;join_retry_timeout=2000;shun=false;print_local_addr=true)</code></p>
<p>See the <a href="clustering.jsp">Clustering OSCache</a> documentation for further details on the above
two properties.</p>
<%@ include file="navpanel.jsp" %>
</body>
</html>
\ No newline at end of file
+<html>
+<head>
+<title>OSCache Configuration Guide</title>
+</head>
+<body bgcolor="#FFFFFF">
+<p>This guide only covers the configuration of OSCache by using the <code>oscache.properties</code> file.
+ To see how to install OSCache and where to place the <code>oscache.properties</code> file, see the
+ <a href="install.jsp">Installation Guide</a>.</p>
+
+The following properties are able to be set in the <code>oscache.properties</code> file:
+
+<h3>cache.memory</h3>
+<p>Valid values are <code>true</code> or <code>false</code>, with <code>true</code> being the default value.
+If you want to disable memory caching, just comment out or remove this line.</p>
+<p>Note: disabling memory AND disk caching is possible but fairly stupid ;)</p>
+
+<h3>cache.capacity</h3>
+<p>The maximum number of items that a cache will hold. By default the capacity is unlimited - the cache will
+never remove any items. Negative values will also be treated as meaning unlimited capacity.</p>
+
+<h3>cache.algorithm</h3>
+<p>The default cache algorithm to use. Note that in order to use an algorithm the cache size must also
+be specified. If the cache size is not specified, the cache algorithm will be Unlimited cache regardless
+of the value of this property. If you specify a size but not an algorithm, the cache algorithm used will be
+<code>com.opensymphony.oscache.base.algorithm.LRUCache</code>.</p>
+<p>OSCache currently comes with three algorithms:
+<ul>
+ <li><code>com.opensymphony.oscache.base.algorithm.LRUCache</code> - Least Recently Used. This is the
+ default when a <code>cache.capacity</code> is set.</li>
+ <li><code>com.opensymphony.oscache.base.algorithm.FIFOCache</code> - First In First Out.</li>
+ <li><code>com.opensymphony.oscache.base.algorithm.UnlimitedCache</code> - Content that is added to
+ the cache will never be discarded. This is the default when no value is set for the <code>cache.capacity</code>
+ property.</li>
+</ul>
+</p>
+
+<h3>cache.unlimited.disk</h3>
+<p>Indicates whether the disk cache should be treated as unlimited or not. The default value is
+<code>false</code>.</p>
+
+<h3>cache.persistence.class</h3>
+<p>Specifies the class to use for persisting cache entries. This class must implement the <code>PersistenceListener</code>
+interface. OSCache comes with an implementation that provides filesystem based persistence. Set this property
+to <code>com.opensymphony.oscache.plugins.diskpersistence.DiskPersistenceListener</code> to enable this
+implementation. By specifying your own class here you should be able to persist cache data using say JDBC or LDAP.</p>
+<p>The <code>DiskPersistenceListener</code> class requires the following extra configuration property to be
+set:
+<blockquote>
+<h3>cache.path</h3>
+<p>This specifies the directory on disk where caches will be stored. The directory will be created if it
+doesn't already exist, but remember that OSCache must have permission to write to this location.</p>
+<p>Note: for Windows machines, the backslash character '\' needs to be escaped. ie in Windows:</p>
+<p><code>cache.path=c:\\myapp\\cache</code></p>
+<p>or *ix:</p>
+<p><code>cache.path=/opt/myapp/cache</code></p>
+</blockquote>
+
+<h3>cache.event.listeners</h3>
+<p>This takes a comma-delimited list of fully-qualified class names. Each class in the list <em>must</em>
+implement one (or more) of the following interfaces:
+<ul>
+ <li><b>CacheEntryEventListener</b> - Receives cache add/update/flush and remove events.</li>
+ <li><b>CacheMapAccessEventListener</b> - Receives cache access events. This allows you to keep statistical
+ information to track how effectively the cache is working.</li>
+</ul>
+No listeners are configured by default, however some ship with OSCache that you may wish to enable:
+<ul>
+ <li><b>com.opensymphony.oscache.plugins.clustersupport.BroadcastingCacheEventListener</b>
+ - provides clustering support for OSCache. Enabling this will cause cache flush events to be broadcast to
+ other instances of OSCache running on your LAN. See <a href="clustering.jsp">Clustering OSCache</a> for
+ further information about this event listener.</li>
+ <li><b>com.opensymphony.oscache.extra.CacheEntryEventListenerImpl</b> - a simple listener implementation
+ that maintains a running count of all of the entry events that occur during a cache's lifetime.</li>
+ <li><b>com.opensymphony.oscache.extra.CacheMapAccessEventListenerImpl</b> - a simple listener implementation
+ that keeps count of all the cache map events (cache hits and misses, and stale hits) that occur on a cache
+ instance.</li>
+</ul>
+It is also of course quite straightforward to write your own event listener. See the
+<a href="api">JavaDoc API</a> for further details.</p>
+
+<h3>cache.key</h3>
+<p>This is the key that will be used by the ServletCacheAdministrator (and hence the custom tags) to
+store the cache object in the application and session scope. The default value when this property is
+not specified is <code>"__oscache_cache"</code>. If you want to access this default value in your code,
+it is available as <code>com.opensymphony.oscache.base.Const.DEFAULT_CACHE_KEY</code>.</p>
+
+<h3>cache.use.host.domain.in.key</h3>
+<p>If your server is configured with multiple hosts, you may wish to add host name information to
+automatically generated cache keys. If so, set this property to <code>true</code>. The default value
+is <code>false</code>.</p>
+
+<h3>Additional Properties</h3>
+
+<p>In additon to the above basic options, any other properties that are specified in this file will still be
+loaded and can be made available to your event handlers. For example, the <code>JavaGroupsBroadcastingListener</code>
+supports the following additional properties:</p>
+
+<p><b>cache.cluster.multicast.ip</b></p>
+<p>The multicast IP to use for this cache cluster. Defaults to <code>231.12.21.132</code>.
+
+<p><b>cache.cluster.properties</b></p>
+<p>Specifies additional configuration options for the clustering. The default setting is</p>
+<p><code>UDP(mcast_addr=231.12.21.132;mcast_port=45566;ip_ttl=32;mcast_send_buf_size=150000;mcast_recv_buf_size=80000):PING(timeout=2000;num_initial_members=3):MERGE2(min_interval=5000;max_interval=10000):FD_SOCK:VERIFY_SUSPECT(timeout=1500):pbcast.NAKACK(gc_lag=50;retransmit_timeout=300,600,1200,2400,4800):pbcast.STABLE(desired_avg_gossip=20000):UNICAST(timeout=5000):FRAG(frag_size=8096;down_thread=false;up_thread=false):pbcast.GMS(join_timeout=5000;join_retry_timeout=2000;shun=false;print_local_addr=true)</code></p>
+
+<p>See the <a href="clustering.jsp">Clustering OSCache</a> documentation for further details on the above
+two properties.</p>
+<%@ include file="navpanel.jsp" %>
+</body>
+</html>
Index: default.jsp
===================================================================
RCS file: /cvsroot/opensymphony/website/web/oscache/default.jsp,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- default.jsp 27 Jul 2003 14:33:43 -0000 1.1
+++ default.jsp 22 Sep 2003 23:08:41 -0000 1.2
@@ -1 +1 @@
-<html>
<head>
<title>OSCache Overview</title>
</head>
<body bgcolor="#FFFFFF">
<p><b>OSCache</b> is a widely used, high performance J2EE caching solution.</p>
<h3>The Problems Solved</h3>
<p><b>OSCache</b> solves fundamental problems for dynamic websites:</p>
<ul>
<li><b>Caching Dynamic Content</b> - Dynamic content must often be executed in some form each
request, but sometimes that content doesn't change every request. Caching the whole page does
not help because <i>sections</i> of the page change every request.
<ul>
<li><b>OSCache</b> solves this problem by providing a means to cache sections of JSP pages.</li>
</ul>
</li>
<li><b>Caching Binary Content</b> - Generated images and PDFs can be very costly in terms
of server load.
<ul>
<li><b>OSCache</b> solves this problem through a Servlet 2.3 CachingFilter which can cache any
URI (such as an entire page or a generated image/PDF)</li>
</ul>
</li>
<li><b>Error Tolerance</b> - If one error occurs somewhere on your dynamic page, chances are the
whole page will be returned as an error, even if 95% of the page executed correctly.
<ul>
<li><b>OSCache</b> solves this problem by allowing you to serve the cached content in the event
of an error, and then reporting the error appropriately.</li>
</ul>
</li>
</ul>
<h3>Brief Feature List</h3>
<p>In addition to it's servlet-specific features, <b>OSCache</b> can be used as a generic caching
solution for <i>any</i> Java application. A few of its generic features include:</p>
<ul>
<li><b>Caching of Arbitrary Objects</b> - You are not restricted to caching portions of JSP pages
or HTTP requests. Any Java object can be cached.</li>
<li><b>Comprehensive API</b> - The <b>OSCache</b> API gives you full programmatic control over all of
<b>OSCache's</b> features.</li>
<li><b>Persistent Caching</b> - The cache can optionally be disk-based, thereby allowing expensive-to-create
data to remain cached even across application restarts.</li>
<li><b>Clustering</b> - Support for clustering of cached data can be enabled with a single configuration
parameter. No code changes required.</li>
<li><b>Expiry of Cache Entries</b> - You have a huge amount of control over how cached objects expire,
including pluggable RefreshPolicies if the default functionality does not meet your requirements.</li>
</ul>
<p>We encourage you to take a look at the full <a href="features.jsp">feature list</a> to see what else
<b>OSCache</b> has to offer.</p>
<p>Other documentation:</p>
<ul>
<li><b><a href="features.jsp">Feature List</a></b> - Details on <b>OSCache</b>'s features and how they are best used</li>
<li><b><a href="requirements.jsp">Requirements</a></b> - What is required to run <b>OSCache</b></li>
<li><b><a href="changelog.jsp">Change Log</a></b> - See what's new in the latest version of <b>OSCache</b></li>
<li><b><a href="faq.jsp">FAQ</a></b> - Frequently Asked Questions about <b>OSCache</b></li>
<li><b><a href="install.jsp">Installation Guide</a></b> - How to install <b>OSCache</b> and where to get it.</li>
<li><b><a href="configuration.jsp">Configuration</a></b> - Configuration options for <b>OSCache</b>.</li>
<li><b><a href="filter.jsp">Caching Content with the CacheFilter</a></b> - How to configure OSCache to cache entire servlet responses.</li>
<li><b><a href="tags.jsp">JSP Tags</a></b> - Detailed documentation on <b>OSCache</b>'s tags and how to use them.</li>
<li><b><a href="clustering.jsp">Clustering OSCache</a></b> - How to use <code>OSCache</code> in a cluster.</li>
<li><b><a href="cron.jsp">Cron Expressions</a></b> - How to use the cron expression syntax to expire content.</li>
<li><b><a href="api">JavaDoc API</a></b> - The <b>OSCache</b> API documentation in JavaDoc format.</li>
</ul>
<%@ include file="navpanel.jsp" %>
</body>
</html>
\ No newline at end of file
+<html>
<head>
<title>OSCache 2.0 Overview</title>
</head>
<body bgcolor="#FFFFFF">
<p><b>OSCache</b> is a widely used, high performance J2EE caching solution.</p>
<h3>The Problems Solved</h3>
<p><b>OSCache</b> solves fundamental problems for dynamic websites:</p>
<ul>
<li><b>Caching Dynamic Content</b> - Dynamic content must often be executed in some form each
request, but sometimes that content doesn't change every request. Caching the whole page does
not help because <i>sections</i> of the page change every request.
<ul>
<li><b>OSCache</b> solves this problem by providing a means to cache sections of JSP pages.</li>
</ul>
</li>
<li><b>Caching Binary Content</b> - Generated images and PDFs can be very costly in terms
of server load.
<ul>
<li><b>OSCache</b> solves this problem through a Servlet 2.3 CachingFilter which can cache any
URI (such as an entire page or a generated image/PDF)</li>
</ul>
</li>
<li><b>Error Tolerance</b> - If one error occurs somewhere on your dynamic page, chances are the
whole page will be returned as an error, even if 95% of the page executed correctly.
<ul>
<li><b>OSCache</b> solves this problem by allowing you to serve the cached content in the event
of an error, and then reporting the error appropriately.</li>
</ul>
</li>
</ul>
<h3>Brief Feature List</h3>
<p>In addition to it's servlet-specific features, <b>OSCache</b> can be used as a generic caching
solution for <i>any</i> Java application. A few of its generic features include:</p>
<ul>
<li><b>Caching of Arbitrary Objects</b> - You are not restricted to caching portions of JSP pages
or HTTP requests. Any Java object can be cached.</li>
<li><b>Comprehensive API</b> - The <b>OSCache</b> API gives you full programmatic control over all of
<b>OSCache's</b> features.</li>
<li><b>Persistent Caching</b> - The cache can optionally be disk-based, thereby allowing expensive-to-create
data to remain cached even across application restarts.</li>
<li><b>Clustering</b> - Support for clustering of cached data can be enabled with a single configuration
parameter. No code changes required.</li>
<li><b>Expiry of Cache Entries</b> - You have a huge amount of control over how cached objects expire,
including pluggable RefreshPolicies if the default functionality does not meet your requirements.</li>
</ul>
<p>We encourage you to take a look at the full <a href="features.jsp">feature list</a> to see what else
<b>OSCache</b> has to offer.</p>
<p>Other documentation:</p>
<ul>
<li><b><a href="features.jsp">Feature List</a></b> - Details on <b>OSCache</b>'s features and how they are best used</li>
<li><b><a href="requirements.jsp">Requirements</a></b> - What is required to run <b>OSCache</b></li>
<li><b><a href="changelog.jsp">Change Log</a></b> - See what's new in the latest version of <b>OSCache</b></li>
<li><b><a href="faq.jsp">FAQ</a></b> - Frequently Asked Questions about <b>OSCache</b></li>
<li><b><a href="install.jsp">Installation Guide</a></b> - How to install <b>OSCache</b> and where to get it.</li>
<li><b><a href="configuration.jsp">Configuration</a></b> - Configuration options for <b>OSCache</b>.</li>
<li><b><a href="filter.jsp">Caching Content with the CacheFilter</a></b> - How to configure OSCache to cache entire servlet responses.</li>
<li><b><a href="tags.jsp">JSP Tags</a></b> - Detailed documentation on <b>OSCache</b>'s tags and how to use them.</li>
<li><b><a href="clustering.jsp">Clustering OSCache</a></b> - How to use <code>OSCache</code> in a cluster.</li>
<li><b><a href="cron.jsp">Cron Expressions</a></b> - How to use the cron expression syntax to expire content.</li>
<li><b><a href="api">JavaDoc API</a></b> - The <b>OSCache</b> API documentation in JavaDoc format.</li>
</ul>
<%@ include file="navpanel.jsp" %>
</body>
</html>
\ No newline at end of file
Index: install.jsp
===================================================================
RCS file: /cvsroot/opensymphony/website/web/oscache/install.jsp,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- install.jsp 13 Aug 2003 16:17:10 -0000 1.2
+++ install.jsp 22 Sep 2003 23:08:41 -0000 1.3
@@ -1 +1 @@
-<html>
<head>
<title>OSCache Installation Guide</title>
</head>
<body bgcolor="#FFFFFF">
<p>This installation guide shows you how to configure OSCache for use inside your JSP pages. It assumes
you have downloaded the latest version (<a href="download.jsp">available here</a>).</p>
<p>If you intend to use OSCache via the API rather than via the taglibs, these instructions do not apply.
Just make sure oscache.jar is somewhere on your application's classpath.</p>
<h3>Extraction Steps</h3>
<p>Extract the downloaded file to a directory of your choosing. </p>
<p>Put the <code>/oscache.jar</code> file in the <code>/WEB-INF/lib</code> directory</p>
<p>Put the <code>/src/oscache.properties</code> file in the <code>/WEB-INF/classes</code>
directory and edit the properties contained within it (for example if you want
disk caching, edit the <code>cache.path</code> property to point to where you
want the cache files stored on disk). See the <a href="configuration.jsp">Configuration Guide</a>
for further details on what options are available.</p>
<p>Remember to escape any \ characters in Windows paths - ie if you want cache
files to go in c:\cachedir, the property should be c:\\cachedir.</p>
<p>Put the <code>/src/META-INF/taglib.tld</code> file in your <code>/WEB-INF/classes</code>
directory. You can rename this to <code>oscache.tld</code> if you have any conflicting
tld files. </p>
<p>Your directory structure should now look something like this:</p>
<BLOCKQUOTE> <TT> <CODE> $WEB_APPLICATION\WEB-INF\lib\oscache.jar<br/>
$WEB_APPLICATION\WEB-INF\classes\oscache.properties<br/>
$WEB_APPLICATION\WEB-INF\classes\taglib.tld<br/>
</CODE> </TT> </BLOCKQUOTE>
<h3>Installation Steps</h3>
<p>Add the following to your web.xml file</p>
<BLOCKQUOTE>
<p><TT> <CODE> <taglib><br>
<taglib-uri>oscache</taglib-uri><br>
<taglib-location>/WEB-INF/classes/taglib.tld</taglib-location><br>
</taglib>
</CODE></TT> </p>
</BLOCKQUOTE>
<p>Now add the appropriate <a href="tags.jsp">tags</a> to your JSP files and
you're done.</p>
<p>It should work properly. <a href="../contact.jsp">Tell us</a> on the mailing list if it doesn't work in your container.</p>
<h3>Debugging</h3>
<p>OSCache now uses <a href="http://jakarta.apache.org/commons/logging.html">Jakarta Commons Logging</a>
for logging any messages. Please see the Commons Logging documentation for details on logging configuration.
Note that OSCache has been compiled with debugging information enabled so you should be able to
use your favourite debugger to step through the source if need be.</p>
<%@ include file="navpanel.jsp" %>
/body>
</html>
\ No newline at end of file
+<html>
<head>
<title>OSCache Installation Guide</title>
</head>
<body bgcolor="#FFFFFF">
<p>This installation guide shows you how to configure OSCache for use inside your JSP pages. It assumes
you have downloaded the latest version (<a href="download.jsp">available here</a>).</p>
<p>If you intend to use OSCache via the API rather than via the taglibs, these instructions do not apply.
Just make sure oscache.jar is somewhere on your application's classpath.</p>
<h3>Extraction Steps</h3>
<p>Extract the downloaded file to a directory of your choosing. </p>
<p>Put the <code>/oscache.jar</code> file in the <code>/WEB-INF/lib</code> directory</p>
<p>Make sure commons=logging.jar is on your classpath (normally this also means putting it in
<code>/WEB-INF/lib</code>.</p>
<p>If you are using JDK 1.3.x it is optional, but strongly recommended, to add commons-collections.jar
to your classpath. OSCache will use this to provide a significant speed increase. (Note that with
JDK 1.4 and higher, commons-collections.jar will not be used - the 1.4 implementation is faster
still).</p>
<p>Put the <code>/src/oscache.properties</code> file in the <code>/WEB-INF/classes</code>
directory and edit the properties contained within it (for example if you want
disk caching, configure the persistence listener and edit the <code>cache.path</code> property
to point to where you want the cache files stored on disk). See the
<a href="configuration.jsp">Configuration Guide</a> for further details on what options are
available.</p>
<p>Remember to escape any \ characters in Windows paths - ie if you want cache
files to go in c:\cachedir, the cache.path property should be set to c:\\cachedir.</p>
<p>Put the <code>/src/META-INF/taglib.tld</code> file in your <code>/WEB-INF/classes</code>
directory. You can rename this to <code>oscache.tld</code> if you have any conflicting
tld files.</p>
<p>Your directory structure should now look something like this:</p>
<BLOCKQUOTE> <TT> <CODE> $WEB_APPLICATION\WEB-INF\lib\oscache.jar<br/>
$WEB_APPLICATION\WEB-INF\classes\oscache.properties<br/>
$WEB_APPLICATION\WEB-INF\classes\taglib.tld<br/>
</CODE> </TT> </BLOCKQUOTE>
<h3>Installation Steps</h3>
<p>Add the following to your web.xml file</p>
<BLOCKQUOTE>
<p><TT> <CODE> <taglib><br>
<taglib-uri>oscache</taglib-uri><br>
<taglib-location>/WEB-INF/classes/taglib.tld</taglib-location><br>
</taglib>
</CODE></TT> </p>
</BLOCKQUOTE>
<p>Now add the appropriate <a href="tags.jsp">tags</a> to your JSP files and you're done.</p>
<p>It should work properly. <a href="../contact.jsp">Tell us</a> on the mailing list if it doesn't work in your container.</p>
<h3>Debugging</h3>
<p>OSCache now uses <a href="http://jakarta.apache.org/commons/logging.html">Jakarta Commons Logging</a>
for logging any messages. Please see the Commons Logging documentation for details on logging
configuration.</p>
<p>Note that OSCache has been compiled with debugging information enabled so you should be able to
use your favourite debugger to step through the source if need be.</p>
<%@ include file="navpanel.jsp" %>
/body>
</html>
\ No newline at end of file
Index: requirements.jsp
===================================================================
RCS file: /cvsroot/opensymphony/website/web/oscache/requirements.jsp,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- requirements.jsp 5 Aug 2003 08:09:01 -0000 1.2
+++ requirements.jsp 22 Sep 2003 23:08:41 -0000 1.3
@@ -1 +1 @@
-<html>
<head>
<title>OSCache Requirements</title>
</head>
<body bgcolor="#FFFFFF">
<p><b>OSCache</b> can be used directly to provide caching for any Java application.
Using the OSCache tag library requires Servlet 2.2 and JSP 1.2 support to run properly.
<p>So far it has been tested in the following application servers and web containers:</p>
<ul>
<li><a href="http://www.orionserver.com">OrionServer</a> (version 1.4.0 and
above)</li>
<li><a href="http://www.macromedia.com">Macromedia JRun</a> (version 3.0 and
above)</li>
<li><a href="http://www.weblogic.com">BEA Weblogic</a> (should work on version
5.x and above)</li>
<li><a href="http://www.caucho.com">Caucho Resin</a> (version 1.2.3) - thanks
to <a href="mailto:[email protected]">Sami Siren</a> for this test</li>
<li><a href="http://jakarta.apache.org/tomcat">Tomcat</a> (version 4.0 and above)</li>
</ul>
<p>This does not mean it will not run on other servers! It should run on any specification
compliant container. If you have run OSCache successfully in other servers, please
<a href="mailto:chris@swebtec.com">let
us know</a> and we'll add to this list.</p>
<p>The Caching Filter (for caching entire pages, and binary content such as GIFs
and PDFs) requires Servlet 2.3 support. It is known to work on Orion, Weblogic
and Tomcat 4.0.</p>
<p> </p>
<%@ include file="navpanel.jsp" %>
</body>
</html>
\ No newline at end of file
+<html>
<head>
<title>OSCache Requirements</title>
</head>
<body bgcolor="#FFFFFF">
<p><b>OSCache</b> can be used directly to provide caching for any Java application.
Using the OSCache tag library requires Servlet 2.2 and JSP 1.2 support to run properly.
<p>So far it has been tested in the following application servers and web containers:</p>
<ul>
<li><a href="http://www.orionserver.com">OrionServer</a> (version 1.4.0 and
above)</li>
<li><a href="http://www.macromedia.com">Macromedia JRun</a> (version 3.0 and
above)</li>
<li><a href="http://www.weblogic.com">BEA Weblogic</a> (should work on version
5.x and above)</li>
<li><a href="http://www.ibm.com/websphere">IBM Websphere</a> (tested on version
5.0)</li>
<li><a href="http://www.ibm.com/websphere">Silverstream</a> (tested on version
3.7.4)</li>
<li><a href="http://www.caucho.com">Caucho Resin</a> (version 1.2.3) - thanks
to <a href="mailto:[email protected]">Sami Siren</a> for this test</li>
<li><a href="http://jakarta.apache.org/tomcat">Tomcat</a> (version 4.0 and above)</li>
</ul>
<p>This does not mean it will not run on other servers! It should run on any specification
compliant container. If you have run OSCache successfully in other servers, please
<a href="mailto:chris@swebtec.com">let
us know</a> and we'll add to this list.</p>
<p>The Caching Filter (for caching entire pages, and binary content such as GIFs
and PDFs) requires Servlet 2.3 support. It is known to work on Orion, Weblogic
and Tomcat 4.0.</p>
<p>OSCache is compatible with JRE 1.3 and higher. For best performance, JRE 1.4.x
or higher should be used.</p>
<p> </p>
<%@ include file="navpanel.jsp" %>
</body>
</html>
\ No newline at end of file
-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf
lmpx.com only provides a reader for public news (NNTP) servers. It is not
affiliated with the servers or forums shown here and is not responsible for
the content of articles, which is written by their respective authors.