Anonymous avatar Anonymous committed 3084e4d

Submitter: Andres March
Date: January 17th, 2005

Moved docs to wiki. First export of docs for the 2.1 release.

Comments (0)

Files changed (31)

docs/CacheFilter.html

+<html>
+    <head>
+        <title>OSCache : CacheFilter</title>
+	    <link rel="stylesheet" href="styles/site.css" type="text/css" />
+        <META http-equiv="Content-Type" content="text/html; charset=UTF-8">	    
+    </head>
+
+    <body>
+	    <table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
+		    <tr>
+			    <td valign="top" class="pagebody">
+				    <div class="pageheader">
+					    <span class="pagetitle">
+                            OSCache : CacheFilter
+                                                    </span>
+				    </div>
+				    <div class="pagesubheading">
+					    This page last changed on Jan 16, 2005 by <font color="#0050B2">dres1011</font>.
+				    </div>
+
+				    <p class="paragraph">OSCache comes with a servlet filter that enables you to transparently cache entire pages of your website, and even binary files. Caching of binary files is extremely useful when they are generated dynamically, eg PDF files or images.</p>To configure the filter, add something like the following to your web.xml file (obviously you will want to set the URL pattern to match only the content you want to cache; this example will cache all JSP pages):<br/>
+
+<div class="code"><div class="codeContent">
+<pre><span class="xml&#45;tag">&lt;filter&gt;</span>&#10;      <span class="xml&#45;tag">&lt;filter&#45;name&gt;</span>CacheFilter<span class="xml&#45;tag">&lt;/filter&#45;name&gt;</span>&#10;      <span class="xml&#45;tag">&lt;filter&#45;class&gt;</span>com.opensymphony.oscache.web.filter.CacheFilter<span class="xml&#45;tag">&lt;/filter&#45;class&gt;</span>&#10;   <span class="xml&#45;tag">&lt;/filter&gt;</span>&#10;   <span class="xml&#45;tag">&lt;filter&#45;mapping&gt;</span>&#10;      <span class="xml&#45;tag">&lt;filter&#45;name&gt;</span>CacheFilter<span class="xml&#45;tag">&lt;/filter&#45;name&gt;</span>&#10;      <span class="xml&#45;tag">&lt;url&#45;pattern&gt;</span>&#42;.jsp<span class="xml&#45;tag">&lt;/url&#45;pattern&gt;</span>&#10;   <span class="xml&#45;tag">&lt;/filter&#45;mapping&gt;</span></pre>
+</div></div><br/>
+The default duration is one hour and the default scope for the cache is application scope. You can change these settings using initialization parameters. The time parameter sets the cache time (in seconds), while the scope parameter lets you set the scope. Valid values for the scope are application and session.<p class="paragraph">As an example, the following settings would cache content for 10 minutes in session scope:</p><div class="code"><div class="codeContent">
+<pre><span class="xml&#45;tag">&lt;filter&gt;</span>&#10;      <span class="xml&#45;tag">&lt;filter&#45;name&gt;</span>CacheFilter<span class="xml&#45;tag">&lt;/filter&#45;name&gt;</span>&#10;      <span class="xml&#45;tag">&lt;filter&#45;class&gt;</span>com.opensymphony.oscache.web.filter.CacheFilter<span class="xml&#45;tag">&lt;/filter&#45;class&gt;</span>&#10;      <span class="xml&#45;tag">&lt;init&#45;param&gt;</span>&#10;         <span class="xml&#45;tag">&lt;param&#45;name&gt;</span>time<span class="xml&#45;tag">&lt;/param&#45;name&gt;</span>&#10;         <span class="xml&#45;tag">&lt;param&#45;value&gt;</span>600<span class="xml&#45;tag">&lt;/param&#45;value&gt;</span>&#10;      <span class="xml&#45;tag">&lt;/init&#45;param&gt;</span>&#10;      <span class="xml&#45;tag">&lt;init&#45;param&gt;</span>&#10;         <span class="xml&#45;tag">&lt;param&#45;name&gt;</span>scope<span class="xml&#45;tag">&lt;/param&#45;name&gt;</span>&#10;         <span class="xml&#45;tag">&lt;param&#45;value&gt;</span>session<span class="xml&#45;tag">&lt;/param&#45;value&gt;</span>&#10;      <span class="xml&#45;tag">&lt;/init&#45;param&gt;</span>&#10;   <span class="xml&#45;tag">&lt;/filter&gt;</span></pre>
+</div></div><br/>
+Note that the filter will only cache content that has a status of 200 (HttpServletResponse.SC_OK).
+
+				    
+                    			    </td>
+		    </tr>
+	    </table>
+	    <table border="0" cellpadding="0" cellspacing="0" width="100%">
+			<tr>
+				<td height="12" background="border/border_bottom.gif"><img src="border/spacer.gif" width="1" height="1" border="0"/></td>
+			</tr>
+		    <tr>
+			    <td align="center"><font color="grey">Document generated by Confluence on Jan 18, 2005 00:39</font></td>
+		    </tr>
+	    </table>
+    </body>
+</html>

docs/Change Log.html

+<html>
+    <head>
+        <title>OSCache : Change Log</title>
+	    <link rel="stylesheet" href="styles/site.css" type="text/css" />
+        <META http-equiv="Content-Type" content="text/html; charset=UTF-8">	    
+    </head>
+
+    <body>
+	    <table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
+		    <tr>
+			    <td valign="top" class="pagebody">
+				    <div class="pageheader">
+					    <span class="pagetitle">
+                            OSCache : Change Log
+                                                    </span>
+				    </div>
+				    <div class="pagesubheading">
+					    This page last changed on Jan 18, 2005 by <font color="#0050B2">dres1011</font>.
+				    </div>
+
+				    <p class="paragraph"><h3 style="margin: 4px 0px 4px 0px;" class="heading3"><a name="ChangeLog-OSCache2.1"> OSCache 2.1</a></h3></p>(18th January 2004 - by Andres March)
+<h4 class="heading4"><a name="ChangeLog-BugFixes%3A"> Bug Fixes:</a></h4>
+
+<ul class="star">
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-70" title="Visit page outside Confluence">CACHE-70 </a> - last modified problem</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-73" title="Visit page outside Confluence">CACHE-73 </a> - NullpointerException after deserialization of AbstractConcurrentReadCache</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-85" title="Visit page outside Confluence">CACHE-85 </a> - JavaGroups changed package name</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-98" title="Visit page outside Confluence">CACHE-98 </a> - Disk cache not getting served first time for long keys</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-107" title="Visit page outside Confluence">CACHE-107 </a> - flushEntry does not behave correctly in cluster</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-118" title="Visit page outside Confluence">CACHE-118</a> - Updating groups doesn&#039;t work</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-119" title="Visit page outside Confluence">CACHE-119</a> - flush does not work correctly in a clustered environment</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-126" title="Visit page outside Confluence">CACHE-126</a> - java.lang.NoClassDefFoundError: org/javagroups/blocks/NotificationBus$Consumer</li>
+</ul>
+<h4 class="heading4"><a name="ChangeLog-Improvements%3A"> Improvements:</a></h4>
+
+<ul class="star">
+<li> Moved all docs to <a href="http://wiki.opensymphony.com/display/CACHE/Home" title="Visit page outside Confluence">wiki</a></li>
+<li> Updated jgroups jar and configuration based upon recommendations from Bela Ban (javagroups maintainer).</li>
+<li> Website documentation updates.</li>
+<li> Added HashDiskPersistenceListner that hashes file names in order to eliminate nasty characters and overly long names</li>
+<li> Added property that allows cache entries to only be persisted when the memory capacity has been exceeded. The property is called: cache.persistence.overflow.only. It defaults to false for backwards compatibility meaning all cache entries are persisted when a listener has been registered.</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-58" title="Visit page outside Confluence">CACHE-58 </a> - If-Modified-Since ignored in cache filter</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-92" title="Visit page outside Confluence">CACHE-92 </a> - public access for configuration properties</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-94" title="Visit page outside Confluence">CACHE-94 </a> - More evenly distributed disk caching</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-95" title="Visit page outside Confluence">CACHE-95 </a> - Output the scope name&#039;s in toString()</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-102" title="Visit page outside Confluence">CACHE-102 </a> - upgrade to Commons Logging 1.0.4</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-103" title="Visit page outside Confluence">CACHE-103 </a> - upgrade to Commons Collections 3.1</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-104" title="Visit page outside Confluence">CACHE-104 </a> - Destroy cache</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-105" title="Visit page outside Confluence">CACHE-105 </a> - call get() method on put() method call</li>
+</ul>
+<h3 class="heading3"><a name="ChangeLog-OSCache2.0.2"> OSCache 2.0.2</a></h3><p class="paragraph">(22nd January 2004 - by Mathias Bogaert)
+<h4 class="heading4"><a name="ChangeLog-BugFixes%3A"> Bug Fixes:</a></h4></p><ul class="star">
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-63" title="Visit page outside Confluence">CACHE-63 </a> NullPointerException in GeneralCacheAdministrator#destroy().</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-44" title="Visit page outside Confluence">CACHE-44 </a> Multi threading issues with LRU Cache.</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-66" title="Visit page outside Confluence">CACHE-66 </a> DiskPersistenceListener is not Serializable.</li>
+<li> GeneralCacheAdministrator now creates the cache from within the constructor. This prevents possible threading issues if the cache is not initialized during application startup.</li>
+</ul>
+<h4 class="heading4"><a name="ChangeLog-Improvements%3A"> Improvements:</a></h4>
+
+<ul class="star">
+<li> Website documentation updates.</li>
+<li> Added OSCache in the Wild.</li>
+</ul>
+<h3 class="heading3"><a name="ChangeLog-OSCache2.0.1"> OSCache 2.0.1</a></h3><p class="paragraph">(4th November 2003 - by Chris Miller)
+<h4 class="heading4"><a name="ChangeLog-BugFixes%3A"> Bug Fixes:</a></h4></p><ul class="star">
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-59" title="Visit page outside Confluence">CACHE-59 </a> Silent mode could not be reset.</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-60" title="Visit page outside Confluence">CACHE-60 </a> Fixed deadlock problem when cancelUpdate() was called while under load.</li>
+</ul>
+<h4 class="heading4"><a name="ChangeLog-Improvements%3A"> Improvements:</a></h4>
+
+<ul class="star">
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-56" title="Visit page outside Confluence">CACHE-56 </a> Refresh period is no longer mandatory.</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-51" title="Visit page outside Confluence">CACHE-51 </a> Added an &lt;cache:addgroup /&gt; tag. This allows cache groups to be dynamically added from within a &lt;cache:cache /&gt; tag.</li>
+<li> Website documentation is now bundled with the OSCache distribution.</li>
+</ul>
+<h4 class="heading4"><a name="ChangeLog-Changesthatmayaffectbackwardscompatibility%3A"> Changes that may affect backwards compatibility:</a></h4>
+
+<ul class="star">
+<li> StringUtil.split() now returns a List rather than a String[].</li>
+</ul>
+<h3 class="heading3"><a name="ChangeLog-OSCache2.0"> OSCache 2.0</a></h3><p class="paragraph">(22nd September 2003 - by Chris Miller)
+<h4 class="heading4"><a name="ChangeLog-BugFixes%3A"> Bug Fixes:</a></h4></p><ul class="star">
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-52" title="Visit page outside Confluence">CACHE-52 </a> Fixed a problem that caused no output on Tomcat for small JSP files.</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-53" title="Visit page outside Confluence">CACHE-53 </a> Updated documentation to explain that a PersistenceListener must be specified to enable caching to disk.</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-55" title="Visit page outside Confluence">CACHE-55 </a> JMS was throwing an exception on Weblogic.</li>
+<li> Altering the cache capacity on the fly using the administrator classes wasn&#039;t working correctly.</li>
+</ul>
+<h4 class="heading4"><a name="ChangeLog-Improvements%3A"> Improvements:</a></h4>
+
+<ul class="star">
+<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 class="heading3"><a name="ChangeLog-OSCache2.0%28beta2%29"> OSCache 2.0 (beta 2)</a></h3><p class="paragraph">(4th August 2003 - by Chris Miller)
+<h4 class="heading4"><a name="ChangeLog-NewFeatures%3A"> New Features:</a></h4></p><ul class="star">
+<li> Now supports JavaGroups version 2.1.</li>
+<li> JMS Clustering support has been added -Romulus Pasca.</li>
+<li> Clustering code has been refactored. As a result of this, some of the clustering configuration has changed since beta 1 - please see the updated clustering documentation for details.</li>
+<li> Performance enhancement: When running under JRE 1.3.x, the LRUCache will now attempt to use the Jakarta commons collections SequencedHashMap. If the commons-collections.jar is not present then the code resorts to using a LinkedList and a warning is logged. Note that under JRE 1.4.x and higher the commons-collections.jar is not required.</li>
+<li> Config.getProperties() method added.</li>
+</ul>
+<h4 class="heading4"><a name="ChangeLog-BugFixes%3A"> Bug Fixes:</a></h4>
+
+<ul class="star">
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-48" title="Visit page outside Confluence">CACHE-48 </a> FastCronParser no longer requires JDK 1.4.x.</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-45" title="Visit page outside Confluence">CACHE-45 </a> Fixed a serialization bug.</li>
+<li> The CachewideEvent was not holding the event date.</li>
+<li> Prevented an error from being logged in the CachewideEvent handling (even though no problem had occurred).</li>
+<li> Fixed a subtle bug in the concurrent unit test.</li>
+<li> The ServletCacheAdministrator&#039;s app scope cache is created on startup (via the CacheContextListener).</li>
+</ul>
+<h3 class="heading3"><a name="ChangeLog-OSCache2.0%28beta1%29"> OSCache 2.0 (beta 1)</a></h3><p class="paragraph">(19th July 2003 - by Chris Miller)
+<h4 class="heading4"><a name="ChangeLog-NewFeatures%3A"> New Features:</a></h4></p><ul class="star">
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-11" title="Visit page outside Confluence">CACHE-11 </a> Cache grouping support. This allows cache entries to be placed into an arbitrary group or groups and flushed with a single flushGroup() call.</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-30" title="Visit page outside Confluence">CACHE-30 </a> Added support for expiring cache entries based on a cron expression. Entries that are older than the date/time that most recently matches the cron expression will be considered stale. This is exposed to the cache tag via the &#039;cron&#039; attribute. See cronTest.jsp for examples.</li>
+<li> Event listener support has been refactored and improved. It is now possible to specify a comma-delimited list of event listeners using this property. Previously only one class could be specified. Events listed here should implement the CacheEntryEventListener and/or the ScopeEventListener interfaces.</li>
+<li> New event CacheMapAccessEvent.STALE_HIT. This event is fired when an attempt is made to retrieve and entry from the cache, and the entry is found but is stale.</li>
+<li> Clustering support has been added as an event listener. Currently it is implemented using <a href="http://www.javagroups.com" title="Visit page outside Confluence">JavaGroups </a>. To enable, just add the BroadcastingCacheEventListener class to the cache.event.listeners property.</li>
+<li> Now uses Jakarta Commons Logging for all log messages. This means that the cache.debug configuration property is now ignored - use whatever logging configuration is appropriate for your logging setup instead. -Fabian Crabus</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-14" title="Visit page outside Confluence">CACHE-14, Matthias Nott </a> Now allows for content to be cached indefinitely without expiration.</li>
+<li> The build.xml &lt;javac ...&gt; directives now specify debug=&quot;true&quot;.</li>
+<li> Performance boost: When OSCache is running on JRE 1.4 or higher, LRUCache and FIFOCache use a LinkedHashSet instead of a LinkedList.</li>
+<li> Japloy is now used to ensure source is consistently formatted.</li>
+<li> Test cases now work on non-windows platforms. Also coverage reports added courtesy of clover.</li>
+</ul>
+<h4 class="heading4"><a name="ChangeLog-Changesthatmayaffectbackwardscompatibility%3A"> Changes that may affect backwards compatibility:</a></h4>
+
+<ul class="star">
+<li> The cache.entryevent.classes property in the configuration file has been renamed to cache.event.listeners, since it accepts CacheEntryEventListener, ScopeEventListener and CacheMapAccessEventListener types.</li>
+<li> The cache.persistence.classes property has been renamed to cache.persistence.class since it is only possible to specify one PersistenceListener.</li>
+<li> For consistency, cache.unlimited_disk is now cache.unlimited.disk and cache.useHostDomainInKey is now cache.use.host.domain.in.key.</li>
+<li> The oscache.tld file now uses a taglib 1.2 DTD.</li>
+<li> To build OSCache, JDK 1.4.x or higher is required. There is however no runtime dependency on JDK 1.4.x.</li>
+<li> The Cache.flushPattern() method and &lt;cache:flush pattern=&quot;...&quot;/&gt; are deprecated. You are instead encouraged to group your cache entries when you add them to the cache and then use the Cache.flushGroup() method or the &lt;cache:flush group=&quot;...&quot;/&gt; tag to flush an entire cache group.</li>
+<li> Disk persistence now puts all files in the same directory. This has a number of side effects. Keys &gt;255 chars will cause problems. Also, similar keys might get mapped to the same file. For example, it is very inadvisable to have two keys with the names &#039;my_key&#039; and &#039;my.key&#039;.</li>
+<li> GeneralCacheAdministrator is no longer static. Users that relied on this behaviour can still hold onto a static reference to it with minor code changes.</li>
+<li> When a NeedsRefreshException is thrown, it is now vital that the cache entry is either updated, or Cache.cancelUpdate(key) is called to release the lock on this cache entry. This is a consequence of the fix for <a href="http://jira.opensymphony.com/browse/CACHE-42" title="Visit page outside Confluence">CACHE-42 </a>.</li>
+<li> CacheProperties class was removed. It didn&#039;t work on 1.7.5 anyway. The same effect can be achieved by specifying a subclass of Properties.</li>
+<li> Autogenerated cache keys now contain the request method (eg, HEAD, GET, etc).</li>
+<li> OSCache has been repackaged from &quot;com.opensymphony.module.oscache.&#42;&quot; to &quot;com.opensymphony.oscache.&#42;&quot;. Any code or configuration files that refer to &quot;com.opensymphony.module.oscache&quot; will need to be updated.</li>
+</ul>
+<h4 class="heading4"><a name="ChangeLog-BugFixes%3A"> Bug Fixes:</a></h4>
+
+<ul class="star">
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-4" title="Visit page outside Confluence">CACHE-4 </a> WebSphere 3.5.x compatibility.</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-5" title="Visit page outside Confluence">CACHE-5 </a> Added a mode attribute to the cache tag to allow content to be cached but not sent to the output stream. See oscacheTest.jsp for an example.</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-7" title="Visit page outside Confluence">CACHE-7 </a> &quot;cache&quot; Tag has no &quot;setEncoding&quot; method.</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-9" title="Visit page outside Confluence">CACHE-9 </a> It could be useful being able to specify directories relative to the web application dir. for config file and cache dir. Use new properties aware getInstance method.</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-10" title="Visit page outside Confluence">CACHE-10 </a> Cannot write and use custom class implementing CacheProperties.</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-13" title="Visit page outside Confluence">CACHE-13 </a> AbstractConcurrentReadCache loops indefinitely when persistRetrieve() returns null.</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-14" title="Visit page outside Confluence">CACHE-14 </a> You can now specify an unlimited refresh time by supplying a negative value for the duration.</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-17" title="Visit page outside Confluence">CACHE-17 </a> An example war is now included - &quot;ant example-war&quot;. Once deployed this can be tested using &quot;ant test-web&quot;.</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-26" title="Visit page outside Confluence">CACHE-26 </a> Security hole whereby certain keys can overwrite any file.</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-28" title="Visit page outside Confluence">CACHE-28 </a> URLs can now be used as keys with disk persistence.</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-31" title="Visit page outside Confluence">CACHE-31 </a> and <a href="http://jira.opensymphony.com/browse/CACHE-33" title="Visit page outside Confluence">CACHE-33 </a> The cache tag&#039;s refresh attribute will now be taken into account even if a custom refresh policy has been specified.</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-34" title="Visit page outside Confluence">CACHE-34 </a> Setting properties with AbstractCacheAdministrators. New getInstance method added to ServletCacheAdministrator that takes in properties.</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-35" title="Visit page outside Confluence">CACHE-35 </a> CacheFilter needs to distinguish between HEAD and GET requests.</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-39" title="Visit page outside Confluence">CACHE-39 </a> and <a href="http://jira.opensymphony.com/browse/CACHE-44" title="Visit page outside Confluence">CACHE-44 </a> Synchronization with LRUCache fixed.</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-42" title="Visit page outside Confluence">CACHE-42 </a> Threads will no longer race to (re)build expired or new cache entries. By default stale content will be served if available. This behaviour can be changed by setting oscache.blocking=true, which will instead cause threads to block until the new cache entry is available.</li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE-43" title="Visit page outside Confluence">CACHE-43 </a> Taglibs have been made spec-compliant. They now follow the guidelines at <a href="http://jakarta.apache.org/taglibs/guidelines.html." title="Visit page outside Confluence">&#104;ttp://jakarta.apache.org/taglibs/guidelines.html.</a></li>
+<li> Some synchronization issues were fixed in LRUCache.getItem() and AbstractConcurrentReadCache.setMaxEntries().</li>
+<li> ScopeEventListener classes were previously not able to be specified in the configuration even though the dispatching code was implemented. ScopeEventListeners can now be specified using the cache.event.listeners configuration property.</li>
+<li> CacheMapAccessEvents now only fire when an attempt is made to retrieve the actual cache content for external use. Previously these events were being fired in circumstances that were not of statistical interest - for example HIT and MISS events were being fired when updating or flushing entries from the cache.</li>
+<li> Minor bug in oscacheTestMultipleTagNoKey.jsp - some of the tag refresh times weren&#039;t correctly specified.</li>
+<li> cachetest.jsp - the &#039;refresh&#039; functionality wasn&#039;t working because the addition of the refresh parameter caused the cache key to be different. The key is now specified explicitly.</li>
+<li> EntryRefreshPolicy is now serializable so it can be persisted to the disk cache.</li>
+<li> ServletCacheAdministrator now sorts request parameters and filters out jsessionid so they have no impact on the generated cache key.</li>
+<li> CacheFilter only caches successful responses (status code == SC_OK).</li>
+</ul>
+<h4 class="heading4"><a name="ChangeLog-KnownProblems%3A%28thesehaveexistedforsometimeinthe1.x.xversionsandwillbeaddressedinanupcoming2.x.xrelease%29"> Known Problems: (these have existed for some time in the 1.x.x versions and will be addressed in an upcoming 2.x.x release)</a></h4>
+
+<ul class="star">
+<li> Session caches (created using the ServletCacheAdministrator) have some known limitations:<br/>
+o Due to a workaround in the code, it is possible for a system under heavy load to get its persistent session caches confused across sessions.<br/>
+o Session caches will not work in a clustered environment.<br/>
+o Session caches have the same settings global settings applied to them as the application scope cache. This means that if you want a persistent cache for the application scope cache, the session caches will use it too.
+</li>
+</ul>
+<h3 class="heading3"><a name="ChangeLog-OSCache1.7.5"> OSCache 1.7.5</a></h3>
+(5th January 2002 - by Mike Cannon-Brookes, mike@atlassian.com)<br/>
+
+<ul class="star">
+<li> Fixed up logging system slightly. All errors should now be logged with logError() and normal messages with log()</li>
+<li> Fixed bug in build file which put oscache.properties inside the oscache.jar (resulting in it being loaded badly in some containers)</li>
+<li> Changed cache.capacity in the default oscache.properties file to 1000. This means up to 1000 items will be cached in the default setup, and LRUCache will be used (100 seemed too small)</li>
+</ul>
+<h3 class="heading3"><a name="ChangeLog-OSCache1.7.4"> OSCache 1.7.4</a></h3>
+(3rd December 2001 - by Francois Beauregard, fbeauregard@pyxis-tech.com, and<br/>
+Mike Cannon-Brookes, mike@atlassian.com)<br/>
+
+<ul class="star">
+<li> Made all servlet cache components serializable (fixes bug reported on list with JRun)</li>
+</ul>
+<h3 class="heading3"><a name="ChangeLog-OSCache1.7.3"> OSCache 1.7.3</a></h3>
+(11th November 2001 - by Francois Beauregard, fbeauregard@pyxis-tech.com)<br/>
+
+<ul class="star">
+<li> TestCacheEntry had a test method with improper name (flush -&gt; testFlush)</li>
+<li> Pluggable entry refresh policy now available in the cache tag</li>
+</ul>
+<h3 class="heading3"><a name="ChangeLog-OSCache1.7.2"> OSCache 1.7.2</a></h3>
+(31st October 2001 - by Mike Cannon-Brookes, mike@atlassian.com)<br/>
+
+<ul class="star">
+<li> Cleaned up <em class="emphasis">all</em> JavaDoc messages to ensure consistency and readability (removed unnecessary CVS tags, added &lt;code&gt; and &lt;pre&gt; where needed, added @return and @param to all methods)</li>
+<li> Renamed nbMaxEntries to cacheCapacity and cache.size property to cache.capacity (to fit better with Collections API where capacity is max size, size is current size)</li>
+<li> Renamed algoClass to algorithmClass for clarity.</li>
+<li> Fixed up build.xml so that test classes are compiled to a different location and not included in oscache.jar (to make it smaller footprint)</li>
+</ul>
+<h3 class="heading3"><a name="ChangeLog-OSCache1.7.1"> OSCache 1.7.1</a></h3>
+(26th September 2001 - by Francois Beauregard, fbeauregard@pyxis-tech.com, and<br/>
+Alain Bergevin, abergevin@pyxis-tech.com, of Pyxis Technologies Inc.)<br/>
+
+<ul class="star">
+<li> Cache Events</li>
+<li> Persistence mechanism refactored</li>
+<li> Cache Algorithms FIFO + LRU (Limit the size of the cache)</li>
+<li> AbstractConcurrentReadCache from Doug Lea&#039;s ConcurrentReaderHashMap.<br/>
+Should give oscache performance improvement
+</li>
+<li> Disk Persistence does not need any locking strategies. Everything is handled by AbstractConcurrentReadCache</li>
+<li> Pluggable entry refresh policies</li>
+<li> Unlimited cache size for disk</li>
+<li> Specify Duration using Simple Date Format or ISO-8601 as suggested by Fredrik Lindgren)<br/>
+The next one that would make sense I think is being able to specify a specific time of day.
+</li>
+</ul>
+<h3 class="heading3"><a name="ChangeLog-OSCache1.7.0"> OSCache 1.7.0</a></h3>
+(26th September 2001 - by Francois Beauregard, fbeauregard@pyxis-tech.com, and<br/>
+Alain Bergevin, abergevin@pyxis-tech.com, of Pyxis Technologies Inc.)<p class="paragraph">This version include some refactoring, corrections and new features.<br/>
+Here are the highlights:</p><ul class="star">
+<li> CacheAdministrator has been split in 3. We have now AbstractCacheAdministrator, and ServletCacheAdministrator and GeneralCacheAdministrator extends it</li>
+<li> Packages have been adjusted. We now have oscache.base, oscache.general and oscache.Servlet.<br/>
+Adjustement must be made to the oscache.tld
+</li>
+<li> ServletCacheHashMap has been created in order to reflect specific needs for Servlets. It extends CacheHashMap</li>
+<li> Support for multiple cache tag in a single page, without supplying a key. Nested cache tag are not yet supported (you need to manage keys in that case).</li>
+<li> OSCache can now cache any objects (not only JSP content) using GeneralCacheAdministrator</li>
+<li> GenerateKey now support suffixes (used to deal with multiple cache tags)</li>
+<li> A complete JUnit test suite has been created for osCache, including a JSP and a Servlet</li>
+<li> Added the required libraries for the test unit. The JUnit JAR has been upgraded to version 3.7</li>
+<li> Required libraries are now HHTPUnit, Tidy, JUnit 3.7 and JUnitPerf</li>
+<li> The cBuffer variable used for keyGeneration has been moved locally to GenerateKey since it was a threading issue</li>
+<li> The build file has been modified to include test running</li>
+<li> The flushAll method is now abstract since CacheAbstractAdministrator can&#039;t know all valid scopes</li>
+<li> Removed the retry logic for disk cache read and write (not used anymore)</li>
+<li> Fixed an issue with the needsRefresh method which returned an invalid value when invoked first by returning true and then invoked having to return false. Both case returned true.</li>
+<li> The doStartTag method in CacheTag has been modified to prevent returning null when cache content is missing (cache file deleted)</li>
+<li> The doAfterBody method in CacheTag has been modified in order to prevent hitting the cache twice in some situation</li>
+<li> The useBody method in CacheTag has been renamed to setUseBody in order to reflect its usage</li>
+<li> LoadProperties interface added to CacheProperties</li>
+<li> Added a NeedsRefreshException</li>
+<li> Retrofited the changed made by Kesav Kumar in order to retrieve the sessionId correctly</li>
+<li> Added code toughness to avoid working with invalid parameters in public methods</li>
+<li> Magic numbers and strings are now declared as constants</li>
+<li> Many methods are now declared as final or protected</li>
+<li> Imports are now more accurate, no more *</li>
+<li> Comments and some headers modified to reflect JavaDoc standard</li>
+</ul>
+<h3 class="heading3"><a name="ChangeLog-OSCache1.6.1"> OSCache 1.6.1</a></h3><p class="paragraph">(16th September, 2001 - by Todd Gochenour, tgochenour@peregrine.com)</p><ul class="star">
+<li> Removed attribute &quot;encoding&quot; in all areas, since Object serialization stores strings in UTF-8 format, encoding is no longer necessary.</li>
+<li> Added Synchronization to getCacheEntry() to insure multiple threads do not access HashMap and get erroneous results.</li>
+<li> Implemented property cache.useHostDomainInKey (true/false) to prepend URL request server name to cache key when cache used by multiple servers. The &quot;cache.domainname&quot; property found in oscache.properties (not used in code) was removed.</li>
+<li> Corrected file caching logic so that multiple processes can share cache information (file locking). Missing still is the ability to signal processes that a cache needs to be flushed when using Memory Caching along with File Caching.</li>
+<li> Unit testing revealed some minor configuration bugs which were corrected.</li>
+</ul>
+<h3 class="heading3"><a name="ChangeLog-OSCache1.6"> OSCache 1.6</a></h3><p class="paragraph">(5th September, 2001 - by Mike Cannon-Brookes, mike@atlassian.com)</p><ul class="star">
+<li> Changed the CacheEntry so that it caches Object rather than String (allowing image caching) (Serge Knystautas, sergek@lokitech.com)</li>
+<li> Cached objects are now serialized to disk so cannot be read by humans anymore (this allows us to cache Object) (Serge Knystautas, sergek@lokitech.com)</li>
+<li> Added a Servlet 2.3 CacheFilter (and associated response classes) that caches whole requests (Serge Knystautas, sergek@lokitech.com)</li>
+<li> Minor changes to CacheAdministrator (the way Cache and CacheEntry&#039;s are retrieved) - merging Serge and Todd&#039;s changes</li>
+</ul>
+<h3 class="heading3"><a name="ChangeLog-OSCache1.5"> OSCache 1.5</a></h3><p class="paragraph">(6th August, 2001 - by Todd Gochenour, tgochenour@peregrine.com)</p><ul class="star">
+<li> Added boolean &quot;cache.memory&quot; attribute to oscache.properties to eliminate memory consumption and rely strictly on disk storage.</li>
+<li> Added three interfaces &quot;CacheLog&quot;, &quot;CacheProperties&quot;, and &quot;CacheContents&quot; to allow plugable implementations for these functions. The CacheContents interface allows the pages to be cached using a database.</li>
+<li> Added &quot;Language&quot; attribute to CacheTag and FlushTag to distinguish a page that supports I18N generation. The ISO-639 language code is used when the scope of the page is &quot;Application&quot;. The code defines a subdirectory under the &quot;application&quot; directory of file caching.</li>
+<li> Modified the CacheAdministrator.generateKey() function to append the request&#039;s QueryString to the URI when automatically generating keys. The QueryString is encoded using the MD5 digest base64 algorithms.</li>
+<li> Added attribute &quot;encoding&quot; to a CacheTag so that the file IO does proper conversion when reading and writing the cache files. (per suggestion of Pedro Gomez)</li>
+<li> Added retries when SecurityException is thrown. Java has no built in exclusive file locking implementations. The file is written to a lock file and then renamed as an atomic operation so that multiple processes on the same box can reliable access cache data.</li>
+<li> Added &quot;pattern&quot; attribute to FlushTag which invokes a CacheHashMap.flushPattern() function to scan for and flush all keys that contain the value of the pattern. (per suggestion of Todd Rudrick)</li>
+<li> Added support for a CacheTag time value of zero which turns off caching for that tag. (per suggestion of Pedro Gomez)</li>
+</ul>
+<h3 class="heading3"><a name="ChangeLog-OSCache1.3"> OSCache 1.3</a></h3><p class="paragraph">(9th June, 2001 - by Mike Cannon-Brookes, mike@atlassian.com)</p><ul class="star">
+<li> Fixed a single bug in the file caching - should now work</li>
+<li> Added property to set the cache key (not sure if this is useful)</li>
+<li> Cleaned up a lot of the code, refactored slightly so that the tags are more light weight and rely more on the Administrator and CacheHashMap for functionality.</li>
+</ul>
+<h3 class="heading3"><a name="ChangeLog-OSCache1.2.5"> OSCache 1.2.5</a></h3><p class="paragraph">(18th May, 2001 - by Mike Cannon-Brookes, mike@atlassian.com)</p><ul class="star">
+<li> Added ability to turn off file caching (just remove or comment out cache.properties)</li>
+<li> Removed a pesky (but ineffectual) bug where session caches being removed from disk were throwing NullPointerExceptions</li>
+</ul>
+<h3 class="heading3"><a name="ChangeLog-OSCache1.2.1"> OSCache 1.2.1</a></h3><p class="paragraph">(10th May, 2001 - by Mike Cannon-Brookes, mike@atlassian.com)</p><ul class="star">
+<li> Speed improvements in CacheEntry and CacheAdministrator (by Kesav Kumar - kesavk@voquette.com)</li>
+<li> Fixed DOCTYPE in taglib.tld (also Kesav!)</li>
+<li> Removed backup / swap / temp files from zip (and changed build file)</li>
+</ul>
+<h3 class="heading3"><a name="ChangeLog-OSCache1.2"> OSCache 1.2</a></h3><p class="paragraph">(28th March, 2001 - by Mike Cannon-Brookes, mike@atlassian.com)</p><ul class="star">
+<li> Fixed a large bug that resulted in CacheEntry&#039;s not refreshing. Large enough in a Caching library to demand a new point release <img class="rendericon" src="./icons/emoticons/wink.gif" height="20" width="20" align="absmiddle" alt="" border="0"/></li>
+</ul>
+<h3 class="heading3"><a name="ChangeLog-OSCache1.1"> OSCache 1.1</a></h3><p class="paragraph">(25th March, 2001 - by Mike Cannon-Brookes, mike@atlassian.com)</p><ul class="star">
+<li> Moved up to 1.1 because a lot of documentation improving and some small bug fixing has been done</li>
+<li> Javadocs should now be very readable for all classes and methods</li>
+<li> Fixed a NullPointer that was being thrown in CacheEntry.needsRefresh()</li>
+<li> Cleaned up the build file so it now produces releasable zip files easily</li>
+<li> Added servlet.jar so that the compiling now works OOB (Out Of the Box)</li>
+</ul>
+<h3 class="heading3"><a name="ChangeLog-OSCache1.0%28betarelease2%29"> OSCache 1.0 (beta release 2)</a></h3><p class="paragraph">(20th March, 2001 - by Mike Cannon-Brookes, mike@atlassian.com)</p><ul class="star">
+<li> Fixed more bugs.</li>
+<li> Moved things around so that the CacheAdministrator has more functionality and is now a Singleton (per web app context). This means no more depedency on ServletContextListener to start the CacheAdministrator.</li>
+<li> Therefore we are now Servlet 2.2 / JSP 1.1 compliant! w00!</li>
+</ul>
+<h3 class="heading3"><a name="ChangeLog-OSCache1.0%28betarelease1%29"> OSCache 1.0 (beta release 1)</a></h3><p class="paragraph">(20th February, 2001 - by Mike Cannon-Brookes, mike@atlassian.com)</p><ul class="star">
+<li> Fixed a few bugs.</li>
+<li> Greatest of which there is no longer a disk leakage from session caches on disk.</li>
+<li> Also session caching bugs fixed, usecached bugs fixed - lots of work done here.</li>
+<li> Implemented to flush individual keys.</li>
+</ul>
+<h3 class="heading3"><a name="ChangeLog-OSCache1.0%28betarelease0%29"> OSCache 1.0 (beta release 0)</a></h3><p class="paragraph">(26th November, 2000 - by Mike Cannon-Brookes, mike@atlassian.com)</p><ul class="star">
+<li> Initial release of OSCache</li>
+<li> Conceptualised a few things I&#039;ve been working on over the past month.</li>
+<li> Added persistent on disk caching and error tolerance (through &lt;usecached /&gt; tag)</li>
+</ul>
+
+				    
+                    			    </td>
+		    </tr>
+	    </table>
+	    <table border="0" cellpadding="0" cellspacing="0" width="100%">
+			<tr>
+				<td height="12" background="border/border_bottom.gif"><img src="border/spacer.gif" width="1" height="1" border="0"/></td>
+			</tr>
+		    <tr>
+			    <td align="center"><font color="grey">Document generated by Confluence on Jan 18, 2005 00:39</font></td>
+		    </tr>
+	    </table>
+    </body>
+</html>

docs/Cron Expressions.html

+<html>
+    <head>
+        <title>OSCache : Cron Expressions</title>
+	    <link rel="stylesheet" href="styles/site.css" type="text/css" />
+        <META http-equiv="Content-Type" content="text/html; charset=UTF-8">	    
+    </head>
+
+    <body>
+	    <table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
+		    <tr>
+			    <td valign="top" class="pagebody">
+				    <div class="pageheader">
+					    <span class="pagetitle">
+                            OSCache : Cron Expressions
+                                                    </span>
+				    </div>
+				    <div class="pagesubheading">
+					    This page last changed on Jan 17, 2005 by <font color="#0050B2">dres1011</font>.
+				    </div>
+
+				    <p class="paragraph">Prior to version 2.0 of <b class="strong">OSCache</b>, content expiry could only be specified in terms of how long a piece of content had been in the cache, ie, it was based on the age of the content. If you needed to expire it at a particular time of day or on a specific date, you had to write a custom RefreshPolicy class.</p><b class="strong">OSCache 2.0</b> now gives you the ability to expire content at specific dates and/or times based on a cron expression.<p class="paragraph"><h3 class="heading3"><a name="CronExpressions-WhatisaCronExpression%3F"> What is a Cron Expression?</a></h3></p>Many of you are probably already familiar with the unix cron program. For those that aren&#039;t, cron is a daemon process that allows users to execute commands or scripts automatically at user-configurable dates and times. The important part as far as OSCache is concerned is the cron expression syntax that allows users to dictate when commands should be executed - you can now use the same syntax to expire content in OSCache! A cron expression is a simple text string that specifies particular dates and/or times that are matched against.<p class="paragraph"><h3 class="heading3"><a name="CronExpressions-HowDoesOSCacheMatchAgainstanExpression%3F"> How Does OSCache Match Against an Expression?</a></h3></p><b class="strong">OSCache</b> uses cron expressions in a manner that might seem &#039;backwards&#039; to what you might initially expect. When using a cron expression to test if a cache entry is stale, OSCache finds the date and time (prior to the current time) that most recently matches the supplied expression. This date/time is used as the expiry time - entries that were placed in the cache prior to this expiry time are considered stale and result in a NeedsRefreshException being thrown.<p class="paragraph">As an example, suppose you specify a cron expiry that matches every hour, on the hour (&quot;0 * * * *&quot;). If the current time is 10:42pm, then any content that was placed in the cache prior to 10:00pm would be considered stale.</p><h3 class="heading3"><a name="CronExpressions-TheCronExpressionSyntax"> The Cron Expression Syntax</a></h3><p class="paragraph">A cron expression consists of the following 5 fields:</p><ul class="star">
+<li> <b class="strong">Minute</b> - specifies what minute of the hour to expire content on. It is a number between 0 and 59.</li>
+<li> <b class="strong">Hour</b> - determines what hour of the day content will expire on. It is specified using the 24-hour clock, so the values must be between 0 (midnight) and 23 (11pm).</li>
+<li> <b class="strong">DOM</b> - the Day of the Month. This is a number from 1 to 31. It indicates what day the content should expire on. For example, to expire content on the 10th of every month, set this field to 10.</li>
+<li> <b class="strong">Month</b> - month of the year to expire the content. This can be specified either numerically (1 through 12), or by using the actual month name (eg &#039;January&#039;). Month names are case-insensitive and only the first three characters are taken into account - the rest are ignored.</li>
+<li> <b class="strong">DOW</b> - The Day of the Week that the content should be expired on. This can be a numeric value (0-6, where 0 = Sunday, 1 = Monday, ..., 6 = Saturday), or you can use the actual day name. As is the case with month names, DOW names are case-insensitive and only the first three characters matter.</li>
+</ul><br/>
+If you don&#039;t want to specify a value for a particular field (ie you want the cron expression to match all values for that field), just use a * character for the field value.<p class="paragraph">As an example, an expression that expired content at 11:45pm each day during April would look like this: &quot;45 23 * April *&quot;.</p><b class="strong">OSCache</b> also allows you to optionally specify lists, ranges and intervals (or even a combination of all three) within each field:<br/>
+
+<ul class="star">
+<li> <b class="strong">Lists</b> - items in a list are delimited using the &#039;,&#039; character. Content expiry times will be matched against all values in the list for that field. For example, &quot;0,15,30,45 * * * *&quot; will expire content every quarter-hour on the quarter hour.</li>
+<li> <b class="strong">Ranges</b> - ranges are specified using the &#039;-&#039; character. A range will include all values from the start to the end value (inclusive). For example, &quot;* * * Jan-June *&quot; will expire content every minute only during the first 6 months of the year.</li>
+<li> <b class="strong">Intervals</b> - an interval is specified using the &#039;/&#039; character. The value to the left of the &#039;/&#039; character indicates either the starting point or the range of values that should be incremented over, while the value to the right of the &#039;/&#039; specifies the interval or step size. Some examples -
+<div class="preformatted"><div class="preformattedContent">
+<pre>&quot;10/20 &#42; &#42; &#42; &#42;&quot; is equivalent to &quot;10,30,50 &#42; &#42; &#42; &#42;&quot;, &#10;while &quot;10&#45;45/20 &#42; &#42; &#42; &#42;&quot; would only match 10 and 30 minutes past the hour, since 50 is outside the specified range.</pre>
+</div></div>
+<div class="preformatted"><div class="preformattedContent">
+<pre>Supplying &#039;&#42;&#039; as the left&#45;hand value of an interval will match the same values as if you had specified a range over all possible values.&#10;Eg &quot;&#42;/10 &#42; &#42; &#42; &#42;&quot; matches minutes 0,10,20,30,40 and 50.</pre>
+</div></div>
+</li>
+</ul><br/>
+To have a look at further examples of both valid and invalid syntax, it is suggested you take a look at the JUnit test cases in the com.opensymphony.oscache.util.TestFastCronParser class. This class is located under the src/core/test directory. For examples of how to specify cron expiry times using the taglibs, see the <a href="JSP Tags.html" title="JSP Tags">Tag Reference</a> and the cronTest.jsp file in the example web application.<p class="paragraph"><h3 class="heading3"><a name="CronExpressions-Notes"> Notes</a></h3></p><ul class="star">
+<li> You can specify both a cron expression and a refresh interval at the same time if you like. This is useful in cases where you always want to expire content at midnight, but you also never want it to be more than 6 hours old.</li>
+<li> Specifying out of range values, such as a 13 in the month field, will cause a ParseException to be thrown.</li>
+<li> If a DOM is specified that cannot exist given the allowable months, a ParseException will be thrown. For example, &quot;* * 31 Feb *&quot; will fail because no date will ever match the 31st February!</li>
+<li> The DOM and DOW fields cannot both be specified at the same time. One must always be set to &#039;*&#039; otherwise a ParseException will be thrown.</li>
+<li> Leap years and local daylight savings time are taken into account. Eg &quot;0 0 29 Feb *&quot; will match midnight on the 29th February, ie only once every 4 years.</li>
+<li> Currently the time used to match the cron expression against is always based on the local time on the server. If there is demand support for specifying an alternate timezone may</li>
+</ul>
+
+				    
+                    			    </td>
+		    </tr>
+	    </table>
+	    <table border="0" cellpadding="0" cellspacing="0" width="100%">
+			<tr>
+				<td height="12" background="border/border_bottom.gif"><img src="border/spacer.gif" width="1" height="1" border="0"/></td>
+			</tr>
+		    <tr>
+			    <td align="center"><font color="grey">Document generated by Confluence on Jan 18, 2005 00:39</font></td>
+		    </tr>
+	    </table>
+    </body>
+</html>

docs/Documentation.html

+<html>
+    <head>
+        <title>OSCache : Documentation</title>
+	    <link rel="stylesheet" href="styles/site.css" type="text/css" />
+        <META http-equiv="Content-Type" content="text/html; charset=UTF-8">	    
+    </head>
+
+    <body>
+	    <table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
+		    <tr>
+			    <td valign="top" class="pagebody">
+				    <div class="pageheader">
+					    <span class="pagetitle">
+                            OSCache : Documentation
+                                                    </span>
+				    </div>
+				    <div class="pagesubheading">
+					    This page last changed on Jan 18, 2005 by <font color="#0050B2">dres1011</font>.
+				    </div>
+
+				    <p class="paragraph"><h3 style="margin: 4px 0px 4px 0px;" class="heading3"><a name="Documentation-1.Overview"> 1. Overview</a></h3>
+<ol>
+<li> <a href="What is OSCache.html" title="What is OSCache">What is OSCache</a></li>
+<li> <a href="Feature List.html" title="Feature List">Feature List</a> - Details on OSCache&#039;s features and how they are best used</li>
+<li> <a href="Requirements.html" title="Requirements">Requirements</a> - What is required to run OSCache</li>
+<li> <a href="FAQ.html" title="FAQ">FAQ</a> - Frequently Asked Questions about OSCache</li>
+<li> <a href="OSCache in the Wild.html" title="OSCache in the Wild">OSCache in the Wild</a> - A list of sites that are using OSCache in production.</li>
+</ol>
+<h3 class="heading3"><a name="Documentation-2.OSCacheversions"> 2. OSCache versions</a></h3>
+<ol>
+<li> <a href="Change Log.html" title="Change Log">Change Log</a> - See what&#039;s new in the latest version of OSCache</li>
+<li> <a href="http://jira.opensymphony.com/secure/BrowseProject.jspa?id=10001&amp;report=roadmap" title="Visit page outside Confluence">Project Roadmap</a></li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE?report=com.atlassian.jira.plugin.system.project:changelog-panel" title="Visit page outside Confluence">JIRA Changelog</a></li>
+</ol>
+<h3 class="heading3"><a name="Documentation-3.Tutorial"> 3. Tutorial</a></h3>
+<ol>
+<li> <a href="Installation Guide.html" title="Installation Guide">Installation Guide</a> - How to install OSCache and where to get it.</li>
+<li> <a href="CacheFilter.html" title="CacheFilter">Caching Content with the CacheFilter</a> - How to configure OSCache to cache entire servlet responses.</li>
+<li> <a href="Clustering.html" title="Clustering">Clustering OSCache</a> - How to use OSCache in a cluster.</li>
+</ol>
+<h3 class="heading3"><a name="Documentation-4.ReferenceGuide"> 4. Reference Guide</a></h3>
+<ol>
+<li> <a href="Configuration.html" title="Configuration">Configuration</a> - Configuration options for OSCache.</li>
+<li> <a href="JSP Tags.html" title="JSP Tags">JSP Tags</a> - Detailed documentation on OSCache&#039;s tags and how to use them.</li>
+<li> <a href="Cron Expressions.html" title="Cron Expressions">Cron Expressions</a> - How to use the cron expression syntax to expire content.</li>
+<li> <a href="http://www.opensymphony.com/oscache/api/" title="Visit page outside Confluence">JavaDoc API</a> - The OSCache API documentation in JavaDoc format.</li>
+</ol>
+<h3 class="heading3"><a name="Documentation-5.Thirdpartyintegration"> 5. Third-party integration</a></h3>
+<ol>
+<li> <a href="Hibernate.html" title="Hibernate">Hibernate</a> - How to integrate OSCache with Hibernate.</li>
+<li> Spring</li>
+</ol>
+<h3 class="heading3"><a name="Documentation-6.Links"> 6. Links</a></h3>
+<ol>
+<li> <a href="http://www.opensymphony.com/oscache/" title="Visit page outside Confluence">Current Release Home</a></li>
+<li> <a href="https://oscache.dev.java.net/" title="Visit page outside Confluence">dev.java.net Project</a></li>
+<li> <a href="https://oscache.dev.java.net/servlets/ProjectDocumentList" title="Visit page outside Confluence">Download Source and Binaries</a></li>
+<li> <a href="https://oscache.dev.java.net/source/browse/oscache/" title="Visit page outside Confluence">CVS Access</a></li>
+<li> <a href="https://oscache.dev.java.net/servlets/ProjectMailingListList" title="Visit page outside Confluence">Mailing List</a></li>
+</ol></p>
+
+				    
+                    			    </td>
+		    </tr>
+	    </table>
+	    <table border="0" cellpadding="0" cellspacing="0" width="100%">
+			<tr>
+				<td height="12" background="border/border_bottom.gif"><img src="border/spacer.gif" width="1" height="1" border="0"/></td>
+			</tr>
+		    <tr>
+			    <td align="center"><font color="grey">Document generated by Confluence on Jan 18, 2005 00:39</font></td>
+		    </tr>
+	    </table>
+    </body>
+</html>

docs/Feature List.html

+<html>
+    <head>
+        <title>OSCache : Feature List</title>
+	    <link rel="stylesheet" href="styles/site.css" type="text/css" />
+        <META http-equiv="Content-Type" content="text/html; charset=UTF-8">	    
+    </head>
+
+    <body>
+	    <table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
+		    <tr>
+			    <td valign="top" class="pagebody">
+				    <div class="pageheader">
+					    <span class="pagetitle">
+                            OSCache : Feature List
+                                                    </span>
+				    </div>
+				    <div class="pagesubheading">
+					    This page last changed on Jan 16, 2005 by <font color="#0050B2">dres1011</font>.
+				    </div>
+
+				    <p class="paragraph"><h3 style="margin: 4px 0px 4px 0px;" class="heading3"><a name="FeatureList-OSCacheFeatures"> OSCache Features</a></h3></p><h4 class="heading4"><a name="FeatureList-Fastinmemorycaching"> Fast in-memory caching</a></h4>
+
+<ul class="star">
+<li> OSCache allows you to execute dynamic content periodically (eg every 30 minutes) rather than every request and store the result in memory. Each further request is served directly from the memory cache, resulting in dramatic speed increases.</li>
+<li> The cache is keyed programmatically. This means you can calculate a cache key that works for your situation. For example an ecommerce site might use product ID as keys, or content site might use an article date and article ID combination.</li>
+<li> The cache is stored in standard scopes that any JSP programmer is familiar with (application or session). The session scope allows you to have different cached content per user. This is one unlike any other caching system we&#039;ve ever seen.</li>
+</ul>
+<h4 class="heading4"><a name="FeatureList-Persistentondiskcaching"> Persistent on-disk caching</a></h4>
+
+<ul class="star">
+<li> OSCache can also write the cache to disk. This provides caching across server restarts, and caching of datasets that do not fit into memory. Caching can be configured to use memory or file caching, or a combination of both.</li>
+<li> If you want to persist the cache to somewhere other than disk, you can plug in a custom PersistenceListener. This allows you to persist the cache to anywhere (for example to a database via JDBC or to LDAP via JNDI).</li>
+<li> When using both disk caching and memory caching. It is possible to limit the cache size to avoid using too much memory but let disk cache unlimited, resulting in browser style complementary disk cache. When cached objects are removed from memory, they are still on disk. If the item is needed again and it is not expired the cache file will be used. This also gives fault tolerance if the server crashes.</li>
+<li> Persistence can also be switched to overflow mode using the property oscache.persistence.overflow.only. This changes the default behavior (of persisting every cache entry when there is a listener) to only persist when the memory cache capacity has been reached.</li>
+</ul>
+<h4 class="heading4"><a name="FeatureList-ExcellentPerformance"> Excellent Performance</a></h4>
+
+<ul class="star">
+<li> Written with performance in mind.</li>
+<li> Mulitple cache requests can be handled concurrently.</li>
+<li> Only one requesting thread needs to update an expired cache entry even if multiple threads are requesting it simultaneously. Other threads can be configured to either receive the recently-expired object, or block until the cached object is updated. Similarly, when a new entry is being added to the cache, other threads requesting that entry will block until it is ready rather than run off and race to build the same object. In a high load environment this can provide enormous performance benefits.</li>
+<li> Automatically takes advantage of JRE 1.4 or higher if available.</li>
+</ul>
+<h4 class="heading4"><a name="FeatureList-Clusteringsupport"> Clustering support</a></h4>
+
+<ul class="star">
+<li> OSCache can easily be configured to cluster across multiple boxes. This provides both scalability and failover support without any changes required in your caching code.</li>
+</ul>
+<h4 class="heading4"><a name="FeatureList-FlexibleCachingSystem"> Flexible Caching System</a></h4>
+
+<ul class="star">
+<li> OSCache allows you to cache portions of JSP pages, arbitrary Java objects, and even entire servlet responses.</li>
+<li> Cache capacity can be set allowing you to limit the number of cached objects.</li>
+<li> Multiple caching algorithms are supported such as LRU (Least Recently Used), FIFO (First In First Out), or unlimited. It is also possible to plug in your own custom algorithm.</li>
+<li> You are given a huge amount of control over the way cached objects expire. Objects can be cached indefinitely, expired once they reach a certain age, or expired based on a cron expression. Programmatic flushing is also possible, and if that is still not enough pluggable RefreshPolicies allow custom refresh strategies.</li>
+<li> Cached objects can be grouped together however you like, allowing for powerful management of cached data. This is an extremely useful feature that is far more powerful than what other caching solutions typically offer (such as the flushing of cache keys that match a particular pattern).</li>
+<li> Fully event driven! OSCache fires events for various happenings &#039;under the hood&#039; such as cache entry events (adding, updating, flushing and removing) and cache accesses (hit, stale hit and miss). It is easy to add your own event handlers.</li>
+<li> Multiple caches can be created, each with their own unique configuration.</li>
+</ul>
+<h4 class="heading4"><a name="FeatureList-SimpleJSPTagLibrary"> Simple JSP Tag Library</a></h4>
+
+<ul class="star">
+<li> The <a href="JSP Tags.html" title="JSP Tags">tag library</a> to perform and control the caching is very simple. See the Tag Reference for more information.</li>
+</ul>
+<h4 class="heading4"><a name="FeatureList-CachingFilter"> Caching Filter</a></h4>
+
+<ul class="star">
+<li> A Servlet 2.3 Filter allows for caching of entire pages and generated binary files (like dynamically created images or PDF files).</li>
+</ul>
+<h4 class="heading4"><a name="FeatureList-ComprehensiveAPI"> Comprehensive API</a></h4>
+
+<ul class="star">
+<li> For the ultimate control, OSCache can be used through its straightforward API. You can instantiate, configure and control multiple caches programmatically. It would be possible for example to create one small in-memory cache that held currency conversion rates and was updated daily at 2am, while another cache could be purely disk based and used for holding dynamically created images.</li>
+</ul>
+<h4 class="heading4"><a name="FeatureList-ExceptionHandling"> Exception Handling</a></h4>
+
+<ul class="star">
+<li> OSCache provides a way for your site to gracefully tolerate errors. This is not error prevention, rather if an error occurs it should not stop your site from functioning. For example if your database goes down, normally your product descriptions will not be browsable. Using OSCache you can cache those descriptions so you can still browse them.</li>
+</ul>
+<h4 class="heading4"><a name="FeatureList-CacheFlushing"> Cache Flushing</a></h4>
+
+<ul class="star">
+<li> Flushing of caches can be controlled via JSP Tags, so these functions can easily be built into your administration interface.</li>
+<li> There is programmatic control over what caches are flushed (eg all caches or just a particular scope).</li>
+<li> Cached objects can be expired in a number of ways. Objects can be told to expire once they reach a certain age, or, through the use of cron expressions, on particular dates and/or times (eg it is trivial to make an object expire every weekday at 3am). If this is not enough, you can expire objects programmatically as required, or plug in your own custom RefreshPolicy class that can dynamically decide when an object should be flushed.</li>
+<li> Entire groups of objects can be easily flushed from the cache. For example suppose you were caching product data as well as entire pages of your website. When a product was updated, you could flush not just the product object but also all the pages that contain information about that product. No more waiting for the cached objects to expire before the updated content shows up on your site!</li>
+</ul>
+<h4 class="heading4"><a name="FeatureList-Portablecaching"> Portable caching</a></h4>
+
+<ul class="star">
+<li> Pure Java, this means it is platform independent.</li>
+<li> OSCache is compliant with Servlet 2.3 and JSP 1.2 standards, which means it should work in the latest generation of servlet containers and application servers.</li>
+</ul>
+<h4 class="heading4"><a name="FeatureList-i18nAware"> i18n Aware</a></h4>
+
+<ul class="star">
+<li> The caching is i18n aware and supports all encodings.</li>
+</ul>
+<h4 class="heading4"><a name="FeatureList-SolidReputation"> Solid Reputation</a></h4>
+
+<ul class="star">
+<li> Thousands of downloads, hundreds of users on the <a href="https://oscache.dev.java.net/servlets/ProjectMailingListList" title="Visit page outside Confluence">mailing list</a>.</li>
+<li> Comprehensive <a href="http://www.junit.org/" title="Visit page outside Confluence">JUnit</a> test suite that covers every aspect of OSCache, including a web stress test and various concurrent cache access scenarios. To back this up, the kind folks at <a href="http://www.cortexebusiness.com.au/" title="Visit page outside Confluence">Cortex</a> have supplied us with a <a href="http://www.thecortex.net/clover/" title="Visit page outside Confluence">Clover</a> license to provide detailed code coverage analysis of our unit tests.</li>
+<li> We have solid <a href="http://jira.opensymphony.com/" title="Visit page outside Confluence">issue tracking</a> using <a href="http://www.atlassian.com/software/jira" title="Visit page outside Confluence">JIRA</a> to keep track of any feature requests, bug reports and development progress. <a href="http://www.atlassian.com/software/jira" title="Visit page outside Confluence">JIRA</a> is provided courtesy of <a href="http://www.atlassian.com/" title="Visit page outside Confluence">Atlassian</a>.</li>
+</ul>
+
+				    
+                    			    </td>
+		    </tr>
+	    </table>
+	    <table border="0" cellpadding="0" cellspacing="0" width="100%">
+			<tr>
+				<td height="12" background="border/border_bottom.gif"><img src="border/spacer.gif" width="1" height="1" border="0"/></td>
+			</tr>
+		    <tr>
+			    <td align="center"><font color="grey">Document generated by Confluence on Jan 18, 2005 00:39</font></td>
+		    </tr>
+	    </table>
+    </body>
+</html>

docs/Hibernate Cache Adapter.html

+<html>
+    <head>
+        <title>OSCache : Hibernate Cache Adapter</title>
+	    <link rel="stylesheet" href="styles/site.css" type="text/css" />
+        <META http-equiv="Content-Type" content="text/html; charset=UTF-8">	    
+    </head>
+
+    <body>
+	    <table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
+		    <tr>
+			    <td valign="top" class="pagebody">
+				    <div class="pageheader">
+					    <span class="pagetitle">
+                            OSCache : Hibernate Cache Adapter
+                                                    </span>
+				    </div>
+				    <div class="pagesubheading">
+					    This page last changed on Jan 17, 2005 by <font color="#0050B2">dres1011</font>.
+				    </div>
+
+				    <p class="paragraph">Patched version of OSCache.java originally created by Mathias Bogaert.</p><div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>OSCache.java</b></div><div class="codeContent">
+<pre><span class="java&#45;keyword">import</span> java.util.Properties;&#10;&#10;<span class="java&#45;keyword">import</span> net.sf.hibernate.util.PropertiesHelper;&#10;<span class="java&#45;keyword">import</span> net.sf.hibernate.util.StringHelper;&#10;&#10;<span class="java&#45;keyword">import</span> com.opensymphony.oscache.base.Config;&#10;<span class="java&#45;keyword">import</span> com.opensymphony.oscache.base.CacheEntry;&#10;<span class="java&#45;keyword">import</span> com.opensymphony.oscache.base.NeedsRefreshException;&#10;<span class="java&#45;keyword">import</span> com.opensymphony.oscache.general.GeneralCacheAdministrator;&#10;&#10;/&#42;&#42;&#10; &#42; Adapter <span class="java&#45;keyword">for</span> the OSCache implementation&#10; &#42;/&#10;<span class="java&#45;keyword">public</span> class OSCache <span class="java&#45;keyword">implements</span> Cache &#123;&#10;    &#10;    /&#42;&#42; &#10;     &#42; The &lt;tt&gt;OSCache&lt;/tt&gt; cache capacity property suffix. &#10;     &#42;/&#10;    <span class="java&#45;keyword">public</span>&#160;<span class="java&#45;keyword">static</span>&#160;<span class="java&#45;keyword">final</span>&#160;<span class="java&#45;object">String</span> OSCACHE&#95;CAPACITY = <span class="java&#45;quote">&quot;cache.capacity&quot;</span>;&#10;&#10;    <span class="java&#45;keyword">private</span>&#160;<span class="java&#45;keyword">static</span>&#160;<span class="java&#45;keyword">final</span> Properties OSCACHE&#95;PROPERTIES = <span class="java&#45;keyword">new</span> Config().getProperties();&#10;	/&#42;&#42; &#10;	 &#42; The OSCache 2.0 cache administrator. &#10;	 &#42;/&#10;	<span class="java&#45;keyword">private</span>&#160;<span class="java&#45;keyword">static</span> GeneralCacheAdministrator cache = <span class="java&#45;keyword">new</span> GeneralCacheAdministrator();&#10;&#10;    <span class="java&#45;keyword">private</span>&#160;<span class="java&#45;keyword">static</span>&#160;<span class="java&#45;object">Integer</span> capacity = PropertiesHelper.getInteger(OSCACHE&#95;CAPACITY, OSCACHE&#95;PROPERTIES);&#10;&#10;    <span class="java&#45;keyword">static</span> &#123;&#10;        <span class="java&#45;keyword">if</span> (capacity &#33;= <span class="java&#45;keyword">null</span>) cache.setCacheCapacity(capacity.intValue());&#10;    &#125;&#10;    &#10;	<span class="java&#45;keyword">private</span>&#160;<span class="java&#45;keyword">final</span>&#160;<span class="java&#45;object">int</span> refreshPeriod;&#10;	<span class="java&#45;keyword">private</span>&#160;<span class="java&#45;keyword">final</span>&#160;<span class="java&#45;object">String</span> cron;&#10;	<span class="java&#45;keyword">private</span>&#160;<span class="java&#45;keyword">final</span>&#160;<span class="java&#45;object">String</span> regionName;&#10;    <span class="java&#45;keyword">private</span>&#160;<span class="java&#45;keyword">final</span>&#160;<span class="java&#45;object">String</span>&#91;&#93; regionGroups;&#10;	&#10;	<span class="java&#45;keyword">private</span>&#160;<span class="java&#45;object">String</span> toString(<span class="java&#45;object">Object</span> key) &#123;&#10;		<span class="java&#45;keyword">return</span>&#160;<span class="java&#45;object">String</span>.valueOf(key) &#43; StringHelper.DOT &#43; regionName;&#10;	&#125;&#10;&#10;	<span class="java&#45;keyword">public</span> OSCache(<span class="java&#45;object">int</span> refreshPeriod, <span class="java&#45;object">String</span> cron, <span class="java&#45;object">String</span> region) &#123;&#10;		<span class="java&#45;keyword">this</span>.refreshPeriod = refreshPeriod;&#10;		<span class="java&#45;keyword">this</span>.cron = cron;&#10;		<span class="java&#45;keyword">this</span>.regionName = region;&#10;        <span class="java&#45;keyword">this</span>.regionGroups = <span class="java&#45;keyword">new</span>&#160;<span class="java&#45;object">String</span>&#91;&#93; &#123;region&#125;;&#10;	&#125;&#10;&#10;	<span class="java&#45;keyword">public</span>&#160;<span class="java&#45;object">Object</span> get(<span class="java&#45;object">Object</span> key) <span class="java&#45;keyword">throws</span> CacheException &#123;&#10;		<span class="java&#45;keyword">try</span> &#123;&#10;			<span class="java&#45;keyword">return</span> cache.getFromCache( toString(key), refreshPeriod, cron );&#10;		&#125;&#10;		<span class="java&#45;keyword">catch</span> (NeedsRefreshException e) &#123;&#10;			cache.cancelUpdate( toString(key) );&#10;			<span class="java&#45;keyword">return</span>&#160;<span class="java&#45;keyword">null</span>;&#10;		&#125;&#10;	&#125;&#10;&#10;	<span class="java&#45;keyword">public</span> void put(<span class="java&#45;object">Object</span> key, <span class="java&#45;object">Object</span> value) <span class="java&#45;keyword">throws</span> CacheException &#123;&#10;		cache.putInCache( toString(key), value, regionGroups );&#10;	&#125;&#10;&#10;	<span class="java&#45;keyword">public</span> void remove(<span class="java&#45;object">Object</span> key) <span class="java&#45;keyword">throws</span> CacheException &#123;&#10;		cache.flushEntry( toString(key) );&#10;	&#125;&#10;&#10;	<span class="java&#45;keyword">public</span> void clear() <span class="java&#45;keyword">throws</span> CacheException &#123;&#10;		cache.flushGroup(regionName);&#10;	&#125;&#10;&#10;	<span class="java&#45;keyword">public</span> void destroy() <span class="java&#45;keyword">throws</span> CacheException &#123;&#10;		<span class="java&#45;keyword">synchronized</span> (cache) &#123;&#10;		    cache.destroy();&#10;        &#125;&#10;	&#125;&#10;&#10;	<span class="java&#45;keyword">public</span> void lock(<span class="java&#45;object">Object</span> key) <span class="java&#45;keyword">throws</span> CacheException &#123;&#10;		<span class="java&#45;comment">// local cache, so we use synchronization</span>&#10;	&#125;&#10;&#10;	<span class="java&#45;keyword">public</span> void unlock(<span class="java&#45;object">Object</span> key) <span class="java&#45;keyword">throws</span> CacheException &#123;&#10;		<span class="java&#45;comment">// local cache, so we use synchronization</span>&#10;	&#125;&#10;&#10;	<span class="java&#45;keyword">public</span>&#160;<span class="java&#45;object">long</span> nextTimestamp() &#123;&#10;		<span class="java&#45;keyword">return</span> Timestamper.next();&#10;	&#125;&#10;&#10;	<span class="java&#45;keyword">public</span>&#160;<span class="java&#45;object">int</span> getTimeout() &#123;&#10;		<span class="java&#45;keyword">return</span> CacheEntry.INDEFINITE&#95;EXPIRY;&#10;	&#125;&#10;&#10;&#125;</pre>
+</div></div> 
+
+				    
+                    			    </td>
+		    </tr>
+	    </table>
+	    <table border="0" cellpadding="0" cellspacing="0" width="100%">
+			<tr>
+				<td height="12" background="border/border_bottom.gif"><img src="border/spacer.gif" width="1" height="1" border="0"/></td>
+			</tr>
+		    <tr>
+			    <td align="center"><font color="grey">Document generated by Confluence on Jan 18, 2005 00:39</font></td>
+		    </tr>
+	    </table>
+    </body>
+</html>

docs/Hibernate Cache Provider.html

+<html>
+    <head>
+        <title>OSCache : Hibernate Cache Provider</title>
+	    <link rel="stylesheet" href="styles/site.css" type="text/css" />
+        <META http-equiv="Content-Type" content="text/html; charset=UTF-8">	    
+    </head>
+
+    <body>
+	    <table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
+		    <tr>
+			    <td valign="top" class="pagebody">
+				    <div class="pageheader">
+					    <span class="pagetitle">
+                            OSCache : Hibernate Cache Provider
+                                                    </span>
+				    </div>
+				    <div class="pagesubheading">
+					    This page last changed on Jan 17, 2005 by <font color="#0050B2">dres1011</font>.
+				    </div>
+
+				    <p class="paragraph">Patched version of OSCacheProvider.java originally created by Mathias Bogaert.</p><div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>OSCacheProvider.java</b></div><div class="codeContent">
+<pre><span class="java&#45;keyword">import</span> java.util.Properties;&#10;&#10;<span class="java&#45;keyword">import</span> net.sf.hibernate.util.PropertiesHelper;&#10;<span class="java&#45;keyword">import</span> net.sf.hibernate.util.StringHelper;&#10;&#10;<span class="java&#45;keyword">import</span> com.opensymphony.oscache.base.CacheEntry;&#10;<span class="java&#45;keyword">import</span> com.opensymphony.oscache.base.Config;&#10;&#10;/&#42;&#42;&#10; &#42; Support <span class="java&#45;keyword">for</span> OpenSymphony OSCache. This implementation assumes&#10; &#42; that identifiers have well&#45;behaved &lt;tt&gt;toString()&lt;/tt&gt; methods.&#10; &#42;/&#10;<span class="java&#45;keyword">public</span> class OSCacheProvider <span class="java&#45;keyword">implements</span> CacheProvider &#123;&#10;&#10;	/&#42;&#42; &#10;	 &#42; The &lt;tt&gt;OSCache&lt;/tt&gt; refresh period property suffix. &#10;	 &#42;/&#10;	<span class="java&#45;keyword">public</span>&#160;<span class="java&#45;keyword">static</span>&#160;<span class="java&#45;keyword">final</span>&#160;<span class="java&#45;object">String</span> OSCACHE&#95;REFRESH&#95;PERIOD = <span class="java&#45;quote">&quot;refresh.period&quot;</span>;&#10;	/&#42;&#42; &#10;	 &#42; The &lt;tt&gt;OSCache&lt;/tt&gt; CRON expression property suffix. &#10;	 &#42;/&#10;	<span class="java&#45;keyword">public</span>&#160;<span class="java&#45;keyword">static</span>&#160;<span class="java&#45;keyword">final</span>&#160;<span class="java&#45;object">String</span> OSCACHE&#95;CRON = <span class="java&#45;quote">&quot;cron&quot;</span>;&#10;	&#10;	<span class="java&#45;keyword">private</span>&#160;<span class="java&#45;keyword">static</span>&#160;<span class="java&#45;keyword">final</span> Properties OSCACHE&#95;PROPERTIES = <span class="java&#45;keyword">new</span> Config().getProperties();&#10;&#10;	/&#42;&#42;&#10;	 &#42; Builds a <span class="java&#45;keyword">new</span> &#123;&#64;link Cache&#125; instance, and gets it&#039;s properties from the OSCache &#123;&#64;link Config&#125;&#10;	 &#42; which reads the properties file (&lt;code&gt;oscache.properties&lt;/code&gt;) from the classpath.&#10;	 &#42; If the file cannot be found or loaded, an the defaults are used.&#10;	 &#42;&#10;	 &#42; &#64;param region&#10;	 &#42; &#64;param properties&#10;	 &#42; &#64;<span class="java&#45;keyword">return</span>&#10;	 &#42; &#64;<span class="java&#45;keyword">throws</span> CacheException&#10;	 &#42;/&#10;	<span class="java&#45;keyword">public</span> Cache buildCache(<span class="java&#45;object">String</span> region, Properties properties) <span class="java&#45;keyword">throws</span> CacheException &#123;&#10;&#10;		<span class="java&#45;object">int</span> refreshPeriod = PropertiesHelper.getInt(&#10;			StringHelper.qualify(region, OSCACHE&#95;REFRESH&#95;PERIOD), &#10;			OSCACHE&#95;PROPERTIES, &#10;			CacheEntry.INDEFINITE&#95;EXPIRY&#10;		);&#10;		<span class="java&#45;object">String</span> cron = OSCACHE&#95;PROPERTIES.getProperty( StringHelper.qualify(region, OSCACHE&#95;CRON) );&#10;&#10;		<span class="java&#45;comment">// construct the cache        </span>&#10;        <span class="java&#45;keyword">return</span>&#160;<span class="java&#45;keyword">new</span> OSCache(refreshPeriod, cron, region);&#10;	&#125;&#10;&#10;	<span class="java&#45;keyword">public</span>&#160;<span class="java&#45;object">long</span> nextTimestamp() &#123;&#10;		<span class="java&#45;keyword">return</span> Timestamper.next();&#10;	&#125;&#10;&#10;&#125;</pre>
+</div></div>
+
+				    
+                    			    </td>
+		    </tr>
+	    </table>
+	    <table border="0" cellpadding="0" cellspacing="0" width="100%">
+			<tr>
+				<td height="12" background="border/border_bottom.gif"><img src="border/spacer.gif" width="1" height="1" border="0"/></td>
+			</tr>
+		    <tr>
+			    <td align="center"><font color="grey">Document generated by Confluence on Jan 18, 2005 00:39</font></td>
+		    </tr>
+	    </table>
+    </body>
+</html>
+<html>
+    <head>
+        <title>OSCache : Home</title>
+	    <link rel="stylesheet" href="styles/site.css" type="text/css" />
+        <META http-equiv="Content-Type" content="text/html; charset=UTF-8">	    
+    </head>
+
+    <body>
+	    <table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
+		    <tr>
+			    <td valign="top" class="pagebody">
+				    <div class="pageheader">
+					    <span class="pagetitle">
+                            OSCache : Home
+                            	                            <img src="icons/home_16.gif" height="16" width="16" border="0" align="absmiddle"/>
+                                                    </span>
+				    </div>
+				    <div class="pagesubheading">
+					    This page last changed on Jan 18, 2005 by <font color="#0050B2">dres1011</font>.
+				    </div>
+
+				    <p class="paragraph">Welcome to the OSCache wiki. OSCache&#039;s official homepage is <a href="http://www.opensymphony.com/oscache/." title="Visit page outside Confluence">&#104;ttp://www.opensymphony.com/oscache/.</a> There you can find documentation for the latest released version of OSCache This wiki is used for additional information as well as documentation for the latest developing version (see Previous releases).</p><ul class="star">
+<li> <a href="Documentation.html" title="Documentation">Documentation</a><ul class="star">
+<li> <a href="http://www.opensymphony.com/oscache/api/" title="Visit page outside Confluence">JavaDoc API</a> - The OSCache API documentation in JavaDoc format.</li>
+</ul></li>
+<li> <a href="Installation Guide.html" title="Installation Guide">Installation Guide</a> - How to install OSCache and where to get it.</li>
+</ul>
+<ul class="star">
+<li> <a href="https://oscache.dev.java.net/servlets/ProjectDocumentList" title="Visit page outside Confluence">Download Source and Binaries</a></li>
+<li> <a href="https://oscache.dev.java.net/source/browse/oscache/" title="Visit page outside Confluence">CVS Access</a></li>
+<li> <a href="https://oscache.dev.java.net/servlets/ProjectMailingListList" title="Visit page outside Confluence">Mailing List</a></li>
+</ul>
+<ul class="star">
+<li> <a href="http://jira.opensymphony.com/secure/BrowseProject.jspa?id=10001&amp;report=roadmap" title="Visit page outside Confluence">Project Roadmap</a></li>
+<li> <a href="http://jira.opensymphony.com/browse/CACHE?report=com.atlassian.jira.plugin.system.project:changelog-panel" title="Visit page outside Confluence">JIRA Changelog</a></li>
+<li> <a href="http://wiki.opensymphony.com//display/CACHE/Index" title="Index">Index</a></li>
+</ul>
+
+				    
+                    			    </td>
+		    </tr>
+	    </table>
+	    <table border="0" cellpadding="0" cellspacing="0" width="100%">
+			<tr>
+				<td height="12" background="border/border_bottom.gif"><img src="border/spacer.gif" width="1" height="1" border="0"/></td>
+			</tr>
+		    <tr>
+			    <td align="center"><font color="grey">Document generated by Confluence on Jan 18, 2005 00:39</font></td>
+		    </tr>
+	    </table>
+    </body>
+</html>

docs/Installation Guide.html

+<html>
+    <head>
+        <title>OSCache : Installation Guide</title>
+	    <link rel="stylesheet" href="styles/site.css" type="text/css" />
+        <META http-equiv="Content-Type" content="text/html; charset=UTF-8">	    
+    </head>
+
+    <body>
+	    <table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
+		    <tr>
+			    <td valign="top" class="pagebody">
+				    <div class="pageheader">
+					    <span class="pagetitle">
+                            OSCache : Installation Guide
+                                                    </span>
+				    </div>
+				    <div class="pagesubheading">
+					    This page last changed on Jan 17, 2005 by <font color="#0050B2">dres1011</font>.
+				    </div>
+
+				    <p class="paragraph">This installation guide shows you how to configure OSCache for use inside your JSP pages. It assumes you have <a href="https://oscache.dev.java.net/servlets/ProjectDocumentList" title="Visit page outside Confluence">downloaded the latest version.</a></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&#039;s classpath.<p class="paragraph"><h4 class="heading4"><a name="InstallationGuide-ExtractionSteps"> Extraction Steps</a></h4></p><ol>
+<li> Extract the downloaded file to a directory of your choosing.</li>
+<li> Put the /oscache.jar file in the /WEB-INF/lib directory</li>
+<li> Make sure commons=logging.jar is on your classpath (normally this also means putting it in /WEB-INF/lib.</li>
+<li> 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).</li>
+<li> Put the /src/oscache.properties file in the /WEB-INF/classes directory and edit the properties contained within it (for example if you want disk caching, configure the persistence listener and edit the cache.path property to point to where you want the cache files stored on disk). See the <a href="configuration.html" title="Configuration">Configuration Guide</a> for further details on what options are available.</li>
+<li> 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:<br clear="all" />
+cachedir.
+</li>
+<li> Put the /src/META-INF/taglib.tld file in your /WEB-INF/classes directory. You can rename this to oscache.tld if you have any conflicting tld files.</li>
+<li> Your directory structure should now look something like this:
+<div class="panel"><div class="panelContent">
+<p class="paragraph">$WEB_APPLICATION\WEB-INF\lib\oscache.jar<br/>
+$WEB_APPLICATION\WEB-INF\classes\oscache.properties<br/>
+$WEB_APPLICATION\WEB-INF\classes\taglib.tld</p>
+</div></div>
+</li>
+</ol>
+<h4 class="heading4"><a name="InstallationGuide-InstallationSteps"> Installation Steps</a></h4>
+
+<ol>
+<li> Add the following to your web.xml file
+<div class="code"><div class="codeContent">
+<pre><span class="xml&#45;tag">&lt;taglib&gt;</span>&#10;          <span class="xml&#45;tag">&lt;taglib&#45;uri&gt;</span>oscache<span class="xml&#45;tag">&lt;/taglib&#45;uri&gt;</span>&#10;          <span class="xml&#45;tag">&lt;taglib&#45;location&gt;</span>/WEB&#45;INF/classes/taglib.tld<span class="xml&#45;tag">&lt;/taglib&#45;location&gt;</span>&#10;    <span class="xml&#45;tag">&lt;/taglib&gt;</span></pre>
+</div></div>
+</li>
+<li> Now add the appropriate <a href="JSP Tags.html" title="JSP Tags">tags</a> to your JSP files and you&#039;re done.</li>
+<li> It should work properly. <a href="mailto:users@oscache.dev.java.net" title="Send mail to Tell us on the mailing list">Tell us on the mailing list</a> if it doesn&#039;t work in your container.</li>
+</ol>
+<div align='center'><div class='informationMacroPadding'><table cellpadding='5' width='85%' cellspacing='0' class='infoMacro' border='0'><tr><td width='16' valign='top'><img src="/images/icons/emoticons/information.png" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b class="strong">Logging</b><br /><br/>
+OSCache now uses Jakarta Commons Logging for logging any messages. Please see the Commons Logging documentation for details on logging configuration.
+</td></tr></table></div></div><br/>
+
+<div align='center'><div class='informationMacroPadding'><table cellpadding='5' width='85%' cellspacing='0' class='tipMacro' border='0'><tr><td width='16' valign='top'><img src="/images/icons/emoticons/check.png" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b class="strong">Debugging</b><br /><br/>
+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.
+</td></tr></table></div></div>
+
+				    
+                    			    </td>
+		    </tr>
+	    </table>
+	    <table border="0" cellpadding="0" cellspacing="0" width="100%">
+			<tr>
+				<td height="12" background="border/border_bottom.gif"><img src="border/spacer.gif" width="1" height="1" border="0"/></td>
+			</tr>
+		    <tr>
+			    <td align="center"><font color="grey">Document generated by Confluence on Jan 18, 2005 00:39</font></td>
+		    </tr>
+	    </table>
+    </body>
+</html>

docs/JSP Tags.html

+<html>
+    <head>
+        <title>OSCache : JSP Tags</title>
+	    <link rel="stylesheet" href="styles/site.css" type="text/css" />
+        <META http-equiv="Content-Type" content="text/html; charset=UTF-8">	    
+    </head>
+
+    <body>
+	    <table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
+		    <tr>
+			    <td valign="top" class="pagebody">
+				    <div class="pageheader">
+					    <span class="pagetitle">
+                            OSCache : JSP Tags
+                                                    </span>
+				    </div>
+				    <div class="pagesubheading">
+					    This page last changed on Jan 17, 2005 by <font color="#0050B2">dres1011</font>.
+				    </div>
+
+				    <p class="paragraph"><b class="strong">OSCache</b> comes with a JSP tag library that controls all its major functions. The tags are listed below with descriptions, attributes and examples of use.</p>For instructions on installing OSCache in a web application, see the <a href="Installation Guide.html" title="Installation Guide">Installation Guide</a>.<p class="paragraph">The tags are:</p><ul class="star">
+<li> <a href="#JSPTags-cache" title="cache on JSP Tags">cache</a> - The main caching tag</li>
+<li> <a href="#JSPTags-usecached" title="usecached on JSP Tags">usecached</a> - A nested tag to force using a cached version.</li>
+<li> <a href="#JSPTags-flush" title="flush on JSP Tags">flush</a> - To flush caches programmatically.</li>
+<li> <a href="#JSPTags-addgroup" title="addgroup on JSP Tags">addgroup</a> - This tag must be nested inside &lt;cache:cache/&gt;. It allows groups to be dynamically added to a cached block.</li>
+</ul>
+<div align='center'><div class='informationMacroPadding'><table cellpadding='5' width='85%' cellspacing='0' class='infoMacro' border='0'><tr><td width='16' valign='top'><img src="/images/icons/emoticons/information.png" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b class="strong">Tag Legend</b><br />
+<ul class="star">
+<li> For all listed attributes,  <font color="red">req</font> means it that attribute is required and any value in <b class="strong">&#91; &#93;</b> is a default value. All attributes can accept runtime expressions.</li>
+</ul>
+<ul class="star">
+<li> From the title of the tag you can see whether or not the tag has a body:<ul class="star">
+<li> <b class="strong">&lt;tag&gt;&lt;/tag&gt;</b> tags always have a body</li>
+<li> <b class="strong">&lt;tag /&gt;</b> does not have a body</li>
+<li> <b class="strong">&lt;tag /&gt;&lt;/tag&gt;</b> can have a body or not depending on the circumstances.</li>
+</ul></li>
+</ul></td></tr></table></div></div><p class="paragraph"><h3 class="heading3"><a name="JSPTags-%3Caname%3D%22JSPTagscache%22%3E%3C%2Fa%3E%26lt%3Bcache%26gt%3B%26lt%3B%2Fcache%26gt%3B"> <a name="JSPTags-cache"></a>&lt;cache&gt;&lt;/cache&gt;</a></h3></p><h4 class="heading4"><a name="JSPTags-Description%3A"> Description:</a></h4><p class="paragraph">This is the main tag of OSCache. The body of the tag will be cached according to the attributes specified. The first time a cache is used the body content is executed and cached.</p>    Each subsequent time the tag is run, it will check to see if the cached content is stale. Content is considered stale due to one (or more) of the following being true:<br/>
+
+<ul class="star">
+<li> The cached body content has been in the cache for longer than the time specified by the time or duration attribute.</li>
+<li> The cron attribute matches a date/time that is more recent than the time the body content was originally cached.</li>
+<li> The scope the body content is cached in was flushed since the content was originally cached.</li>
+</ul><br/>
+    If the cached body content is stale, the tag will execute the body again and recache the new body content. Otherwise it will serve the cached content and the body will be skipped (resulting in a large speed increase).<p class="paragraph"><h4 class="heading4"><a name="JSPTags-Attributes%3A"> Attributes:</a></h4></p><ul class="star">
+<li> <b class="strong">key</b> - &#91;The request URI + query string&#93; - The cache key, any string. This should be unique for the given scope since duplicate keys will map to the same cache entry. The default value uses an escaped version of the URI and query string of the current page.<br/>
+It is possible to specify multiple cache tags in the same page without specifying keys - in this situation an index is appended to the key of subsequent tags. However this usage is discouraged since if the flow of the page is inconsistent, or cache tags are nested, the indicies will potentially change each time the page is executed, resulting in seemingly jumbled cache entries.
+</li>
+<li> <b class="strong">scope</b> - &#91;application&#93; - The scope of this cache (valid values are &quot;application&quot; and &quot;session&quot;).</li>
+<li> <b class="strong">time</b> - &#91;3600&#93; The amount of time to cache this content for (in seconds). (Default is 3600 seconds, one hour). Supplying a negative value for this attribute means that the content never expires.</li>
+<li> <b class="strong">duration</b> - &#91;&#93; - The duration of this cache (this attribute is an alternative to time). duration can be specified using Simple Date Format or ISO-8601 date format.</li>
+<li> <b class="strong">cron</b> - &#91;&#93; - A cron expression that determines when this cached content will expire. This allows content to be expired at particular dates and/or times, rather than once a cache entry reaches a certain age. See <a href="Cron Expressions.html" title="Cron Expressions">Cron Expressions</a> to read more about this attribute.</li>
+<li> <b class="strong">refresh</b> - &#91;false&#93; - A boolean. If true, the cache will be refreshed regardless of whether it is considered stale or not. This enables you to decide at runtime whether or not to rebuild the content.</li>
+<li> <b class="strong">mode</b> - &#91;&#93; - Setting this to &quot;silent&quot; will prevent the body of the tag from being written to the output stream. This may be useful if you want to preload the cache with content without actually displaying that content to the user.</li>
+<li> <b class="strong">groups</b> - &#91;&#93; - A comma-delimited list of group names can be provided. This allows cache entries to be grouped according to your needs. Grouping is useful when you have cached content that depends on other parts of your application or data - when that dependency changes, flushing the relevant group will cause all cache entries in that group to be expired.</li>
+<li> <b class="strong">language</b> - &#91;&#93; - The ISO-639 language code to distinguish different content cached under an otherwise identical key. This is useful on a multilingual site where the same JSP code is used to render content in different languages depending on the current user&#039;s preferences.</li>
+<li> <b class="strong">refreshpolicyclass</b> - &#91;&#93; - A fully-qualified classname that extends com.opensymphony.oscache.web.WebEntryRefreshPolicy. This allows you to programmatically determine whether cached content should be exipired.</li>
+<li> <b class="strong">refreshpolicyparam</b> - &#91;&#93; - Any arbitrary parameters that you need to pass through to the refreshpolicyclass. Specifying this attribute without specifying a refreshpolicyclass will have no effect.
+<div class="code"><div class="codeHeader"><b>Examples</b></div><div class="codeContent">
+<pre>This will cache the JSP content using the current URI as a key (which means <span class="java&#45;keyword">this</span> must be the only cache tag on the page to work).&#10;&#10;    &lt;cache:cache&gt;&#10;         &#8230; some jsp content ...&#10;    &lt;/cache:cache&gt;&#10;&#10;    This will cache the content with a constant key in the user&#039;s session scope. Any page that uses <span class="java&#45;keyword">this</span> key will access one shared cache.&#10;&#10;    &lt;cache:cache key=<span class="java&#45;quote">&quot;foobar&quot;</span> scope=<span class="java&#45;quote">&quot;session&quot;</span>&gt;&#10;         &#8230; some jsp content ...&#10;    &lt;/cache:cache&gt;&#10;&#10;    This will cache the content with a programmatic key (here a product ID) <span class="java&#45;keyword">for</span> 30 minutes. It will also refresh <span class="java&#45;keyword">if</span> the variable needRefresh &#10;is <span class="java&#45;keyword">true</span>.&#10;&#10;    &lt;cache:cache key=<span class="java&#45;quote">&quot;&lt;&#37;= product.getId() &#37;&gt;&quot;</span> time=<span class="java&#45;quote">&quot;1800&quot;</span> refresh=<span class="java&#45;quote">&quot;&lt;&#37;= needRefresh &#37;&gt;&quot;</span>&gt;&#10;         &#8230; some jsp content ...&#10;    &lt;/cache:cache&gt;&#10;&#10;    This will cache the content with a programmatic key, expiring it every morning at 2am. It will also refresh <span class="java&#45;keyword">if</span> the variable needRefresh &#10;is <span class="java&#45;keyword">true</span>.&#10;&#10;    &lt;cache:cache key=<span class="java&#45;quote">&quot;&lt;&#37;= product.getId() &#37;&gt;&quot;</span> cron=<span class="java&#45;quote">&quot;0 2 &#42; &#42; &#42;&quot;</span> refresh=<span class="java&#45;quote">&quot;&lt;&#37;= needRefresh &#37;&gt;&quot;</span>&gt;&#10;         &#8230; some jsp content ...&#10;    &lt;/cache:cache&gt;&#10;&#10;    Suppose we had a dynamic list of categories that we pull from a database, and we also store currency exchange rates that get updated &#10;occasionally by calling a webservice. Suppose also that we have some content that displays information about both the categories and the &#10;current exchange rate values. The following example caches the body content and assigns it to two cache groups, <span class="java&#45;quote">&quot;currencyData&quot;</span> and &#10;<span class="java&#45;quote">&quot;categoryList&quot;</span>. When the exchange rates or the category list is updated, the appropriate group can be flushed causing <span class="java&#45;keyword">this</span> content (along &#10;with any other content associated with that group) to be exipired and then rebuilt the next time the page is processed:&#10;&#10;    &lt;cache:cache key=<span class="java&#45;quote">&quot;&lt;&#37;= product.getId() &#37;&gt;&quot;</span> time=<span class="java&#45;quote">&quot;&#45;1&quot;</span> group=<span class="java&#45;quote">&quot;currencyData, categories&quot;</span>&gt;&#10;         &#8230; display category list ...&#10;         &#8230; display currency information ...&#10;    &lt;/cache:cache&gt;</pre>
+</div></div>
+</li>
+</ul>
+<h3 class="heading3"><a name="JSPTags-%3Caname%3D%22JSPTagsusecached%22%3E%3C%2Fa%3E%26lt%3Busecached%2F%26gt%3B"> <a name="JSPTags-usecached"></a>&lt;usecached /&gt;</a></h3>
+<h4 class="heading4"><a name="JSPTags-Description%3A"> Description:</a></h4>
+This tag is nested within a &lt;cache&gt; tag and tells its parent whether or not to use the cached version.<p class="paragraph"><h4 class="heading4"><a name="JSPTags-Attributes%3A"> Attributes:</a></h4>
+<ul class="star">
+<li> <b class="strong">use</b> - &#91;true&#93; - A boolean that tells the tag whether or not to use the cached version. (true = use cached version). This is useful for<br/>
+programmatic control of the cache.
+<div class="code"><div class="codeHeader"><b>Example</b></div><div class="codeContent">
+<pre>This is a good example of error tolerance. If an exception occurs, the cached version of <span class="java&#45;keyword">this</span> content will be output instead.&#10;&#10;    &lt;cache:cache&gt;&#10;         &lt;&#37; <span class="java&#45;keyword">try</span> &#123; &#37;&gt;&#10;         &#8230; some jsp content ...&#10;         &lt;&#37; &#125; <span class="java&#45;keyword">catch</span> (Exception e) &#123; &#37;&gt;&#10;              &lt;cache:usecached /&gt;&#10;         &lt;&#37; &#125; &#37;&gt;&#10;    &lt;/cache:cache&gt;</pre>
+</div></div>
+</li>
+</ul>
+<h3 class="heading3"><a name="JSPTags-%3Caname%3D%22JSPTagsflush%22%3E%3C%2Fa%3E%26lt%3Bflush%2F%26gt%3B"> <a name="JSPTags-flush"></a>&lt;flush /&gt;</a></h3></p><h4 class="heading4"><a name="JSPTags-Description%3A"> Description:</a></h4>
+    This tag is used to flush caches at runtime. It is especially useful because it can be coded into the administration section of your site so that admins can decide when to flush the caches.<p class="paragraph"><h4 class="heading4"><a name="JSPTags-Attributes%3A"> Attributes:</a></h4></p><ul class="star">
+<li> <b class="strong">scope</b> - &#91;all&#93; - This decides what scope will be flushed. Valid values are &quot;application&quot;, &quot;session&quot; and null. A null scope will flush all caches, regardless of their scope.</li>
+<li> <b class="strong">key</b> - [] - When a key and a scope are both given, just that single cache entry will be marked to be flushed. When it is next accessed, it will be refreshed. It is not valid to specify a key without a scope.</li>
+<li> <b class="strong">group</b> - [] - Specifying a group will cause all cache entries in the group to be flushed. It is not valid to specify a group without a scope.</li>
+<li> <b class="strong">pattern</b> - [] - Any keys that contain this string will be flushed from the specified scope. It is not valid to specify a pattern without a scope. (Note: pattern flushing has been deprecated - you are encouraged to use the grouping functionality instead. It is more flexible and provides better performance.)</li>
+<li> <b class="strong">language</b> - [] - The ISO-639 language code to distinguish different content cached under an otherwise identical key. This is useful on a multilingual site where the same JSP code is used to render content in different languages depending on the current user&#039;s preferences.</li>
+</ul>
+<div class="code"><div class="codeContent">
+<pre>This will flush the application scope.&#10;&#10;    &lt;cache:flush scope=<span class="java&#45;quote">&quot;application&quot;</span> /&gt;&#10;&#10;    This will flush the cache entry with key <span class="java&#45;quote">&quot;foobar&quot;</span> in the session scope.&#10;&#10;    &lt;cache:flush scope=<span class="java&#45;quote">&quot;session&quot;</span> key=<span class="java&#45;quote">&quot;foobar&quot;</span> /&gt;&#10;&#10;    This will flush all cache entries in the <span class="java&#45;quote">&quot;currencyData&quot;</span> group from the application scope.&#10;&#10;    &lt;cache:flush scope=<span class="java&#45;quote">&quot;application&quot;</span> group=<span class="java&#45;quote">&quot;currencyData&quot;</span> /&gt;</pre>
+</div></div><p class="paragraph"><h3 class="heading3"><a name="JSPTags-%3Caname%3D%22JSPTagsaddgroup%22%3E%3C%2Fa%3E%26lt%3Baddgroup%2F%26gt%3B"> <a name="JSPTags-addgroup"></a>&lt;addgroup /&gt;</a></h3></p><h4 class="heading4"><a name="JSPTags-Description%3A"> Description:</a></h4><p class="paragraph">This tag must be nested inside a &lt;cache:cache/&gt; tag. It allows groups to be dynamically added to a cached block. It is useful when the group(s) a cached block should belong to are unknown until the block is actually rendered. As each group is &#039;discovered&#039;, this tag can be used to add the group to the block&#039;s group list.</p><h4 class="heading4"><a name="JSPTags-Attributes%3A"> Attributes:</a></h4>
+
+<ul class="star">
+<li> <b class="strong">group</b> - <font color="red">req</font> - The name of the group to add the enclosing cache block to.</li>
+</ul>
+<div class="code"><div class="codeContent">
+<pre>This will add the cache block with the key &#039;test1&#039; to groups &#039;group1&#039; and &#039;group2&#039;.&#10;&#10;    &lt;cache:cache key=<span class="java&#45;quote">&quot;test1&quot;</span>&gt;&#10;         &lt;cache:addgroup group=<span class="java&#45;quote">&quot;group1&quot;</span> /&gt;&#10;         &#8230; some jsp content ...&#10;         &lt;cache:addgroup group=<span class="java&#45;quote">&quot;group2&quot;</span> /&gt;&#10;         &#8230; some more jsp content ...&#10;    &lt;/cache:cache&gt;</pre>
+</div></div>
+
+				    
+                    			    </td>
+		    </tr>
+	    </table>
+	    <table border="0" cellpadding="0" cellspacing="0" width="100%">
+			<tr>
+				<td height="12" background="border/border_bottom.gif"><img src="border/spacer.gif" width="1" height="1" border="0"/></td>
+			</tr>
+		    <tr>
+			    <td align="center"><font color="grey">Document generated by Confluence on Jan 18, 2005 00:39</font></td>
+		    </tr>
+	    </table>
+    </body>
+</html>

docs/OSCache in the Wild.html

+<html>
+    <head>
+        <title>OSCache : OSCache in the Wild</title>
+	    <link rel="stylesheet" href="styles/site.css" type="text/css" />
+        <META http-equiv="Content-Type" content="text/html; charset=UTF-8">	    
+    </head>
+
+    <body>
+	    <table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
+		    <tr>
+			    <td valign="top" class="pagebody">
+				    <div class="pageheader">
+					    <span class="pagetitle">
+                            OSCache : OSCache in the Wild
+                                                    </span>
+				    </div>
+				    <div class="pagesubheading">
+					    This page last changed on Jan 17, 2005 by <font color="#0050B2">dres1011</font>.
+				    </div>
+
+				    <p class="paragraph">The following are some of the sites that are using OSCache in production. This is far from an exhaustive list of course! If you have or know of a site using OSCache, please let us know so we can add it to the list. While not required, any performance figures, load levels or case studies that you can include would be greatly appreciated.</p><ul class="star">
+<li> <a href="http://www.theserverside.com/" title="Visit page outside Confluence">The Server Side</a></li>
+<li> <a href="http://www.javablogs.com/" title="Visit page outside Confluence">JavaBlogs</a></li>
+<li> <a href="http://www.jroller.com/" title="Visit page outside Confluence">JRoller</a></li>
+<li> <a href="http://www.javalobby.org/" title="Visit page outside Confluence">JavaLobby</a></li>
+<li> <a href="http://www.premierleague.com/" title="Visit page outside Confluence">Premier League</a> - Some details are available <a href="http://www.objectivity.co.uk/Customers/Case+studies/FAPL.htm" title="Visit page outside Confluence">here</a>.</li>
+<li> <a href="http://www.blueyonder.co.uk/" title="Visit page outside Confluence">Blue Yonder</a> - Handles 10 million hits per month.</li>
+<li> <a href="http://www.officiallondontheatre.co.uk/" title="Visit page outside Confluence">Society of London Theatre</a> - Handles 7 million hits (900,000 page views) per month.</li>
+<li> <a href="http://www.burlington.co.uk/" title="Visit page outside Confluence">Burlington Paintings</a></li>
+<li> <a href="http://www.bennetts.com/" title="Visit page outside Confluence">Bennetts</a></li>
+<li> <a href="http://www.swebtec.com/" title="Visit page outside Confluence">Swebtec</a></li>
+<li> <a href="http://eq2players.station.sony.com/" title="Visit page outside Confluence">Sony Online Entertainment - Everquest2 Players' Site</a> - Handles over 1 million page views per day.</li>
+</ul>
+
+				    
+                    			    </td>
+		    </tr>
+	    </table>
+	    <table border="0" cellpadding="0" cellspacing="0" width="100%">
+			<tr>
+				<td height="12" background="border/border_bottom.gif"><img src="border/spacer.gif" width="1" height="1" border="0"/></td>
+			</tr>
+		    <tr>
+			    <td align="center"><font color="grey">Document generated by Confluence on Jan 18, 2005 00:39</font></td>
+		    </tr>
+	    </table>
+    </body>
+</html>

docs/What is OSCache.html

+<html>
+    <head>
+        <title>OSCache : What is OSCache</title>
+	    <link rel="stylesheet" href="styles/site.css" type="text/css" />
+        <META http-equiv="Content-Type" content="text/html; charset=UTF-8">	    
+    </head>
+
+    <body>
+	    <table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
+		    <tr>
+			    <td valign="top" class="pagebody">
+				    <div class="pageheader">
+					    <span class="pagetitle">
+                            OSCache : What is OSCache
+                                                    </span>
+				    </div>
+				    <div class="pagesubheading">
+					    This page last changed on Jan 16, 2005 by <font color="#0050B2">dres1011</font>.
+				    </div>
+
+				    <p class="paragraph"><b class="strong">OSCache</b> is a widely used, high performance J2EE caching framework.</p><div class="panel"><div class="panelHeader"><b>The Problems Solved</b></div><div class="panelContent">
+<p class="paragraph"><b class="strong">OSCache</b> solves fundamental problems for dynamic websites:</p><ol>
+<li> <b class="strong">Caching Dynamic Content</b> - Dynamic content of some form must often be executed during each request, but sometimes that content doesn&#039;t change every request. Caching the whole page does not help because sections of the page change every request.<ul class="star">
+<li> <b class="strong">OSCache</b> solves this problem by providing a means to cache sections of JSP pages.</li>
+</ul></li>
+<li> <b class="strong">Caching Binary Content</b> - Generated images and PDFs can be very costly in terms of server load.<ul class="star">
+<li> <b class="strong">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 class="strong">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 class="star">
+<li> <b class="strong">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>
+</ol>
+</div></div><br/>
+
+<div class="panel"><div class="panelHeader"><b>Brief Feature List</b></div><div class="panelContent">
+<p class="paragraph">In addition to it&#039;s servlet-specific features, <b class="strong">OSCache</b> can be used as a generic caching solution for any Java application. A few of its generic features include:</p><ul class="star">
+<li> <b class="strong">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 class="strong">Comprehensive API</b> - The <b class="strong">OSCache</b> API gives you full programmatic control over all of OSCache&#039;s features.</li>
+<li> <b class="strong">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 class="strong">Clustering</b> - Support for clustering of cached data can be enabled with a single configuration parameter. No code changes required.</li>
+<li> <b class="strong">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>
+</div></div><br/>
+We encourage you to take a look at the full <a href="Feature List.html" title="Feature List">Feature List</a> to see what else <b class="strong">OSCache</b> has to offer.
+
+				    
+                    			    </td>
+		    </tr>
+	    </table>
+	    <table border="0" cellpadding="0" cellspacing="0" width="100%">
+			<tr>
+				<td height="12" background="border/border_bottom.gif"><img src="border/spacer.gif" width="1" height="1" border="0"/></td>
+			</tr>
+		    <tr>
+			    <td align="center"><font color="grey">Document generated by Confluence on Jan 18, 2005 00:39</font></td>
+		    </tr>
+	    </table>
+    </body>
+</html>

docs/api.css

-td, li, br, div, p
-{
-	font-family : verdana, arial, helvetica, sans-serif;
-	font-size: 11px;
-}
-
-body
-{
-  margin:  0;
-  padding:  0;
-  color:  #333333;
-  background-color: white;
-  font-size: 11px;
-  font-family: verdana, arial, helvetica, sans-serif;
-  line-height: 19px;
-}
-
-TD.NavBarCell1
-{
-  font-size: 10px;
-  font-family: Verdana, Sans-Serif;
-  font-weight: bold;
-  color: #666666;
-  background-color: #99CCFF;
-}
-
-TD.NavBarCell1Rev
-{
-  font-family: Verdana, Sans-Serif;
-  font-size: 11px;
-  font-weight: bold;
-  color: #dedede;
-  background-color: #669900;
-}
-
-TR.TableHeadingColor
-{
-	background-color: #99CCFF;
-}
-
-HR
-{
-	size: 1;
-	color: #000000;
-	height: 1;
-}
-
-a
-{
-  text-decoration: none;
-}
-
-a:link
-{
-  color: #003366;
-}
-a:visited
-{
-  color: #cc6600;
-}
-a:active
-{
-  background-color: transparent;
-  color: #cc6600;
-}
-
-li
-{
-	padding-bottom: 2pt;
-}
-
-h2
-{
-  color: #006699;
-  margin-bottom: 10px;
-  margin-top: 10px;
-}
-
-h3
-{
-  color: #006699;
-}
-
-h4
-{
-  font: 11px verdana, arial, helvetica, sans-serif;
-  font-weight: bold;
-  color: #cc6600;
-}
-h5, h6
-{
-  color: #032588;
-}
Add a comment to this file

docs/atlassian-sponsor.gif

Removed
Old image
Add a comment to this file

docs/border/border_bottom.gif

Added
New image

docs/changelog.html

-<html>
-<head>
-<title>OSCache Changelog</title>
-</head>
-
-<body>
-
-<h3>OSCache 2.1</h3>
-<p><i>(11th January 2005 - by <a href="mailto:oscache at andresmarch dot com">Andres March</a>)</i></p>
-<b>Bug Fixes:</b>
-<ul>
-  <li>[<a href='http://jira.opensymphony.com/browse/CACHE-70'>CACHE-70</a>] - last modified problem</li>
-<li>[<a href='http://jira.opensymphony.com/browse/CACHE-73'>CACHE-73</a>] - NullpointerException after deserialization of AbstractConcurrentReadCache</li>
-<li>[<a href='http://jira.opensymphony.com/browse/CACHE-85'>CACHE-85</a>] - JavaGroups changed package name</li>
-<li>[<a href='http://jira.opensymphony.com/browse/CACHE-98'>CACHE-98</a>] - Disk cache not getting served first time for long keys</li>
-<li>[<a href='http://jira.opensymphony.com/browse/CACHE-107'>CACHE-107</a>] - flushEntry does not behave correctly in cluster</li>
-<li>[<a href='http://jira.opensymphony.com/browse/CACHE-118'>CACHE-118</a>] - Updating groups doesn't work</li>
-</ul>
-<b>Improvements:</b>
-<ul>
- <li>Updated jgroups jar and configuration based upon recommendations from Bela Ban (javagroups maintainer).</li>
-  <li>Website documentation updates.</li>
-  <LI>Added HashDiskPersistenceListner that hashes file names in order to
-  eliminate nasty characters and overly long names</LI>
-  <LI>Added property that allows cache entries to only be persisted when 
-  the memory capacity has been exceeded.  The property is called: cache.persistence.overflow.only.
-  It defaults to false for backwards compatibility meaning all cache entries are persisted when
-  a listener has been registered.</LI>
-  <li>[<a href='http://jira.opensymphony.com/browse/CACHE-58'>CACHE-58</a>] - If-Modified-Since ignored in cache filter</li>
-<li>[<a href='http://jira.opensymphony.com/browse/CACHE-92'>CACHE-92</a>] - public access for configuration properties</li>
-<li>[<a href='http://jira.opensymphony.com/browse/CACHE-94'>CACHE-94</a>] - More evenly distributed disk caching</li>
-<li>[<a href='http://jira.opensymphony.com/browse/CACHE-95'>CACHE-95</a>] - Output the scope name's in toString()</li>
-<li>[<a href='http://jira.opensymphony.com/browse/CACHE-102'>CACHE-102</a>] - Updated the Commons Logging jar to v1.0.4</li>
-<li>[<a href='http://jira.opensymphony.com/browse/CACHE-103'>CACHE-103</a>] - Updated the Commons Collections jar to v3.1</li>
-<li>[<a href='http://jira.opensymphony.com/browse/CACHE-104'>CACHE-104</a>] - Destroy cache</li>
-<li>[<a href='http://jira.opensymphony.com/browse/CACHE-105'>CACHE-105</a>] - call get() method on put() method call</li>
-</ul>
-
-<h3>OSCache 2.0.2</h3>
-<p><i>(22nd January 2004 - by <a href="mailto:pathos at pandora dot be">Mathias Bogaert</a>)</i></p>
-<b>Bug Fixes:</b>
-<ul>
-  <li>[CACHE-63] NullPointerException in GeneralCacheAdministrator#destroy().</li>
-  <li>[CACHE-44] Multi threading issues with LRU Cache.</li>
-  <li>[CACHE-66] DiskPersistenceListener is not Serializable.</li>
-  <li>GeneralCacheAdministrator now creates the cache from within the constructor. This prevents possible
-  threading issues if the cache is not initialized during application startup.</li>
-</ul>
-<b>Improvements:</b>
-<ul>
-  <li>Website documentation updates.</li>
-  <li>Added <a href="deployments.html">OSCache in the Wild</a>.</li>
-</ul>
-
-<h3>OSCache 2.0.1</h3>
-<p><i>(4th November 2003 - by <a href="&#109;a&#105;&#108;&#116;&#111;:chris&#64;swebtec.&#99;&#111;&#109;">Chris Miller</a>)</i></p>
-<b>Bug Fixes:</b>
-<ul>
-  <li>[CACHE-59] Silent mode could not be reset.</li>
-  <li>[CACHE-60] Fixed deadlock problem when cancelUpdate() was called while under load.</li>
-</ul>
-<b>Improvements:</b>
-<ul>
-  <li>[CACHE-56] Refresh period is no longer mandatory.</li>
-  <li>[CACHE-51] Added an &lt;cache:addgroup /&gt; tag. This allows cache groups to be
-  dynamically added from within a &lt;cache:cache /&gt; tag.</li>
-  <li>Website documentation is now bundled with the OSCache distribution.</li>
-</ul>
-<b>Changes that may affect backwards compatibility:</b>
-<ul>
-  <li>StringUtil.split() now returns a List rather than a String[].</li>
-</ul>
-
-
-<h3>OSCache 2.0</h3>
-<p><i>(22nd September 2003 - by <a href="&#109;a&#105;&#108;&#116;&#111;:chris&#64;swebtec.&#99;&#111;&#109;">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="&#109;a&#105;&#108;&#116;&#111;:chris&#64;swebtec.&#99;&#111;&#109;">Chris Miller</a>)</i></p>
-<b>New Features:</b>
-<ul>
-  <li>Now supports JavaGroups version 2.1.</li>
-  <li>JMS Clustering support has been added [Romulus Pasca].</li>
-  <li>Clustering code has been refactored. As a result of this, some of the
-  clustering configuration has changed since beta 1 - please see the updated
-  clustering documentation for details.</li>
-  <li>Performance enhancement: When running under JRE 1.3.x, the LRUCache will
-  now attempt to use the Jakarta commons collections SequencedHashMap. If the
-  commons-collections.jar is not present then the code resorts to using a
-  LinkedList and a warning is logged. Note that under JRE 1.4.x and higher the
-  commons-collections.jar is not required.</li>
-  <li>Config.getProperties() method added.</li>
-</ul>
-<b>Bug Fixes:</b>
-<ul>
-  <li>[CACHE-48] FastCronParser no longer requires JDK 1.4.x.</li>
-  <li>[CACHE-45] Fixed a serialization bug.</li>
-  <li>The CachewideEvent was not holding the event date.</li>
-  <li>Prevented an error from being logged in the CachewideEvent handling (even
-  though no problem had occurred).</li>
-  <li>Fixed a subtle bug in the concurrent unit test.</li>
-  <li>The ServletCacheAdministrator's app scope cache is created on startup (via
-  the CacheContextListener).</li>
-</ul>
-
-
-<h3>OSCache 2.0 (beta 1)</h3>
-<p><i>(19th July 2003 - by <a href="&#109;a&#105;&#108;&#116;&#111;:chris&#64;swebtec.&#99;&#111;&#109;">Chris Miller</a>)</i></p>
-<b>New Features:</b>
-<ul>
-  <li>[CACHE-11] Cache grouping support. This allows cache entries to be placed
-  into an arbitrary group or groups and flushed with a single flushGroup()
-  call.</li>
-  <li>[CACHE-30] Added support for expiring cache entries based on a cron expression.
-  Entries that are older than the date/time that most recently matches the cron
-  expression will be considered stale. This is exposed to the cache tag via
-  the 'cron' attribute. See cronTest.jsp for  examples.</li>
-  <li>Event listener support has been refactored and improved. It is now possible
-  to specify a comma-delimited list of event listeners using this property.
-  Previously only one class could be specified. Events listed here should
-  implement the CacheEntryEventListener and/or the ScopeEventListener interfaces.</li>
-  <li>New event CacheMapAccessEvent.STALE_HIT. This event is fired when an attempt
-  is made to retrieve and entry from the cache, and the entry is found but is
-  stale.</li>
-  <li>Clustering support has been added as an event listener. Currently it is
-  implemented using JavaGroups (www.javagroups.com). To enable, just add the
-  BroadcastingCacheEventListener class to the cache.event.listeners property.</li>
-  <li>Now uses Jakarta Commons Logging for all log messages. This means that the
-  cache.debug configuration property is now ignored - use whatever logging
-  configuration is appropriate for your logging setup instead. [Fabian Crabus]</li>
-  <li>[CACHE-14, Matthias Nott] Now allows for content to be cached indefinitely
-  without expiration.</li>
-  <li>The build.xml &lt;javac ...&gt; directives now specify debug="true".</li>
-  <li>Performance boost: When OSCache is running on JRE 1.4 or higher, LRUCache
-  and FIFOCache use a LinkedHashSet instead of a LinkedList.</li>
-  <li>Japloy is now used to ensure source is consistently formatted.</li>
-  <li>Test cases now work on non-windows platforms. Also coverage reports added
-  courtesy of clover.</li>
-</ul>
-<b>Changes that may affect backwards compatibility:</b>
-<ul>
-  <li>The cache.entryevent.classes property in the configuration file has been
-  renamed to cache.event.listeners, since it accepts CacheEntryEventListener,
-  ScopeEventListener and CacheMapAccessEventListener types.</li>
-  <li>The cache.persistence.classes property has been renamed to cache.persistence.class
-  since it is only possible to specify one PersistenceListener.</li>
-  <li>For consistency, cache.unlimited_disk is now cache.unlimited.disk and
-  cache.useHostDomainInKey is now cache.use.host.domain.in.key.</li>
-  <li>The oscache.tld file now uses a taglib 1.2 DTD.</li>
-  <li>To build OSCache, JDK 1.4.x or higher is required. There is however no
-  runtime dependency on JDK 1.4.x.</li>
-  <li>The Cache.flushPattern() method and &lt;cache:flush pattern=&quot;...&quot;/&gt;
-  are deprecated. You are instead encouraged to group your cache entries when you
-  add them to the cache and then use the Cache.flushGroup() method or the
-  &lt;cache:flush group=&quot;...&quot;/&gt; tag to flush an entire cache group.</li>
-  <li>Disk persistence now puts all files in the same directory. This has a number
-  of side effects. Keys >255 chars will cause problems. Also, similar keys
-  might get mapped to the same file. For example, it is very inadvisable to
-  have two keys with the names 'my_key' and 'my.key'.</li>
-  <li>GeneralCacheAdministrator is no longer static. Users that relied
-  on this behaviour can still hold onto a static reference to it with
-  minor code changes.</li>
-  <li>When a NeedsRefreshException is thrown, it is now vital that the cache
-  entry is either updated, or Cache.cancelUpdate(key) is called to release
-  the lock on this cache entry. This is a consequence of the fix for [CACHE-42].</li>
-  <li>CacheProperties class was removed. It didn't work on 1.7.5 anyway.
-  The same effect can be achieved by specifying a subclass of Properties.</li>
-  <li>Autogenerated cache keys now contain the request method (eg, HEAD, GET, etc).</li>
-  <li>OSCache has been repackaged from "com.opensymphony.module.oscache.*" to
-  "com.opensymphony.oscache.*". Any code or configuration files that refer to
-  "com.opensymphony.module.oscache" will need to be updated.</li>
-</ul>
-<b>Bug Fixes:</b>
-<ul>
-  <li>[CACHE-4] WebSphere 3.5.x compatibility.</li>
-  <li>[CACHE-5] Added a mode attribute to the cache tag to allow content to be
-  cached but not sent to the output stream. See oscacheTest.jsp for an example.</li>
-  <li>[CACHE-7] "cache" Tag has no "setEncoding" method.</li>
-  <li>[CACHE-9] It could be useful being able to specify directories relative
-  to the web application dir. for config file and cache dir. Use new
-  properties aware getInstance method.</li>
-  <li>[CACHE-10] Cannot write and use custom class implementing CacheProperties.</li>
-  <li>[CACHE-13] AbstractConcurrentReadCache loops indefinitely when
-  persistRetrieve() returns null.</li>
-  <li>[CACHE-14] You can now specify an unlimited refresh time by supplying a
-  negative value for the duration.</li>
-  <li>[CACHE-17] An example war is now included - "ant example-war". Once deployed
-  this can be tested using "ant test-web".</li>
-  <li>[CACHE-26] Security hole whereby certain keys can overwrite any file.</li>
-  <li>[CACHE-28] URLs can now be used as keys with disk persistence.</li>
-  <li>[CACHE-31 and CACHE-33] The cache tag's refresh attribute will now be taken
-  into account even if a custom refresh policy has been specified.</li>
-  <li>[CACHE-34] Setting properties with AbstractCacheAdministrators.
-  New getInstance method added to ServletCacheAdministrator that takes
-  in properties.</li>
-  <li>[CACHE-35] CacheFilter needs to distinguish between HEAD and GET requests.</li>
-  <li>[CACHE-39 and CACHE-44] Synchronization with LRUCache fixed.</li>
-  <li>[CACHE-42] Threads will no longer race to (re)build expired or new
-  cache entries. By default stale content will be served if available.
-  This behaviour can be changed by setting oscache.blocking=true, which will
-  instead cause threads to block until the new cache entry is available.</li>
-  <li>[CACHE-43] Taglibs have been made spec-compliant. They now follow the
-  guidelines at http://jakarta.apache.org/taglibs/guidelines.html.</li>
-  <li>Some synchronization issues were fixed in LRUCache.getItem() and
-  AbstractConcurrentReadCache.setMaxEntries().</li>
-  <li>ScopeEventListener classes were previously not able to be specified in the
-  configuration even though the dispatching code was implemented.
-  ScopeEventListeners can now be specified using the cache.event.listeners
-  configuration property.</li>
-  <li>CacheMapAccessEvents now only fire when an attempt is made to retrieve the
-  actual cache content for external use. Previously these events were being
-  fired in circumstances that were not of statistical interest - for example
-  HIT and MISS events were being fired when updating or flushing entries from
-  the cache.</li>
-  <li>Minor bug in oscacheTestMultipleTagNoKey.jsp - some of the tag refresh times
-  weren't correctly specified.</li>
-  <li>cachetest.jsp - the 'refresh' functionality wasn't working because the
-  addition of the refresh parameter caused the cache key to be different.
-  The key is now specified explicitly.</li>
-  <li>EntryRefreshPolicy is now serializable so it can be persisted to the disk
-  cache.</li>
-  <li>ServletCacheAdministrator now sorts request parameters and filters out
-  jsessionid so they have no impact on the generated cache key.</li>
-  <li>CacheFilter only caches successful responses (status code == SC_OK).</li>
-
-</ul>
-<b>Known Problems:</b>
-(these have existed for some time in the 1.x.x versions and will be addressed in
-an upcoming 2.x.x release)
-<ul>
-  <li>Session caches (created using the ServletCacheAdministrator) have some
-  known limitations:
-  <ul>
-    <li>Due to a workaround in the code, it is possible for a system under
-        heavy load to get its persistent session caches confused across
-        sessions.</li>
-    <li>Session caches will not work in a clustered environment.</li>
-    <li>Session caches have the same settings global settings applied to them
-        as the application scope cache. This means that if you want a
-        persistent cache for the application scope cache, the session caches
-        will use it too.</li>
-  </ul>
-  </li>
-</ul>
-
-<h3>OSCache 1.7.5</h3>
-<i>(5th January 2002 - by Mike Cannon-Brookes, mike@atlassian.com)</i>
-<ul>
-<li>Fixed up logging system slightly. All errors should now be logged with logError()
-	and normal messages with log()</li>
-  <li>Fixed bug in build file which put oscache.properties inside the oscache.jar (resulting
-	in it being loaded badly in some containers)</li>
-  <li>Changed cache.capacity in the default oscache.properties file to 1000. This means up to 1000
-	items will be cached in the default setup, and LRUCache will be used (100 seemed too small)</li>
-</ul>
-
-<h3>OSCache 1.7.4</h3>
-<i>(3rd December 2001 - by Francois Beauregard, fbeauregard@pyxis-tech.com, and<br>
- Mike Cannon-Brookes, mike@atlassian.com)</i>
-<ul>
-  <li>Made all servlet cache components serializable (fixes bug reported on list
-  with JRun)</li>
-</ul>
-
-<h3>OSCache 1.7.3</h3>
-<i>(11th November 2001 - by Francois Beauregard, fbeauregard@pyxis-tech.com)</i>
-<ul>
-  <li>TestCacheEntry had a test method with improper name (flush -> testFlush)</li>
-  <li>Pluggable entry refresh policy now available in the cache tag</li>
-</ul>
-
-<h3>OSCache 1.7.2</h3>
-<i>(31st October 2001 - by Mike Cannon-Brookes, mike@atlassian.com)</i>
-<ul>
-  <li>Cleaned up _all_ JavaDoc messages to ensure consistency and readability
-    (removed unnecessary CVS tags, added &lt;code&gt; and &lt;pre&gt; where needed,
-    added @return and @param to all methods)</li>
-  <li>Renamed nbMaxEntries to cacheCapacity and cache.size property to
-    cache.capacity (to fit better with Collections API where capacity is max size,
-    size is current size)</li>
-  <li>Renamed algoClass to algorithmClass for clarity.</li>
-  <li>Fixed up build.xml so that test classes are compiled to a different location
-    and not included in oscache.jar (to make it smaller footprint)</li>
-</ul>
-
-<h3>OSCache 1.7.1</h3>
-  <i>(26th September 2001 - by Francois Beauregard, fbeauregard@pyxis-tech.com,
-    and<br>
-    Alain Bergevin, abergevin@pyxis-tech.com, of <a href="http://www.pyxis-tech.com">Pyxis
-    Technologies Inc.</a>)</i><br>
-</p>
-<ul>
-  <li>Cache Events</li>
-  <li>Persistence mechanism refactored</li>
-  <li>Cache Algorithms FIFO + LRU (Limit the size of the cache)</li>
-  <li>AbstractConcurrentReadCache from Doug Lea's ConcurrentReaderHashMap.<br>
-    Should give oscache performance improvement</li>
-  <li>Disk Persistence does not need any locking strategies. Everything is handled
-    by AbstractConcurrentReadCache</li>
-  <li>Pluggable entry refresh policies</li>
-  <li>Unlimited cache size for disk</li>
-  <li>Specify Duration using Simple Date Format or ISO-8601 as suggested by Fredrik Lindgren)<br>
-    The next one that would make sense I think is being able to specify a specific
-    time of day.</li>
-</ul>
-
-<h3>OSCache 1.7.0</h3>
-  <i>(26th September 2001 - by Francois Beauregard, fbeauregard@pyxis-tech.com,
-  and<br>
-  Alain Bergevin, abergevin@pyxis-tech.com, of <a href="http://www.pyxis-tech.com">Pyxis
-  Technologies Inc.</a>)</i><br>
-</p>
-
-<p>This version include some refactoring, corrections and new features.<br>
-  Here are the highlights:</p>
-<ul>
-  <li>CacheAdministrator has been split
-    in 3. We have now AbstractCacheAdministrator, and ServletCacheAdministrator
-    and GeneralCacheAdministrator extends it</li>
-  <li>Packages have been adjusted. We now have oscache.base, oscache.general and oscache.Servlet.<br>
-    Adjustement must be made to the oscache.tld</li>
-  <li>ServletCacheHashMap has been created in order to reflect specific needs for
-    Servlets. It extends CacheHashMap</li>
-  <li>Support for multiple cache tag in a single page, without supplying a key.
-    Nested cache tag are not yet supported (you need to manage keys in that case).</li>
-  <li>OSCache can now cache any objects (not only JSP content) using
-    GeneralCacheAdministrator</li>
-  <li>GenerateKey now support suffixes (used to deal with multiple cache tags)</li>
-  <li>A complete JUnit test suite has been created for osCache, including a JSP
-    and a Servlet</li>
-  <li>Added the required libraries for the test unit. The JUnit JAR has been
-    upgraded to version 3.7</li>
-  <li>Required libraries are now HHTPUnit, Tidy, JUnit 3.7 and JUnitPerf</li>
-  <li>The cBuffer variable used for keyGeneration has been moved locally to
-    GenerateKey since it was a threading issue</li>
-  <li>The build file has been modified to include test running</li>
-  <li>The flushAll method is now abstract since CacheAbstractAdministrator can't
-    know all valid scopes</li>
-  <li>Removed the retry logic for disk cache read and write (not used anymore)</li>
-  <li>Fixed an issue with the needsRefresh method which returned an invalid value
-    when invoked first by returning true
-    and then invoked having to return false. Both case returned true.</li>
-  <li>The doStartTag method in CacheTag has been modified to prevent returning null
-    when cache content is missing (cache file deleted)</li>
-  <li>The doAfterBody method in CacheTag has been modified in order to prevent
-    hitting the cache twice in some situation</li>
-  <li>The useBody method in CacheTag has been renamed to setUseBody in order to
-    reflect its usage</li>
-  <li>LoadProperties interface added to CacheProperties</li>
-  <li>Added a NeedsRefreshException</li>
-  <li>Retrofited the changed made by Kesav Kumar in order to retrieve the sessionId
-    correctly</li>
-  <li>Added code toughness to avoid working with invalid parameters in public methods</li>
-  <li>Magic numbers and strings are now declared as constants</li>
-  <li>Many methods are now declared as final or protected</li>
-  <li>Imports are now more accurate, no more *</li>
-  <li>Comments and some headers modified to reflect JavaDoc standard</li>
-</ul>
-
-
-<h3>OSCache 1.6.1</h3>
-  <p><i>(16th September, 2001 - by Todd Gochenour, tgochenour@peregrine.com)</i></p>
-<ul>
-  <li>Removed attribute "encoding" in all areas, since Object serialization stores
-    strings in UTF-8 format, encoding is no longer necessary.</li>
-  <li>Added Synchronization to getCacheEntry() to insure multiple threads do not access
-    HashMap and get erroneous results.</li>
-  <li>Implemented property cache.useHostDomainInKey (true/false) to prepend URL request
-    server name to cache key when cache used by multiple servers. The "cache.domainname"
-    property found in oscache.properties (not used in code) was removed.</li>
-  <li>Corrected file caching logic so that multiple processes can share cache information
-    (file locking). Missing still is the ability to signal processes that a cache needs
-    to be flushed when using Memory Caching along with File Caching.</li>
-  <li>Unit testing revealed some minor configuration bugs which were corrected.</li>
-</ul>
-
-<h3>OSCache 1.6</h3>
-  <p><i>(5th September, 2001 - by Mike Cannon-Brookes, mike@atlassian.com)</i></p>
-
-<ul>
-  <li>Changed the CacheEntry so that it caches Object rather than String (allowing
-    image caching) (Serge Knystautas, sergek@lokitech.com)</li>
-  <li>Cached objects are now serialized to disk so cannot be read by humans anymore
-    (this allows us to cache Object) (Serge Knystautas, sergek@lokitech.com)</li>
-  <li>Added a Servlet 2.3 CacheFilter (and associated response classes) that caches
-    whole requests (Serge Knystautas, sergek@lokitech.com)</li>
-  <li>Minor changes to CacheAdministrator (the way Cache and CacheEntry's are retrieved)
-    - merging Serge and Todd's changes</li>
-</ul>
-
-<h3>OSCache 1.5</h3>
-  <p><i>(6th August, 2001 - by Todd Gochenour, tgochenour@peregrine.com)</i></p>
-<ul>
-  <li>Added boolean "cache.memory" attribute to oscache.properties to eliminate memory
-    consumption and rely strictly on disk storage.</li>
-  <li>Added three interfaces "CacheLog", "CacheProperties", and "CacheContents" to allow
-    plugable implementations for these functions. The CacheContents interface allows the
-    pages to be cached using a database.</li>
-  <li>Added "Language" attribute to CacheTag and FlushTag to distinguish a page that
-    supports I18N generation. The ISO-639 language code is used when the scope of the page
-    is "Application". The code defines a subdirectory under the "application" directory of
-    file caching.</li>
-  <li>Modified the CacheAdministrator.generateKey() function to append the request's
-    QueryString to the URI when automatically generating keys. The QueryString is encoded
-    using the MD5 digest base64 algorithms.</li>
-  <li>Added attribute "encoding" to a CacheTag so that the file IO does proper conversion
-    when reading and writing the cache files. (per suggestion of Pedro Gomez)</li>
-  <li>Added retries when SecurityException is thrown. Java has no built in exclusive file
-    locking implementations. The file is written to a lock file and then renamed as an
-    atomic operation so that multiple processes on the same box can reliable access cache data.</li>
-  <li>Added "pattern" attribute to FlushTag which invokes a CacheHashMap.flushPattern()
-    function to scan for and flush all keys that contain the value of the pattern. (per
-    suggestion of Todd Rudrick)</li>
-  <li>Added support for a CacheTag time value of zero which turns off caching for that tag.
-    (per suggestion of Pedro Gomez)</li>
-</ul>
-
-<h3>OSCache 1.3</h3>
-  <p><i>(9th June, 2001 - by Mike Cannon-Brookes, mike@atlassian.com)</i></p>
-<ul>
-  <li>Fixed a single bug in the file caching - should now work</li>
-  <li>Added property to set the cache key (not sure if this is useful)</li>
-  <li>Cleaned up a lot of the code, refactored slightly so that the tags are more light
-    weight and rely more on the Administrator and CacheHashMap for functionality.</li>
-</ul>
-
-<h3>OSCache 1.2.5</h3>
-  <p><i>(18th May, 2001 - by Mike Cannon-Brookes, mike@atlassian.com)</i></p>
-<ul>
-  <li>Added ability to turn off file caching (just remove or comment out cache.properties)</li>
-  <li>Removed a pesky (but ineffectual) bug where session caches being removed from disk
-    were throwing NullPointerExceptions</li>
-</ul>
-
-<h3>OSCache 1.2.1</h3>
-  <p><i>(10th May, 2001 - by Mike Cannon-Brookes, mike@atlassian.com)</i></p>
-<ul>
-  <li>Speed improvements in CacheEntry and CacheAdministrator (by Kesav Kumar -
-    kesavk@voquette.com)</li>
-  <li>Fixed DOCTYPE in taglib.tld (also Kesav!)</li>
-  <li>Removed backup / swap / temp files from zip (and changed build file)</li>
-</ul>
-
-<h3>OSCache 1.2</h3>
-  <p><i>(28th March, 2001 - by Mike Cannon-Brookes, mike@atlassian.com)</i></p>
-<ul>
-  <li>Fixed a large bug that resulted in CacheEntry's not refreshing. Large enough
-    in a Caching library to demand a new point release ;)</li>
-</ul>
-
-<h3>OSCache 1.1</h3>
-  <p><i>(25th March, 2001 - by Mike Cannon-Brookes, mike@atlassian.com)</i></p>
-<ul>
-  <li>Moved up to 1.1 because a lot of documentation improving and some small bug fixing
-    has been done</li>
-  <li>Javadocs should now be very readable for all classes and methods</li>
-  <li>Fixed a NullPointer that was being thrown in CacheEntry.needsRefresh()</li>
-  <li>Cleaned up the build file so it now produces releasable zip files easily</li>
-  <li>Added servlet.jar so that the compiling now works OOB (Out Of the Box)</li>
-</ul>
-
-<h3>OSCache 1.0 (beta release 2)</h3>
-  <p><i>(20th March, 2001 - by Mike Cannon-Brookes, mike@atlassian.com)</i></p>
-<ul>
-  <li>Fixed more bugs.</li>
-  <li>Moved things around so that the CacheAdministrator has more functionality and
-    is now a Singleton (per web app context). This means no more depedency on
-    ServletContextListener to start the CacheAdministrator.</li>
-  <li>Therefore we are now Servlet 2.2 / JSP 1.1 compliant! w00!</li>
-</ul>
-
-<h3>OSCache 1.0 (beta release 1)</h3>
-  <p><i>(20th February, 2001 - by Mike Cannon-Brookes, mike@atlassian.com)</i></p>
-<ul>
-  <li>Fixed a few bugs.</li>
-  <li>Greatest of which there is no longer a disk leakage from session caches on disk.</li>
-  <li>Also session caching bugs fixed, usecached bugs fixed - lots of work done here.</li>
-  <li>Implemented <flush scope="" key=""> to flush individual keys.</li>
-</ul>
-
-<h3>OSCache 1.0 (beta release 0)</h3>
-  <p><i>(26th November, 2000 - by Mike Cannon-Brookes, mike@atlassian.com)</i></p>
-<ul>
-  <li>Initial release of OSCache</li>
-  <li>Conceptualised a few things I've been working on over the past month.</li>
-  <li>Added persistent on disk caching and error tolerance (through &lt;usecached /&gt; tag)</li>
-</ul>
-</body>
-</html>

docs/clustering.html

-<html>
-<head>
-<title>Clustering OSCache</title>
-</head>
-
-<body bgcolor="#FFFFFF">
-
-<p>New in OSCache 2.0 is support for clustering of caches. OSCache currently ships with
-implementations that allow you to use either <a href="http://www.javagroups.com">JavaGroups</a>
-or <a href="http://java.sun.com/products/jms">JMS</a> as the underlying broadcast protocol.
-</p>
-
-<p>Caches across a cluster only broadcast messages when flush events occur. This means that the
-content of the caches are built up independently on each server, but whenever content becomes
-stale on one server it is made stale on them all. This provides a very high performing solution
-since we never have to pass cached objects around the cluster. And since there is no central
-server that is in charge of the cluster, the clustering is very robust.</p>
-
-
-<p>Configuring OSCache to cluster is very simple. Follow either the JMS or the JavaGroups instructions
-below depending on which protocol you want to use.</p>
-
-
-<h3>JMS Configuration</h3>
-
-<p>Configure your JMS server. OSCache requires that a JMS <code>ConnectionFactory</code> and a <code>Topic</code>
-are available via JNDI. See your JMS server's documentation for details.</p>
-
-<p>Add the JMS broadcasting listener to your <code>oscache.properties</code> file like this:</p>
-
-<p><code>cache.event.listeners=com.opensymphony.oscache.plugins.clustersupport.JMSBroadcastingListener</code></p>
-
-<p>(Note that this listener requires JMS 1.1 or higher, however legacy support for 1.0.x is also provided.
-If your JMS server only supports JMS 1.0.x then use <code>JMS10BroadcastingListener</code> instead of
-<code>JMSBroadcastingListener</code>. The rest of this documentation applies equally to both the 1.1 and 1.0
-listeners.)</p>
-
-<p>The JMS listener supports the following configuration parameters:
-<ul>
-<li><b>cache.cluster.jms.topic.factory</b> - The JNDI name that binds the JMS topic connection factory. This
-should match the name that is specified in your JMS server's configuration. Typically it will be something like
-<code>"java:comp/env/jms/TopicConnectionFactory"</code></li>
-<li><b>cache.cluster.jms.topic.name</b> - The JNDI name of the topic that will be used for the OSCache
-sending the messages. This should match the name of a topic that is configured on your JMS server. Typically
-this value will be something like <code>"java:comp/env/jms/OSCacheTopic"</code>.</li>
-<li><b>cache.cluster.jms.node.name</b> - A name that uniquely identifies this node in the cluster. This is used
-to prevent nodes from processing their own broadcast messages. Each node in the cluster must have a different
-value, for example <code>"node1"</code>, <code>"node2"</code>, ... .</li>
-</ul></p>
-
-<p>If you are running OSCache from a standalone application or are not running in an environment where
-<code>new InitialContext()</code> will find your JNDI <code>InitialContextFactory</code> or provider URL,
-you will have to specify them either in a <code>jndi.properties</code> file or as system properties. See the
-<code><a href="http://java.sun.com/j2se/1.4.2/docs/api/javax/naming/InitialContext.html">InitalContext</a></code>
-documentation for details.</p>
-
-
-<h3>JavaGroups Configuration</h3>
-
-<p>Just make sure you have jgroups-all.jar file in your classpath (for a webapp put it in WEB-INF/lib),
-and add the JavaGrops broadcasting listener to your <code>oscache.properties</code> file like this:</p>
-
-<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. The jgroups-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
-not interfere with each other. The IP to use can be specified in your <code>oscache.properties</code>
-file by the <code>cache.cluster.multicast.ip</code> property. The default value is <code>231.12.21.132</code>,
-however you can use any class D IP address. Class D address fall in the range <code>224.0.0.0</code>
-through <code>239.255.255.255</code>.</p>
-
-<p>If you need more control over the multicast configuration (eg setting network timeout or time-to-live
-values), you can use the <code>cache.cluster.properties</code> configuration property. Use this
-<em>instead of</em> the <code>cache.cluster.multicast.ip</code> property. The default value is:</p>
-
-<p><code><pre>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;max_xmit_size=8192):\
-UNICAST(timeout=300,600,1200,2400):\
-pbcast.STABLE(desired_avg_gossip=20000):\
-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)
-</pre></code></p>
-
-See the <a href="http://www.javagroups.com">JavaGroups</a> site for more information. In particular,
-look at the documentation of Channels in the <a href="http://www.javagroups.com/javagroupsnew/docs/newuser/index.html">User's Guide</a>.
-</body>
-</html>

docs/configuration.html

-<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.html">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.blocking</h3>
-<p>When a request is made for a stale cache entry, it is possible that another thread is already in the process
-of rebuilding that entry. This setting specifies how OSCache handles the subsequent 'non-building' threads. The
-default behaviour (<code>cache.blocking=false</code>) is to serve the old content to subsequent threads until the
-cache entry has been updated. This provides the best performance (at the cost of serving slightly stale data).
-When blocking is enabled, threads will instead block until the new cache entry is ready to be served.
-Once the new entry is put in the cache the blocked threads will be restarted and given the new entry.</p>
-<p>Note that <em>even if blocking is disabled</em>, when there is no stale data available to be served threads
-will block until the data is added to the cache by the thread that is responsible for building the data.</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>.  In this case, the disk cache capacity will be equal to the memory cache capacity set by
-cache.capacity.</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.HashDiskPersistenceListener</code> to enable this
-implementation. By specifying your own class here you should be able to persist cache data using say JDBC or LDAP.  
-NOTE: This class hashes the toString() of the object being cached to produce the file name of the entry.  If you
-prefer readable file names, the parent DIskPersistenceListener can still be used but it will have issues with illegal 
-filesystem characters or long names.</p>
-<p>The <code>HashDiskPersistenceListener</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><B>NEW! </B>cache.persistence.overflow.only</h3>
-<p>Indicates whether the persistence should only happen once the memory cache capacity has been reached. 
-The default value is <code>false</code> for backwards compatibility but the recommended value is 
-<CODE>true</CODE> when the memory cache is enabled.  This property drastically changes the behavior of the 
-cache in that the persisted cache will now be different then what is in memory.</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.html">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><pre>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)</pre></p>
-
-<p>See the <a href="clustering.html">Clustering OSCache</a> documentation for further details on the above
-two properties.</p>
-</body>
-</html>

docs/cron.html

-<html>
-<head>
-<title>Expiring Cached Content with Cron Expressions</title>
-</head>
-
-<body bgcolor="#FFFFFF">
-<p>Prior to version 2.0 of OSCache, content expiry could only be specified in terms of how long a
-piece of content had been in the cache, ie, it was based on the age of the content. If you needed
-to expire it at a particular time of day or on a specific date, you had to write a custom
-<code>RefreshPolicy</code> class.</p>
-<p>OSCache 2.0 now gives you the ability to expire content at specific dates and/or times based on
-a <em>cron expression</em>.</p>
-
-<h3>What is a Cron Expression?</h3>
-<p>Many of you are probably already familiar with the unix cron program. For those that aren't,
-cron is a daemon process that allows users to execute commands or scripts automatically at
-user-configurable dates and times. The important part as far as OSCache is concerned is the cron
-expression syntax that allows users to dictate when commands should be executed - you can now use
-the same s