erik/opensymphony-oscache
erik/opensymphony-oscache
1
0
Fork 0
Code Issues Pull requests Releases Activity

Initial import from https://bitbucket.org/opensymphony/oscache/

Browse source
This commit is contained in:
Erik C. Thauvin 2017-05-21 00:05:57 -07:00
commit bd8f23d7d6
268 changed files with 34908 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

9
.cvsignore Normal file
View file

@ -0,0 +1,9 @@
build
build.test
build.properties
dist
*.i*
.settings
.fbprefs
.fbwarnings
.clover

38
.gitignore vendored Normal file
View file

@ -0,0 +1,38 @@
**/.idea/dictionaries
**/.idea/gradle.xml
**/.idea/libraries
**/.idea/tasks.xml
**/.idea/workspace.xml
*.i*
*.iws
*.sublime-*
.classpath
.clover
.DS_Store
.fbprefs
.fbwarnings
.gradle
.kobalt
.nb-gradle
.project
.settings
.settings
/bin
/build
/deploy
/dist
/gen
/gradle.properties
/local.properties
/out
/proguard-project.txt
/project.properties
/target
/test-output
build
build.properties
build.test
dist
ehthumbs.db
kobaltBuild
Thumbs.db

6
.hg_archival.txt Normal file
View file

@ -0,0 +1,6 @@
repo: cec0503fd7a03d0d505cd298779c9360e537ce20
node: 0f167fd17c8cbe8bc54ff6af55a23def6a6be315
branch: default
latesttag: v2_4_1/trunk
latesttagdistance: 15
changessincelatesttag: 15

22
.hgtags Normal file
View file

@ -0,0 +1,22 @@
b7492cd8c07a635a3e68caea9035f5853fd48dc8 v2_0_beta_2
0f86681123c9655c51f3192d4a50b3fac93900b7 v2_0
d89751f6dcec297b9a208b7efee4ef4bdd7e595c v2_0_1
65afa90270ba4e49944e930798fcf8737911b58b v2_0_2
4895938a47d91229b5de22fdf22709ce7b13213a v2_1
2507938446fee2869ffc1c48264e9d4075b3fd35 Root_v2_1_1
ecbbc5adc32fefab262c1d831a51c3f4f8d5b8d7 Root_amarch_sandbox
1b4d987e855bc02bf08bc2fa2a1108b90c98e9ee v2_2-rc
bf3f6d64f71f5df293ebfa013436f7cad6c4174a v2_2
861e6b8461d62713433fbab21ba419ec0819c65c v2_3
4bde37724bf310846d8477f2baa405315a94e101 v2_3_1
274a32e71716a5e8abf1f9fe4d58e7a7bd3a4525 v2_3_2
aa3aca67671d3a690e6814e7e9181a5fc018e21b v2_4
dfacfe8055d0abdb02e1db6b63b539cdfcee43b2 v2_4
387d7900897c90e64994858b90355a48119ea60e v2_4
cdf414156c2cd0b70d375afe9ea3c457a5284a70 v2_4
b8ad75c5a7496184cfaa03b0e261a25d99b16b61 v2_4
983dd56faabaf83c7c435c50bfc764e190fd4890 v2_4
7169b41cea95570f43fce9ee1e65d6c6a101b0fe v2_4
fb73d9245d05d829c427e9c2e8942f597d14b83c v2_4
2371325c217681ad4daaf93bb913f14bef9986f7 v2_4_1
5fe61334beb77f2314b1f5595962bdf748605633 v2_4_1/trunk

50
LICENSE.txt Normal file
View file

@ -0,0 +1,50 @@
/* ====================================================================
* The OpenSymphony Software License, Version 1.1
*
* (this license is derived and fully compatible with the Apache Software
* License - see http://www.apache.org/LICENSE.txt)
*
* Copyright (c) 2001 The OpenSymphony Group. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* OpenSymphony Group (http://www.opensymphony.com/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "OpenSymphony" and "The OpenSymphony Group"
* must not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact license@opensymphony.com .
*
* 5. Products derived from this software may not be called "OpenSymphony"
* or "OSCore", nor may "OpenSymphony" or "OSCore" appear in their
* name, without prior written permission of the OpenSymphony Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*/

390
build.xml Normal file
View file

@ -0,0 +1,390 @@
<?xml version="1.0" ?>
<!-- OSCache build file - http://www.opensymphony.com/oscache -->
<project name="oscache" default="jar" basedir=".">
<!-- overridden properties (must be before the import!) -->
<property name="compile.version" value="1.4"/>
<property name="test.compile.version" value="1.4"/>
<property name="lib.optional" value="${lib}/plugins"/> <!-- overwritten -->
<property name="jar.excludes" value="test/**, docs/**, *.war, **/*.html"/>
<property name="tmp.dir" value="tmp"/> <!-- ??? -->
<!-- This property must match with what is included in the oscache.properties files -->
<property name="test.cache.path" value="/tmp/cachetagscache"/>
<!-- debug -->
<property name="debug" value="true"/>
<!-- import common osbuild.xml -->
<property name="common.build" value="../opensymphony/common/osbuild.xml"/>
<import file="${common.build}"/>
<property name="clover.initstring" location="${build.clover}/coverageBase.db"/>
<!-- project properties -->
<property name="src.webapp" value="${src}/webapp"/> <!-- new -->
<patternset id="src.test.pattern.base">
<include name="**/TestComplete*.class"/>
<exclude name="**/web/*.*"/>
<exclude name="**/clustersupport/*.*"/>
</patternset>
<patternset id="src.test.pattern.web">
<include name="**/web/TestComplete*.class"/>
<include name="**/web/TestLoadComplete*.class"/>
</patternset>
<patternset id="src.test.pattern.cluster">
<include name="**/TestCompleteCluster.class"/>
</patternset>
<!-- init -->
<target name="init" depends="ivy-check,common.init">
<taskdef name="ivy-configure" classname="fr.jayasoft.ivy.ant.IvyConfigure"/>
<taskdef name="ivy-resolve" classname="fr.jayasoft.ivy.ant.IvyResolve"/>
<taskdef name="ivy-retrieve" classname="fr.jayasoft.ivy.ant.IvyRetrieve"/>
<taskdef name="ivy-publish" classname="fr.jayasoft.ivy.ant.IvyPublish"/>
<taskdef name="ivy-report" classname="fr.jayasoft.ivy.ant.IvyReport"/>
<taskdef name="ivy-deliver" classname="fr.jayasoft.ivy.ant.IvyDeliver"/>
<ivy-retrieve/>
</target>
<!-- Ivy -->
<target name="ivyrep.copy-ivy" depends="init">
<ivy-deliver deliverpattern="${ivyrep.path}/opensymphony/${name}/[artifact]-[revision].[ext]"
pubrevision="${version}-${TIME}" pubdate="${TIME}"/>
</target>
<available property="ivy.available" classname="fr.jayasoft.ivy.ant.IvyRetrieve"/>
<target name="ivy-check" unless="ivy.available">
<fail message="Please download Ivy at http://www.jayasoft.org/ivy and copy ivy.jar to ${ant.home}${file.separator}lib"/>
</target>
<!-- Prepares the build directory -->
<target name="prepare" depends="init">
<mkdir dir="${build.java}/META-INF"/>
<copy file="${src}/etc/META-INF/taglib.tld" tofile="${build.java}/META-INF/taglib.tld"/>
</target>
<!-- Compiles the core source code -->
<target name="compile" depends="prepare">
<javac srcdir="${src.java}" destdir="${build.java}" includes="com/opensymphony/oscache/**" debug="${debug}" classpathref="cp" source="${compile.version}" target="${compile.version}"/>
</target>
<!-- Prepares and compiles the web application, which includes the web test suite -->
<target name="example-war" depends="jar">
<mkdir dir="${build}/webapp"/>
<mkdir dir="${dist}"/>
<javac srcdir="${src.webapp}/WEB-INF/classes" destdir="${build}/webapp" includes="com/opensymphony/oscache/**" debug="${debug}" classpath="${build.java}" classpathref="cp"/>
<war destfile="${dist}/${name}-example.war" basedir="${src.webapp}" webxml="${src.webapp}/WEB-INF/web.xml" excludes="WEB-INF/web.xml">
<lib file="${build}/${name}-${version}.jar"/>
<lib file="${lib}/commons-logging.jar"/>
<classes dir="${build}/webapp"/>
</war>
</target>
<!-- Deploy example war for the test web -->
<target name="deploy-example-war" depends="example-war" if="test.web.deployDir">
<!-- Use auto deployment of app server, e.g. BEA WLS -->
<copy file="${dist}/${name}-example.war" tofile="${test.web.deployDir}/${name}-example.war" overwrite="yes"/>
<!-- if your pc is to fast, sleep here for a while to allow redeployment of the web app -->
<echo message="Deploying example web app and waiting for a while..." level="info"/>
<sleep seconds="30"/>
</target>
<!-- Build a usable jar file -->
<target name="jar" depends="compile">
<mkdir dir="${build}"/>
<jar jarfile="${build}/${name}-${version}.jar" basedir="${build.java}" excludes="${jar.excludes}">
<manifest>
<attribute name="Implementation-Title" value="${fullname}"/>
<attribute name="Implementation-Version" value="${version}"/>
<attribute name="Implementation-Vendor" value="OpenSymphony"/>
</manifest>
</jar>
</target>
<!-- macrodef for tests -->
<macrodef name="testBase">
<attribute name="file"/>
<attribute name="message"/>
<sequential>
<echo message="@{message}" level="info"/>
<copy file="@{file}" tofile="${build.test}/oscache.properties" overwrite="yes"/>
<!-- Clear out any previous persistent cache directory -->
<delete dir="${test.cache.path}" failonerror="false"/>
<junit printsummary="yes" haltonfailure="no" haltonerror="yes" fork="yes" failureproperty="test.failure">
<classpath>
<pathelement location="${build.test}"/>
<path refid="cp"/>
</classpath>
<formatter type="xml"/>
<batchtest todir="${dist.docs}/junit">
<fileset dir="${build.test}">
<patternset refid="src.test.pattern.base"/>
</fileset>
</batchtest>
</junit>
<!-- Clear out persistent cache directory -->
<delete dir="${test.cache.path}" failonerror="false"/>
</sequential>
</macrodef>
<macrodef name="testWeb">
<attribute name="file"/>
<attribute name="message"/>
<sequential>
<echo message="@{message}" level="info"/>
<copy file="@{file}" tofile="${build.test}/oscache.properties" overwrite="yes"/>
<!-- Clear out any previous persistent cache directory -->
<delete dir="${test.cache.path}" failonerror="false"/>
<javac srcdir="${src.test}" destdir="${build.test}" includes="com/opensymphony/oscache/web/**" debug="${debug}" classpath="${build}" classpathref="cp"/>
<java classname="com.opensymphony.oscache.web.CheckDeployment" failonerror="true" classpath="${build.test}" fork="yes">
<arg value="${test.web.baseURL}"/>
</java>
<junit printsummary="yes" haltonfailure="no" haltonerror="yes" fork="yes" failureproperty="test.failure">
<sysproperty key="test.web.baseURL" value="${test.web.baseURL}"/>
<classpath>
<pathelement location="${build.test}"/>
<pathelement location="${build}"/>
<path refid="cp"/>
</classpath>
<formatter type="xml"/>
<formatter type="plain" useFile="false"/>
<batchtest todir="${dist.docs}/junit">
<fileset dir="${build.test}">
<patternset refid="src.test.pattern.web"/>
</fileset>
</batchtest>
</junit>
<!-- Clear out persistent cache directory -->
<delete dir="${test.cache.path}" failonerror="false"/>
</sequential>
</macrodef>
<!-- Compiling sources for junit tests and clover -->
<target name="test-compile" depends="junit-check, clover-check">
<mkdir dir="${dist.docs}/junit"/>
<mkdir dir="${dist.docs}/clover"/>
<mkdir dir="${build.test}"/>
<mkdir dir="${build.clover}"/>
<mkdir dir="${build.clover}/history" />
<taskdef resource="clovertasks"/>
<taskdef name="junit" classname="org.apache.tools.ant.taskdefs.optional.junit.JUnitTask"/>
<javac destdir="${build.test}" debug="${debug}" classpathref="cp" source="${test.compile.version}" target="${test.compile.version}" compiler="org.apache.tools.ant.taskdefs.CloverCompilerAdapter">
<src path="${src.java}"/>
</javac>
<javac destdir="${build.test}" debug="${debug}" classpathref="cp" source="${test.compile.version}" target="${test.compile.version}">
<src path="${src.test}"/>
</javac>
</target>
<!-- Run base tests -->
<target name="test-base-mc" depends="test-compile" unless="test.failure" description="run base tests">
<!-- Run tests using Memory Cache Only -->
<testBase file="${src.test}/oscacheMemoryOnly.properties" message="Running base tests with memory cache only"/>
</target>
<target name="test-base-dc" depends="test-compile" unless="test.failure" description="run base tests">
<!-- Rerun tests using Disk Cache Only -->
<testBase file="${src.test}/oscacheDiskOnly.properties" message="Running base tests with disk cache only"/>
</target>
<target name="test-base-dc-hash" depends="test-compile" unless="test.failure" description="run base tests">
<!-- Rerun tests using Disk Cache Only -->
<testBase file="${src.test}/oscacheDiskOnlyHash.properties" message="Running base tests with disk cache hash persistence only"/>
</target>
<target name="test-base-dmc" depends="test-compile" unless="test.failure" description="run base tests">
<!-- ReRun tests using Disk and Memory Cache -->
<testBase file="${src.test}/oscacheDiskAndMemory.properties" message="Running base tests with disk and memory caches"/>
</target>
<target name="test-base-mdoc" depends="test-compile" unless="test.failure" description="run base tests">
<!-- ReRun tests using Memory and Disk Overflow Cache -->
<testBase file="${src.test}/oscacheMemoryAndOverflowToDisk.properties" message="Running base tests with memory and disk overflow caches"/>
</target>
<target name="test-base" depends="test-base-mc, test-base-dc, test-base-dc-hash, test-base-dmc, test-base-mdoc" description="run all base tests"/>
<!-- Run web tests -->
<target name="test-web-mc" depends="test-compile, example-war, deploy-example-war" unless="test.failure" if="test.web.baseURL" description="run web tests">
<!-- Run tests using Memory Cache Only -->
<testWeb file="${src.test}/oscacheMemoryOnly.properties" message="Running web tests with memory cache only"/>
</target>
<target name="test-web-dc" depends="test-compile, example-war, deploy-example-war" unless="test.failure" if="test.web.baseURL" description="run web tests">
<!-- Rerun tests using Disk Cache Only -->
<testWeb file="${src.test}/oscacheDiskOnly.properties" message="Running web tests with disk cache only"/>
</target>
<target name="test-web-dc-hash" depends="test-compile, example-war, deploy-example-war" unless="test.failure" if="test.web.baseURL" description="run web tests">
<!-- Rerun tests using Disk Cache Only -->
<testWeb file="${src.test}/oscacheDiskOnlyHash.properties" message="Running web tests with disk cache hash persistence only"/>
</target>
<target name="test-web-dmc" depends="test-compile, example-war, deploy-example-war" unless="test.failure" if="test.web.baseURL" description="run web tests">
<!-- ReRun tests using Disk and Memory Cache -->
<testWeb file="${src.test}/oscacheDiskAndMemory.properties" message="Running web tests with disk and memory caches"/>
</target>
<target name="test-web-mdoc" depends="test-compile, example-war, deploy-example-war" unless="test.failure" if="test.web.baseURL" description="run web tests">
<!-- ReRun tests using Memory and Disk Overflow Cache -->
<testWeb file="${src.test}/oscacheMemoryAndOverflowToDisk.properties" message="Running web tests with memory and disk overflow caches"/>
</target>
<target name="test-web" depends="test-web-mc, test-web-dc, test-web-dc-hash, test-web-dmc, test-web-mdoc" description="run all web tests"/>
<!-- Run clustering tests -->
<target name="test-cluster" depends="test-compile" unless="test.failure" if="test-cluster" description="run cluster tests">
<echo message="Running tests with memory caches and clustering" level="info"/>
<!-- Clear out any previous persistent cache directory -->
<delete dir="${test.cache.path}" failonerror="false"/>
<junit printsummary="yes" haltonfailure="no" haltonerror="yes" fork="yes" failureproperty="test.failure">
<classpath>
<pathelement location="${build.test}"/>
<path refid="cp"/>
</classpath>
<formatter type="xml"/>
<batchtest todir="${dist.docs}/junit">
<fileset dir="${build.test}">
<patternset refid="src.test.pattern.cluster"/>
</fileset>
</batchtest>
</junit>
<!-- Clear out persistent cache directory -->
<delete dir="${test.cache.path}" failonerror="false"/>
</target>
<!-- Run JUnit tests using different combinations of disk and memory caching -->
<target name="test" depends="test-base, test-web, test-cluster" description="run all tests"/>
<!-- Create the distribution zip files -->
<target name="dist" depends="jar, docs, example-war">
<!-- copy the standard file -->
<copy file="${build}/${name}-${version}.jar" tofile="${dist}/${name}-${version}.jar"/>
<!-- create the full package -->
<mkdir dir="${tmp.dir}/docs"/>
<mkdir dir="${tmp.dir}/src"/>
<mkdir dir="${tmp.dir}/lib"/>
<mkdir dir="${tmp.dir}/etc"/>
<copy todir="${tmp.dir}/docs">
<fileset dir="${dist.docs}"/>
</copy>
<copy todir="${tmp.dir}/src">
<fileset dir="${src}" excludes="etc/**"/>
</copy>
<copy file="${lib}/commons-logging.jar" todir="${tmp.dir}/lib"/>
<copy file="${lib}/jgroups-all.jar" todir="${tmp.dir}/lib"/>
<copy file="${build}/${name}-${version}.jar" todir="${tmp.dir}"/>
<copy file="${src}/etc/oscache.properties" tofile="${tmp.dir}/etc/oscache.properties"/>
<copy file="${src}/etc/META-INF/taglib.tld" tofile="${tmp.dir}/etc/META-INF/${name}.tld"/>
<copy file="readme.txt" tofile="${tmp.dir}/readme.txt" failonerror="false"/>
<zip zipfile="${dist}/${name}-${version}-full.zip" basedir="${tmp.dir}" includes="**"/>
<!-- Remove everything that's not in the binary release -->
<delete dir="${tmp.dir}/src"/>
<delete dir="${tmp.dir}/${lib.build}"/>
<delete dir="${tmp.dir}/docs/junit"/>
<delete dir="${tmp.dir}/docs/clover"/>
<delete file="${tmp.lib}/jgroups-all.jar"/>
<zip zipfile="${dist}/${name}-${version}-binary.zip" basedir="${tmp.dir}" includes="**"/>
<delete dir="${tmp.dir}"/>
<!-- Creates checksum for the distribution files -->
<checksum>
<fileset dir="${dist}">
<include name="*.jar"/>
<include name="*.zip"/>
<include name="*.war"/>
</fileset>
</checksum>
</target>
<target name="clover.report" depends="test">
<clover-report>
<current outfile="${dist.docs}/clover">
<fileset dir="${src.java}" excludes="**/Test*"/>
<format type="html"/>
</current>
</clover-report>
<!--
<clover-historypoint historyDir="${build.clover}/history" />
<clover-report>
<historical outfile="${dist.docs}/clover/historical.pdf" historyDir="${build.clover}/history" />
</clover-report>
-->
</target>
<target name="junit.report" depends="test">
<junitreport todir="${dist.docs}/junit">
<fileset dir="${dist.docs}/junit">
<include name="TEST-*.xml"/>
</fileset>
<report format="frames" todir="${dist.docs}/junit"/>
</junitreport>
<!-- we fail here (instead of in the test target) so that the reports get generated first) -->
<fail if="test.failure" message="Tests did not all pass, failing!"/>
</target>
<target name="reports" depends="common.reports">
<mkdir dir="${dist.docs}/dependencies"/>
<ivy-report todir="${dist.docs}/dependencies" graph="false"/>
</target>
</project>

93
docs/api.css Normal file
View file

@ -0,0 +1,93 @@
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;
}

38
docs/index.html Normal file
View file

@ -0,0 +1,38 @@
<html>
<head>
<title>OSCache</title>
</head>
<body>
<p/>
OSCache is a caching solution that includes a JSP tag library and set of classes to perform fine grained dynamic caching of JSP content,
servlet responses or arbitrary objects. It provides both in memory and persistent on disk caches, and can allow your site
to have graceful error tolerance (eg if an error occurs like your db goes down, you can serve the cached content so people
can still surf the site almost without knowing). Take a look at the great <a href="wiki/Feature%20List.html">features</a> of OSCache.
<p/>
Here you will find documentation and download information for the latest version of OSCache.
<p/>
<ul>
<li><a href="wiki/Documentation.html">Documentation</a></li>
<li><a href="api/index.html">JavaDoc API</a></li>
</ul>
Reports:
<ul>
<li><a href="junit/index.html">Unit Test Results</a></li>
<li><a href="clover/index.html">Clover Coverage Report</a></li>
<li><a href="dependencies/opensymphony-oscache-default.html">Ivy Dependency Report</a></li>
</ul>
<p/>
Documentation for the currently developing release can always be found on the <a href="http://wiki.opensymphony.com/display/CACHE">OSCache Wiki</a>.
If you have edits or corrections to make to the documentation here, you may edit them directly on the wiki as well.
</body>
</html>

220
docs/meta.xml Normal file
View file

@ -0,0 +1,220 @@
<project>
<name>OSCache</name>
<jiraId>10001</jiraId>
<jiraName>CACHE</jiraName>
<confluenceName>CACHE</confluenceName>
<svn>true</svn>
<forums>
<usersId>4</usersId>
<cvsId>12</cvsId>
</forums>
<evaluating>
<item>
<name>Overview</name>
<url>wiki/What%20is%20OSCache.html</url>
</item>
<item>
<name>Feature List</name>
<url>wiki/Feature%20List.html</url>
</item>
<item>
<name>Requirements</name>
<url>wiki/Requirements.html</url>
</item>
<item>
<name>Installation Guide</name>
<url>wiki/Installation%20Guide.html</url>
</item>
<item>
<name>Configuration Guide</name>
<url>wiki/Configuration.html</url>
</item>
</evaluating>
<docs>
<url>wiki/Documentation.html</url>
<items>
<item>
<name>FAQ</name>
<url>wiki/FAQ.html</url>
</item>
<item>
<name>Tag Reference</name>
<url>wiki/JSP%20Tags.html</url>
</item>
<item>
<name>The Caching Filter</name>
<url>wiki/CacheFilter.html</url>
</item>
<item>
<name>Cron Expressions</name>
<url>wiki/Cron%20Expressions.html</url>
</item>
<item>
<name>OSCache and Hibernate</name>
<url>wiki/Hibernate.html</url>
</item>
<item>
<name>Clustering</name>
<url>wiki/Clustering.html</url>
</item>
</items>
</docs>
<owners>
<person>
<name>Andres March</name>
<email>me at andresmarch dot com</email>
</person>
</owners>
<developers>
<person>
<name>Lars Torunski</name>
<email>ltorunski at t-online dot de</email>
</person>
<person>
<name>Chris Miller</name>
<email>chris_overseas at hotmail dot com</email>
</person>
</developers>
<releases>
<release>
<version>2.4.1</version>
<date>07/07/2007</date>
<jiraId>21705</jiraId>
<downloads>
<download>
<url>https://oscache.dev.java.net/files/documents/629/61427/oscache-2.4.1-full.zip</url>
<name>Full</name>
</download>
</downloads>
</release>
<release>
<version>2.4</version>
<date>05/01/2007</date>
<jiraId>21660</jiraId>
<downloads>
<download>
<url>https://oscache.dev.java.net/files/documents/629/57136/oscache-2.4-full.zip</url>
<name>Full</name>
</download>
</downloads>
</release>
<release>
<version>2.3.2</version>
<date>07/23/2006</date>
<jiraId>21651</jiraId>
<downloads>
<download>
<url>https://oscache.dev.java.net/files/documents/629/37840/oscache-2.3.2-full.zip</url>
<name>Full</name>
</download>
</downloads>
</release>
<release>
<version>2.3.1</version>
<date>06/19/2006</date>
<jiraId>21630</jiraId>
<downloads>
<download>
<url>https://oscache.dev.java.net/files/documents/629/36361/oscache-2.3.1-full.zip</url>
<name>Full</name>
</download>
</downloads>
</release>
<release>
<version>2.3</version>
<date>03/06/2006</date>
<jiraId>21570</jiraId>
<downloads>
<download>
<url>https://oscache.dev.java.net/files/documents/629/30345/oscache-2.3-full.zip</url>
<name>Full</name>
</download>
</downloads>
</release>
<release>
<version>2.2 Final</version>
<date>11/06/2005</date>
<jiraId>21550</jiraId>
<downloads>
<download>
<url>https://oscache.dev.java.net/files/documents/629/23623/oscache-2.2-full.zip</url>
<name>Full</name>
</download>
</downloads>
</release>
<release>
<version>2.2 RC</version>
<date>09/18/2005</date>
<jiraId>21450</jiraId>
<downloads>
<download>
<url>https://oscache.dev.java.net/files/documents/629/20854/oscache-2.2-rc-full.zip</url>
<name>Full</name>
</download>
</downloads>
</release>
<release>
<version>2.1.1</version>
<date>5/01/2005</date>
<jiraId>21441</jiraId>
<downloads>
<download>
<url>https://oscache.dev.java.net/files/documents/629/13962/oscache-2.1.1-full.zip</url>
<name>Full</name>
</download>
</downloads>
</release>
<release>
<version>2.1</version>
<date>1/18/2005</date>
<jiraId>21223</jiraId>
<downloads>
<download>
<url>https://oscache.dev.java.net/files/documents/629/10654/oscache-2.1-full.zip</url>
<name>Full</name>
</download>
</downloads>
</release>
<release>
<version>2.0.2</version>
<date>1/22/2004</date>
<jiraId>21251</jiraId>
<downloads>
<download>
<url>https://oscache.dev.java.net/files/documents/629/2653/oscache-2.0.2-full.zip</url>
<name>Full</name>
</download>
</downloads>
</release>
<release>
<version>2.0.1</version>
<date>1/04/2003</date>
<jiraId>21250</jiraId>
<downloads>
<download>
<url>https://oscache.dev.java.net/files/documents/629/1580/oscache-2.0.1-full.zip</url>
<name>Full</name>
</download>
</downloads>
</release>
<release>
<version>2.0</version>
<date>09/22/2003</date>
<jiraId>21222</jiraId>
<downloads>
<download>
<url>https://oscache.dev.java.net/files/documents/629/1051/oscache_2_0_full.zip</url>
<name>Full</name>
</download>
</downloads>
</release>
</releases>
</project>

41
docs/navpanel.jsp Normal file
View file

@ -0,0 +1,41 @@
<p>
<h3>About</h3>
<a href="<%= request.getContextPath() %>/oscache/wiki/What%20is%20OSCache.html">Overview</a> <br>
<a href="<%= request.getContextPath() %>/oscache/wiki/Feature%20List.html">Feature List</a><br>
<a href="http://oscache.dev.java.net/servlets/ProjectDocumentList">Download</a><br>
<a href="<%= request.getContextPath() %>/oscache/wiki/Change%20Log.html">Changelog</a><br>
<a href="<%= request.getContextPath() %>/oscache/wiki/Requirements.html">Requirements</a><br>
</p>
<p>
<h3>Documentation</h3>
<a href="<%= request.getContextPath() %>/oscache/wiki/Installation%20Guide.html">Installation Guide</a><br>
<a href="<%= request.getContextPath() %>/oscache/wiki/FAQ.html">FAQ</a><br>
<a href="<%= request.getContextPath() %>/oscache/wiki/Configuration.html">Configuration</a><br>
<a href="<%= request.getContextPath() %>/oscache/wiki/JSP%20Tags.html">Tag Reference</a><br>
<a href="<%= request.getContextPath() %>/oscache/wiki/CacheFilter.html">The Caching Filter</a><br>
<a href="<%= request.getContextPath() %>/oscache/wiki/Cron%20Expressions.html">Cron Expressions</a><br>
<a href="<%= request.getContextPath() %>/oscache/wiki/Hibernate.html">OSCache and Hibernate</a><br>
<a href="<%= request.getContextPath() %>/oscache/wiki/Clustering.html">Clustering</a><br>
<a href="<%= request.getContextPath() %>/oscache/api/">API Reference</a>
</p>
<p>
<h3>Services</h3>
<b>JIRA</b><br>
- <a href="http://jira.opensymphony.com/browse/CACHE?report=com.atlassian.jira.plugin.system.project:openissues-panel">Issue Overview</a><br>
- <a href="http://jira.opensymphony.com/browse/CACHE?report=com.atlassian.jira.plugin.system.project:roadmap-panel">Roadmap</a><br>
- <a href="http://jira.opensymphony.com/browse/CACHE?report=com.atlassian.jira.plugin.system.project:changelog-panel">Changelog</a><br>
<b>Wiki</b><br>
- <a href="http://wiki.opensymphony.com/display/CACHE">OSCache page</a>
</p>
<p>
<h3>Sponsor Companies</h3>
These companies have contributed a lot to OSCache and we thank them.<br>
<a href="http://www.pyxis-tech.com"><img src="<%= request.getContextPath() %>/oscache/pyxis-box-sponsor.gif" width="120" height="60" border="0" alt="Pyxis Technologies" vspace="2"></a><br>
<a href="http://www.atlassian.com"><img src="<%= request.getContextPath() %>/oscache/atlassian-sponsor.gif" width="120" height="60" border="0" alt="Atlassian" vspace="2"></a>
</p>

BIN
docs/wiki/7147/CacheChainModel_v3.jpg Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 76 KiB

76
docs/wiki/API Usage.html Normal file
View file

@ -0,0 +1,76 @@
<html>
<head>
<title>OSCache -
Usage
</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">
<p>Beside the <a href="JSP Tags.html" title="JSP Tags">JSP tag library</a> and the <a href="CacheFilter.html" title="CacheFilter">CacheFilter</a> you can use OSCache through its straightforward API. You can use the <a href="http://www.opensymphony.com/oscache/api/com/opensymphony/oscache/general/GeneralCacheAdministrator.html" title="Visit page outside Confluence">GeneralCacheAdministrator</a> to create, flush and administrate the cache. The GeneralCacheAdministrator has a cache instance and delegates different Cache's methods. Furthermore the GeneralCacheAdministrator is in charge of load the <a href="Configuration.html" title="Configuration">cache.properties</a> and create a cache instance with the properties definded. You have to store an instance of the GeneralCacheAdministrator in a static value or use a singleton pattern to access the same GeneralCacheAdministrator.</p>
<h4><a name="APIUsage-Typicalusewithfailover"></a>Typical use with fail over</h4>
<div class="code"><div class="codeContent">
<pre class="code-java"><span class="code-object">String</span> myKey = <span class="code-quote">"myKey"</span>;
<span class="code-object">String</span> myValue;
<span class="code-object">int</span> myRefreshPeriod = 1000;
<span class="code-keyword">try</span> {
<span class="code-comment">// Get from the cache
</span> myValue = (<span class="code-object">String</span>) admin.getFromCache(myKey, myRefreshPeriod);
} <span class="code-keyword">catch</span> (NeedsRefreshException nre) {
<span class="code-keyword">try</span> {
<span class="code-comment">// Get the value (probably from the database)
</span> myValue = <span class="code-quote">"This is the content retrieved."</span>;
<span class="code-comment">// Store in the cache
</span> admin.putInCache(myKey, myValue);
} <span class="code-keyword">catch</span> (Exception ex) {
<span class="code-comment">// We have the current content <span class="code-keyword">if</span> we want fail-over.
</span> myValue = (<span class="code-object">String</span>) nre.getCacheContent();
<span class="code-comment">// It is essential that cancelUpdate is called <span class="code-keyword">if</span> the
</span> <span class="code-comment">// cached content is not rebuilt
</span> admin.cancelUpdate(myKey);
}
}</pre>
</div></div>
<h4><a name="APIUsage-Typicalusewithoutfailover"></a>Typical use without fail over</h4>
<div class="code"><div class="codeContent">
<pre class="code-java"><span class="code-object">String</span> myKey = <span class="code-quote">"myKey"</span>;
<span class="code-object">String</span> myValue;
<span class="code-object">int</span> myRefreshPeriod = 1000;
<span class="code-keyword">try</span> {
<span class="code-comment">// Get from the cache
</span> myValue = (<span class="code-object">String</span>) admin.getFromCache(myKey, myRefreshPeriod);
} <span class="code-keyword">catch</span> (NeedsRefreshException nre) {
<span class="code-keyword">try</span> {
<span class="code-comment">// Get the value (probably from the database)
</span> myValue = <span class="code-quote">"This is the content retrieved."</span>;
<span class="code-comment">// Store in the cache
</span> admin.putInCache(myKey, myValue);
updated = <span class="code-keyword">true</span>;
} <span class="code-keyword">finally</span> {
<span class="code-keyword">if</span> (!updated) {
<span class="code-comment">// It is essential that cancelUpdate is called <span class="code-keyword">if</span> the
</span> <span class="code-comment">// cached content could not be rebuilt
</span> admin.cancelUpdate(myKey);
}
}
}</pre>
</div></div>
<h4><a name="APIUsage-Note"></a>Note</h4>
<table cellpadding='5' width='85%' cellspacing='8px' class='noteMacro' border="0" align='center'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="./icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b class="strong">Be Careful</b><br />
<p>If a NeedsRefreshException is raised you have to invoke admin.putInCache or even admin.cancelUpdate to avoid deadlock situation.</p></td></tr></table>
</td>
</tr>
</table>
</body>
</html>

180
docs/wiki/CacheFilter Tutorial.html Normal file
View file

@ -0,0 +1,180 @@
<html>
<head>
<title>OSCache -
CacheFilter Tutorial
</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">
<h3><a name="CacheFilterTutorial-Introduction"></a>Introduction </h3>
<p><b>OSCache</b> 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, e.g. PDF files or images. In addition by using the last modified header the transaction overhead and server load is reduced excellently which speed ups the server response time.</p>
<p>How to configure OSCache to cache entire servlet responses is described in the <a href="CacheFilter.html" title="CacheFilter">configuration page of the CacheFilter</a>. This short tutorial should demonstrate how to make your web site more responsive, and save load on your server. Using the CacheFilter the user will appreciate a faster loading site and will visit it more often.</p>
<h3><a name="CacheFilterTutorial-Improvements"></a>Improvements</h3>
<p>Major improvements have been made to the CacheFilter in the releases 2.2 and 2.3:</p>
<ul>
<li>Default initialization of the last modified header which reduces transaction overhead and server load</li>
<li>CRON expressions to expire content at specific dates and/or times</li>
<li>Preserving more http headers, e.g. the expires header</li>
<li>Special handling for fragments of a page</li>
<li>Custom cache key generation by subclassing CacheFilter or by implementing a special interface</li>
<li>Custom cache groups generation by subclassing CacheFilter or by implementing a special interface</li>
<li>Support of GZip filters in the filter chain</li>
<li>Avoids session creation for application scope pages</li>
<li>Reduced memory consumption</li>
<li>Multiple matching cache filters won't dead-lock the response anymore</li>
<li>The cache won't be serve the same response twice before the client begins to cache it anymore</li>
</ul>
<h3><a name="CacheFilterTutorial-CacheableContent"></a>Cacheable Content</h3>
<table cellpadding='5' width='85%' cellspacing='8px' class='noteMacro' border="0" align='center'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="./icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b class="strong">Cacheable content</b><br />
<p>Note that the filter will only cache content that has a status of 200 (HttpServletResponse.SC_OK).</p></td></tr></table>
<h3><a name="CacheFilterTutorial-Configuringthefilter"></a>Configuring the filter</h3>
<h4><a name="CacheFilterTutorial-Example1"></a>Example 1</h4>
<p>To configure the filter, add something like the following to your <tt>web.xml</tt> 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 for 10 minutes in session scope):</p>
<div class="code"><div class="codeContent">
<pre class="code-xml"><span class="code-tag">&lt;filter&gt;</span>
<span class="code-tag">&lt;filter-name&gt;</span>CacheFilter<span class="code-tag">&lt;/filter-name&gt;</span>
<span class="code-tag">&lt;filter-class&gt;</span>com.opensymphony.oscache.web.filter.CacheFilter<span class="code-tag">&lt;/filter-class&gt;</span>
<span class="code-tag">&lt;init-param&gt;</span>
<span class="code-tag">&lt;param-name&gt;</span>time<span class="code-tag">&lt;/param-name&gt;</span>
<span class="code-tag">&lt;param-value&gt;</span>600<span class="code-tag">&lt;/param-value&gt;</span>
<span class="code-tag">&lt;/init-param&gt;</span>
<span class="code-tag">&lt;init-param&gt;</span>
<span class="code-tag">&lt;param-name&gt;</span>scope<span class="code-tag">&lt;/param-name&gt;</span>
<span class="code-tag">&lt;param-value&gt;</span>session<span class="code-tag">&lt;/param-value&gt;</span>
<span class="code-tag">&lt;/init-param&gt;</span>
<span class="code-tag">&lt;/filter&gt;</span>
<span class="code-tag">&lt;filter-mapping&gt;</span>
<span class="code-tag">&lt;filter-name&gt;</span>CacheFilter<span class="code-tag">&lt;/filter-name&gt;</span>
<span class="code-tag">&lt;url-pattern&gt;</span>*.jsp<span class="code-tag">&lt;/url-pattern&gt;</span>
<span class="code-tag">&lt;/filter-mapping&gt;</span></pre>
</div></div>
<p>The default duration is one hour and the default scope for the cache is application scope. You can change these settings using <a href="CacheFilter.html" title="CacheFilter">initialization parameters</a>.</p>
<h4><a name="CacheFilterTutorial-Example2"></a>Example 2</h4>
<p>The initialization of the last modified header based on the current time reduces transaction overhead and server load, because the browser can ask the server if the cached content in the browser cache was changed on the server since the last request. If the content wasn't changed , the server will response with the status 304 (not modified).</p>
<p>Furthermore if the <a href="CacheFilter.html#CacheFilter-expires" title="expires on CacheFilter">expires parameter</a> is the set to <em>time</em>, the server will send the date and time after which the content is considered stale. Then common browsers won't request the server anymore until the cached content is considered stale. The example will cache the content for one hour by default and the expires date and time will be calculated based on the creation time and the <em>time</em> parameter (default is one hour).</p>
<div class="code"><div class="codeContent">
<pre class="code-xml"><span class="code-tag">&lt;filter&gt;</span>
<span class="code-tag">&lt;filter-name&gt;</span>CacheFilterStaticContent<span class="code-tag">&lt;/filter-name&gt;</span>
<span class="code-tag">&lt;filter-class&gt;</span>com.opensymphony.oscache.web.filter.CacheFilter<span class="code-tag">&lt;/filter-class&gt;</span>
<span class="code-tag">&lt;init-param&gt;</span>
<span class="code-tag">&lt;param-name&gt;</span>expires<span class="code-tag">&lt;/param-name&gt;</span>
<span class="code-tag">&lt;param-value&gt;</span>time<span class="code-tag">&lt;/param-value&gt;</span>
<span class="code-tag">&lt;/init-param&gt;</span>
<span class="code-tag">&lt;/filter&gt;</span>
<span class="code-tag">&lt;filter-mapping&gt;</span>
<span class="code-tag">&lt;filter-name&gt;</span>CacheFilterStaticContent<span class="code-tag">&lt;/filter-name&gt;</span>
<span class="code-tag">&lt;url-pattern&gt;</span>*.jsp<span class="code-tag">&lt;/url-pattern&gt;</span>
<span class="code-tag">&lt;/filter-mapping&gt;</span></pre>
</div></div>
<h3><a name="CacheFilterTutorial-Usingthefilter"></a>Using the filter</h3>
<h4><a name="CacheFilterTutorial-Example1%3AICacheKeyProvider"></a>Example 1: ICacheKeyProvider</h4>
<p>A simple example how to use the <a href="CacheFilter.html#CacheFilter-ICacheKeyProvider" title="ICacheKeyProvider on CacheFilter">ICacheKeyProvider</a> parameter of the CacheFilter. The cache key in constructed with the http request URI and with two request parameters <em>pageid</em> and <em>pagination</em>.</p>
<div class="code"><div class="codeContent">
<pre class="code-java"><span class="code-keyword">import</span> javax.servlet.http.HttpServletRequest;
<span class="code-keyword">import</span> com.opensymphony.oscache.base.Cache;
<span class="code-keyword">import</span> com.opensymphony.oscache.web.ServletCacheAdministrator;
<span class="code-keyword">import</span> com.opensymphony.oscache.web.filter.ICacheKeyProvider;
<span class="code-keyword">public</span> class ExampleCacheKeyProvider <span class="code-keyword">implements</span> ICacheKeyProvider {
<span class="code-keyword">public</span> <span class="code-object">String</span> createCacheKey(HttpServletRequest httpRequest, ServletCacheAdministrator scAdmin, Cache cache) {
<span class="code-comment">// buffer <span class="code-keyword">for</span> the cache key
</span> <span class="code-object">StringBuffer</span> buffer = <span class="code-keyword">new</span> <span class="code-object">StringBuffer</span>(100);
<span class="code-comment">// part 1 of the key: the request uri
</span> buffer.append(httpRequest.getRequestURI());
<span class="code-comment">// separation
</span> buffer.append('_');
<span class="code-comment">// part 2 of the key: the page id
</span> buffer.append(httpRequest.getParameter(<span class="code-quote">"pageid"</span>));
<span class="code-comment">// separation
</span> buffer.append('_');
<span class="code-comment">// part 3 of the key: the pagination
</span> buffer.append(httpRequest.getParameter(<span class="code-quote">"pagination"</span>));
<span class="code-keyword">return</span> buffer.toString();
}
}</pre>
</div></div>
<p>You can use session attributes values for the cache key also, if request parameters aren't available or e.g. security settings have to be add to the cache key.</p>
<h4><a name="CacheFilterTutorial-Example2%3AFlush"></a>Example 2: Flush</h4>
<p>The flush example shows how to flush a CacheFilter with scope <em>application</em> based on group names. In this example the http servlet request of the user is required to get the cache object.</p>
<div class="code"><div class="codeContent">
<pre class="code-java"><span class="code-keyword">import</span> com.opensymphony.oscache.base.Cache;
<span class="code-keyword">import</span> com.opensymphony.oscache.web.ServletCacheAdministrator;
<span class="code-keyword">import</span> java.util.Collection;
<span class="code-keyword">import</span> java.util.Iterator;
<span class="code-keyword">import</span> javax.servlet.http.HttpServletRequest;
<span class="code-keyword">import</span> javax.servlet.jsp.PageContext;
<span class="code-keyword">public</span> class OSCacheAdmin {
/**
* flush the CacheFilter according to dependent group
*
* @param request the HttpServletRequest of the user
* @param groupNames a string collection of group names
*/
<span class="code-keyword">public</span> <span class="code-keyword">static</span> void flushCacheGroup(HttpServletRequest request, Collection groupNames) {
Cache cache = ServletCacheAdministrator.getInstance(request.getSession().getServletContext()).getCache(request, PageContext.APPLICATION_SCOPE);
Iterator groups = groupNames.iterator();
<span class="code-keyword">while</span> (groups.hasNext()) {
<span class="code-object">String</span> group = (<span class="code-object">String</span>) groups.next();
cache.flushGroup(group);
}
}
}</pre>
</div></div>
<p>If you're CacheFilter is running with scope <em>session</em>, you have to get the cache as follows:</p>
<div class="code"><div class="codeContent">
<pre class="code-java">Cache cache = ServletCacheAdministrator.getInstance(request.getSession(<span class="code-keyword">true</span>).getServletContext()).getCache(request, PageContext.SESSION_SCOPE);</pre>
</div></div>
</td>
</tr>
</table>
</body>
</html>

118
docs/wiki/CacheFilter.html Normal file
View file

@ -0,0 +1,118 @@
<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">
<p><b>OSCache</b> 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, e.g. PDF files or images.</p>
<p>A <a href="CacheFilter Tutorial.html" title="CacheFilter Tutorial">tutorial</a> describes how to cache entire pages of your website and what performance improvements can be done with the CacheFilter.</p>
<p>Beginning with release 2.4 you are be able to set/override the CacheFilter initialization parameters at runtime.</p>
<h4><a name="CacheFilter-CacheableContent"></a>Cacheable Content</h4>
<table cellpadding='5' width='85%' cellspacing='8px' class='noteMacro' border="0" align='center'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="./icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b class="strong">Cacheable content</b><br /><br/>
Note that the filter will only cache content that has a status of 200 (HttpServletResponse.SC_OK).</td></tr></table>
<h3><a name="CacheFilter-Configuringthefilter"></a>Configuring the filter</h3>
<p>To configure the filter, use the <tt>oscache.properties</tt> to <a href="Configuration.html" title="Configuration">configure</a> the core settings of OSCache and add something like the following to your <tt>web.xml</tt> file:</p>
<div class="code"><div class="codeContent">
<pre class="code-xml"><span class="code-tag">&lt;filter&gt;</span>
<span class="code-tag">&lt;filter-name&gt;</span>CacheFilter<span class="code-tag">&lt;/filter-name&gt;</span>
<span class="code-tag">&lt;filter-class&gt;</span>com.opensymphony.oscache.web.filter.CacheFilter<span class="code-tag">&lt;/filter-class&gt;</span>
<span class="code-tag">&lt;init-param&gt;</span>
<span class="code-tag">&lt;param-name&gt;</span>time<span class="code-tag">&lt;/param-name&gt;</span>
<span class="code-tag">&lt;param-value&gt;</span>600<span class="code-tag">&lt;/param-value&gt;</span>
<span class="code-tag">&lt;/init-param&gt;</span>
<span class="code-tag">&lt;init-param&gt;</span>
<span class="code-tag">&lt;param-name&gt;</span>scope<span class="code-tag">&lt;/param-name&gt;</span>
<span class="code-tag">&lt;param-value&gt;</span>session<span class="code-tag">&lt;/param-value&gt;</span>
<span class="code-tag">&lt;/init-param&gt;</span>
<span class="code-tag">&lt;/filter&gt;</span>
<span class="code-tag">&lt;filter-mapping&gt;</span>
<span class="code-tag">&lt;filter-name&gt;</span>CacheFilter<span class="code-tag">&lt;/filter-name&gt;</span>
<span class="code-tag">&lt;url-pattern&gt;</span>*.jsp<span class="code-tag">&lt;/url-pattern&gt;</span>
<span class="code-tag">&lt;/filter-mapping&gt;</span></pre>
</div></div>
<p>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 for 10 minutes in session scope. The default duration is one hour and the default scope for the cache is application scope. </p>
<p>If the <a href="#CacheFilter-ICacheKeyProvider" title="ICacheKeyProvider on CacheFilter">ICacheKeyProvider</a> parameter isn't set, the CacheFilter will use the HTTP request URI and the QueryString to create the cache key. </p>
<p>You can change the CacheFilter settings using the following initialization parameters.</p>
<h4><a name="CacheFilter-Parameter%3Atime"></a><a name="CacheFilter-time"></a>Parameter: time</h4>
<p>The time parameter sets the cache time (in seconds) for the content. The default cache time is one hour.</p>
<p>Specifying <em>&#45;1</em> (indefinite expiry) as the cache time will ensure a content does not become stale until it is either explicitly flushed or the expires refresh policy causes the entry to expire.</p>
<h4><a name="CacheFilter-Parameter%3Ascope"></a><a name="CacheFilter-scope"></a>Parameter: scope</h4>
<p>The scope parameter lets you set the scope to cache content in. Valid values for the scope are <em>application</em> (default) and <em>session</em>.</p>
<h4><a name="CacheFilter-Parameter%3Acron%28NEW%5C%21Since2.3%29"></a><a name="CacheFilter-cron"></a>Parameter: cron (NEW&#33; Since 2.3)</h4>
<p>A cron expression that determines when the page 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. Please consider that the (default) time value is still evaluated, hence the time value should be set to indefinite expiry.</p>
<h4><a name="CacheFilter-Parameter%3Afragment%28NEW%5C%21Since2.2%29"></a><a name="CacheFilter-fragment"></a>Parameter: fragment (NEW&#33; Since 2.2)</h4>
<p>Defines if the filter handles fragments of a page. Acceptable values are <em>auto</em> for auto detect, <em>no</em> for false and <em>yes</em> for true. The default value is auto detect which checks the <em>javax.servlet.include.request_uri</em> request attribute. Fragments of a page shouldn't be gzipped or evaluate the last modified header.</p>
<h4><a name="CacheFilter-Parameter%3Anocache%28NEW%5C%21Since2.2%29"></a><a name="CacheFilter-nocache"></a>Parameter: nocache (NEW&#33; Since 2.2)</h4>
<p>Defines which objects shouldn't be cached. Acceptable values are <em>off</em> (default) for caching all objects and <em>sessionIdInURL</em> for don't cache page if the session id is contained in the URL.</p>
<h4><a name="CacheFilter-Parameter%3AlastModified%28NEW%5C%21Since2.2%29"></a><a name="CacheFilter-lastModified"></a>Parameter: lastModified (NEW&#33; Since 2.2)</h4>
<p>Defines if the last modified header will be sent in the response. Acceptable values are <em>off</em> for don't sending the header, even it is set in the filter chain, <em>on</em> for sending it if it is set in the filter chain and <em>initial</em> (default) the last modified information will be set based on current time.</p>
<h4><a name="CacheFilter-Parameter%3Amaxage%28NEW%5C%21Since2.3.1%29"></a><a name="CacheFilter-maxage"></a>Parameter: max-age (NEW&#33; Since 2.3.1)</h4>
<p>Specifies the maximum amount of time in seconds that the cache content will be considered new in the browser's cache. The browser will retrieve the content from it's own cache for the amount of time without requesting the web server again. The default max-age time is 60 seconds. Combined with the <a href="#CacheFilter-lastModified" title="lastModified on CacheFilter">last modified header</a> the transaction overhead and server load is reduced excellently which speed ups the server response time. Further parameters are <em>no init</em> for don't initializing the max-age cache control and <em>time</em> to set max-age based on the time parameter and creation time of the content (expiration timestamp minus current timestamp) by each request.</p>
<h4><a name="CacheFilter-Parameter%3Aexpires%28NEW%5C%21Since2.2%29"></a><a name="CacheFilter-expires"></a>Parameter: expires (NEW&#33; Since 2.2)</h4>
<p>Defines if the expires header will be sent in the response. Acceptable values are <em>off</em> for don't sending the header, even it is set in the filter chain, <em>on</em> (default) for sending it if it is set in the filter chain and <em>time</em> the expires information will be intialized based on the time parameter and creation time of the content.<table cellpadding='5' width='85%' cellspacing='8px' class='noteMacro' border="0" align='center'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="./icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b class="strong">Value 'time'</b><br /><br/>
The parameter <em>time</em> would force the CacheFilter to send the expires header, because the value is set always. The developer must consider that some browsers evaluate the value and will use the cached content in the browsers cache, until the content is expired. Consequently a flush of the cache in the web application won't update a page in the browser cache. Hence different users may see see a different status of page.</td></tr></table></p>
<h4><a name="CacheFilter-Parameter%3AICacheKeyProvider%28NEW%5C%21Since2.2%29"></a><a name="CacheFilter-ICacheKeyProvider"></a>Parameter: ICacheKeyProvider (NEW&#33; Since 2.2)</h4>
<p>Specify a class which implements the interface <tt>ICacheKeyProvider</tt>. A developer can implement a class which provides cache keys based on the request, the servlect cache administrator and the cache.</p>
<h4><a name="CacheFilter-Parameter%3AICacheGroupsProvider%28NEW%5C%21Since2.2%29"></a><a name="CacheFilter-ICacheGroupsProvider"></a>Parameter: ICacheGroupsProvider (NEW&#33; Since 2.2)</h4>
<p>Specify a class which implements the interface <tt>ICacheGroupsProvider</tt>. A developer can implement a class which provides cache groups based on the request, the servlect cache administrator and the cache.</p>
<h4><a name="CacheFilter-Parameter%3AEntryRefreshPolicy%28New%5C%21Since2.3%29"></a><a name="CacheFilter-EntryRefreshPolicy"></a>Parameter: EntryRefreshPolicy (New&#33; Since 2.3)</h4>
<p>Specify a class which implements the interface <tt>EntryRefreshPolicy</tt>. A developer can implement a class which provides a different custom cache invalidation policy for a specific cache entry. If not specified, the default policy is timed entry expiry as specified with the <em>time</em> parameter described above. </p>
<h4><a name="CacheFilter-Parameter%3AdisableCacheOnMethods%28New%5C%21Since2.4%29"></a><a name="CacheFilter-disableCacheOnMethods"></a>Parameter: disableCacheOnMethods (New&#33; Since 2.4)</h4>
<p>Specify HTTP method names in a comma separated list for which cacheing should be disabled. The default value is &lt;code&gt;null&lt;/code&gt; for cacheing all requests without regarding the method name. See <a href="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletRequest.html#getMethod()" title="Visit page outside Confluence">HttpServletRequest#getMethod</a>, e.g.:</p>
<div class="code"><div class="codeContent">
<pre class="code-xml"><span class="code-tag">&lt;init-param&gt;</span>
<span class="code-tag">&lt;param-name&gt;</span>disableCacheOnMethods<span class="code-tag">&lt;/param-name&gt;</span>
<span class="code-tag">&lt;param-value&gt;</span>POST,PUT,DELETE<span class="code-tag">&lt;/param-value&gt;</span>
<span class="code-tag">&lt;/init-param&gt;</span></pre>
</div></div>
<h4><a name="CacheFilter-Parameter%3Aoscachepropertiesfile%28New%5C%21Since2.4%29"></a><a name="CacheFilter-oscachepropertiesfile"></a>Parameter: oscache-properties-file (New&#33; Since 2.4)</h4>
<p>By specifying a OSCache properties file for a CacheFilter, the developer can run multiple caches each with different <a href="Configuration.html" title="Configuration">configurations</a> tailored to the requirements of the application. In each properties file the developer has to define a unique <a href="Configuration.html#Configuration-cache.key" title="cache.key on Configuration">cache.key</a> otherwise the default properties file is used. If the parameter is not specified, the default properties file will be used. The file has to be put into the classpath, e.g. <em>WEB-INF/classes</em>.</p>
</td>
</tr>
</table>
</body>
</html>

127
docs/wiki/Chain Caching Model.html Normal file
View file

@ -0,0 +1,127 @@
<html>
<head>
<title>OSCache -
Chain Caching Model
</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">
<h2><a name="ChainCachingModel-Discussion"></a>Discussion</h2>
<p><ins>Lars wrote:</ins><br/>
Would it be possible to use the intercepting filter pattern to support all possible cache models with a lot of combination capabilities? It's possible to define the capacity for each cache etc.</p>
<p>DiskPersistence, SoftReferenceCache etc. would implement the Command interface of Commons Chain or a new interface of OSCache.</p>
<p><a href="http://jakarta.apache.org/commons/chain/" title="Visit page outside Confluence">http://jakarta.apache.org/commons/chain/</a><br/>
<a href="http://java.sun.com/blueprints/corej2eepatterns/Patterns/InterceptingFilter.html" title="Visit page outside Confluence">http://java.sun.com/blueprints/corej2eepatterns/Patterns/InterceptingFilter.html</a></p>
<p><ins>Andres wrote:</ins><br/>
I think that is a good idea but it may be overkill for the most use cases. Also, not every cache interceptor could have all the capabilities. In particular, how would you imagine a realistic use case for a cache.get() call. Should multiple interceptors return values?</p>
<p>I think disk persistence is still in, although I don't think it will be like it is now. We will be accepting Object keys, so any cache impl will need to accept them. I have been thinking about a lightweight object db that has persistence built-in but I'm not sure.</p>
<p>This is definitely an interesting topic and I'd like to discuss it more.<br/>
Now is the time to make these sort of decisions.</p>
<p><ins>Lars wrote:</ins><br/>
The cache interceptors are cascaded. If the first interceptor doesn't return a value then the 2nd interceptor will be requested.</p>
<p><ins>Andres wrote:</ins><br/>
The scenarios below basically describe a more flexible implementation of the 2 cache (memory and disk) architecture in place.&nbsp; There is no doubt that a chained design can be better.&nbsp; I would be mindful of the abuse that can occur with a inifinitely flexible system.&nbsp; I prefer though to allow people to shoot themselves in the foot but make it extremely easy not to do so by providing very simple out of the box implementations.&nbsp; I have attached a <a href="http://wiki.opensymphony.com/download/attachments/7147/cache+sequences.pdf?version=1" title="cache sequences.pdf attached to Chain Caching Model">simple sequence diagram</a>.&nbsp; I think further documenting the scenarios you have below as well as all the other use cases we intend to provide is the best course of action at this point.&nbsp; All the old code has been torn out.&nbsp; We are at the point where we should be conscious of the new design that we allow to take shape.</p>
<p><ins>Lars wrote:</ins><br/>
The interface needed for the Cache Link (which you describe in a <a href="http://wiki.opensymphony.com/download/attachments/7147/cache+sequences.pdf?version=1" title="cache sequences.pdf attached to Chain Caching Model">simple sequence diagram</a>) is exactly the same interface as the EvictionAlgorithm. The Cache Chain has to handle in which Cache Link a cache content should be. Furthermore the Cache Chain has to put an evicted cache content from the memory cache to the disk cache.</p>
<p>1.) How do you want to synchronize the access to the same cache content? In OSCache 2 this is done by the EntryUpdateState based on the key.<br/>
2.) Should the Cache Chain contain all the cache keys without knowing in which Cache Link the content is? Or should each Cache Link contain it's own cache keys?</p>
<p>Some other points:<br/>
3.) Please update the java doc of EvictionAlgorithm, because some parameters are wrong.<br/>
4.) currently you synchronize the cache events, I think there maybe a performance loss, because in my environments a lot of events are fired</p>
<p>I added a <a href="http://wiki.opensymphony.com/download/attachments/7147/CacheChainModel_v1.pdf?version=1" title="CacheChainModel_v1.pdf attached to Chain Caching Model">simple class diagramm</a> and saved the diagramm in the <a href="http://wiki.opensymphony.com/download/attachments/7147/oscache.fpr.gz?version=4" title="oscache.fpr.gz attached to Chain Caching Model">Fujaba format</a>.</p>
<p><ins>Andres wrote:</ins></p>
<p>The cache chain should have no knowledge of what is in any of the cache links. However, the issue of eviction is clear. When a put() is called, the link should return an evicted entry or null if the cache is not full. The chain will then know if it needs to continue the put into the next link. To clarify the interfaces, I think a Chain interface should extend Map. The Link and EvictionAlgorithm should themselves be interfaces. Link could have implementations such as memory, disk, database. EvictionAlgorithm could have implementations such as LRU, FIFO, etc....</p>
<p>1.) In my branch, I have synchronized the entire cache on each cache access. I think this will still be fast enough and will surely be more stable. basically, get, put, and remove are sync'd. I do not think we need to achieve a highly concurrent cache in order to provide a solution that is hundreds of times faster than db or disk access.</p>
<p>However, we could add functionality the improves performance but does not cause deadlocks, such as a write behind feature on puts, so that puts get queued and another thread does the work when it has time. </p>
<p>2.) I don't think this would be wise. I don't think the chain should have knowledge of the keys. I think all it should have is references to the links and stateless logic. Either way each link would need to keep its own keys, therefore putting them in the chain would add another map that would have to be accessed and slow performance.</p>
<p>There are 3 places I believe the keys must exist: in the store (duh), in the algorithm (or we could generalize this as any metrics collector), and in the groups map.</p>
<p>Group functionality is a similar issue. I had wanted to drop this functionality but it seems the people that use cache tags (I never have yet) really depend on them. This functionality is unique to OSCache as far as I am aware.<br/>
Maintaining the groups in each link could kill performance. I think we need a GroupManager that exists outside of the cache links and is referenced from the chain. This way it is only called once per chain. One disadvantage would be that when a group is removed each remove would have to be called on each link until it found the correct store. </p>
<p>3./4.) Yeah, that is sort of borrowed code and is not necessary. However, we need to be mindful of the access to the listener list. The easiest way is to probably make the list implementation a SynchronizedArrayList or something.</p>
<p>The way I am thinking the current code in my branch could be moved over to a chain model is:</p>
<ol>
<li>most of the BaseCache code gets put into the chain minus the algorithm and group map code.</li>
<li>the MemoryCache gets turned into one of the link implementations and gets the algorithm reference</li>
<li>the group map code gets refactored into a GroupManager and called from the chain.</li>
</ol>
<p><ins>Lars wrote:</ins><br/>
I think the implementations of the CacheChain interface could be a SimplePipeCacheChain and a SizeBasedCacheChain. The SimplePipeCacheChain is comparable to the current architectur. The SizeBasesCacheChain puts the cache objects to the different CacheLinks based on the cache content sizes, e.g. large images a stored to disk and not in memory.</p>
<p><img src="Chain Caching Model_attachments/CacheChainModel_v3.jpg" align="absmiddle" border="0" /></p>
<p>The default CacheChain should be the SimplePipeCacheChain. The SizeBasedCacheChain can be implemented as part of a 3.1 release.</p>
<h2><a name="ChainCachingModel-Scenariostobecheckedandtested"></a>Scenarios to be checked and tested</h2>
<p>Configuration with a LRU algorithm: (1) MemoryCache &#45;<del>&gt; (2) SoftRefCache &#45;</del>&gt; (3) DiskPersistCache</p>
<h3><a name="ChainCachingModel-ScenarioA%3AGetforaobjectinSoftRefCache"></a>Scenario A: Get for a object in SoftRefCache</h3>
<ol>
<li>the cache object x1 is in the SoftRefCache</li>
<li>the 1st getEntry will return null for the MemoryCache</li>
<li>the 2nd getEntry will find the cache object x1 in SoftRefCache</li>
<li>cache object x1 has to be removed from the SoftRefCache and has to put into the 1st cache (or maybe in the previous cache &lt;&#45; design decission).</li>
<li>the cache object x1 will edge out the cache object xi (LRU) from the MemoryCache and the cache object xi has to me removed from the MemoryCache and to put in the next cache (SoftRefCache).</li>
</ol>
<h3><a name="ChainCachingModel-ScenarioB%3AGetforaobjectinDiskPersistCache"></a>Scenario B: Get for a object in DiskPersistCache</h3>
<ol>
<li>the cache object x2 is in the DiskPersistCache</li>
<li>the 1st getEntry will return null for the MemoryCache</li>
<li>the 2nd getEntry will return null for the SoftRefCache</li>
<li>the 3rd getEntry will find the cache object x2 in DiskPersistCache</li>
<li>cache object x2 has to be removed from the DiskPersistCache and has to put into the 1st cache. The cache object x2 will edge out xj in MemoryCache, which has to be put in SoftRefCache. Hence xj will edge out xk in SoftRefCache, which has to be put in DiskPersistCache</li>
</ol>
<h3><a name="ChainCachingModel-ScenarioC%3APutanewobject"></a>Scenario C: Put a new object</h3>
<ol>
<li>the new cache object x3 should be put into the cache</li>
<li>the cache object x3 will be edge out a cache object xa from MemoryCache</li>
<li>xa has to be put into SoftRefCache, where xa will edge out xb</li>
<li>xb has to be put in DiskPersistCache, where xb will edge out xc</li>
<li>until DiskPersistCache is not unlimited the xc cache object has to be removed from cache. Hence the cache key for xc has to be removed from the map.</li>
</ol>
<h3><a name="ChainCachingModel-ScenarioD%3APutastaleobjectorgetastaleobject"></a>Scenario D: Put a stale object or get a stale object</h3>
<p><b>TODO</b></p>
</td>
</tr>
</table>
</body>
</html>

BIN
docs/wiki/Chain Caching Model_attachments/CacheChainModel_v1.pdf Normal file
View file

Binary file not shown.

BIN
docs/wiki/Chain Caching Model_attachments/CacheChainModel_v3.jpg Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 76 KiB

BIN
docs/wiki/Chain Caching Model_attachments/cache sequences.pdf Normal file
View file

Binary file not shown.

BIN
docs/wiki/Chain Caching Model_attachments/oscache.fpr.gz Normal file
View file

Binary file not shown.

122
docs/wiki/Change Log.html Normal file
View file

@ -0,0 +1,122 @@
<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">
<h3><a name="ChangeLog-ReleaseNotes"></a>Release Notes</h3>
<ul>
<li>2007
<ul>
<li><a href="OSCache 2.4.1.html" title="OSCache 2.4.1">OSCache
2.4.1</a></li>
<li><a href="OSCache 2.4.html" title="OSCache 2.4">OSCache
2.4</a></li>
</ul>
</li>
<li>2006
<ul>
<li><a href="OSCache 2.3.2.html" title="OSCache 2.3.2">OSCache
2.3.2</a></li>
<li><a href="OSCache 2.3.1.html" title="OSCache 2.3.1">OSCache
2.3.1</a></li>
<li><a href="OSCache 2.3.html" title="OSCache 2.3">OSCache
2.3</a></li>
</ul>
</li>
<li>2005
<ul>
<li><a href="OSCache 2.2.html" title="OSCache 2.2">OSCache
2.2</a></li>
<li><a href="OSCache 2.2 RC.html" title="OSCache 2.2 RC">OSCache
2.2 RC</a></li>
<li><a href="OSCache 2.1.1.html" title="OSCache 2.1.1">OSCache
2.1.1</a></li>
<li><a href="OSCache 2.1.html" title="OSCache 2.1">OSCache
2.1</a></li>
</ul>
</li>
<li>2004
<ul>
<li><a href="OSCache 2.0.2.html" title="OSCache 2.0.2">OSCache
2.0.2</a></li>
</ul>
</li>
<li>2003
<ul>
<li><a href="OSCache 2.0.1.html" title="OSCache 2.0.1">OSCache
2.0.1</a></li>
<li><a href="OSCache 2.0.html" title="OSCache 2.0">OSCache
2.0</a></li>
<li><a href="OSCache 2.0 beta 2.html"
title="OSCache 2.0 beta 2">OSCache 2.0 beta 2</a></li>
<li><a href="OSCache 2.0 beta 1.html"
title="OSCache 2.0 beta 1">OSCache 2.0 beta 1</a></li>
</ul>
</li>
<li>2002
<ul>
<li><a href="OSCache 1.7.5.html" title="OSCache 1.7.5">OSCache
1.7.5</a></li>
</ul>
</li>
<li>2001
<ul>
<li><a href="OSCache 1.7.4.html" title="OSCache 1.7.4">OSCache
1.7.4</a></li>
<li><a href="OSCache 1.7.3.html" title="OSCache 1.7.3">OSCache
1.7.3</a></li>
<li><a href="OSCache 1.7.2.html" title="OSCache 1.7.2">OSCache
1.7.2</a></li>
<li><a href="OSCache 1.7.1.html" title="OSCache 1.7.1">OSCache
1.7.1</a></li>
<li><a href="OSCache 1.7.0.html" title="OSCache 1.7.0">OSCache
1.7.0</a></li>
<li><a href="OSCache 1.6.1.html" title="OSCache 1.6.1">OSCache
1.6.1</a></li>
<li><a href="OSCache 1.6.html" title="OSCache 1.6">OSCache
1.6</a></li>
<li><a href="OSCache 1.5.html" title="OSCache 1.5">OSCache
1.5</a></li>
<li><a href="OSCache 1.3.html" title="OSCache 1.3">OSCache
1.3</a></li>
<li><a href="OSCache 1.2.5.html" title="OSCache 1.2.5">OSCache
1.2.5</a></li>
<li><a href="OSCache 1.2.1.html" title="OSCache 1.2.1">OSCache
1.2.1</a></li>
<li><a href="OSCache 1.2.html" title="OSCache 1.2">OSCache
1.2</a></li>
<li><a href="OSCache 1.1.html" title="OSCache 1.1">OSCache
1.1</a></li>
<li><a href="OSCache 1.0 beta 2.html"
title="OSCache 1.0 beta 2">OSCache 1.0 beta 2</a></li>
<li><a href="OSCache 1.0 beta 1.html"
title="OSCache 1.0 beta 1">OSCache 1.0 beta 1</a></li>
</ul>
</li>
<li>2000
<ul>
<li><a href="OSCache 1.0 beta 0.html"
title="OSCache 1.0 beta 0">OSCache 1.0 beta 0</a></li>
</ul>
</li>
</ul>
<p>See also <a
href="http://jira.opensymphony.com/browse/CACHE?report=com.atlassian.jira.plugin.system.project:changelog-panel"
title="Visit page outside Confluence">JIRA - Change Log</a> or read
the complete <a href="Complete Change Log.html"
title="Complete Change Log">release notes at once</a>.</p>
</td>
</tr>
</table>
</body>
</html>

79
docs/wiki/Clustering.html Normal file
View file

@ -0,0 +1,79 @@
<html>
<head>
<title>OSCache -
Clustering
</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">
<p>New in OSCache 2.0 is support for clustering of caches. OSCache currently ships with implementations that allow you to use either JavaGroups or JMS 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><a name="Clustering-JMSConfiguration"></a>JMS Configuration</h3>
<p>Configure your JMS server. OSCache requires that a JMS ConnectionFactory and a Topic are available via JNDI. See your JMS server's documentation for details.</p>
<p>Add the JMS broadcasting listener to your oscache.properties file like this:</p>
<div class="preformatted"><div class="preformattedContent">
<pre>cache.event.listeners=com.opensymphony.oscache.plugins.clustersupport.JMSBroadcastingListener
</pre>
</div></div>
<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 <tt>JMS10BroadcastingListener</tt> instead of <tt>JMSBroadcastingListener</tt>. 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:</p>
<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 "java:comp/env/jms/TopicConnectionFactory"</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 "java:comp/env/jms/OSCacheTopic".</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 "node1", "node2", ... .</li>
</ul>
<p>If you are running OSCache from a standalone application or are not running in an environment where new InitialContext() will find your JNDI InitialContextFactory or provider URL, you will have to specify them either in a jndi.properties file or as system properties. See the InitalContext documentation for details.</p>
<h3><a name="Clustering-JavaGroupsConfiguration"></a>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 JavaGroups broadcasting listener to your oscache.properties file like this:</p>
<div class="preformatted"><div class="preformattedContent">
<pre>cache.event.listeners=com.opensymphony.oscache.plugins.clustersupport.JavaGroupsBroadcastingListener
</pre>
</div></div>
<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.jgroups.org" title="Visit page outside Confluence">JavaGroups website</a>.</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 oscache.properties file by the cache.cluster.multicast.ip property. The default value is 231.12.21.132, however you can use any class D IP address. Class D address fall in the range 224.0.0.0 through 239.255.255.255.</p>
<p>If you need more control over the multicast configuration (eg setting network timeout or time-to-live values), you can use the cache.cluster.properties configuration property. Use this instead of the cache.cluster.multicast.ip property. The default value is:</p>
<div class="preformatted"><div class="preformattedContent">
<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>
</div></div>
<p>See the <a href="http://www.javagroups.com/" title="Visit page outside Confluence">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" title="Visit page outside Confluence">User's Guide</a>.</p>
</td>
</tr>
</table>
</body>
</html>

2959
docs/wiki/Complete Change Log.html Normal file
View file

File diff suppressed because it is too large Load diff

134
docs/wiki/Configuration.html Normal file
View file

@ -0,0 +1,134 @@
<html>
<head>
<title>OSCache -
Configuration
</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">
<p>This guide only covers the configuration of OSCache by using the oscache.properties file. To see how to install OSCache and where to place the oscache.properties file, see the <a href="Installation Guide.html" title="Installation Guide">Installation Guide</a>.<br/>
The following properties are able to be set in the oscache.properties file:</p>
<h4><a name="Configuration-cache.memory"></a>cache.memory</h4>
<p>Valid values are true or false, with true 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 <img class="emoticon" src="./icons/emoticons/wink.gif" height="20" width="20" align="absmiddle" alt="" border="0"/></p>
<h4><a name="Configuration-cache.capacity"></a>cache.capacity</h4>
<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>
<h4><a name="Configuration-cache.algorithm"></a>cache.algorithm</h4>
<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 com.opensymphony.oscache.base.algorithm.LRUCache.</p>
<p>OSCache currently comes with three algorithms:</p>
<ul>
<li><b>com.opensymphony.oscache.base.algorithm.LRUCache</b> - Least Recently Used. This is the default when a cache.capacity is set.</li>
<li><b>com.opensymphony.oscache.base.algorithm.FIFOCache</b> - First In First Out.</li>
<li><b>com.opensymphony.oscache.base.algorithm.UnlimitedCache</b> - Content that is added to the cache will never be discarded. This is the default when no value is set for the cache.capacity property.</li>
</ul>
<h4><a name="Configuration-cache.blocking"></a>cache.blocking</h4>
<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 (cache.blocking=false) 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 even if blocking is disabled, 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>
<h4><a name="Configuration-cache.unlimited.disk"></a>cache.unlimited.disk</h4>
<p>Indicates whether the disk cache should be treated as unlimited or not. The default value is false. In this case, the disk cache capacity will be equal to the memory cache capacity set by cache.capacity.</p>
<h4><a name="Configuration-cache.persistence.class"></a>cache.persistence.class</h4>
<p>Specifies the class to use for persisting cache entries. This class must implement the PersistenceListener interface. OSCache comes with an implementation that provides filesystem based persistence. Set this property to com.opensymphony.oscache.plugins.diskpersistence.HashDiskPersistenceListener 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>
<table cellpadding='5' width='85%' cellspacing='8px' class='noteMacro' border="0" align='center'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="./icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b class="strong">Note</b><br />
<p>The HashDiskPersistenceListener and DiskPersistenceListener classes require <b>cache.path</b> to be set in order to know where to persist the files to disk.</p></td></tr></table>
<h4><a name="Configuration-cache.path"></a>cache.path</h4>
<p>This specifies the directory on disk where the 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. Avoid sharing the same cache path between different caches, because OSCache has not been designed to handle this.</p>
<table cellpadding='5' width='85%' cellspacing='8px' class='noteMacro' border="0" align='center'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="./icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b class="strong">Note</b><br />
<p> For Windows machines, the backslash character '\' needs to be escaped. ie in Windows:</p></td></tr></table>
<div class="preformatted"><div class="preformattedContent">
<pre> cache.path=c:\\myapp\\cache
or *ix:
cache.path=/opt/myapp/cache
</pre>
</div></div>
<h4><a name="Configuration-cache.persistence.overflow.only%28NEW%21Since2.1%29"></a>cache.persistence.overflow.only (NEW! Since 2.1)</h4>
<p>Indicates whether the persistence should only happen once the memory cache capacity has been reached. The default value is false for backwards compatibility but the recommended value is true 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>
<h4><a name="Configuration-cache.event.listeners"></a>cache.event.listeners</h4>
<p>This takes a comma-delimited list of fully-qualified class names. Each class in the list must implement one (or more) of the following interfaces:</p>
<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>
<p>No listeners are configured by default, however some ship with OSCache that you may wish to enable:</p>
<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" title="Clustering">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>
<p>It is also of course quite straightforward to write your own event listener. See the <a href="http://www.opensymphony.com/oscache/api" title="Visit page outside Confluence">JavaDoc API</a> for further details and <a href="Statistics.html" title="Statistics">Statistics</a> for an example.</p>
<h4><a name="Configuration-cache.key"></a><a name="Configuration-cache.key"></a>cache.key</h4>
<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 "__oscache_cache". If you want to access this default value in your code, it is available as com.opensymphony.oscache.web.ServletCacheAdministrator.DEFAULT_CACHE_KEY.</p>
<h4><a name="Configuration-cache.use.host.domain.in.key"></a>cache.use.host.domain.in.key</h4>
<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 true. The default value is false.</p>
<h3><a name="Configuration-AdditionalProperties"></a>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 JavaGroupsBroadcastingListener supports the following additional properties:</p>
<h4><a name="Configuration-cache.cluster.multicast.ip"></a>cache.cluster.multicast.ip</h4>
<p>The multicast IP to use for this cache cluster. Defaults to 231.12.21.132.</p>
<h4><a name="Configuration-cache.cluster.properties"></a>cache.cluster.properties</h4>
<p>Specifies additional configuration options for the clustering. The default setting is</p>
<div class="preformatted"><div class="preformattedContent">
<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>
</div></div>
<p>See the <a href="Clustering.html" title="Clustering">Clustering</a> OSCache documentation for further details on the above two properties.</p>
</td>
</tr>
</table>
</body>
</html>

85
docs/wiki/Cron Expressions.html Normal file
View file

@ -0,0 +1,85 @@
<html>
<head>
<title>OSCache -
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">
<p>Prior to version 2.0 of <b>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>
<p><b>OSCache 2.0</b> now gives you the ability to expire content at specific dates and/or times based on a cron expression.</p>
<h3><a name="CronExpressions-WhatisaCronExpression%3F"></a>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 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>
<h3><a name="CronExpressions-HowDoesOSCacheMatchAgainstanExpression%3F"></a>How Does OSCache Match Against an Expression?</h3>
<p><b>OSCache</b> uses cron expressions in a manner that might seem 'backwards' 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>
<p>As an example, suppose you specify a cron expiry that matches every hour, on the hour ("0 * * * *"). 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><a name="CronExpressions-WhatistheDifferenceBetweentheRefreshPeriodandaCronExpression%3F"></a>What is the Difference Between the Refresh Period and a Cron Expression?</h3>
<p>The difference between the refresh period and a cron expression is that the refresh period specifies the maximum allowable age of a cache entry, whilst a cron expression specifies specific expiry times, regardless of how old an entry is. Eg imagine caching an object at 10:29am. With a refresh period of 30 minutes that entry would expire at 10:59am. With a cron expression of "0,30 * * * *" that entry would expire at 10:30am.</p>
<h3><a name="CronExpressions-TheCronExpressionSyntax"></a>The Cron Expression Syntax</h3>
<p>A cron expression consists of the following 5 fields:</p>
<ul>
<li><b>Minute</b> - specifies what minute of the hour to expire content on. It is a number between 0 and 59.</li>
<li><b>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>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>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 'January'). Month names are case-insensitive and only the first three characters are taken into account - the rest are ignored.</li>
<li><b>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>
<p>If you don'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>
<p>As an example, an expression that expired content at 11:45pm each day during April would look like this: "45 23 * April *".</p>
<p><b>OSCache</b> also allows you to optionally specify lists, ranges and intervals (or even a combination of all three) within each field:</p>
<ul>
<li><b>Lists</b> - items in a list are delimited using the ',' character. Content expiry times will be matched against all values in the list for that field. For example, "0,15,30,45 * * * *" will expire content every quarter-hour on the quarter hour.</li>
<li><b>Ranges</b> - ranges are specified using the '-' character. A range will include all values from the start to the end value (inclusive). For example, "* * * Jan-June *" will expire content every minute only during the first 6 months of the year.</li>
<li><b>Intervals</b> - an interval is specified using the '/' character. The value to the left of the '/' character indicates either the starting point or the range of values that should be incremented over, while the value to the right of the '/' specifies the interval or step size. Some examples -
<div class="preformatted"><div class="preformattedContent">
<pre>"10/20 * * * *" is equivalent to "10,30,50 * * * *",
while "10-45/20 * * * *" 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 '*' as the left-hand value of an interval will match the same values as if you had specified a range over all possible values.
Eg "*/10 * * * *" matches minutes 0,10,20,30,40 and 50.
</pre>
</div></div></li>
</ul>
<p>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>
<h3><a name="CronExpressions-Notes"></a>Notes</h3>
<ul>
<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, "* * 31 Feb *" 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 '*' otherwise a ParseException will be thrown.</li>
<li>Leap years and local daylight savings time are taken into account. Eg "0 0 29 Feb *" 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>
</body>
</html>

81
docs/wiki/Documentation.html Normal file
View file

@ -0,0 +1,81 @@
<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">
<h3><a name="Documentation-1.Overview"></a>1. Overview</h3>
<ol>
<li><a href="What is OSCache.html" title="What is OSCache">What is OSCache</a></li>
<li><a href="License.html" title="License">License</a></li>
<li><a href="Feature List.html" title="Feature List">Feature List</a> - Details on OSCache'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><a name="Documentation-2.OSCacheversions"></a>2. OSCache versions</h3>
<ol>
<li><a href="Change Log.html" title="Change Log">Change Log</a> - See what's new in the latest version of OSCache (see also <a href="http://jira.opensymphony.com/browse/CACHE?report=com.atlassian.jira.plugin.system.project:changelog-panel" title="Visit page outside Confluence">JIRA - Change Log</a>).</li>
<li><a href="Roadmap.html" title="Roadmap">Roadmap</a> - See the expected future releases of OSCache (see also <a href="http://jira.opensymphony.com/browse/CACHE?report=com.atlassian.jira.plugin.system.project:roadmap-panel" title="Visit page outside Confluence">JIRA - Road Map</a>).</li>
<li>Build and Test Reports - <a href="http://www.opensymphony.com/oscache/junit/index.html" title="Visit page outside Confluence">Unit Test Results</a>, <a href="http://www.opensymphony.com/oscache/clover/index.html" title="Visit page outside Confluence">Clover Coverage Report</a> and <a href="http://www.opensymphony.com/oscache/dependencies/opensymphony-oscache-default.html" title="Visit page outside Confluence">Ivy Dependency Report</a></li>
</ol>
<h3><a name="Documentation-3.Tutorial"></a>3. Tutorial</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 Tutorial.html" title="CacheFilter Tutorial">CacheFilter Tutorial</a> - How to cache entire pages of your website.</li>
<li><a href="Clustering.html" title="Clustering">Clustering OSCache</a> - How to use OSCache in a cluster.</li>
<li><a href="Statistics.html" title="Statistics">Statistics</a> - How to implement a cache listener to provide cache hits and misses information.</li>
<li><a href="JMX Monitoring.html" title="JMX Monitoring">JMX Monitoring</a> - JMX Monitoring and Administration via Spring.</li>
<li><a href="API Usage.html" title="API Usage">API Usage</a> - How to use the GeneralCacheAdministrator.</li>
<li>Taking the load off: <a href="http://www.theserverside.com/articles/article.tss?l=OSCacheHelpsDatabases" title="Visit page outside Confluence">OSCache helps database cope</a> by Andres March.</li>
<li><a href="SVN and Compiling OSCache.html" title="SVN and Compiling OSCache">SVN and Compiling OSCache</a> - How to access CVS and compile OSCache.</li>
</ol>
<h3><a name="Documentation-4.ReferenceGuide"></a>4. Reference Guide</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's tags and how to use them.</li>
<li><a href="CacheFilter.html" title="CacheFilter">CacheFilter Configuration</a> - How to configure OSCache to cache entire servlet responses.</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><a name="Documentation-5.Thirdpartyintegration"></a>5. Third-party integration</h3>
<ol>
<li><a href="Hibernate.html" title="Hibernate">Hibernate</a> - How to integrate OSCache with Hibernate.</li>
<li><a href="Hibernate 2.1 and pre OSCache 2.4 support.html" title="Hibernate 2.1 and pre OSCache 2.4 support">Hibernate 2.1 and pre OSCache 2.4 support</a> - Hibernate 2.1 integration and pre OSCache 2.4 classes.</li>
<li><a href="Spring.html" title="Spring">Spring</a> - Simple configuration with no special support from Spring (taken from the <a href="http://opensource.atlassian.com/confluence/spring/display/INTEGRATE/OSCache" title="Visit page outside Confluence">Spring Integration</a>).</li>
<li><a href="http://www.jpox.org/docs/1_1/cache.html" title="Visit page outside Confluence">JPOX</a> - Integration of OSCache with JPOX transparent persistence JDO implementation.</li>
</ol>
<h3><a name="Documentation-6.Links"></a>6. Links</h3>
<ol>
<li><a href="http://www.opensymphony.com/oscache/" title="Visit page outside Confluence">Current Release Home</a></li>
<li><a href="http://forums.opensymphony.com/forum.jspa?forumID=4" title="Visit page outside Confluence">Support Forum</a></li>
<li><a href="https://oscache.dev.java.net/servlets/ProjectDocumentList" title="Visit page outside Confluence">Download Source and Binaries</a></li>
<li>The current development release is available by the <a href="http://ivyrep.opensymphony.com/opensymphony/oscache/" title="Visit page outside Confluence">Ivy Repository</a></li>
<li><a href="http://svn.opensymphony.com/svn/oscache/" title="Visit page outside Confluence">SVN Access</a> beginning with release 2.4 or <a href="https://oscache.dev.java.net/source/browse/oscache/" title="Visit page outside Confluence">CVS Access</a> until release 2.3.2</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/ProjectMailingListList" title="Visit page outside Confluence">Mailing List</a></li>
</ol>
</td>
</tr>
</table>
</body>
</html>

174
docs/wiki/FAQ.html Normal file
View file

@ -0,0 +1,174 @@
<html>
<head>
<title>OSCache -
FAQ
</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">
<p>Got a question you'd like to ask? Ask us and we'll add it to the <a href="" title="FAQ">FAQ</a>.</p>
<p>Questions</p>
<ul>
<li><a href="#FAQ-uses" title="uses on FAQ">What can I use OSCache for exactly? </a></li>
<li><a href="#FAQ-data" title="data on FAQ">Where is the data cached? </a></li>
<li><a href="#FAQ-objects" title="objects on FAQ">Can OSCache cache Java objects rather than portions of JSP pages? I mean if I create a Product object, can I cache it and use it later so that I don't have to fetch data again? </a></li>
<li><a href="#FAQ-features" title="features on FAQ">What other features does OSCache have? </a></li>
<li><a href="#FAQ-tags" title="tags on FAQ">Can you give me some examples of how the OSCache tags are used? </a></li>
<li><a href="#FAQ-nesting" title="nesting on FAQ">Can OSCache tags be nested? </a></li>
<li><a href="#FAQ-size" title="size on FAQ">What control do you have over the cache size? I can imagine the size of the in-memory cache getting very big. Is it possible to set a max cache size and then remove the least-recently-used entries from the cache? </a></li>
<li><a href="#FAQ-algorithm" title="algorithm on FAQ">How does OSCache decide which object to remove? What caching algorithm does OSCache use? </a></li>
<li><a href="#FAQ-clustering" title="clustering on FAQ">How does OSCache's clustering work? </a></li>
<li><a href="#FAQ-expire" title="expire on FAQ">What happens if I need to expire data in the cache? </a></li>
<li><a href="#FAQ-groups" title="groups on FAQ">Can you tell me more about grouping cache entries? How might this be used? </a></li>
<li><a href="#FAQ-API" title="API on FAQ">I don't want to use the taglibs, I want to access OSCache directly from within my application. Where do I start? </a></li>
</ul>
<ul>
<li><a href="#FAQ-help" title="help on FAQ">Where else can I go for help if I can't find an answer to my question here? </a></li>
</ul>
<h4><a name="FAQ-WhatcanIuseOSCacheforexactly%3F"></a><a name="FAQ-uses"></a>What can I use OSCache for exactly?</h4>
<p>OSCache can be used on three different levels:</p>
<ul>
<li>JSP Caching - The first and simplest approach is to use the supplied taglibs to cache portions of JSP pages after the page has been rendered. This sounds simple but it's remarkably powerful and useful for almost every JSP application.</li>
<li>Request Caching - OSCache comes with a filter that allows you to cache entire HTTP responses - including dynamically generated images!</li>
<li>General-Purpose Cache - You can also use OSCache as a general-purpose caching solution by calling its API directly from your code. This allows arbitrary Java objects to be cached, and provides more control over the cache's behaviour. Note that any Java application can use OSCache in this manner; there is no requirement for a web server to be present when calling the API directly.</li>
</ul>
<p>All three approaches can be mixed and matched within the same application.</p>
<h4><a name="FAQ-Whereisthedatacached%3F"></a><a name="FAQ-data"></a>Where is the data cached?</h4>
<p>Out of the box, OSCache is capable of caching data in memory (so it is very fast), and/or to disk (so your cache can be persistent across server restarts). Support is also provided for managing a cluster of caches across multiple servers.</p>
<p>In addition to these capabilities, it is possible to plug in custom persistence code and custom event handlers, so you could easily extend OSCache to persist cached objects to say a database or an LDAP directory.</p>
<h4><a name="FAQ-CanOSCachecacheJavaobjectsratherthanportionsofJSPpages%3FImeanifIcreateaProductobject%2CcanIcacheitanduseitlatersothatIdon%27thavetofetchdataagain%3F"></a><a name="FAQ-objects"></a>Can OSCache cache Java objects rather than portions of JSP pages? I mean if I create a Product object, can I cache it and use it later so that I don't have to fetch data again?</h4>
<p>Yes, however to do this you will need to write code that talks to the OSCache API directly. The taglibs are currently only designed to cache rendered JSP content. This should hopefully not be too big a limitation since any creation or manipulation of java objects should generally be performed in beans or MVC action classes rather than JSP scriptlets anyway.</p>
<h4><a name="FAQ-WhatotherfeaturesdoesOSCachehave%3F"></a><a name="FAQ-features"></a>What other features does OSCache have?</h4>
<p>There is a full list of features in the <a href="Feature List.html" title="Feature List">Feature List</a> documentation.</p>
<h4><a name="FAQ-CanyougivemesomeexamplesofhowtheOSCachetagsareused%3F"></a><a name="FAQ-tags"></a>Can you give me some examples of how the OSCache tags are used?</h4>
<div class="code"><div class="codeHeader"><b>Example 1</b></div><div class="codeContent">
<pre class="code-xml"><span class="code-tag">&lt;cache:cache time=<span class="code-quote">"600"</span>&gt;</span>
<span class="code-tag">&lt;%= myBean.getTitle() %&gt;</span>
<span class="code-tag">&lt;/cache:cache&gt;</span></pre>
</div></div>
<p>This will only access your EJB once every 10 minutes. Every other request it will just serve the cached JSP content that was produced the first time (this results in much faster page loading).</p>
<div class="code"><div class="codeHeader"><b>Example 2</b></div><div class="codeContent">
<pre class="code-xml"><span class="code-tag">&lt;cache:cache key=<span class="code-quote">"foobar"</span> scope=<span class="code-quote">"session"</span>&gt;</span>
<span class="code-tag">&lt;%= myBean.getTitle() %&gt;</span>
<span class="code-tag">&lt;/cache:cache&gt;</span></pre>
</div></div>
<p>This time the cache is keyed (you could have a programmatic key here too, like &lt;%= foobarString %&gt;) and it's scoped by session.</p>
<p>This is revolutionary as far as caching goes. You can now have cached content, that's different for every user! No more full page caches with no dynamic content!</p>
<div class="code"><div class="codeHeader"><b>Example 3</b></div><div class="codeContent">
<pre class="code-xml">(a very powerful &amp; useful way to use the taglibs):
<span class="code-tag">&lt;cache:cache&gt;</span>
<span class="code-tag">&lt;% try { %&gt;</span>
<span class="code-tag">&lt;%= myBean.getTitle() %&gt;</span>&gt;
<span class="code-tag">&lt;% } catch (Exception e) { %&gt;</span>
<span class="code-tag">&lt;% application.log(<span class="code-quote">"Exception occurred in myBean.getTitle(): "</span> + e); %&gt;</span>
<span class="code-tag">&lt;cache:usecached /&gt;</span>
<span class="code-tag">&lt;% } %&gt;</span>
<span class="code-tag">&lt;/cache:cache&gt;</span></pre>
</div></div>
<p>If a RemoteException occurs trying to get the EJB title (for example the database goes down) the cached content will be served so the user will not suspect a thing. No error page as per a normal JSP application. What does this mean? It means greater error tolerance in your JSP apps!</p>
<p>One example of where this is useful - when our machine restarts, our app server loads faster than the database server. No problem - because the cache is persistent, it serves cached content while the database boots, then seamlessly kicks in to the database for a cache refresh when the database is ready.</p>
<p>See the <a href="JSP Tags.html" title="JSP Tags">Tag Reference</a> and the example web application for further taglib examples.</p>
<h4><a name="FAQ-CanOSCachetagsbenested%3F"></a><a name="FAQ-nesting"></a>Can OSCache tags be nested?</h4>
<p>You can't currently nest &lt;cache&gt; tags within one another - not that you'd probably want to. It is because of the cache object being placed in the page scope for use by programmers within the tag.</p>
<p>We're not sure if anyone actually uses this so we might remove it to allow for tag nesting (presumably across includes or something).</p>
<h4><a name="FAQ-Whatcontroldoyouhaveoverthecachesize%3FIcanimaginethesizeoftheinmemorycachegettingverybig.Isitpossibletosetamaxcachesizeandthenremovetheleastrecentlyusedentriesfromthecache%3F"></a><a name="FAQ-size"></a>What control do you have over the cache size? I can imagine the size of the in-memory cache getting very big. Is it possible to set a max cache size and then remove the least-recently-used entries from the cache?</h4>
<p>You can limit the memory cache by the number of objects that are cached. When an object is added to the cache and the limit is exceeded, another object will be removed from the cache to make room.</p>
<p>Currently the disk cache can either be set to unlimited, or tied to the same size as the memory cache (ie, objects will be removed from the disk cache at the same time as they are removed from the memory cache. Depending on the useage patterns of your cache, restarting your application could mean that the disk cache might continue to grow). We understand that this is not ideal and there is room for improvement here. Stay tuned!</p>
<h4><a name="FAQ-HowdoesOSCachedecidewhichobjecttoremove%3FWhatcachingalgorithmdoesOSCacheuse%3F"></a><a name="FAQ-algorithm"></a>How does OSCache decide which object to remove? What caching algorithm does OSCache use?</h4>
<p>The caching algorithm is configurable. OSCache currently ships with 3 different algorithms - LRU (Least Recently Used), FIFO (First In First Out), and Unlimited. Should one of those not prove suitable, it is also possible to specify a custom algorithm class.</p>
<h4><a name="FAQ-HowdoesOSCache%27sclusteringwork%3F"></a><a name="FAQ-clustering"></a>How does OSCache's clustering work?</h4>
<p>The clustering is implemented as a listener that catches 'flush' events. These events are then broadcast across the network (using either the JavaGroups library or JMS) so that other nodes in the cluster can flush the relevant object(s) from their local cache. Note that for performance reasons, when objects are added to a cache they are not broadcast to other nodes. This means that each node in the cluster maintains their own relatively indedependent cache, yet still remains fresh.</p>
<p>If this mechanism does not suit your requirements, you can always code up a different solution by writing a custom event handler.</p>
<h4><a name="FAQ-WhathappensifIneedtoexpiredatainthecache%3F"></a><a name="FAQ-expire"></a>What happens if I need to expire data in the cache?</h4>
<p>Cache entries can be flushed explicitly in several ways:</p>
<ul>
<li>Individual entries can be flushed by specifying the cache key of the entry to flush eg &lt;cache:flush key="myKey" scope="application"/&gt;</li>
<li>When adding an entry to the cache, it can optionally be placed into one or more groups. An entire group of entries can then be flushed by specifying the name of the group to flush. eg &lt;cache:flush group="group1" scope="application"/&gt;</li>
<li>A pattern can be specified; all keys that contain the supplied pattern will be flushed. eg &lt;cache:flush pattern="menu" scope="application"/&gt; will flush all keys that contain the string "menu". (note that this approach is now deprecated. The cache grouping is more flexible and performs better than pattern flushing.)</li>
</ul>
<p>In addition, cached data can be expired at retrieval time by specifying a maximum age for the data, or by indicating what dates and/or times the data should expire. See the time, duration and cron attributes of the &lt;cache&gt; tag for more information.</p>
<h4><a name="FAQ-Canyoutellmemoreaboutgroupingcacheentries%3FHowmightthisbeused%3F"></a><a name="FAQ-groups"></a>Can you tell me more about grouping cache entries? How might this be used?</h4>
<p>This is a powerful feature that makes it easy to manage your cache content. Suppose you are rendering a website and the pages that you are caching depend on various factors. Perhaps they use various shared templates, some database content, and maybe some of them depend on an external data feed. By creating a cache group for each of these factors, each cached page can be placed into the group(s) that the page is dependent on. Then when say an external datafeed is updated it is trivial to flush all pages that depend on that datafeed.</p>
<div class="code"><div class="codeHeader"><b>Example 1:displayProduct.jsp</b></div><div class="codeContent">
<pre class="code-xml">...
<span class="code-tag">&lt;cache:cache key=<span class="code-quote">"myKey1"</span> groups=<span class="code-quote">"product100,datafeed"</span>&gt;</span>
<span class="code-tag">&lt;%= myProductBean.getProduct(100).getName() %&gt;</span>
<span class="code-tag">&lt;%= myDatafeedBean.getDataFeed().getTotal() %&gt;</span>
<span class="code-tag">&lt;/cache:cache&gt;</span>
...</pre>
</div></div>
<div class="code"><div class="codeHeader"><b>Example 2:updateDatafeed.jsp</b></div><div class="codeContent">
<pre class="code-xml">...
<span class="code-tag">&lt;%= myDatafeedBean.refreshDatafeed() %&gt;</span>
<span class="code-tag">&lt;%-- Flush all cache entries that depend on the datafeed --%&gt;</span>
<span class="code-tag">&lt;cache:flush group=<span class="code-quote">"datafeed"</span> scope=<span class="code-quote">"application"</span>&gt;</span>
...</pre>
</div></div>
<h4><a name="FAQ-Idon%27twanttousethetaglibs%2CIwanttoaccessOSCachedirectlyfromwithinmyapplication.WheredoIstart%3F"></a><a name="FAQ-API"></a>I don't want to use the taglibs, I want to access OSCache directly from within my application. Where do I start?</h4>
<p>We'd suggest the best place to start would be to look at the GeneralCacheAdministrator class. It provides a simple wrapper for a single cache instance and should give you all the basic functionality you need. If you want to work with multiple caches or manipulate your cache beyond what GeneralCacheAdministrator provides, consider either writing your own administrator class using GeneralCacheAdministrator as a starting point, or just create and use the Cache class directly. See the Javadocs for more information.</p>
<h4><a name="FAQ-WhereelsecanIgoforhelpifIcan%27tfindananswertomyquestionhere%3F"></a><a name="FAQ-help"></a>Where else can I go for help if I can't find an answer to my question here?</h4>
<p>The best place to try is on the OSCache <a href="https://oscache.dev.java.net/servlets/ProjectMailingListList" title="Visit page outside Confluence">mailing list</a>. It reaches a wide audience and is your best chance of getting a fast response. Remember to search the archives first to see if your question has already been answered.</p>
<p>Got a question you'd like to ask? <a href="http://wiki.opensymphony.com/display/CACHE/FAQ?showComments=true#addcomment" title="Visit page outside Confluence">Ask us</a> and we'll add it to the <a href="" title="FAQ">FAQ</a>. </p>
</td>
</tr>
</table>
</body>
</html>

133
docs/wiki/Feature List.html Normal file
View file

@ -0,0 +1,133 @@
<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">
<h3><a name="FeatureList-OSCacheFeatures"></a>OSCache Features</h3>
<h4><a name="FeatureList-Fastinmemorycaching"></a>Fast in-memory caching</h4>
<ul>
<li>OSCache allows you to store dynamic content (eg for 30 minutes) 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've ever seen.</li>
</ul>
<h4><a name="FeatureList-Persistentondiskcaching"></a>Persistent on-disk caching</h4>
<ul>
<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><a name="FeatureList-ExcellentPerformance"></a>Excellent Performance</h4>
<ul>
<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><a name="FeatureList-Clusteringsupport"></a>Clustering support</h4>
<ul>
<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><a name="FeatureList-FlexibleCachingSystem"></a>Flexible Caching System</h4>
<ul>
<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 'under the hood' 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><a name="FeatureList-SimpleJSPTagLibrary"></a>Simple JSP Tag Library</h4>
<ul>
<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><a name="FeatureList-CachingFilter"></a>Caching Filter</h4>
<ul>
<li>A Servlet 2.3 Filter allows for caching of entire pages and generated binary files (like dynamically created images or PDF files).</li>
<li>Caching of binary files is extremely useful when they are generated dynamically and the average creation time is long.</li>
<li>The <a href="CacheFilter.html" title="CacheFilter">CacheFilter</a> is using the last modified header to reduce excellently the transaction overhead and server load which speed ups the server response time.</li>
</ul>
<h4><a name="FeatureList-ComprehensiveAPI"></a>Comprehensive API</h4>
<ul>
<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><a name="FeatureList-ExceptionHandling"></a>Exception Handling</h4>
<ul>
<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><a name="FeatureList-CacheFlushing"></a>Cache Flushing</h4>
<ul>
<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><a name="FeatureList-Portablecaching"></a>Portable caching</h4>
<ul>
<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><a name="FeatureList-i18nAware"></a>i18n Aware</h4>
<ul>
<li>The caching is i18n aware and supports all encodings.</li>
</ul>
<h4><a name="FeatureList-SolidReputation"></a>Solid Reputation</h4>
<ul>
<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>
</body>
</html>

119
docs/wiki/Hibernate 2.1 Cache Adapter.html Normal file
View file

@ -0,0 +1,119 @@
<html>
<head>
<title>OSCache -
Hibernate 2.1 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">
<p>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 class="code-java"><span class="code-keyword">import</span> java.util.Properties;
<span class="code-keyword">import</span> net.sf.hibernate.cache.Cache;
<span class="code-keyword">import</span> net.sf.hibernate.cache.CacheException;
<span class="code-keyword">import</span> net.sf.hibernate.cache.Timestamper;
<span class="code-keyword">import</span> net.sf.hibernate.util.PropertiesHelper;
<span class="code-keyword">import</span> net.sf.hibernate.util.StringHelper;
<span class="code-keyword">import</span> com.opensymphony.oscache.base.Config;
<span class="code-keyword">import</span> com.opensymphony.oscache.base.CacheEntry;
<span class="code-keyword">import</span> com.opensymphony.oscache.base.NeedsRefreshException;
<span class="code-keyword">import</span> com.opensymphony.oscache.general.GeneralCacheAdministrator;
/**
* Adapter <span class="code-keyword">for</span> the OSCache implementation
*/
<span class="code-keyword">public</span> class OSCache <span class="code-keyword">implements</span> Cache {
/**
* The &lt;tt&gt;OSCache&lt;/tt&gt; cache capacity property suffix.
*/
<span class="code-keyword">public</span> <span class="code-keyword">static</span> <span class="code-keyword">final</span> <span class="code-object">String</span> OSCACHE_CAPACITY = <span class="code-quote">"cache.capacity"</span>;
<span class="code-keyword">private</span> <span class="code-keyword">static</span> <span class="code-keyword">final</span> Properties OSCACHE_PROPERTIES = <span class="code-keyword">new</span> Config().getProperties();
/**
* The OSCache 2.0 cache administrator.
*/
<span class="code-keyword">private</span> <span class="code-keyword">static</span> GeneralCacheAdministrator cache = <span class="code-keyword">new</span> GeneralCacheAdministrator();
<span class="code-keyword">private</span> <span class="code-keyword">static</span> <span class="code-object">Integer</span> capacity = PropertiesHelper.getInteger(OSCACHE_CAPACITY, OSCACHE_PROPERTIES);
<span class="code-keyword">static</span> {
<span class="code-keyword">if</span> (capacity != <span class="code-keyword">null</span>) cache.setCacheCapacity(capacity.intValue());
}
<span class="code-keyword">private</span> <span class="code-keyword">final</span> <span class="code-object">int</span> refreshPeriod;
<span class="code-keyword">private</span> <span class="code-keyword">final</span> <span class="code-object">String</span> cron;
<span class="code-keyword">private</span> <span class="code-keyword">final</span> <span class="code-object">String</span> regionName;
<span class="code-keyword">private</span> <span class="code-keyword">final</span> <span class="code-object">String</span>[] regionGroups;
<span class="code-keyword">private</span> <span class="code-object">String</span> toString(<span class="code-object">Object</span> key) {
<span class="code-keyword">return</span> <span class="code-object">String</span>.valueOf(key) + StringHelper.DOT + regionName;
}
<span class="code-keyword">public</span> OSCache(<span class="code-object">int</span> refreshPeriod, <span class="code-object">String</span> cron, <span class="code-object">String</span> region) {
<span class="code-keyword">this</span>.refreshPeriod = refreshPeriod;
<span class="code-keyword">this</span>.cron = cron;
<span class="code-keyword">this</span>.regionName = region;
<span class="code-keyword">this</span>.regionGroups = <span class="code-keyword">new</span> <span class="code-object">String</span>[] {region};
}
<span class="code-keyword">public</span> <span class="code-object">Object</span> get(<span class="code-object">Object</span> key) <span class="code-keyword">throws</span> CacheException {
<span class="code-keyword">try</span> {
<span class="code-keyword">return</span> cache.getFromCache( toString(key), refreshPeriod, cron );
}
<span class="code-keyword">catch</span> (NeedsRefreshException e) {
cache.cancelUpdate( toString(key) );
<span class="code-keyword">return</span> <span class="code-keyword">null</span>;
}
}
<span class="code-keyword">public</span> void put(<span class="code-object">Object</span> key, <span class="code-object">Object</span> value) <span class="code-keyword">throws</span> CacheException {
cache.putInCache( toString(key), value, regionGroups );
}
<span class="code-keyword">public</span> void remove(<span class="code-object">Object</span> key) <span class="code-keyword">throws</span> CacheException {
cache.flushEntry( toString(key) );
}
<span class="code-keyword">public</span> void clear() <span class="code-keyword">throws</span> CacheException {
cache.flushGroup(regionName);
}
<span class="code-keyword">public</span> void destroy() <span class="code-keyword">throws</span> CacheException {
<span class="code-keyword">synchronized</span> (cache) {
cache.destroy();
}
}
<span class="code-keyword">public</span> void lock(<span class="code-object">Object</span> key) <span class="code-keyword">throws</span> CacheException {
<span class="code-comment">// local cache, so we use synchronization
</span> }
<span class="code-keyword">public</span> void unlock(<span class="code-object">Object</span> key) <span class="code-keyword">throws</span> CacheException {
<span class="code-comment">// local cache, so we use synchronization
</span> }
<span class="code-keyword">public</span> <span class="code-object">long</span> nextTimestamp() {
<span class="code-keyword">return</span> Timestamper.next();
}
<span class="code-keyword">public</span> <span class="code-object">int</span> getTimeout() {
<span class="code-keyword">return</span> CacheEntry.INDEFINITE_EXPIRY;
}
}</pre>
</div></div>
</td>
</tr>
</table>
</body>
</html>

96
docs/wiki/Hibernate 2.1 Cache Provider.html Normal file
View file

@ -0,0 +1,96 @@
<html>
<head>
<title>OSCache -
Hibernate 2.1 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">
<p>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 class="code-java"><span class="code-keyword">import</span> java.util.Properties;
<span class="code-keyword">import</span> net.sf.hibernate.cache.Cache;
<span class="code-keyword">import</span> net.sf.hibernate.cache.CacheException;
<span class="code-keyword">import</span> net.sf.hibernate.cache.CacheProvider;
<span class="code-keyword">import</span> net.sf.hibernate.cache.Timestamper;
<span class="code-keyword">import</span> net.sf.hibernate.util.PropertiesHelper;
<span class="code-keyword">import</span> net.sf.hibernate.util.StringHelper;
<span class="code-keyword">import</span> com.opensymphony.oscache.base.CacheEntry;
<span class="code-keyword">import</span> com.opensymphony.oscache.base.Config;
/**
* Support <span class="code-keyword">for</span> OpenSymphony OSCache. This implementation assumes
* that identifiers have well-behaved &lt;tt&gt;toString()&lt;/tt&gt; methods.
*/
<span class="code-keyword">public</span> class OSCacheProvider <span class="code-keyword">implements</span> CacheProvider {
/**
* The &lt;tt&gt;OSCache&lt;/tt&gt; refresh period property suffix.
*/
<span class="code-keyword">public</span> <span class="code-keyword">static</span> <span class="code-keyword">final</span> <span class="code-object">String</span> OSCACHE_REFRESH_PERIOD = <span class="code-quote">"refresh.period"</span>;
/**
* The &lt;tt&gt;OSCache&lt;/tt&gt; CRON expression property suffix.
*/
<span class="code-keyword">public</span> <span class="code-keyword">static</span> <span class="code-keyword">final</span> <span class="code-object">String</span> OSCACHE_CRON = <span class="code-quote">"cron"</span>;
<span class="code-keyword">private</span> <span class="code-keyword">static</span> <span class="code-keyword">final</span> Properties OSCACHE_PROPERTIES = <span class="code-keyword">new</span> Config().getProperties();
/**
* Builds a <span class="code-keyword">new</span> {@link Cache} instance, and gets it's properties from the OSCache {@link Config}
* which reads the properties file (&lt;code&gt;oscache.properties&lt;/code&gt;) from the classpath.
* If the file cannot be found or loaded, an the defaults are used.
*
* @param region
* @param properties
* @<span class="code-keyword">return</span>
* @<span class="code-keyword">throws</span> CacheException
*/
<span class="code-keyword">public</span> Cache buildCache(<span class="code-object">String</span> region, Properties properties) <span class="code-keyword">throws</span> CacheException {
<span class="code-object">int</span> refreshPeriod = PropertiesHelper.getInt(
StringHelper.qualify(region, OSCACHE_REFRESH_PERIOD),
OSCACHE_PROPERTIES,
CacheEntry.INDEFINITE_EXPIRY
);
<span class="code-object">String</span> cron = OSCACHE_PROPERTIES.getProperty( StringHelper.qualify(region, OSCACHE_CRON) );
<span class="code-comment">// construct the cache
</span> <span class="code-keyword">return</span> <span class="code-keyword">new</span> OSCache(refreshPeriod, cron, region);
}
<span class="code-keyword">public</span> <span class="code-object">long</span> nextTimestamp() {
<span class="code-keyword">return</span> Timestamper.next();
}
/**
* Callback to perform any necessary initialization of the underlying cache implementation
* during SessionFactory construction.
*
* @param properties current configuration settings.
*/
<span class="code-keyword">public</span> void start(Properties properties) <span class="code-keyword">throws</span> CacheException {
}
/**
* Callback to perform any necessary cleanup of the underlying cache implementation
* during SessionFactory.close().
*/
<span class="code-keyword">public</span> void stop() {
}
}</pre>
</div></div>
</td>
</tr>
</table>
</body>
</html>

68
docs/wiki/Hibernate 2.1 and pre OSCache 2.4 support.html Normal file
View file

@ -0,0 +1,68 @@
<html>
<head>
<title>OSCache -
Hibernate 2.1 and pre OSCache 2.4 support
</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">
<table cellpadding='5' width='85%' cellspacing='8px' class='noteMacro' border="0" align='center'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="./icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b class="strong">Info</b><br />
<p>This page is intended to give integration support for Hibernate 2.1 and for pre OSCache 2.4 releases.<br/>
It's recommended to use the new <a href="Hibernate.html" title="Hibernate">Hibernate 3.2</a> classes.</p></td></tr></table>
<p><a href="http://www.hibernate.org/" title="Visit page outside Confluence">Hibernate</a> is a powerful, ultra-high performance object/relational persistence and query service for Java. Hibernate lets you develop persistent objects following common Java idiom - including association, inheritance, polymorphism, composition and the Java collections framework. Extremely fine-grained, richly typed object models are possible.</p>
<p>Hibernate 2.1 features support for plugin cache providers and is designed to integrate with distributed caches (2.1 also implements more aggressive use of the cache). <b>net.sf.hibernate.cache.CacheProvider</b> is the extension point for user-defined cache integration.</p>
<p><a href="http://www.hibernate.org/6.html" title="Visit page outside Confluence">Hibernate 2.1.1</a> or higher is required.</p>
<h3><a name="Hibernate2.1andpreOSCache2.4support-hibernate.cache.providerclass"></a>hibernate.cache.provider_class</h3>
<p>OSCache and Hibernate 2.1 integrate though OSCacheProvider. </p>
<table cellpadding='5' width='85%' cellspacing='8px' class='warningMacro' border="0" align='center'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="./icons/emoticons/forbidden.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b class="strong">Warning</b><br />
<p>Unfortunately, at this time the OSCacheProvider distributed with Hibernate 2.1.x is not suited to clustering with OSCache. A patch has been submitted to the Hibernate team but not yet applied. Even if you do not require clustering, we recommend use of these patched versions of <a href="Hibernate 2.1 Cache Provider.html" title="Hibernate 2.1 Cache Provider">OSCacheProvider</a> and <a href="Hibernate 2.1 Cache Adapter.html" title="Hibernate 2.1 Cache Adapter">OSCache</a> for Hibernate 2.x and <a href="Hibernate 3 Cache Provider.html" title="Hibernate 3 Cache Provider">OSCacheProvider</a> and <a href="Hibernate 3 Cache Adaptor.html" title="Hibernate 3 Cache Adaptor">OSCache</a> for Hibernate 3.x. Just cut-n-paste the code and use the provider class you create as the hibernate.cache.provider_class as shown below.</p></td></tr></table>
<p>To enable OSCache in Hibernate's configuration, add the following line to hibernate.cfg.xml:</p>
<div class="code"><div class="codeHeader"><b>hibernate.cfg.xml</b></div><div class="codeContent">
<pre class="code-xml"><span class="code-tag">&lt;property name=<span class="code-quote">"hibernate.cache.provider_class"</span>&gt;</span>my.patched.provider.package.OSCacheProvider<span class="code-tag">&lt;/property&gt;</span></pre>
</div></div>
<p>The default refresh period is <a href="http://www.opensymphony.com/oscache/api/com/opensymphony/oscache/base/CacheEntry.html#INDEFINITE_EXPIRY" title="Visit page outside Confluence">CacheEntry.INDEFINITE_EXPIRY</a>. The first time a cacheable query is done, the cache has no effect on speed. On the second and successive queries, the cache will be populated and available to be hit.</p>
<table cellpadding='5' width='85%' cellspacing='8px' class='noteMacro' border="0" align='center'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="./icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b class="strong">Object Identifiers</b><br />
<p>Object identifiers must have well-behaved toString() methods, because OSCache uses the toString() method for the key of the cache. Therefore it needs to create a unique identifier for the object being stored.</p></td></tr></table>
<h3><a name="Hibernate2.1andpreOSCache2.4support-CacheRegionConfiguration"></a>Cache Region Configuration</h3>
<p>To modify the refresh period, CRON expression, add the region configuration to your <a href="Configuration.html" title="Configuration">oscache.properties</a> file, as demonstrated below:</p>
<div class="preformatted"><div class="preformattedContent">
<pre>[region].refresh.period = 4000
[region].cron = * * 31 Feb *
# The maximum cache capacity can only be set per region if you use the
# net.sf.hibernate.cache.OSCacheProvider distributed with Hibernate.
[region].capacity = 5000
# The patched version distributed with OSCache only allows a single cache.capacity setting and saves memory.
</pre>
</div></div>
<p>The com.mypackage.domain.Customer is Hibernate's internal cache region, which defaults to the classname, and which can be altered by setting Hibernate's configuration property <a href="http://www.hibernate.org/hib_docs/reference/en/html/session-configuration.html" title="Visit page outside Confluence">hibernate.cache.region_prefix</a> .</p>
<h3><a name="Hibernate2.1andpreOSCache2.4support-SourceCode"></a>Source Code</h3>
<ul><li><a href="Hibernate 2.1 Cache Adapter.html" title="Hibernate 2.1 Cache Adapter">Hibernate 2.1 Cache Adapter</a></li><li><a href="Hibernate 2.1 Cache Provider.html" title="Hibernate 2.1 Cache Provider">Hibernate 2.1 Cache Provider</a></li><li><a href="Hibernate 3 Cache Adaptor.html" title="Hibernate 3 Cache Adaptor">Hibernate 3 Cache Adaptor</a></li><li><a href="Hibernate 3 Cache Provider.html" title="Hibernate 3 Cache Provider">Hibernate 3 Cache Provider</a></li></ul>
</td>
</tr>
</table>
</body>
</html>

146
docs/wiki/Hibernate 3 Cache Adaptor.html Normal file
View file

@ -0,0 +1,146 @@
<html>
<head>
<title>OSCache -
Hibernate 3 Cache Adaptor
</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">
<p>Patched version of OSCache.java for Hibernate 3 - 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 class="code-java"><span class="code-keyword">import</span> java.util.Properties;
<span class="code-keyword">import</span> java.util.Map;
<span class="code-keyword">import</span> org.hibernate.util.PropertiesHelper;
<span class="code-keyword">import</span> org.hibernate.util.StringHelper;
<span class="code-keyword">import</span> org.hibernate.cache.*;
<span class="code-keyword">import</span> com.opensymphony.oscache.base.Config;
<span class="code-keyword">import</span> com.opensymphony.oscache.base.CacheEntry;
<span class="code-keyword">import</span> com.opensymphony.oscache.base.NeedsRefreshException;
<span class="code-keyword">import</span> com.opensymphony.oscache.general.GeneralCacheAdministrator;
/**
* Adapter <span class="code-keyword">for</span> the OSCache implementation
*/
<span class="code-keyword">public</span> class OSCache <span class="code-keyword">implements</span> Cache {
/**
* The &lt;tt&gt;OSCache&lt;/tt&gt; cache capacity property suffix.
*/
<span class="code-keyword">public</span> <span class="code-keyword">static</span> <span class="code-keyword">final</span> <span class="code-object">String</span> OSCACHE_CAPACITY = <span class="code-quote">"cache.capacity"</span>;
<span class="code-keyword">private</span> <span class="code-keyword">static</span> <span class="code-keyword">final</span> Properties OSCACHE_PROPERTIES = <span class="code-keyword">new</span> Config().getProperties();
/**
* The OSCache 2.0 cache administrator.
*/
<span class="code-keyword">private</span> <span class="code-keyword">static</span> GeneralCacheAdministrator cache = <span class="code-keyword">new</span> GeneralCacheAdministrator();
<span class="code-keyword">private</span> <span class="code-keyword">static</span> <span class="code-object">Integer</span> capacity = PropertiesHelper.getInteger(OSCACHE_CAPACITY,
OSCACHE_PROPERTIES);
<span class="code-keyword">static</span> {
<span class="code-keyword">if</span> (capacity != <span class="code-keyword">null</span>) cache.setCacheCapacity(capacity.intValue());
}
<span class="code-keyword">private</span> <span class="code-keyword">final</span> <span class="code-object">int</span> refreshPeriod;
<span class="code-keyword">private</span> <span class="code-keyword">final</span> <span class="code-object">String</span> cron;
<span class="code-keyword">private</span> <span class="code-keyword">final</span> <span class="code-object">String</span> regionName;
<span class="code-keyword">private</span> <span class="code-keyword">final</span> <span class="code-object">String</span>[] regionGroups;
<span class="code-keyword">private</span> <span class="code-object">String</span> toString(<span class="code-object">Object</span> key) {
<span class="code-keyword">return</span> <span class="code-object">String</span>.valueOf(key) + <span class="code-quote">"."</span> + regionName;
}
<span class="code-keyword">public</span> OSCache(<span class="code-object">int</span> refreshPeriod, <span class="code-object">String</span> cron, <span class="code-object">String</span> region) {
<span class="code-keyword">this</span>.refreshPeriod = refreshPeriod;
<span class="code-keyword">this</span>.cron = cron;
<span class="code-keyword">this</span>.regionName = region;
<span class="code-keyword">this</span>.regionGroups = <span class="code-keyword">new</span> <span class="code-object">String</span>[] {region};
}
<span class="code-keyword">public</span> <span class="code-object">Object</span> get(<span class="code-object">Object</span> key) <span class="code-keyword">throws</span> CacheException {
<span class="code-keyword">try</span> {
<span class="code-keyword">return</span> cache.getFromCache( toString(key), refreshPeriod, cron );
}
<span class="code-keyword">catch</span> (NeedsRefreshException e) {
cache.cancelUpdate( toString(key) );
<span class="code-keyword">return</span> <span class="code-keyword">null</span>;
}
}
<span class="code-keyword">public</span> void put(<span class="code-object">Object</span> key, <span class="code-object">Object</span> value) <span class="code-keyword">throws</span> CacheException {
cache.putInCache( toString(key), value, regionGroups );
}
<span class="code-keyword">public</span> void remove(<span class="code-object">Object</span> key) <span class="code-keyword">throws</span> CacheException {
cache.flushEntry( toString(key) );
}
<span class="code-keyword">public</span> void clear() <span class="code-keyword">throws</span> CacheException {
cache.flushGroup(regionName);
}
<span class="code-keyword">public</span> void destroy() <span class="code-keyword">throws</span> CacheException {
<span class="code-keyword">synchronized</span> (cache) {
cache.destroy();
}
}
<span class="code-keyword">public</span> void lock(<span class="code-object">Object</span> key) <span class="code-keyword">throws</span> CacheException {
<span class="code-comment">// local cache, so we use synchronization
</span> }
<span class="code-keyword">public</span> void unlock(<span class="code-object">Object</span> key) <span class="code-keyword">throws</span> CacheException {
<span class="code-comment">// local cache, so we use synchronization
</span> }
<span class="code-keyword">public</span> <span class="code-object">long</span> nextTimestamp() {
<span class="code-keyword">return</span> Timestamper.next();
}
<span class="code-keyword">public</span> <span class="code-object">int</span> getTimeout() {
<span class="code-keyword">return</span> Timestamper.ONE_MS * 60000; <span class="code-comment">//ie. 60 seconds
</span> }
<span class="code-keyword">public</span> Map toMap() {
<span class="code-keyword">throw</span> <span class="code-keyword">new</span> UnsupportedOperationException();
}
<span class="code-keyword">public</span> <span class="code-object">long</span> getElementCountOnDisk() {
<span class="code-keyword">return</span> -1;
}
<span class="code-keyword">public</span> <span class="code-object">long</span> getElementCountInMemory() {
<span class="code-keyword">return</span> -1;
}
<span class="code-keyword">public</span> <span class="code-object">long</span> getSizeInMemory() {
<span class="code-keyword">return</span> -1;
}
<span class="code-keyword">public</span> <span class="code-object">String</span> getRegionName() {
<span class="code-keyword">return</span> regionName;
}
<span class="code-keyword">public</span> void update(<span class="code-object">Object</span> key, <span class="code-object">Object</span> value) <span class="code-keyword">throws</span> CacheException {
put(key, value);
}
<span class="code-keyword">public</span> <span class="code-object">Object</span> read(<span class="code-object">Object</span> key) <span class="code-keyword">throws</span> CacheException {
<span class="code-keyword">return</span> get(key);
}
}</pre>
</div></div>
</td>
</tr>
</table>
</body>
</html>

94
docs/wiki/Hibernate 3 Cache Provider.html Normal file
View file

@ -0,0 +1,94 @@
<html>
<head>
<title>OSCache -
Hibernate 3 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">
<p>Patched version of OSCacheProvider.java for Hibernate 3.0 - 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 class="code-java"><span class="code-keyword">import</span> java.util.Properties;
<span class="code-keyword">import</span> org.hibernate.util.PropertiesHelper;
<span class="code-keyword">import</span> org.hibernate.util.StringHelper;
<span class="code-keyword">import</span> org.hibernate.cache.*;
<span class="code-keyword">import</span> com.opensymphony.oscache.base.CacheEntry;
<span class="code-keyword">import</span> com.opensymphony.oscache.base.Config;
/**
* Support <span class="code-keyword">for</span> OpenSymphony OSCache. This implementation assumes
* that identifiers have well-behaved &lt;tt&gt;toString()&lt;/tt&gt; methods.
*/
<span class="code-keyword">public</span> class OSCacheProvider <span class="code-keyword">implements</span> CacheProvider {
/**
* The &lt;tt&gt;OSCache&lt;/tt&gt; refresh period property suffix.
*/
<span class="code-keyword">public</span> <span class="code-keyword">static</span> <span class="code-keyword">final</span> <span class="code-object">String</span> OSCACHE_REFRESH_PERIOD = <span class="code-quote">"refresh.period"</span>;
/**
* The &lt;tt&gt;OSCache&lt;/tt&gt; CRON expression property suffix.
*/
<span class="code-keyword">public</span> <span class="code-keyword">static</span> <span class="code-keyword">final</span> <span class="code-object">String</span> OSCACHE_CRON = <span class="code-quote">"cron"</span>;
<span class="code-keyword">private</span> <span class="code-keyword">static</span> <span class="code-keyword">final</span> Properties OSCACHE_PROPERTIES = <span class="code-keyword">new</span> Config().getProperties();
/**
* Builds a <span class="code-keyword">new</span> {@link Cache} instance, and gets it's properties from the OSCache {@link Config}
* which reads the properties file (&lt;code&gt;oscache.properties&lt;/code&gt;) from the classpath.
* If the file cannot be found or loaded, an the defaults are used.
*
* @param region
* @param properties
* @<span class="code-keyword">return</span>
* @<span class="code-keyword">throws</span> CacheException
*/
<span class="code-keyword">public</span> Cache buildCache(<span class="code-object">String</span> region, Properties properties) <span class="code-keyword">throws</span> CacheException {
<span class="code-object">int</span> refreshPeriod = PropertiesHelper.getInt(
StringHelper.qualify(region, OSCACHE_REFRESH_PERIOD),
OSCACHE_PROPERTIES,
CacheEntry.INDEFINITE_EXPIRY
);
<span class="code-object">String</span> cron = OSCACHE_PROPERTIES.getProperty( StringHelper.qualify(region, OSCACHE_CRON) );
<span class="code-comment">// construct the cache
</span> <span class="code-keyword">return</span> <span class="code-keyword">new</span> OSCache(refreshPeriod, cron, region);
}
<span class="code-keyword">public</span> <span class="code-object">long</span> nextTimestamp() {
<span class="code-keyword">return</span> Timestamper.next();
}
<span class="code-keyword">public</span> <span class="code-object">boolean</span> isMinimalPutsEnabledByDefault() {
<span class="code-keyword">return</span> <span class="code-keyword">false</span>;
}
/**
* Callback to perform any necessary cleanup of the underlying cache implementation
* during SessionFactory.close().
*/
<span class="code-keyword">public</span> void stop() {
}
/**
* Callback to perform any necessary initialization of the underlying cache implementation
* during SessionFactory construction.
*
* @param properties current configuration settings.
*/
<span class="code-keyword">public</span> void start(Properties properties) <span class="code-keyword">throws</span> CacheException {
}
}</pre>
</div></div>
</td>
</tr>
</table>
</body>
</html>

144
docs/wiki/Hibernate.html Normal file
View file

@ -0,0 +1,144 @@
<html>
<head>
<title>OSCache - Hibernate</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">
<p><a href="http://www.hibernate.org/"
title="Visit page outside Confluence">Hibernate</a> is a powerful,
ultra-high performance object/relational persistence and query service
for Java. Hibernate lets you develop persistent objects following
common Java idiom - including association, inheritance, polymorphism,
composition and the Java collections framework. Extremely
fine-grained, richly typed object models are possible.</p>
<p>Hibernate 3.2 features support for plugin cache providers and
is designed to integrate with distributed caches (3.2 also implements
more aggressive use of the cache). <b>net.sf.hibernate.cache.CacheProvider</b>
is the extension point for user-defined cache integration.</p>
<p><a href="http://www.hibernate.org/6.html"
title="Visit page outside Confluence">Hibernate Core 3.2.3 GA</a> or
higher is required.</p>
<table cellpadding='5' width='85%' cellspacing='8px'
class='warningMacro' border="0" align='center'>
<colgroup>
<col width='24'>
<col>
</colgroup>
<tr>
<td valign='top'><img src="./icons/emoticons/forbidden.gif"
width="16" height="16" align="absmiddle" alt="" border="0"></td>
<td><b class="strong">Warning</b><br />
<p>Unfortunately, at this time the OSCacheProvider distributed
with Hibernate 3.2 is not suited to clustering with OSCache. A patch
has been submitted to the Hibernate team but not yet applied. Even
if you do not require clustering, we recommend use of
OSCacheProvider and OSCache for Hibernate 3.2 delivered by OSCache
2.4 and higher. The OSCache only allows a single cache.capacity
setting and saves memory.</p>
</td>
</tr>
</table>
<h3><a name="Hibernate-hibernate.cache.providerclass"></a>hibernate.cache.provider_class</h3>
<p>OSCache and Hibernate 3.2 integrate though OSCacheProvider.</p>
<table cellpadding='5' width='85%' cellspacing='8px' class='infoMacro'
border="0" align='center'>
<colgroup>
<col width='24'>
<col>
</colgroup>
<tr>
<td valign='top'><img src="./icons/emoticons/information.gif"
width="16" height="16" align="absmiddle" alt="" border="0"></td>
<td><b class="strong">Clustering</b><br />
<p>The clustered cache invalidation only works for entity
updates when usage="nonstrict-read-write".</p>
</td>
</tr>
</table>
<p>To enable OSCache for Hibernate's second level cache add the
following line to Hibernate's configuration e.g. <em>hibernate.cfg.xml</em>:</p>
<div class="code">
<div class="codeHeader"><b>hibernate.cfg.xml</b></div>
<div class="codeContent"><pre class="code-xml"><span
class="code-tag">&lt;property name=<span class="code-quote">"hibernate.cache.provider_class"</span>&gt;</span>com.opensymphony.oscache.hibernate.OSCacheProvider<span
class="code-tag">&lt;/property&gt;</span></pre></div>
</div>
<p>The default refresh period is <a
href="http://www.opensymphony.com/oscache/api/com/opensymphony/oscache/base/CacheEntry.html#INDEFINITE_EXPIRY"
title="Visit page outside Confluence">CacheEntry.INDEFINITE_EXPIRY</a>.
The first time a cacheable query is done, the cache has no effect on
speed. On the second and successive queries, the cache will be
populated and available to be hit.</p>
<table cellpadding='5' width='85%' cellspacing='8px' class='noteMacro'
border="0" align='center'>
<colgroup>
<col width='24'>
<col>
</colgroup>
<tr>
<td valign='top'><img src="./icons/emoticons/warning.gif"
width="16" height="16" align="absmiddle" alt="" border="0"></td>
<td><b class="strong">Object Identifiers</b><br />
<p>Object identifiers must have well-behaved toString() methods,
because OSCache uses the toString() method for the key of the cache.
Therefore it needs to create a unique identifier for the object
being stored.</p>
</td>
</tr>
</table>
<h3><a name="Hibernate-CacheRegionConfiguration"></a>Cache Region
Configuration</h3>
<p>To modify the refresh period, CRON expression, add the region
configuration to your <a href="Configuration.html"
title="Configuration">oscache.properties</a> file, as demonstrated
below:</p>
<div class="preformatted">
<div class="preformattedContent"><pre>[region].refresh.period = 4000
[region].cron = * * 31 Feb *
</pre></div>
</div>
<p>The com.mypackage.domain.Customer is Hibernate's internal cache
region, which defaults to the classname, and which can be altered by
setting Hibernate's configuration property <a
href="http://www.hibernate.org/hib_docs/reference/en/html/session-configuration.html"
title="Visit page outside Confluence">hibernate.cache.region_prefix</a>
.</p>
<h3><a
name="Hibernate-ConfigureadifferentconfigurationfileforHibernate"></a>Configure
a different configuration file for Hibernate</h3>
<p>To configure a different configuration file use the following
parameter in the Hibernate's configuration:</p>
<div class="code">
<div class="codeHeader"><b>hibernate.cfg.xml</b></div>
<div class="codeContent"><pre class="code-xml"><span
class="code-tag">&lt;property name=<span class="code-quote">"com.opensymphony.oscache.configurationResourceName"</span>&gt;</span>path to oscache-hibernate.properties<span
class="code-tag">&lt;/property&gt;</span></pre></div>
</div>
</td>
</tr>
</table>
</body>
</html>

72
docs/wiki/Home.html Normal file
View file

@ -0,0 +1,72 @@
<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">
<h1><a name="Home-WelcometotheOSCachewiki."></a>Welcome to the OSCache wiki. </h1>
<p>OSCache is a caching solution that includes a JSP tag library and set of classes to perform fine grained dynamic caching of JSP content, servlet responses or arbitrary objects. It provides both in memory and persistent on disk caches, and can allow your site to have graceful error tolerance (eg if an error occurs like your db goes down, you can serve the cached content so people can still surf the site almost without knowing). Take a look at the great <a href="Feature List.html" title="Feature List">features</a> of OSCache.</p>
<p>This wiki is used for additional information as well as documentation for the latest developing version (see <a href="Change Log.html" title="Change Log">previous releases</a>).</p>
<ul>
<li><a href="Documentation.html" title="Documentation">Documentation</a>
<ul>
<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="Configuration.html" title="Configuration">Configuration</a> - Configuration options for OSCache.</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>
</ul>
</li>
</ul>
<ul>
<li><a href="https://oscache.dev.java.net/servlets/ProjectDocumentList" title="Visit page outside Confluence">Download</a> - Download Source and Binaries.</li>
</ul>
<ul>
<li>Versions
<ul>
<li><a href="Change Log.html" title="Change Log">Change Log</a> - See what's new in the latest version of OSCache.</li>
<li><a href="Roadmap.html" title="Roadmap">Roadmap</a> - See the expected future releases of OSCache.</li>
</ul>
</li>
</ul>
<ul>
<li>Contributing
<ul>
<li><a href="http://forums.opensymphony.com/forum.jspa?forumID=4" title="Visit page outside Confluence">Support Forum</a></li>
<li><a href="https://oscache.dev.java.net/servlets/ProjectMailingListList" title="Visit page outside Confluence">Mailing List</a></li>
<li><a href="http://svn.opensymphony.com/svn/oscache/" title="Visit page outside Confluence">SVN Access</a> beginning with release 2.4 or <a href="https://oscache.dev.java.net/source/browse/oscache/" title="Visit page outside Confluence">CVS Access</a> until release 2.3.2</li>
</ul>
</li>
</ul>
<ul>
<li><a href="Index.html" title="Index">Index</a></li>
</ul>
<p>OSCache's official homepage is <a href="http://www.opensymphony.com/oscache/" title="Visit page outside Confluence">http://www.opensymphony.com/oscache/</a>. There you can find the documentation of the latest production release of OSCache.</p>
</td>
</tr>
</table>
</body>
</html>

145
docs/wiki/Installation Guide.html Normal file
View file

@ -0,0 +1,145 @@
<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">
<p>This installation guide shows you how to configure OSCache 2.4
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>, which requires at least <b>Java 1.4</b> and a <b>Servlet
2.3</b> container (part of J2EE 1.3). Read the <a href="Requirements.html"
title="Requirements">Requirements</a> for more details.</p>
<p>If you intend to use OSCache via the <a href="API Usage.html"
title="API Usage">API</a> rather than via the <a href="JSP Tags.html"
title="JSP Tags">taglibs</a>, these instructions do not apply. Just
make sure <tt>oscache.jar</tt> and <tt>commons-logging.jar</tt> are
somewhere on your application's classpath.</p>
<h4><a name="InstallationGuide-ExtractionSteps"></a>Extraction
Steps</h4>
<ol>
<li>Extract the downloaded file to a directory of your choosing.</li>
<li>Put the oscache.jar file in the <tt>/WEB-INF/lib</tt>
directory</li>
<li>Make sure <tt>commons-logging.jar</tt> is on your classpath
(normally this also means putting it in <tt>/WEB-INF/lib</tt>).</li>
<li>Put the <tt>/etc/oscache.properties</tt> file in the <tt>/WEB-INF/classes</tt>
directory and edit the properties contained within it (for example if
you want disk caching, configure the persistence listener and edit
the <tt>cache.path</tt> 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>Your directory structure should now look something like
this:
<div class="panel">
<div class="panelContent">
<p>$WEB_APPLICATION/WEB-INF/lib/oscache.jar<br />
$WEB_APPLICATION/WEB-INF/classes/oscache.properties</p>
</div>
</div>
</li>
</ol>
<table cellpadding='5' width='85%' cellspacing='8px' class='infoMacro'
border="0" align='center'>
<colgroup>
<col width='24'>
<col>
</colgroup>
<tr>
<td valign='top'><img src="./icons/emoticons/information.gif"
width="16" height="16" align="absmiddle" alt="" border="0"></td>
<td><b class="strong">Windows</b><br />
<p>Remember to escape any \ characters in Windows paths - e.g.
if you want cache files to go in c:\cachedir, the <tt>cache.path</tt>
property should be set to c:\ \cachedir.</p>
</td>
</tr>
</table>
<h4><a name="InstallationGuide-InstallationSteps"></a>Installation
Steps</h4>
<ol>
<li>Now add the appropriate <a href="JSP Tags.html"
title="JSP Tags">JSP Tags</a> to your JSP files and you'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't work in your container.</li>
</ol>
<h4><a name="InstallationGuide-FurtherInformation"></a>Further
Information</h4>
<table class="sectionMacro" border="0" cellpadding="5" cellspacing="0"
width="100%">
<tbody>
<tr>
<td class="confluenceTd" valign="top" width="50%">
<table cellpadding='5' width='85%' cellspacing='8px'
class='infoMacro' border="0" align='center'>
<colgroup>
<col width='24'>
<col>
</colgroup>
<tr>
<td valign='top'><img
src="./icons/emoticons/information.gif" width="16" height="16"
align="absmiddle" alt="" border="0"></td>
<td><b class="strong">Logging</b><br />
<p>OSCache uses <a
href="http://jakarta.apache.org/commons/logging/"
title="Visit page outside Confluence">Jakarta Commons
Logging</a> for logging any messages. Please see the <a
href="http://jakarta.apache.org/commons/logging/guide.html#Configuration"
title="Visit page outside Confluence">Commons Logging
documentation</a> for details on logging configuration.</p>
</td>
</tr>
</table>
</td>
<td class="confluenceTd" valign="top" width="50%">
<table cellpadding='5' width='85%' cellspacing='8px'
class='tipMacro' border="0" align='center'>
<colgroup>
<col width='24'>
<col>
</colgroup>
<tr>
<td valign='top'><img src="./icons/emoticons/check.gif"
width="16" height="16" align="absmiddle" alt="" border="0"></td>
<td><b class="strong">Debugging</b><br />
<p>Note that OSCache has been compiled with debugging
information enabled so you should be able to use your favourite
debugger to step through the source if need be.</p>
</td>
</tr>
</table>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
</table>
</body>
</html>

68
docs/wiki/JMX Monitoring.html Normal file
View file

@ -0,0 +1,68 @@
<html>
<head>
<title>OSCache -
Monitoring
</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">
<p>New in OSCache 2.4 is support for JMX monitoring and administration via the <a href="http://www.springframework.org" title="Visit page outside Confluence">Spring Framework</a>.</p>
<p>In oscache.properties, enable the statistic listener:</p>
<div class="preformatted"><div class="preformattedContent">
<pre>cache.event.listeners= com.opensymphony.oscache.extra.StatisticListenerImpl
</pre>
</div></div>
<p>Then add this to the Spring application context</p>
<div class="code"><div class="codeContent">
<pre class="code-xml">&lt;!-- create mbeanserver, this doesn't need to be done if running on an Appserver with
it's own JMX server, such as Tomcat --&gt;
<span class="code-tag">&lt;bean id=<span class="code-quote">"mbeanServer"</span> class=<span class="code-quote">"org.springframework.jmx.support.MBeanServerFactoryBean"</span>/&gt;</span>
<span class="code-tag"><span class="code-comment">&lt;!-- create a connector on port 1109 --&gt;</span></span>
&lt;bean id=<span class="code-quote">"registry"</span>
class=<span class="code-quote">"org.springframework.remoting.rmi.RmiRegistryFactoryBean"</span>&gt;
<span class="code-tag">&lt;property name=<span class="code-quote">"port"</span>&gt;</span>
<span class="code-tag">&lt;value&gt;</span>1109<span class="code-tag">&lt;/value&gt;</span>
<span class="code-tag">&lt;/property&gt;</span>
<span class="code-tag">&lt;/bean&gt;</span>
&lt;bean id=<span class="code-quote">"serverConnector"</span> depends-on=<span class="code-quote">"registry"</span>
class=<span class="code-quote">"org.springframework.jmx.support.ConnectorServerFactoryBean"</span>&gt;
<span class="code-tag">&lt;property name=<span class="code-quote">"objectName"</span>&gt;</span>
<span class="code-tag">&lt;value&gt;</span>connector:name=rmi<span class="code-tag">&lt;/value&gt;</span>
<span class="code-tag">&lt;/property&gt;</span>
<span class="code-tag">&lt;property name=<span class="code-quote">"serviceUrl"</span>&gt;</span>
<span class="code-tag">&lt;value&gt;</span>service:jmx:rmi://localhost/jndi/rmi://localhost:1109/jmxconnector<span class="code-tag">&lt;/value&gt;</span>
<span class="code-tag">&lt;/property&gt;</span>
<span class="code-tag">&lt;/bean&gt;</span>
<span class="code-tag"><span class="code-comment">&lt;!-- export the oscache stats beans --&gt;</span></span>
&lt;bean id=<span class="code-quote">"exporter"</span>
class=<span class="code-quote">"org.springframework.jmx.export.MBeanExporter"</span>&gt;
<span class="code-tag">&lt;property name=<span class="code-quote">"beans"</span>&gt;</span>
<span class="code-tag">&lt;map&gt;</span>
<span class="code-tag">&lt;entry key=<span class="code-quote">"bean:name=StatisticListenerImpl"</span>&gt;</span>
<span class="code-tag">&lt;value&gt;</span>StatisticListenerImpl<span class="code-tag">&lt;/value&gt;</span>
<span class="code-tag">&lt;/entry&gt;</span>
<span class="code-tag">&lt;/map&gt;</span>
<span class="code-tag">&lt;/property&gt;</span>
<span class="code-tag">&lt;/bean&gt;</span>
<span class="code-tag"><span class="code-comment">&lt;!-- oscache stats bean --&gt;</span></span>
<span class="code-tag">&lt;bean id=<span class="code-quote">"StatisticListenerImpl"</span> class=<span class="code-quote">"com.opensymphony.oscache.extra.StatisticListenerImpl"</span>/&gt;</span></pre>
</div></div>
</td>
</tr>
</table>
</body>
</html>

230
docs/wiki/JSP Tags.html Normal file
View file

@ -0,0 +1,230 @@
<html>
<head>
<title>OSCache -
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">
<p><b>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>
<p>For instructions on installing OSCache in a web application, see the <a href="Installation Guide.html" title="Installation Guide">Installation Guide</a>. You just have to add the following line declaring the OSCache custom tag library for use on the jsp page:</p>
<table cellpadding='5' width='85%' cellspacing='8px' class='tipMacro' border="0" align='center'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="./icons/emoticons/check.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b class="strong">Taglib URI</b><br />
<p><tt>&lt;%@ taglib uri="http://www.opensymphony.com/oscache" prefix="cache" %&gt;</tt></p>
<p>In OSCache releases before 2.1.1 you have to change the URI to <tt>/oscache</tt>, see <a href="http://jira.opensymphony.com/browse/CACHE-61" title="Visit page outside Confluence">CACHE-61</a>.</p></td></tr></table>
<h3><a name="JSPTags-Summary"></a>Summary</h3>
<p>The tags are:</p>
<ul>
<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> - It allows a single group name to be dynamically added to a cached block. This tag must be nested inside &lt;cache:cache/&gt;.</li>
<li><a href="#JSPTags-addgroups" title="addgroups on JSP Tags">addgroups</a> - It allows a comma-delimited list of group names to be dynamically added to a cached block. This tag must be nested inside &lt;cache:cache/&gt;.</li>
</ul>
<table cellpadding='5' width='85%' cellspacing='8px' class='infoMacro' border="0" align='center'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="./icons/emoticons/information.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b class="strong">Tag Legend</b><br />
<ul>
<li>For all listed attributes, <font color="red">req</font> means it that attribute is required and any value in <b>[ ]</b> is a default value. All attributes can accept runtime expressions.</li>
</ul>
<ul>
<li>From the title of the tag you can see whether or not the tag has a body:
<ul>
<li><b>&lt;tag&gt;&lt;/tag&gt;</b> tags always have a body</li>
<li><b>&lt;tag /&gt;</b> does not have a body</li>
<li><b>&lt;tag /&gt;&lt;/tag&gt;</b> can have a body or not depending on the circumstances.</li>
</ul>
</li>
</ul>
</td></tr></table>
<h3><a name="JSPTags-%3Ccache%3E%3C%2Fcache%3E"></a><a name="JSPTags-cache"></a>&lt;cache&gt;&lt;/cache&gt;</h3>
<h4><a name="JSPTags-Description%3A"></a>Description:</h4>
<p> 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>
<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:</p>
<ul>
<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>
<p> 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>
<h4><a name="JSPTags-Attributes%3A"></a>Attributes:</h4>
<ul>
<li><b>key</b> - [The request URI + query string] - 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>scope</b> - [application] - The scope of this cache (valid values are "application" and "session").</li>
<li><b>time</b> - [3600] 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>duration</b> - [] - 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>cron</b> - [] - 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>refresh</b> - [false] - 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>mode</b> - [] - Setting this to "silent" 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>groups</b> - [] - 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>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's preferences.</li>
<li><b>refreshpolicyclass</b> - [] - 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>refreshpolicyparam</b> - [] - 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 class="code-xml">This will cache the JSP content using the current URI as a key (which means this must be the only cache tag on the page to work).
<span class="code-tag">&lt;cache:cache&gt;</span>
... some jsp content ...
<span class="code-tag">&lt;/cache:cache&gt;</span>
This will cache the content with a constant key in the user's session scope. Any page that uses this key will access one shared cache.
<span class="code-tag">&lt;cache:cache key=<span class="code-quote">"foobar"</span> scope=<span class="code-quote">"session"</span>&gt;</span>
... some jsp content ...
<span class="code-tag">&lt;/cache:cache&gt;</span>
This will cache the content with a programmatic key (here a product ID) for 30 minutes. It will also refresh if the variable needRefresh
is true.
<span class="code-tag">&lt;cache:cache key=<span class="code-quote">"&lt;%= product.getId() %&gt;</span>"</span> time=<span class="code-quote">"1800"</span> refresh=<span class="code-quote">"<span class="code-tag">&lt;%= needRefresh %&gt;</span>"</span>&gt;
... some jsp content ...
<span class="code-tag">&lt;/cache:cache&gt;</span>
This will cache the content with a programmatic key, expiring it every morning at 2am. It will also refresh if the variable needRefresh
is true.
<span class="code-tag">&lt;cache:cache key=<span class="code-quote">"&lt;%= product.getId() %&gt;</span>"</span> cron=<span class="code-quote">"0 2 * * *"</span> refresh=<span class="code-quote">"<span class="code-tag">&lt;%= needRefresh %&gt;</span>"</span>&gt;
... some jsp content ...
<span class="code-tag">&lt;/cache:cache&gt;</span>
Suppose we had a dynamic list of categories that we pull from a database, and we also store currency exchange rates that get updated
occasionally by calling a webservice. Suppose also that we have some content that displays information about both the categories and the
current exchange rate values. The following example caches the body content and assigns it to two cache groups, <span class="code-quote">"currencyData"</span> and
<span class="code-quote">"categoryList"</span>. When the exchange rates or the category list is updated, the appropriate group can be flushed causing this content (along
with any other content associated with that group) to be exipired and then rebuilt the next time the page is processed:
<span class="code-tag">&lt;cache:cache key=<span class="code-quote">"&lt;%= product.getId() %&gt;</span>"</span> time=<span class="code-quote">"-1"</span> group=<span class="code-quote">"currencyData, categories"</span>&gt;
... display category list ...
... display currency information ...
<span class="code-tag">&lt;/cache:cache&gt;</span></pre>
</div></div></li>
</ul>
<h3><a name="JSPTags-%3Cusecached%2F%3E"></a><a name="JSPTags-usecached"></a>&lt;usecached /&gt;</h3>
<h4><a name="JSPTags-Description%3A"></a>Description:</h4>
<p>This tag is nested within a &lt;cache&gt; tag and tells its parent whether or not to use the cached version.</p>
<h4><a name="JSPTags-Attributes%3A"></a>Attributes:</h4>
<ul>
<li><b>use</b> - [true] - 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 class="code-xml">This is a good example of error tolerance. If an exception occurs, the cached version of this content will be output instead.
<span class="code-tag">&lt;cache:cache&gt;</span>
<span class="code-tag">&lt;% try { %&gt;</span>
... some jsp content ...
<span class="code-tag">&lt;% } catch (Exception e) { %&gt;</span>
<span class="code-tag">&lt;cache:usecached /&gt;</span>
<span class="code-tag">&lt;% } %&gt;</span>
<span class="code-tag">&lt;/cache:cache&gt;</span></pre>
</div></div></li>
</ul>
<h3><a name="JSPTags-%3Cflush%2F%3E"></a><a name="JSPTags-flush"></a>&lt;flush /&gt;</h3>
<h4><a name="JSPTags-Description%3A"></a>Description:</h4>
<p> 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>
<h4><a name="JSPTags-Attributes%3A"></a>Attributes:</h4>
<ul>
<li><b>scope</b> - [all] - This decides what scope will be flushed. Valid values are "application", "session" and null. A null scope will flush all caches, regardless of their scope.</li>
<li><b>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>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>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>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's preferences.</li>
</ul>
<div class="code"><div class="codeHeader"><b>Example</b></div><div class="codeContent">
<pre class="code-xml">This will flush the application scope.
<span class="code-tag">&lt;cache:flush scope=<span class="code-quote">"application"</span> /&gt;</span>
This will flush the cache entry with key <span class="code-quote">"foobar"</span> in the session scope.
<span class="code-tag">&lt;cache:flush scope=<span class="code-quote">"session"</span> key=<span class="code-quote">"foobar"</span> /&gt;</span>
This will flush all cache entries in the <span class="code-quote">"currencyData"</span> group from the application scope.
<span class="code-tag">&lt;cache:flush scope=<span class="code-quote">"application"</span> group=<span class="code-quote">"currencyData"</span> /&gt;</span></pre>
</div></div>
<h3><a name="JSPTags-%3Caddgroup%2F%3E"></a><a name="JSPTags-addgroup"></a>&lt;addgroup /&gt;</h3>
<h4><a name="JSPTags-Description%3A"></a>Description:</h4>
<p> This tag must be nested inside a &lt;cache:cache/&gt; tag. It allows a single group name to be dynamically added to a cached block. It is useful when the group a cached block should belong to are unknown until the block is actually rendered. As each group is 'discovered', this tag can be used to add the group to the block's group list.</p>
<h4><a name="JSPTags-Attributes%3A"></a>Attributes:</h4>
<ul>
<li><b>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="codeHeader"><b>Example</b></div><div class="codeContent">
<pre class="code-xml">This will add the cache block with the key 'test1' to groups 'group1' and 'group2'.
<span class="code-tag">&lt;cache:cache key=<span class="code-quote">"test1"</span>&gt;</span>
<span class="code-tag">&lt;cache:addgroup group=<span class="code-quote">"group1"</span> /&gt;</span>
... some jsp content ...
<span class="code-tag">&lt;cache:addgroup group=<span class="code-quote">"group2"</span> /&gt;</span>
... some more jsp content ...
<span class="code-tag">&lt;/cache:cache&gt;</span></pre>
</div></div>
<h3><a name="JSPTags-%3Caddgroups%2F%3E%28New%5C%21Since2.3%29"></a><a name="JSPTags-addgroups"></a>&lt;addgroups /&gt; (New&#33; Since 2.3)</h3>
<h4><a name="JSPTags-Description%3A"></a>Description:</h4>
<p> This tag must be nested inside a &lt;cache:cache/&gt; tag. It allows a comma-delimited list of groups names to be dynamically added to a cached block with a single tag statement. As a group list is 'discovered', this tag can be used to add the groups to the block's group list.</p>
<h4><a name="JSPTags-Attributes%3A"></a>Attributes:</h4>
<ul>
<li><b>groups</b> - <font color="red">req</font> - The comma-delimited list of groups names to add the enclosing cache block to.</li>
</ul>
<div class="code"><div class="codeHeader"><b>Example</b></div><div class="codeContent">
<pre class="code-xml">This will add the cache block with the key 'test1' to groups 'group1' and 'group2'.
<span class="code-tag">&lt;cache:cache key=<span class="code-quote">"test1"</span>&gt;</span>
... some jsp content ...
<span class="code-tag">&lt;cache:addgroups groups=<span class="code-quote">"group1,group2"</span> /&gt;</span>
... some jsp content ...
<span class="code-tag">&lt;/cache:cache&gt;</span></pre>
</div></div>
</td>
</tr>
</table>
</body>
</html>

20
docs/wiki/License.html Normal file
View file

@ -0,0 +1,20 @@
<html>
<head>
<title>OSCache -
License
</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">
<p>All OpenSymphony projects use the OpenSymphony License, which is a modified Apache License. You can find the license at <a href="http://www.opensymphony.com/oscache/license.action" title="Visit page outside Confluence">http://www.opensymphony.com/oscache/license.action</a></p>
</td>
</tr>
</table>
</body>
</html>

29
docs/wiki/OSCache 1.0 beta 0.html Normal file
View file

@ -0,0 +1,29 @@
<html>
<head>
<title>OSCache -
OSCache 1.0 beta 0
</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">
<h3><a name="OSCache1.0beta0-ReleaseNotes"></a>Release Notes</h3>
<p>(26th November, 2000 - by Mike Cannon-Brookes, mike@atlassian.com)</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>
</td>
</tr>
</table>
</body>
</html>

30
docs/wiki/OSCache 1.0 beta 1.html Normal file
View file

@ -0,0 +1,30 @@
<html>
<head>
<title>OSCache -
OSCache 1.0 beta 1
</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">
<h3><a name="OSCache1.0beta1-ReleaseNotes"></a>Release Notes</h3>
<p>(20th February, 2001 - by Mike Cannon-Brookes, mike@atlassian.com)</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 to flush individual keys.</li>
</ul>
</td>
</tr>
</table>
</body>
</html>

29
docs/wiki/OSCache 1.0 beta 2.html Normal file
View file

@ -0,0 +1,29 @@
<html>
<head>
<title>OSCache -
OSCache 1.0 beta 2
</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">
<h3><a name="OSCache1.0beta2-ReleaseNotes"></a>Release Notes</h3>
<p>(20th March, 2001 - by Mike Cannon-Brookes, mike@atlassian.com)</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>
</td>
</tr>
</table>
</body>
</html>

31
docs/wiki/OSCache 1.1.html Normal file
View file

@ -0,0 +1,31 @@
<html>
<head>
<title>OSCache -
OSCache 1.1
</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">
<h3><a name="OSCache1.1-ReleaseNotes"></a>Release Notes</h3>
<p>(25th March, 2001 - by Mike Cannon-Brookes, mike@atlassian.com)</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>
</td>
</tr>
</table>
</body>
</html>

29
docs/wiki/OSCache 1.2.1.html Normal file
View file

@ -0,0 +1,29 @@
<html>
<head>
<title>OSCache -
OSCache 1.2.1
</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">
<h3><a name="OSCache1.2.1-ReleaseNotes"></a>Release Notes</h3>
<p>(10th May, 2001 - by Mike Cannon-Brookes, mike@atlassian.com)</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>
</td>
</tr>
</table>
</body>
</html>

28
docs/wiki/OSCache 1.2.5.html Normal file
View file

@ -0,0 +1,28 @@
<html>
<head>
<title>OSCache -
OSCache 1.2.5
</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">
<h3><a name="OSCache1.2.5-ReleaseNotes"></a>Release Notes</h3>
<p>(18th May, 2001 - by Mike Cannon-Brookes, mike@atlassian.com)</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>
</td>
</tr>
</table>
</body>
</html>

27
docs/wiki/OSCache 1.2.html Normal file
View file

@ -0,0 +1,27 @@
<html>
<head>
<title>OSCache -
OSCache 1.2
</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">
<h3><a name="OSCache1.2-ReleaseNotes"></a>Release Notes</h3>
<p>(28th March, 2001 - by Mike Cannon-Brookes, mike@atlassian.com)</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 <img class="emoticon" src="./icons/emoticons/wink.gif" height="20" width="20" align="absmiddle" alt="" border="0"/></li>
</ul>
</td>
</tr>
</table>
</body>
</html>

30
docs/wiki/OSCache 1.3.html Normal file
View file

@ -0,0 +1,30 @@
<html>
<head>
<title>OSCache -
OSCache 1.3
</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">
<h3><a name="OSCache1.3-ReleaseNotes"></a>Release Notes</h3>
<p>(9th June, 2001 - by Mike Cannon-Brookes, mike@atlassian.com)</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>
</td>
</tr>
</table>
</body>
</html>

34
docs/wiki/OSCache 1.5.html Normal file
View file

@ -0,0 +1,34 @@
<html>
<head>
<title>OSCache -
OSCache 1.5
</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">
<h3><a name="OSCache1.5-ReleaseNotes"></a>Release Notes</h3>
<p>(6th August, 2001 - by Todd Gochenour, tgochenour@peregrine.com)</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>
</td>
</tr>
</table>
</body>
</html>

32
docs/wiki/OSCache 1.6.1.html Normal file
View file

@ -0,0 +1,32 @@
<html>
<head>
<title>OSCache -
OSCache 1.6.1
</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">
<h3><a name="OSCache1.6.1-ReleaseNotes"></a>Release Notes</h3>
<p>(16th September, 2001 - by Todd Gochenour, tgochenour@peregrine.com)</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>
</td>
</tr>
</table>
</body>
</html>

31
docs/wiki/OSCache 1.6.html Normal file
View file

@ -0,0 +1,31 @@
<html>
<head>
<title>OSCache -
OSCache 1.6
</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">
<h3><a name="OSCache1.6-ReleaseNotes"></a>Release Notes</h3>
<p>(5th September, 2001 - by Mike Cannon-Brookes, mike@atlassian.com)</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>
</td>
</tr>
</table>
</body>
</html>

56
docs/wiki/OSCache 1.7.0.html Normal file
View file

@ -0,0 +1,56 @@
<html>
<head>
<title>OSCache -
OSCache 1.7.0
</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">
<h3><a name="OSCache1.7.0-ReleaseNotes"></a>Release Notes</h3>
<p>(26th September 2001 - by Francois Beauregard, fbeauregard@pyxis-tech.com, and<br/>
Alain Bergevin, abergevin@pyxis-tech.com, of Pyxis Technologies Inc.)</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>
</td>
</tr>
</table>
</body>
</html>

38
docs/wiki/OSCache 1.7.1.html Normal file
View file

@ -0,0 +1,38 @@
<html>
<head>
<title>OSCache -
OSCache 1.7.1
</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">
<h3><a name="OSCache1.7.1-ReleaseNotes"></a>Release Notes</h3>
<p>(26th September 2001 - by Francois Beauregard, fbeauregard@pyxis-tech.com, and<br/>
Alain Bergevin, abergevin@pyxis-tech.com, of Pyxis Technologies Inc.)</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>
</td>
</tr>
</table>
</body>
</html>

30
docs/wiki/OSCache 1.7.2.html Normal file
View file

@ -0,0 +1,30 @@
<html>
<head>
<title>OSCache -
OSCache 1.7.2
</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">
<h3><a name="OSCache1.7.2-ReleaseNotes"></a>Release Notes</h3>
<p>(31st October 2001 - by Mike Cannon-Brookes, mike@atlassian.com)</p>
<ul>
<li>Cleaned up <em>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>
</td>
</tr>
</table>
</body>
</html>

29
docs/wiki/OSCache 1.7.3.html Normal file
View file

@ -0,0 +1,29 @@
<html>
<head>
<title>OSCache -
OSCache 1.7.3
</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">
<h3><a name="OSCache1.7.3-ReleaseNotes"></a>Release Notes</h3>
<p>(11th November 2001 - by Francois Beauregard, fbeauregard@pyxis-tech.com)</p>
<ul>
<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>
</td>
</tr>
</table>
</body>
</html>

28
docs/wiki/OSCache 1.7.4.html Normal file
View file

@ -0,0 +1,28 @@
<html>
<head>
<title>OSCache -
OSCache 1.7.4
</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">
<h3><a name="OSCache1.7.4-ReleaseNotes"></a>Release Notes</h3>
<p>(3rd December 2001 - by Francois Beauregard, fbeauregard@pyxis-tech.com, and<br/>
Mike Cannon-Brookes, mike@atlassian.com)</p>
<ul>
<li>Made all servlet cache components serializable (fixes bug reported on list with JRun)</li>
</ul>
</td>
</tr>
</table>
</body>
</html>

28
docs/wiki/OSCache 1.7.5.html Normal file
View file

@ -0,0 +1,28 @@
<html>
<head>
<title>OSCache -
OSCache 1.7.5
</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">
<h3><a name="OSCache1.7.5-ReleaseNotes"></a>Release Notes</h3>
<p>(5th January 2002 - by Mike Cannon-Brookes, mike@atlassian.com)</p>
<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>
</td>
</tr>
</table>
</body>
</html>

96
docs/wiki/OSCache 2.0 beta 1.html Normal file
View file

@ -0,0 +1,96 @@
<html>
<head>
<title>OSCache -
OSCache 2.0 beta 1
</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">
<h3><a name="OSCache2.0beta1-ReleaseNotes"></a>Release Notes</h3>
<p>(19th July 2003 - by Chris Miller)</p>
<h4><a name="OSCache2.0beta1-NewFeatures%3A"></a>New Features:</h4>
<ul>
<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 '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 <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="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>
<h4><a name="OSCache2.0beta1-Changesthatmayaffectbackwardscompatibility%3A"></a>Changes that may affect backwards compatibility:</h4>
<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="..."/&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="..."/&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 '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 <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'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.&#42;" to "com.opensymphony.oscache.&#42;". Any code or configuration files that refer to "com.opensymphony.module.oscache" will need to be updated.</li>
</ul>
<h4><a name="OSCache2.0beta1-BugFixes%3A"></a>Bug Fixes:</h4>
<ul>
<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> "cache" Tag has no "setEncoding" 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 - "ant example-war". Once deployed this can be tested using "ant test-web".</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'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">http://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'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>
<h4><a name="OSCache2.0beta1-KnownProblems%3A%28thesehaveexistedforsometimeinthe1.x.xversionsandwillbeaddressedinanupcoming2.x.xrelease%29"></a>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)</h4>
<ul>
<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>
</td>
</tr>
</table>
</body>
</html>

44
docs/wiki/OSCache 2.0 beta 2.html Normal file
View file

@ -0,0 +1,44 @@
<html>
<head>
<title>OSCache -
OSCache 2.0 beta 2
</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">
<h3><a name="OSCache2.0beta2-ReleaseNotes"></a>Release Notes</h3>
<p>(4th August 2003 - by Chris Miller)</p>
<h4><a name="OSCache2.0beta2-NewFeatures%3A"></a>New Features:</h4>
<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>
<h4><a name="OSCache2.0beta2-BugFixes%3A"></a>Bug Fixes:</h4>
<ul>
<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's app scope cache is created on startup (via the CacheContextListener).</li>
</ul>
</td>
</tr>
</table>
</body>
</html>

46
docs/wiki/OSCache 2.0.1.html Normal file
View file

@ -0,0 +1,46 @@
<html>
<head>
<title>OSCache -
OSCache 2.0.1
</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">
<h3><a name="OSCache2.0.1-ReleaseNotes"></a>Release Notes</h3>
<p>(4th November 2003 - by Chris Miller)</p>
<h4><a name="OSCache2.0.1-Improvements%3A"></a>Improvements:</h4>
<ul>
<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><a name="OSCache2.0.1-BugFixes%3A"></a>Bug Fixes:</h4>
<ul>
<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><a name="OSCache2.0.1-Changesthatmayaffectbackwardscompatibility%3A"></a>Changes that may affect backwards compatibility:</h4>
<ul>
<li>StringUtil.split() now returns a List rather than a String[].</li>
</ul>
</td>
</tr>
</table>
</body>
</html>

41
docs/wiki/OSCache 2.0.2.html Normal file
View file

@ -0,0 +1,41 @@
<html>
<head>
<title>OSCache -
OSCache 2.0.2
</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">
<h3><a name="OSCache2.0.2-ReleaseNotes"></a>Release Notes</h3>
<p>(22nd January 2004 - by Mathias Bogaert)</p>
<h4><a name="OSCache2.0.2-Improvements%3A"></a>Improvements:</h4>
<ul>
<li>Website documentation updates.</li>
<li>Added OSCache in the Wild.</li>
</ul>
<h4><a name="OSCache2.0.2-BugFixes%3A"></a>Bug Fixes:</h4>
<ul>
<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>
</td>
</tr>
</table>
</body>
</html>

41
docs/wiki/OSCache 2.0.html Normal file
View file

@ -0,0 +1,41 @@
<html>
<head>
<title>OSCache -
OSCache 2.0
</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">
<h3><a name="OSCache2.0-ReleaseNotes"></a>Release Notes</h3>
<p>(22nd September 2003 - by Chris Miller)</p>
<h4><a name="OSCache2.0-Improvements%3A"></a>Improvements:</h4>
<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>
<h4><a name="OSCache2.0-BugFixes%3A"></a>Bug Fixes:</h4>
<ul>
<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't working correctly.</li>
</ul>
</td>
</tr>
</table>
</body>
</html>

289
docs/wiki/OSCache 2.1.1.html Normal file
View file

@ -0,0 +1,289 @@
<html>
<head>
<title>OSCache -
OSCache 2.1.1
</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">
<h3><a name="OSCache2.1.1-ReleaseNotes"></a>Release Notes</h3>
<p>(1st May 2005 - by Andres March)</p>
<h4><a name="OSCache2.1.1-Improvements%3A"></a>Improvements:</h4>
<ul>
<li>The taglib URI was changed to <tt><a href="http://www.opensymphony.com/oscache" title="Visit page outside Confluence">http://www.opensymphony.com/oscache</a></tt> in <a href="http://jira.opensymphony.com/browse/CACHE-61" title="Visit page outside Confluence">CACHE-61</a></li>
<li>The DiskPersistenceListener escapes '?' now and guarantees that the filenames will be unique based on the cache key, see <a href="http://jira.opensymphony.com/browse/CACHE-110" title="Visit page outside Confluence">CACHE-110</a></li>
<li>Session objects in cache tags are created only if necessary, see <a href="http://jira.opensymphony.com/browse/CACHE-88" title="Visit page outside Confluence">CACHE-88</a></li>
<li>The disk persistence configuration key can be accessed now, see <a href="http://jira.opensymphony.com/browse/CACHE-111" title="Visit page outside Confluence">CACHE-111</a></li>
</ul>
<h4><a name="OSCache2.1.1-BugFixes%3A"></a>Bug Fixes:</h4>
<ul>
<li>The CacheFilter doesn't send back a 304 (not modified) response when client cache is de-activated anymore, see <a href="http://jira.opensymphony.com/browse/CACHE-116" title="Visit page outside Confluence">CACHE-116</a></li>
<li>CacheFilter doesn't support correctly i18N by setting encoding not properly, <a href="http://jira.opensymphony.com/browse/CACHE-38" title="Visit page outside Confluence">CACHE-38</a> and <a href="http://jira.opensymphony.com/browse/CACHE-159" title="Visit page outside Confluence">CACHE-159</a></li>
<li>Cron expressions - leap days not always matched correctly, <a href="http://jira.opensymphony.com/browse/CACHE-157" title="Visit page outside Confluence">CACHE-157</a></li>
<li>FindBugs doesn't report that the usage of GetResource may be unsafe if class Config is extended anymore, see <a href="http://jira.opensymphony.com/browse/CACHE-108" title="Visit page outside Confluence">CACHE-108</a></li>
<li>ConcurrentModificationException on flushGroup, see <a href="http://jira.opensymphony.com/browse/CACHE-127" title="Visit page outside Confluence">CACHE-127</a></li>
<li>Exception not thrown when not serializable object is persisted instead stack trace is persisted, see <a href="http://jira.opensymphony.com/browse/CACHE-112" title="Visit page outside Confluence">CACHE-112</a></li>
<li>A few concurrency issues were fixed, see <a href="http://jira.opensymphony.com/browse/CACHE-170" title="Visit page outside Confluence">CACHE-170</a>, <a href="http://jira.opensymphony.com/browse/CACHE-167" title="Visit page outside Confluence">CACHE-167</a>, <a href="http://jira.opensymphony.com/browse/CACHE-127" title="Visit page outside Confluence">CACHE-127</a></li>
</ul>
<h4><a name="OSCache2.1.1-Changesthatmayaffectbackwardscompatibility%3A"></a>Changes that may affect backwards compatibility:</h4>
<ul>
<li>The improvement <a href="http://jira.opensymphony.com/browse/CACHE-88" title="Visit page outside Confluence">CACHE-88</a> may change the behaviour of the application, because a session object isn't created anymore even if it wasn't necessary. A web application may react different to a not existing session object.</li>
<li>The URI change of <a href="http://jira.opensymphony.com/browse/CACHE-61" title="Visit page outside Confluence">CACHE-61</a> from <tt>/oscache</tt> to <tt><a href="http://www.opensymphony.com/oscache" title="Visit page outside Confluence">http://www.opensymphony.com/oscache</a></tt> affects all JSP's which explicit use the old URI.</li>
</ul>
<h4><a name="OSCache2.1.1-JIRAIssueList"></a>JIRA Issue List</h4>
<p><a name="jiraissues">
<table width="100%" cellspacing="0" class="grid">
<tr>
<th colspan="4" style="text-align: left;">
<a href="/spaces/doexportspace.action?key=CACHE&macro.refresh=true#jiraissues"><img src="/images/icons/refresh_16.png" height="16" width="16" border="0" align="right" title="refresh"/></a>
<a href="http://jira.opensymphony.com/secure/IssueNavigator.jspa?&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC&tempMax=25&reset=true&">OpenSymphony JIRA</a>
<span class="smalltext">(15 issues)</span>
</th>
</tr>
<tr>
<th style="text-align: left;">
T </th>
<th style="text-align: left;">
Key </th>
<th style="text-align: left;">
Summary </th>
<th style="text-align: left;">
Status </th>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-170"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-170">CACHE-170</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-170">Data race handling Cache.updateStates results in Thread hangs when the blocking mode is used in concurrence</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-167"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-167">CACHE-167</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-167">removeEntry not synchronized</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-159"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-159">CACHE-159</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-159">CacheFilter does not set encoding properly</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-157"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-157">CACHE-157</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-157">Cron expressions - leap days not always matched correctly</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-131"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/task.gif" alt="Task" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-131">CACHE-131</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-131">JavaDoc: Missing class description - CacheContextListener</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-127"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-127">CACHE-127</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-127">ConcurrentModificationException on flushGroup</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-116"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-116">CACHE-116</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-116">CacheFilter sends back a 304 (not modified) response when client cache is de-activated</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-112"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-112">CACHE-112</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-112">Exception not thrown when not serializable object is persisted instead stack trace is persisted!</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-111"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-111">CACHE-111</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-111">public access for disk persistence configuration key</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-110"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-110">CACHE-110</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-110">DiskPersistenceListener should escape &#39;?&#39;</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-109"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/task.gif" alt="Task" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-109">CACHE-109</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-109">cache.blocking parameter missing in oscache.properties</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-108"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-108">CACHE-108</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-108">FindBugs reports: Usage of GetResource may be unsafe if class Config is extended</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-88"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-88">CACHE-88</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-88">Don&#39;t create session object in cache tags unless necessary</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-61"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-61">CACHE-61</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-61">Taglib URI Attribute</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-38"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-38">CACHE-38</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-38">oscache filter doesn&#39;t support correctly i18N</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21441&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
</table>
</p>
</td>
</tr>
</table>
</body>
</html>

312
docs/wiki/OSCache 2.1.html Normal file
View file

@ -0,0 +1,312 @@
<html>
<head>
<title>OSCache -
OSCache 2.1
</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">
<h3><a name="OSCache2.1-ReleaseNotes"></a>Release Notes</h3>
<p>(18th January 2005 - by Andres March)</p>
<h4><a name="OSCache2.1-NewFeatures%3A"></a>New Features:</h4>
<ul>
<li>Added HashDiskPersistenceListner <a href="http://jira.opensymphony.com/browse/CACHE-132" title="Visit page outside Confluence">CACHE-132 </a> 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. See <a href="http://jira.opensymphony.com/browse/CACHE-133" title="Visit page outside Confluence">CACHE-133 </a></li>
<li>Check If-Modified-Since header in cache filter to increase performance, see <a href="http://jira.opensymphony.com/browse/CACHE-58" title="Visit page outside Confluence">CACHE-58 </a> and <a href="http://jira.opensymphony.com/browse/CACHE-70" title="Visit page outside Confluence">CACHE-70 </a></li>
</ul>
<h4><a name="OSCache2.1-Improvements%3A"></a>Improvements:</h4>
<ul>
<li>Updated jgroups jar regarding changed package name <a href="http://jira.opensymphony.com/browse/CACHE-85" title="Visit page outside Confluence">CACHE-85 </a>, <a href="http://jira.opensymphony.com/browse/CACHE-126" title="Visit page outside Confluence">CACHE-126</a> and configuration based upon recommendations from Bela Ban (javagroups maintainer).</li>
<li>More evenly distributed disk caching, see <a href="http://jira.opensymphony.com/browse/CACHE-94" title="Visit page outside Confluence">CACHE-94 </a></li>
<li>Public access for configuration properties, see <a href="http://jira.opensymphony.com/browse/CACHE-92" title="Visit page outside Confluence">CACHE-92 </a></li>
<li>Public method to clear cache, see <a href="http://jira.opensymphony.com/browse/CACHE-104" title="Visit page outside Confluence">CACHE-104 </a>, <a href="http://jira.opensymphony.com/browse/CACHE-68" title="Visit page outside Confluence">CACHE-68</a></li>
<li>Output the scope name's in toString() of ScopeEventListenerImpl, see <a href="http://jira.opensymphony.com/browse/CACHE-95" title="Visit page outside Confluence">CACHE-95 </a></li>
<li>Call get() method on put() method call, see <a href="http://jira.opensymphony.com/browse/CACHE-105" title="Visit page outside Confluence">CACHE-105 </a></li>
<li>Library updates
<ul>
<li>upgrade to Commons Logging 1.0.4, see <a href="http://jira.opensymphony.com/browse/CACHE-102" title="Visit page outside Confluence">CACHE-102 </a></li>
<li>upgrade to Commons Collections 3.1, see <a href="http://jira.opensymphony.com/browse/CACHE-103" title="Visit page outside Confluence">CACHE-103 </a></li>
</ul>
</li>
<li>Moved all docs to <a href="http://wiki.opensymphony.com/display/CACHE/Home" title="Visit page outside Confluence">wiki</a></li>
<li>Website documentation updates.</li>
</ul>
<h4><a name="OSCache2.1-BugFixes%3A"></a>Bug Fixes:</h4>
<ul>
<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-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'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>
</ul>
<p><a name="jiraissues">
<table width="100%" cellspacing="0" class="grid">
<tr>
<th colspan="3" style="text-align: left;">
<a href="/spaces/doexportspace.action?key=CACHE&macro.refresh=true#jiraissues"><img src="/images/icons/refresh_16.png" height="16" width="16" border="0" align="right" title="refresh"/></a>
<a href="http://jira.opensymphony.com/secure/IssueNavigator.jspa?&pid=10001&fixfor=21223&sorter/field=issuekey&sorter/order=DESC&tempMax=25&reset=true&">OpenSymphony JIRA</a>
<span class="smalltext">(21 issues)</span>
</th>
</tr>
<tr>
<th style="text-align: left;">
T </th>
<th style="text-align: left;">
Key </th>
<th style="text-align: left;">
Summary </th>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-133"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21223&sorter/field=issuekey&sorter/order=DESC/images/icons/newfeature.gif" alt="New Feature" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-133">CACHE-133</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-133">added cache.persistence.overflow.only property</a>
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-132"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21223&sorter/field=issuekey&sorter/order=DESC/images/icons/newfeature.gif" alt="New Feature" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-132">CACHE-132</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-132">Added HashDiskPersistenceListner</a>
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-126"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21223&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-126">CACHE-126</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-126">java.lang.NoClassDefFoundError: org/javagroups/blocks/NotificationBus$Consumer</a>
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-119"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21223&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-119">CACHE-119</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-119">flush does not work correctly in a clustered environment</a>
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-118"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21223&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-118">CACHE-118</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-118">Updating groups doesn&#39;t work</a>
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-107"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21223&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-107">CACHE-107</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-107">flushEntry does not behave correctly in cluster</a>
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-105"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21223&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-105">CACHE-105</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-105">call get() method on put() method call</a>
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-104"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21223&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-104">CACHE-104</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-104">Destroy cache</a>
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-103"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21223&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-103">CACHE-103</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-103">upgrade to Commons Collections 3.1</a>
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-102"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21223&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-102">CACHE-102</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-102">upgrade to Commons Logging 1.0.4 </a>
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-98"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21223&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-98">CACHE-98</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-98">Disk cache not getting served first time for long keys</a>
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-95"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21223&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-95">CACHE-95</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-95">Output the scope name&#39;s in toString()</a>
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-94"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21223&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-94">CACHE-94</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-94">More evenly distributed disk caching</a>
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-92"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21223&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-92">CACHE-92</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-92">public access for configuration properties</a>
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-89"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21223&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-89">CACHE-89</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-89">java.lang.NullPointerException : AbstractCacheAdministrator.finalizeListeners</a>
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-85"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21223&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-85">CACHE-85</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-85">upgrade to JavaGroups 2.2.7</a>
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-73"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21223&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-73">CACHE-73</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-73">NullpointerException after deserialization of AbstractConcurrentReadCache</a>
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-72"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21223&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-72">CACHE-72</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-72">NullPointerException in AbstractConcurrentReadCache.clear</a>
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-71"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21223&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-71">CACHE-71</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-71">Flush and refresh of cached pages fail under heavy load</a>
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-70"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21223&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-70">CACHE-70</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-70">last modified problem</a>
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-58"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21223&sorter/field=issuekey&sorter/order=DESC/images/icons/newfeature.gif" alt="New Feature" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-58">CACHE-58</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-58"> Check If-Modified-Since header in cache filter</a>
</td>
</tr>
</table>
</p>
</td>
</tr>
</table>
</body>
</html>

368
docs/wiki/OSCache 2.2 RC.html Normal file
View file

@ -0,0 +1,368 @@
<html>
<head>
<title>OSCache -
OSCache 2.2 RC
</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">
<h3><a name="OSCache2.2RC-ReleaseNotesReleaseCandidate"></a>Release Notes - Release Candidate</h3>
<p>(18th September 2005 - by Lars Torunski)</p>
<h4><a name="OSCache2.2RC-Besidesbugsbeingfixed%2CmajorimprovementshavebeenmadetotheCacheFilterinmanyways%3A"></a>Besides bugs being fixed, major improvements have been made to the CacheFilter in many ways:</h4>
<ul>
<li>Default initialization of the last modified header which reduces transaction overhead and server load</li>
<li>Support of GZip filters in the filter chain</li>
<li>Custom key generation by subclassing CacheFilter or by implementing a special interface</li>
<li>Preserving more http headers, e.g. the expires header</li>
<li>Special handling for fragments of a page</li>
<li>Avoids session creation for application scope pages</li>
<li>Multiple matching cache filters won't dead-lock the response anymore</li>
</ul>
<h4><a name="OSCache2.2RC-JIRAIssueList"></a>JIRA Issue List</h4>
<p><a name="jiraissues">
<table width="100%" cellspacing="0" class="grid">
<tr>
<th colspan="4" style="text-align: left;">
<a href="/spaces/doexportspace.action?key=CACHE&macro.refresh=true#jiraissues"><img src="/images/icons/refresh_16.png" height="16" width="16" border="0" align="right" title="refresh"/></a>
<a href="http://jira.opensymphony.com/secure/IssueNavigator.jspa?&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC&tempMax=25&reset=true&">OpenSymphony JIRA</a>
<span class="smalltext">(22 issues)</span>
</th>
</tr>
<tr>
<th style="text-align: left;">
T </th>
<th style="text-align: left;">
Key </th>
<th style="text-align: left;">
Summary </th>
<th style="text-align: left;">
Status </th>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-189"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-189">CACHE-189</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-189">AbstractDiskPersistenceListener.store hangs on exception</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-185"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-185">CACHE-185</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-185">Filtered requests will be re-requested twice</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-184"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-184">CACHE-184</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-184">Filter deadlock with external apps (mostly spiders)</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-179"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-179">CACHE-179</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-179">Provider interface for method createCacheKey</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-174"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-174">CACHE-174</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-174">Regression in fix of CACHE-170: UpdateStateEntry may leak when entry are removed</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-173"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-173">CACHE-173</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-173">NullPointerException while flushing inexistant group</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-170"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-170">CACHE-170</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-170">Data race handling Cache.updateStates results in Thread hangs when the blocking mode is used in concurrence</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-169"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-169">CACHE-169</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-169">Default initialization of the last modified header</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-161"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/issue_subtask.gif" alt="Sub-task" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-161">CACHE-161</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-161">CacheFilter easier sub-classing via isCacheable</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-160"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-160">CACHE-160</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-160">ExpiresRefreshPolicy always set in CacheFilter</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-155"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/newfeature.gif" alt="New Feature" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-155">CACHE-155</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-155">Support of GZip filters in the filter chain</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-154"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-154">CACHE-154</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-154">NullPointerException in JavaGroupsBroadcastingListener</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-148"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-148">CACHE-148</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-148">getInstance call not thread-safe</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-144"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-144">CACHE-144</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-144">CacheTag doesn&#39;t clear variables in doStartTag / doFinally</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-143"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-143">CACHE-143</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-143">Report expected expiry to clients/browsers/proxy</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-138"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/task.gif" alt="Task" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-138">CACHE-138</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-138">Document new parameters in the wiki</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-135"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/newfeature.gif" alt="New Feature" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-135">CACHE-135</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-135">CacheFilter for fragements of a page</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-129"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-129">CACHE-129</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-129">CacheFilter will create useless sessions for application-scope pages</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-128"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-128">CACHE-128</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-128">Multiple matching filters will dead-lock the response</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-120"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/newfeature.gif" alt="New Feature" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-120">CACHE-120</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-120">New nocache option when body contains a jsessionid</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-83"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-83">CACHE-83</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-83">CacheHttpServletResponseWrapper &amp; ResponseContent dont preserver Http headers</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-69"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-69">CACHE-69</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-69">Custom Key Generation on CacheFilter</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21450&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
</table>
</p>
</td>
</tr>
</table>
</body>
</html>

226
docs/wiki/OSCache 2.2.html Normal file
View file

@ -0,0 +1,226 @@
<html>
<head>
<title>OSCache -
OSCache 2.2
</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">
<h3><a name="OSCache2.2-ReleaseNotesFinal"></a>Release Notes - Final</h3>
<p>(6th November 2005 - by Lars Torunski)</p>
<h4><a name="OSCache2.2-Additionallytothe2.2RCOSCache2.2RCimprovements%2Cthefinalreleasewasenhancedby%3A"></a>Additionally to the <a href="OSCache 2.2 RC.html" title="OSCache 2.2 RC">2.2 RC</a> improvements, the final release was enhanced by:</h4>
<ul>
<li>Allow cache group definition in CacheFilter</li>
<li>Option to specify when to send Expires-Header</li>
<li>Allow disabling initial set of the last modified header</li>
<li>Continuous Integration and Dependency Management with Ivy</li>
<li>Update to JGroups 2.2.8</li>
</ul>
<h4><a name="OSCache2.2-JIRAIssueList"></a>JIRA Issue List</h4>
<p><a name="jiraissues">
<table width="100%" cellspacing="0" class="grid">
<tr>
<th colspan="4" style="text-align: left;">
<a href="/spaces/doexportspace.action?key=CACHE&macro.refresh=true#jiraissues"><img src="/images/icons/refresh_16.png" height="16" width="16" border="0" align="right" title="refresh"/></a>
<a href="http://jira.opensymphony.com/secure/IssueNavigator.jspa?&pid=10001&fixfor=21550&sorter/field=issuekey&sorter/order=DESC&tempMax=25&reset=true&">OpenSymphony JIRA</a>
<span class="smalltext">(12 issues)</span>
</th>
</tr>
<tr>
<th style="text-align: left;">
T </th>
<th style="text-align: left;">
Key </th>
<th style="text-align: left;">
Summary </th>
<th style="text-align: left;">
Status </th>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-223"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21550&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-223">CACHE-223</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-223">completeUpdate never being called after startUpdate() has been called, OSCache hangs for that key</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21550&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-211"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21550&sorter/field=issuekey&sorter/order=DESC/images/icons/task.gif" alt="Task" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-211">CACHE-211</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-211">Create check sums for the distribution files</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21550&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-210"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21550&sorter/field=issuekey&sorter/order=DESC/images/icons/task.gif" alt="Task" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-210">CACHE-210</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-210">Review: If last test-base and last test-web overwrite previous unit test reports</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21550&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-204"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21550&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-204">CACHE-204</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-204">Allow disabling initial set of the last modified header</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21550&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-203"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21550&sorter/field=issuekey&sorter/order=DESC/images/icons/task.gif" alt="Task" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-203">CACHE-203</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-203">Change JSP tag URI in pages of example war</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21550&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-202"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21550&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-202">CACHE-202</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-202">Expires header should not be inital set in fragments</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21550&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-201"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21550&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-201">CACHE-201</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-201">Defined interface for ICacheKeyProvider not used in CacheFilter</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21550&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-199"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21550&sorter/field=issuekey&sorter/order=DESC/images/icons/task.gif" alt="Task" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-199">CACHE-199</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-199">Continuous Integration and Dependency Management with Ivy</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21550&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-198"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21550&sorter/field=issuekey&sorter/order=DESC/images/icons/task.gif" alt="Task" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-198">CACHE-198</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-198">Update to JGroups 2.2.8</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21550&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-196"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21550&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-196">CACHE-196</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-196">Option to specify when to send Expires-Header</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21550&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-195"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21550&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-195">CACHE-195</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-195">Allow cache group generation in CacheFilter</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21550&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-194"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21550&sorter/field=issuekey&sorter/order=DESC/images/icons/task.gif" alt="Task" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-194">CACHE-194</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-194">Update Documentation</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21550&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
</table>
</p>
</td>
</tr>
</table>
</body>
</html>

107
docs/wiki/OSCache 2.3.1.html Normal file
View file

@ -0,0 +1,107 @@
<html>
<head>
<title>OSCache -
OSCache 2.3.1
</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">
<h3><a name="OSCache2.3.1-ReleaseNotes"></a>Release Notes</h3>
<p>(19th June 2006 - by Lars Torunski)</p>
<h4><a name="OSCache2.3.1-Thismaintenancereleaseof2.3hasoneenhancement%3A"></a>This maintenance release of 2.3 has one enhancement:</h4>
<ul>
<li>CacheFilter: Default initialization of the Cache-Control max-age</li>
</ul>
<h4><a name="OSCache2.3.1-Bugfixes%3A"></a>Bug fixes:</h4>
<ul>
<li>Cache.flushAll(Date flushDate) won't throw NeedsRefreshException when flush date is not yet reached anymore</li>
<li>No NoSuchElementException at Cache.putInCache() anymore</li>
</ul>
<h4><a name="OSCache2.3.1-JIRAIssueList"></a>JIRA Issue List</h4>
<p><a name="jiraissues">
<table width="100%" cellspacing="0" class="grid">
<tr>
<th colspan="4" style="text-align: left;">
<a href="/spaces/doexportspace.action?key=CACHE&macro.refresh=true#jiraissues"><img src="/images/icons/refresh_16.png" height="16" width="16" border="0" align="right" title="refresh"/></a>
<a href="http://jira.opensymphony.com/secure/IssueNavigator.jspa?&pid=10001&fixfor=21630&sorter/field=issuekey&sorter/order=DESC&tempMax=25&reset=true&">OpenSymphony JIRA</a>
<span class="smalltext">(3 issues)</span>
</th>
</tr>
<tr>
<th style="text-align: left;">
T </th>
<th style="text-align: left;">
Key </th>
<th style="text-align: left;">
Summary </th>
<th style="text-align: left;">
Status </th>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-246"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21630&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-246">CACHE-246</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-246">java.util.NoSuchElementException during at com.opensymphony.oscache.base.Cache.putInCache()</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21630&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-241"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21630&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-241">CACHE-241</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-241">Cache.flushAll(Date flushDate) throws NeedsRefreshException when flush date is not yet reached</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21630&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-240"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21630&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-240">CACHE-240</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-240">Default initialization of the Cache-Control max-age</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21630&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
</table>
</p>
</td>
</tr>
</table>
</body>
</html>

104
docs/wiki/OSCache 2.3.2.html Normal file
View file

@ -0,0 +1,104 @@
<html>
<head>
<title>OSCache -
OSCache 2.3.2
</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">
<h3><a name="OSCache2.3.2-ReleaseNotes"></a>Release Notes</h3>
<p>(23rd July 2006 - by Lars Torunski)</p>
<h4><a name="OSCache2.3.2-Thismaintenancereleaseof2.3.1hasoneenhancement%3A"></a>This maintenance release of 2.3.1 has one enhancement:</h4>
<ul>
<li>The removeEntry method in the Cache removes the entry from its groups now</li>
</ul>
<h4><a name="OSCache2.3.2-Bugfixes%3A"></a>Bug fixes:</h4>
<ul>
<li>Method addGroupMappings leads to inconsistent memory cache if a persistent cache group exists</li>
<li>Cache group is updated if entry is removed (duplicate)</li>
</ul>
<h4><a name="OSCache2.3.2-JIRAIssueList"></a>JIRA Issue List</h4>
<p><a name="jiraissues">
<table width="100%" cellspacing="0" class="grid">
<tr>
<th colspan="4" style="text-align: left;">
<a href="/spaces/doexportspace.action?key=CACHE&macro.refresh=true#jiraissues"><img src="/images/icons/refresh_16.png" height="16" width="16" border="0" align="right" title="refresh"/></a>
<a href="http://jira.opensymphony.com/secure/IssueNavigator.jspa?&pid=10001&fixfor=21651&sorter/field=issuekey&sorter/order=DESC&tempMax=25&reset=true&">OpenSymphony JIRA</a>
<span class="smalltext">(3 issues)</span>
</th>
</tr>
<tr>
<th style="text-align: left;">
T </th>
<th style="text-align: left;">
Key </th>
<th style="text-align: left;">
Summary </th>
<th style="text-align: left;">
Status </th>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-244"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21651&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-244">CACHE-244</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-244">Cache group is not updated if entry is removed</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21651&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-188"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21651&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-188">CACHE-188</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-188">removeEntry should update group mappings</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21651&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-181"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21651&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-181">CACHE-181</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-181">addGroupMappings leads to inconsistent Memory-Cache</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21651&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
</table>
</p>
</td>
</tr>
</table>
</body>
</html>

270
docs/wiki/OSCache 2.3.html Normal file
View file

@ -0,0 +1,270 @@
<html>
<head>
<title>OSCache -
OSCache 2.3
</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">
<h3><a name="OSCache2.3-ReleaseNotes"></a>Release Notes</h3>
<p>(6th March 2006 - by Lars Torunski)</p>
<h4><a name="OSCache2.3-ThisreleaseincludesadditionalimprovementstotheCacheFilter%3A"></a>This release includes additional improvements to the CacheFilter:</h4>
<ul>
<li>CRON expressions to expire content at specific dates and/or times</li>
<li>Pluggable EntryRefreshPolicy</li>
<li>Reduced memory consumption</li>
</ul>
<h4><a name="OSCache2.3-Diskpersistence%3A"></a>Disk persistence:</h4>
<ul>
<li>Faster disk persistence</li>
<li>Avoid DiskPersistenceListener deadlocks if process has no rights to delete cache file</li>
</ul>
<h4><a name="OSCache2.3-Furtherchangesare%3A"></a>Further changes are:</h4>
<ul>
<li>new JSP tag <em>addgroups</em></li>
<li>interface to get a list of the cache event listeners</li>
<li>commons collection dependency removed</li>
<li>Java 1.3 support dropped</li>
</ul>
<h4><a name="OSCache2.3-JIRAIssueList"></a>JIRA Issue List</h4>
<p><a name="jiraissues">
<table width="100%" cellspacing="0" class="grid">
<tr>
<th colspan="4" style="text-align: left;">
<a href="/spaces/doexportspace.action?key=CACHE&macro.refresh=true#jiraissues"><img src="/images/icons/refresh_16.png" height="16" width="16" border="0" align="right" title="refresh"/></a>
<a href="http://jira.opensymphony.com/secure/IssueNavigator.jspa?&pid=10001&fixfor=21570&sorter/field=issuekey&sorter/order=DESC&tempMax=25&reset=true&">OpenSymphony JIRA</a>
<span class="smalltext">(14 issues)</span>
</th>
</tr>
<tr>
<th style="text-align: left;">
T </th>
<th style="text-align: left;">
Key </th>
<th style="text-align: left;">
Summary </th>
<th style="text-align: left;">
Status </th>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-235"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21570&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-235">CACHE-235</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-235">Pluggable EntryRefreshPolicy for CacheFilter</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21570&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-230"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21570&sorter/field=issuekey&sorter/order=DESC/images/icons/task.gif" alt="Task" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-230">CACHE-230</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-230">CacheFilter Tutorial</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21570&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-229"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21570&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-229">CACHE-229</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-229">Tomcat 5.5.12 throws IllegalStateException on getId() / fixed Servlet Spec 2.4</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21570&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-228"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21570&sorter/field=issuekey&sorter/order=DESC/images/icons/newfeature.gif" alt="New Feature" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-228">CACHE-228</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-228">Add CRON expressions to CacheFilter to expire content at specific dates and/or times.</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21570&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-227"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21570&sorter/field=issuekey&sorter/order=DESC/images/icons/task.gif" alt="Task" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-227">CACHE-227</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-227">Remove commons collections from distribution</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21570&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-226"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21570&sorter/field=issuekey&sorter/order=DESC/images/icons/task.gif" alt="Task" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-226">CACHE-226</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-226">Drop Java 1.3 support</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21570&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-222"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21570&sorter/field=issuekey&sorter/order=DESC/images/icons/newfeature.gif" alt="New Feature" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-222">CACHE-222</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-222">Add new JSP tag addGroups</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21570&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-217"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21570&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-217">CACHE-217</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-217">Avoid DiskPersistenceListener deadlocks if process has no rights to delete cache file</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21570&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-216"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21570&sorter/field=issuekey&sorter/order=DESC/images/icons/task.gif" alt="Task" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-216">CACHE-216</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-216">Review CacheFilter against Servlet 2.4 spec.</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21570&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-214"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21570&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-214">CACHE-214</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-214">Reduce memory consumption of ResponseContent</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21570&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-200"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21570&sorter/field=issuekey&sorter/order=DESC/images/icons/newfeature.gif" alt="New Feature" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-200">CACHE-200</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-200">add &#39;getCacheEventListenerList()&#39; to Cache class</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21570&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-197"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21570&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-197">CACHE-197</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-197">Speed up disk persistence</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21570&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-183"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21570&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-183">CACHE-183</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-183">HashDiskPersistenceListener / MessageDigest not thread safe</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21570&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-136"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21570&sorter/field=issuekey&sorter/order=DESC/images/icons/task.gif" alt="Task" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-136">CACHE-136</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-136">SequencedHashMap is deprecated in commons collections 3.1</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21570&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
</table>
</p>
</td>
</tr>
</table>
</body>
</html>

97
docs/wiki/OSCache 2.4.1.html Normal file
View file

@ -0,0 +1,97 @@
<html>
<head>
<title>OSCache -
OSCache 2.4.1
</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">
<h3><a name="OSCache2.4.1-ReleaseNotes"></a>Release Notes</h3>
<p>(7th July 2007 - by Lars Torunski)</p>
<h4><a name="OSCache2.4.1-Thismaintenancereleaseof2.4.1hastwobugfixes%3A"></a>This maintenance release of 2.4.1 has two bug fixes:</h4>
<ul>
<li>The cacheFlushed method is not being invoked on the CacheEntryEventListener</li>
<li>CacheFilter max-age parameter MAX_AGE_NO_INIT not set properly</li>
</ul>
<h4><a name="OSCache2.4.1-JIRAIssueList"></a>JIRA Issue List</h4>
<p><a name="jiraissues">
<table width="100%" cellspacing="0" class="grid">
<tr>
<th colspan="4" style="text-align: left;">
<a href="/spaces/doexportspace.action?key=CACHE&macro.refresh=true#jiraissues"><img src="/images/icons/refresh_16.png" height="16" width="16" border="0" align="right" title="refresh"/></a>
<a href="http://jira.opensymphony.com/secure/IssueNavigator.jspa?&pid=10001&fixfor=21705&sorter/field=issuekey&sorter/order=DESC&tempMax=25&reset=true&">OpenSymphony JIRA</a>
<span class="smalltext">(3 issues)</span>
</th>
</tr>
<tr>
<th style="text-align: left;">
T </th>
<th style="text-align: left;">
Key </th>
<th style="text-align: left;">
Summary </th>
<th style="text-align: left;">
Status </th>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-297"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21705&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-297">CACHE-297</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-297">max-age parameter not set on ResponseContent object returned from cache when using MAX_AGE_NO_INIT</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21705&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-296"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21705&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-296">CACHE-296</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-296">For a Cache class the cacheFlushed method is not being invoked on the CacheEntryEventListener.</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21705&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-279"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21705&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-279">CACHE-279</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-279">LRUCache loses entries when updated by mutliple threads.</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21705&sorter/field=issuekey&sorter/order=DESC/images/icons/status_closed.gif" alt="Closed" border="0" />Closed
</td>
</tr>
</table>
</p>
</td>
</tr>
</table>
</body>
</html>

496
docs/wiki/OSCache 2.4.html Normal file
View file

@ -0,0 +1,496 @@
<html>
<head>
<title>OSCache - OSCache 2.4</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">
<h3><a name="OSCache2.4-ReleaseNotes"></a>Release Notes</h3>
<p>(1st Mai 2007 - by Lars Torunski)</p>
<h4><a name="OSCache2.4-Newfeaturesandenhancements"></a>New
features and enhancements</h4>
<p>Furthermore the next major release 2.4 enhances the CacheFilter
and allows a better integration with the <a
href="http://www.springframework.org/"
title="Visit page outside Confluence">Spring Framework</a> and <a
href="JMX Monitoring.html" title="JMX Monitoring">JMX Monitoring</a>.</p>
<ul>
<li>Setting CacheFilter parameters runtime</li>
<li>Lazy initialization in CacheFilter in order to ease spring
integration</li>
<li>Allow disabling cacheing for special http methods (e.g.
POST/DELETE/PUT) in CacheFilter</li>
<li>CacheFilter allow reentrance over different filter
configurations</li>
</ul>
<ul>
<li>Hibernate 3.2 integration support</li>
<li>JMX Monitoring/Administration via Spring</li>
<li>Improve oscache.properties loading</li>
<li>Performance improvment for large disk persistence usage</li>
</ul>
<h4><a name="OSCache2.4-UpgradeGuide"></a>Upgrade Guide</h4>
<ul>
<li>Due to the enhancements in the CacheFilter and method
signature changes, it's recommended to recompile your code.</li>
<li>Due to changes for CACHE-284 the handling of the listeners
have been changed: Before OSCache 2.4 objects which implemented
different CacheEventListener (e.g. CacheEntryEventListener and
CacheMapAccessEventListener) had to be added twice, because the
listeners where registrated only for one special event listener. With
OSCache 2.4 only the object has to be added to the list without the
2nd parameter 'type of the listener'.</li>
</ul>
<h4><a name="OSCache2.4-JIRAIssueList"></a>JIRA Issue List</h4>
<p><a name="jiraissues">
<table width="100%" cellspacing="0" class="grid">
<tr>
<th colspan="4" style="text-align: left;"><a
href="/spaces/doexportspace.action?key=CACHE&macro.refresh=true#jiraissues"><img
src="/images/icons/refresh_16.png" height="16" width="16"
border="0" align="right" title="refresh" /></a> <a
href="http://jira.opensymphony.com/secure/IssueNavigator.jspa?&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC&tempMax=30&reset=true&">OpenSymphony
JIRA</a> <span class="smalltext">(29 issues)</span></th>
</tr>
<tr>
<th style="text-align: left;">T</th>
<th style="text-align: left;">Key</th>
<th style="text-align: left;">Summary</th>
<th style="text-align: left;">Status</th>
</tr>
<tr class="rowNormal">
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-260"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/bug.gif"
alt="Bug" border="0" /></a></td>
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-260">CACHE-260</a>
</td>
<td><a href="http://jira.opensymphony.com/browse/CACHE-260">NullPointerException
in AbstractConcurrentReadCache</a></td>
<td nowrap="true"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/status_closed.gif"
alt="Closed" border="0" />Closed</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-295"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/newfeature.gif"
alt="New Feature" border="0" /></a></td>
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-295">CACHE-295</a>
</td>
<td><a href="http://jira.opensymphony.com/browse/CACHE-295">Hibernate
3.2 integration support</a></td>
<td nowrap="true"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/status_closed.gif"
alt="Closed" border="0" />Closed</td>
</tr>
<tr class="rowNormal">
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-215"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/improvement.gif"
alt="Improvement" border="0" /></a></td>
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-215">CACHE-215</a>
</td>
<td><a href="http://jira.opensymphony.com/browse/CACHE-215">Setting
CacheFilter parameters runtime</a></td>
<td nowrap="true"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/status_closed.gif"
alt="Closed" border="0" />Closed</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-99"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/improvement.gif"
alt="Improvement" border="0" /></a></td>
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-99">CACHE-99</a></td>
<td><a href="http://jira.opensymphony.com/browse/CACHE-99">Use
lazy initialization in cache filter in order to ease spring
integration</a></td>
<td nowrap="true"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/status_closed.gif"
alt="Closed" border="0" />Closed</td>
</tr>
<tr class="rowNormal">
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-258"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/bug.gif"
alt="Bug" border="0" /></a></td>
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-258">CACHE-258</a>
</td>
<td><a href="http://jira.opensymphony.com/browse/CACHE-258">NullPointerException
when using putCache(key, val) in LRUCache</a></td>
<td nowrap="true"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/status_closed.gif"
alt="Closed" border="0" />Closed</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-273"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/task.gif"
alt="Task" border="0" /></a></td>
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-273">CACHE-273</a>
</td>
<td><a href="http://jira.opensymphony.com/browse/CACHE-273">Update
to Commons Logging 1.1</a></td>
<td nowrap="true"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/status_closed.gif"
alt="Closed" border="0" />Closed</td>
</tr>
<tr class="rowNormal">
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-253"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/task.gif"
alt="Task" border="0" /></a></td>
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-253">CACHE-253</a>
</td>
<td><a href="http://jira.opensymphony.com/browse/CACHE-253">Migrate
from CVS to SVN</a></td>
<td nowrap="true"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/status_closed.gif"
alt="Closed" border="0" />Closed</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-261"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/task.gif"
alt="Task" border="0" /></a></td>
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-261">CACHE-261</a>
</td>
<td><a href="http://jira.opensymphony.com/browse/CACHE-261">Check
javadoc of Cache.cancelUpdate on key not being updated </a></td>
<td nowrap="true"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/status_closed.gif"
alt="Closed" border="0" />Closed</td>
</tr>
<tr class="rowNormal">
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-163"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/issue_subtask.gif"
alt="Sub-task" border="0" /></a></td>
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-163">CACHE-163</a>
</td>
<td><a href="http://jira.opensymphony.com/browse/CACHE-163">CacheFilter
easier sub-classing via pre- and post-processes</a></td>
<td nowrap="true"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/status_closed.gif"
alt="Closed" border="0" />Closed</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-162"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/issue_subtask.gif"
alt="Sub-task" border="0" /></a></td>
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-162">CACHE-162</a>
</td>
<td><a href="http://jira.opensymphony.com/browse/CACHE-162">CacheFilter
easier sub-classing via useCache</a></td>
<td nowrap="true"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/status_closed.gif"
alt="Closed" border="0" />Closed</td>
</tr>
<tr class="rowNormal">
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-272"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/improvement.gif"
alt="Improvement" border="0" /></a></td>
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-272">CACHE-272</a>
</td>
<td><a href="http://jira.opensymphony.com/browse/CACHE-272">Allow
disabling of cacheing special http methods (e.g. POST/DELETE/PUT) in
CacheFilter</a></td>
<td nowrap="true"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/status_closed.gif"
alt="Closed" border="0" />Closed</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-277"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/improvement.gif"
alt="Improvement" border="0" /></a></td>
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-277">CACHE-277</a>
</td>
<td><a href="http://jira.opensymphony.com/browse/CACHE-277">CacheFilter
should allow reentrance over different filter configurations</a></td>
<td nowrap="true"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/status_closed.gif"
alt="Closed" border="0" />Closed</td>
</tr>
<tr class="rowNormal">
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-283"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/improvement.gif"
alt="Improvement" border="0" /></a></td>
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-283">CACHE-283</a>
</td>
<td><a href="http://jira.opensymphony.com/browse/CACHE-283">Improve
oscache.properties loading</a></td>
<td nowrap="true"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/status_closed.gif"
alt="Closed" border="0" />Closed</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-266"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/newfeature.gif"
alt="New Feature" border="0" /></a></td>
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-266">CACHE-266</a>
</td>
<td><a href="http://jira.opensymphony.com/browse/CACHE-266">ServletCacheAdministrator
no longer a &quot;Servlet Singleton&quot;</a></td>
<td nowrap="true"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/status_closed.gif"
alt="Closed" border="0" />Closed</td>
</tr>
<tr class="rowNormal">
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-267"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/improvement.gif"
alt="Improvement" border="0" /></a></td>
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-267">CACHE-267</a>
</td>
<td><a href="http://jira.opensymphony.com/browse/CACHE-267">SplitServletOutputStream
doesn&#39;t pass flush() on to underlying stream</a></td>
<td nowrap="true"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/status_closed.gif"
alt="Closed" border="0" />Closed</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-141"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/task.gif"
alt="Task" border="0" /></a></td>
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-141">CACHE-141</a>
</td>
<td><a href="http://jira.opensymphony.com/browse/CACHE-141">CacheFilter
easier sub-classing</a></td>
<td nowrap="true"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/status_closed.gif"
alt="Closed" border="0" />Closed</td>
</tr>
<tr class="rowNormal">
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-288"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/bug.gif"
alt="Bug" border="0" /></a></td>
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-288">CACHE-288</a>
</td>
<td><a href="http://jira.opensymphony.com/browse/CACHE-288">Error
in the HashDiskPersistenceListener byteArrayToHexString</a></td>
<td nowrap="true"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/status_closed.gif"
alt="Closed" border="0" />Closed</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-264"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/bug.gif"
alt="Bug" border="0" /></a></td>
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-264">CACHE-264</a>
</td>
<td><a href="http://jira.opensymphony.com/browse/CACHE-264">problem
with not escaped group names and their filenames for disk
persistence</a></td>
<td nowrap="true"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/status_closed.gif"
alt="Closed" border="0" />Closed</td>
</tr>
<tr class="rowNormal">
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-255"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/bug.gif"
alt="Bug" border="0" /></a></td>
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-255">CACHE-255</a>
</td>
<td><a href="http://jira.opensymphony.com/browse/CACHE-255">
AbstractConcurrentReadCache#put(Object key, Object value) may return
a wrong value</a></td>
<td nowrap="true"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/status_closed.gif"
alt="Closed" border="0" />Closed</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-249"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/improvement.gif"
alt="Improvement" border="0" /></a></td>
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-249">CACHE-249</a>
</td>
<td><a href="http://jira.opensymphony.com/browse/CACHE-249">Performance
improvment for large disk persistence usage</a></td>
<td nowrap="true"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/status_closed.gif"
alt="Closed" border="0" />Closed</td>
</tr>
<tr class="rowNormal">
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-293"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/improvement.gif"
alt="Improvement" border="0" /></a></td>
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-293">CACHE-293</a>
</td>
<td><a href="http://jira.opensymphony.com/browse/CACHE-293">Allow
to specify a different oscache.properties file for Hibernate</a></td>
<td nowrap="true"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/status_closed.gif"
alt="Closed" border="0" />Closed</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-278"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/bug.gif"
alt="Bug" border="0" /></a></td>
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-278">CACHE-278</a>
</td>
<td><a href="http://jira.opensymphony.com/browse/CACHE-278">Filter
ignores max-age parameter when serving from cache</a></td>
<td nowrap="true"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/status_closed.gif"
alt="Closed" border="0" />Closed</td>
</tr>
<tr class="rowNormal">
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-284"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/bug.gif"
alt="Bug" border="0" /></a></td>
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-284">CACHE-284</a>
</td>
<td><a href="http://jira.opensymphony.com/browse/CACHE-284">Cache.dispatchCacheEntryEvent
and Cache.addEventListener implementations are inconsistent</a></td>
<td nowrap="true"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/status_closed.gif"
alt="Closed" border="0" />Closed</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-274"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/improvement.gif"
alt="Improvement" border="0" /></a></td>
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-274">CACHE-274</a>
</td>
<td><a href="http://jira.opensymphony.com/browse/CACHE-274">new
method getIntialContext JMSBroadcastingListener</a></td>
<td nowrap="true"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/status_closed.gif"
alt="Closed" border="0" />Closed</td>
</tr>
<tr class="rowNormal">
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-263"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/task.gif"
alt="Task" border="0" /></a></td>
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-263">CACHE-263</a>
</td>
<td><a href="http://jira.opensymphony.com/browse/CACHE-263">Run
FindBugs 1.1.3 against current source code</a></td>
<td nowrap="true"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/status_closed.gif"
alt="Closed" border="0" />Closed</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-292"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/bug.gif"
alt="Bug" border="0" /></a></td>
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-292">CACHE-292</a>
</td>
<td><a href="http://jira.opensymphony.com/browse/CACHE-292">CacheFilter
max-age default and error-case initialisation are wrong</a></td>
<td nowrap="true"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/status_closed.gif"
alt="Closed" border="0" />Closed</td>
</tr>
<tr class="rowNormal">
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-290"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/improvement.gif"
alt="Improvement" border="0" /></a></td>
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-290">CACHE-290</a>
</td>
<td><a href="http://jira.opensymphony.com/browse/CACHE-290">Bad
Practice</a></td>
<td nowrap="true"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/status_closed.gif"
alt="Closed" border="0" />Closed</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-178"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/newfeature.gif"
alt="New Feature" border="0" /></a></td>
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-178">CACHE-178</a>
</td>
<td><a href="http://jira.opensymphony.com/browse/CACHE-178">JMX
Monitoring/Administration via Spring</a></td>
<td nowrap="true"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/status_closed.gif"
alt="Closed" border="0" />Closed</td>
</tr>
<tr class="rowNormal">
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-252"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/improvement.gif"
alt="Improvement" border="0" /></a></td>
<td nowrap="true"><a
href="http://jira.opensymphony.com/browse/CACHE-252">CACHE-252</a>
</td>
<td><a href="http://jira.opensymphony.com/browse/CACHE-252">Log
warning if user tries to set max entries on an unlimited cache</a></td>
<td nowrap="true"><img
src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21660&sorter/field=priority&sorter/order=DESC/images/icons/status_closed.gif"
alt="Closed" border="0" />Closed</td>
</tr>
</table></p>
</td>
</tr>
</table>
</body>
</html>

37
docs/wiki/OSCache in the Wild.html Normal file
View file

@ -0,0 +1,37 @@
<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">
<p>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>
<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>
<li><a href="http://www.searchmorph.com/" title="Visit page outside Confluence">SearchMorph</a> - Specialized search engine for javadoc-generated pages, and an experimental Wikipedia search engine, both using Lucene. See also my informal benchmark writeups, <a href="http://www.searchmorph.com/wp/2005/01/17/speed-of-jsp-caching-with-oscache/" title="Visit page outside Confluence">"speed-of-jsp-caching-with-oscache"</a> and <a href="http://www.searchmorph.com/wp/2005/01/14/oscache-rocks/" title="Visit page outside Confluence">"OSCache rocks"</a>.</li>
<li><a href="http://www.stockmorph.com/" title="Visit page outside Confluence">StockMorph</a> - JSP pages are hidden behind mod_rewrite magic, however oscache is used in the JSP, and CacheFilter for the servlets</li>
</ul>
</td>
</tr>
</table>
</body>
</html>

41
docs/wiki/Requirements.html Normal file
View file

@ -0,0 +1,41 @@
<html>
<head>
<title>OSCache -
Requirements
</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">
<p>OSCache can be used directly to provide caching for any Java application. Using the <a href="JSP Tags.html" title="JSP Tags">OSCache tag library</a> requires <b>Servlet 2.3</b> and <b>JSP 1.2</b> support (included in J2EE 1.3) to run properly. There is no dependency on a servlet container if the <a href="API Usage.html" title="API Usage">OSCache API</a> is used directly.</p>
<p>So far OSCache has been tested in the following application servers and web containers:</p>
<ul>
<li><a href="http://www.orionserver.com/" title="Visit page outside Confluence">OrionServer</a>(version 1.4.0 and above)</li>
<li><a href="http://www.macromedia.com/" title="Visit page outside Confluence">Macromedia JRun</a> (version 3.0 and above)</li>
<li><a href="http://e-docs.bea.com/" title="Visit page outside Confluence">BEA WebLogic Server</a> (should work on version 8.1 and above)</li>
<li><a href="http://www.ibm.com/websphere" title="Visit page outside Confluence">IBM Websphere</a> (tested on version 5.0)</li>
<li>Silverstream (tested on version 3.7.4)</li>
<li><a href="http://www.caucho.com/" title="Visit page outside Confluence">Caucho Resin</a> (version 1.2.3 and above)</li>
<li><a href="http://jakarta.apache.org/tomcat" title="Visit page outside Confluence">Tomcat</a> (version 4.0 and above)</li>
<li><a href="http://www.iplanet.com/" title="Visit page outside Confluence">iPlanet</a> (tested on version 6.0. Note that the caching filter has not been tested, only the taglibs)</li>
</ul>
<p>This does not mean it will not run on other servers! It should run on any specification compliant container. If you have run OSCache successfully in other servers, please let us know and we'll add to this list.</p>
<p>The <a href="CacheFilter.html" title="CacheFilter">Caching Filter</a> (for caching entire pages, and binary content such as GIFs and PDFs) requires Servlet 2.3 support. It is known to work on Orion, BEA WebLogic Server and Tomcat 4.0.</p>
<p>OSCache requires at least <b>Java 1.4</b> for the <a href="Installation Guide.html" title="Installation Guide">installation</a>.</p>
</td>
</tr>
</table>
</body>
</html>

372
docs/wiki/Roadmap.html Normal file
View file

@ -0,0 +1,372 @@
<html>
<head>
<title>OSCache -
Roadmap
</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">
<h3><a name="Roadmap-Scope"></a>Scope</h3>
<p>This page and the <a href="https://oscache.dev.java.net/servlets/ProjectMailingListList" title="Visit page outside Confluence">mailing list</a> are provided for discussion purposes about the roadmap of OSCache and discussing new features and improvements. See also the <a href="http://jira.opensymphony.com/browse/CACHE?report=com.atlassian.jira.plugin.system.project:roadmap-panel" title="Visit page outside Confluence">JIRA - Road Map</a> for more details or vote for issues in <a href="http://jira.opensymphony.com/browse/CACHE?report=com.atlassian.jira.plugin.system.project:popularissues-panel" title="Visit page outside Confluence">JIRA - Popular Issues</a> .</p>
<h3><a name="Roadmap-OSCache3.0"></a>OSCache 3.0</h3>
<p>The primary goal of this release is to make OSCache more reliable and easier to use and maintain. </p>
<ul>
<li>Reliability and maintainability will be achieved by replacing the core cache storage classes with simpler ones that sync on coarse-grained cache operations. The memory cache, for instance, will use a hash map for its internal storage. Existing features will be provided at a higher level, so to avoid conflicting with the storage management logic.</li>
<li>Usability will be improved through a refactored API that extends the java.util.Map interface. Some of the the things the new API will change:
<ul>
<li>Remove NeedsRefreshException (if you have to ask, then you shouldn't care).</li>
<li>Support for Object keys instead of only strings.</li>
<li>Support for cache regions to enable easier management of multiple caches.</li>
<li>Configuration via Spring (yes, it's a buzzword).</li>
<li>Administration and statistics.</li>
</ul>
</li>
</ul>
<p>Furthermore we discuss a <a href="Chain Caching Model.html" title="Chain Caching Model">Chain Caching Model</a> internal.</p>
<p><a name="jiraissues">
<table width="100%" cellspacing="0" class="grid">
<tr>
<th colspan="4" style="text-align: left;">
<a href="/spaces/doexportspace.action?key=CACHE&macro.refresh=true#jiraissues"><img src="/images/icons/refresh_16.png" height="16" width="16" border="0" align="right" title="refresh"/></a>
<a href="http://jira.opensymphony.com/secure/IssueNavigator.jspa?&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC&tempMax=25&reset=true&">OpenSymphony JIRA</a>
<span class="smalltext">(22 issues)</span>
</th>
</tr>
<tr>
<th style="text-align: left;">
T </th>
<th style="text-align: left;">
Key </th>
<th style="text-align: left;">
Summary </th>
<th style="text-align: left;">
Status </th>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-289"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/task.gif" alt="Task" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-289">CACHE-289</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-289">Change AbstractConcurrentReadCache to use backport-util-concurrent classes</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/status_open.gif" alt="Open" border="0" />Open
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-225"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/task.gif" alt="Task" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-225">CACHE-225</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-225">Update to JGroups 2.2.9.1</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/status_open.gif" alt="Open" border="0" />Open
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-220"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/newfeature.gif" alt="New Feature" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-220">CACHE-220</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-220">Using a weak referenced cache for overflow capability</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/status_open.gif" alt="Open" border="0" />Open
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-172"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-172">CACHE-172</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-172">Easier API usage for developers</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/status_open.gif" alt="Open" border="0" />Open
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-158"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-158">CACHE-158</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-158">cache.capacity and GeneralCacheAdministrator.setCacheCapacity problem</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/status_inprogress.gif" alt="In Progress" border="0" />In Progress
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-152"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-152">CACHE-152</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-152">Still NullPointerException in LRUCache (list is null)</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/status_open.gif" alt="Open" border="0" />Open
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-151"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/bug.gif" alt="Bug" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-151">CACHE-151</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-151">limiting Cache size on disk</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/status_open.gif" alt="Open" border="0" />Open
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-149"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/newfeature.gif" alt="New Feature" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-149">CACHE-149</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-149">get all values API is missing</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/status_open.gif" alt="Open" border="0" />Open
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-145"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-145">CACHE-145</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-145">Allow clustered cached to send update notices when a cached object is modified</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/status_open.gif" alt="Open" border="0" />Open
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-142"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-142">CACHE-142</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-142">DiskPersistenceListener - use properties in cache.path</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/status_open.gif" alt="Open" border="0" />Open
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-140"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-140">CACHE-140</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-140">Option to avoid bypassing the Cache if browser has resource already</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/status_open.gif" alt="Open" border="0" />Open
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-123"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/newfeature.gif" alt="New Feature" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-123">CACHE-123</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-123">Provide a &quot;default content&quot; feature instead of the &quot;missing cached content&quot; string</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/status_open.gif" alt="Open" border="0" />Open
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-121"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/newfeature.gif" alt="New Feature" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-121">CACHE-121</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-121">Need some admin functions from Cache class</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/status_open.gif" alt="Open" border="0" />Open
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-117"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-117">CACHE-117</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-117">add &#39;oscache.cluster.group_name&quot; to take care of different clustered-applications</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/status_open.gif" alt="Open" border="0" />Open
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-100"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/newfeature.gif" alt="New Feature" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-100">CACHE-100</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-100">Provide support for automatic failover to cached version in cache tag</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/status_open.gif" alt="Open" border="0" />Open
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-81"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-81">CACHE-81</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-81">cache.contains()</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/status_open.gif" alt="Open" border="0" />Open
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-79"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/newfeature.gif" alt="New Feature" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-79">CACHE-79</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-79">Allow the list of current groups to be obtained from a cache.</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/status_open.gif" alt="Open" border="0" />Open
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-78"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-78">CACHE-78</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-78">Determining used cache algorithm</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/status_open.gif" alt="Open" border="0" />Open
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-67"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/improvement.gif" alt="Improvement" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-67">CACHE-67</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-67">On caching pages with session IDs in URLs</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/status_reopened.gif" alt="Reopened" border="0" />Reopened
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-49"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/newfeature.gif" alt="New Feature" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-49">CACHE-49</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-49">Add Http1.1 Compression (GZip) and increase efficiency</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/status_open.gif" alt="Open" border="0" />Open
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-21"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/newfeature.gif" alt="New Feature" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-21">CACHE-21</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-21">Cache manager</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/status_open.gif" alt="Open" border="0" />Open
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-12"><img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/newfeature.gif" alt="New Feature" border="0" /></a>
</td>
<td nowrap="true">
<a href="http://jira.opensymphony.com/browse/CACHE-12">CACHE-12</a>
</td>
<td >
<a href="http://jira.opensymphony.com/browse/CACHE-12">Accessing caches from outside the Servlet Context</a>
</td>
<td nowrap="true">
<img src="http://jira.opensymphony.com/secure/IssueNavigator.jspa?reset=true&pid=10001&fixfor=21470&sorter/field=issuekey&sorter/order=DESC/images/icons/status_open.gif" alt="Open" border="0" />Open
</td>
</tr>
</table>
</p>
</td>
</tr>
</table>
</body>
</html>

37
docs/wiki/SVN and Compiling OSCache.html Normal file
View file

@ -0,0 +1,37 @@
<html>
<head>
<title>OSCache -
and Compiling 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">
<h3><a name="SVNandCompilingOSCache-SVN"></a>SVN</h3>
<p>The OSCache SVN repository is hosted at <a href="http://svn.opensymphony.com/svn/oscache" title="Visit page outside Confluence">http://svn.opensymphony.com/svn/oscache</a>. You can get the sources anonymously by using e.g. <a href="http://subclipse.tigris.org" title="Visit page outside Confluence">Subclipse</a> a <a href="http://subversion.tigris.org" title="Visit page outside Confluence">Subversion</a> Eclipse Plugin.</p>
<p>If you want to build OSCache from SVN, you have to checkout the project <a href="http://svn.opensymphony.com/svn/opensymphony/trunk/" title="Visit page outside Confluence">OpenSymphony</a> also.</p>
<h3><a name="SVNandCompilingOSCache-CompilingOSCache"></a>Compiling OSCache</h3>
<p>Run <tt>build.xml</tt> with <a href="http://ant.apache.org/" title="Visit page outside Confluence">Ant</a> 1.6.5 (or higher) under Java 1.4 or later. From the OSCache directory, type</p>
<ul>
<li>ant - to build the oscache.jar</li>
<li>ant dist - to build the complete distribution (only for full SVN checkout)</li>
<li>ant clean - to clean up</li>
</ul>
<p>You may need to add the <a href="http://www.jayasoft.org/ivy" title="Visit page outside Confluence">Ivy</a> jar to your $ANT_HOME/lib directory if it is not there already.</p>
</td>
</tr>
</table>
</body>
</html>

60
docs/wiki/Spring.html Normal file
View file

@ -0,0 +1,60 @@
<html>
<head>
<title>OSCache -
Spring
</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">
<h2><a name="Spring-Configuringa%7B%7BGeneralCacheAdministrator%7D%7D"></a>Configuring a <tt>GeneralCacheAdministrator</tt></h2>
<p>A <a href="API Usage.html" title="API Usage">GeneralCacheAdministrator</a> instance that picks up configuration from an <a href="Configuration.html" title="Configuration">oscache.properties</a> file can be configured within Spring using the following code:</p>
<div class="code"><div class="codeContent">
<pre class="code-xml"><span class="code-tag">&lt;bean id=<span class="code-quote">"cacheAdministrator"</span> class=<span class="code-quote">"com.opensymphony.oscache.general.GeneralCacheAdministrator"</span> destroy-method=<span class="code-quote">"destroy"</span>/&gt;</span></pre>
</div></div>
<p>Notice that a <tt>destory-method</tt> is configured to ensure that the <tt>GeneralCacheAdministrator</tt> is closed down gracefully.</p>
<p>If you'd prefer to keep all your configuration inside the Spring configuration, you can omit the <tt>oscache.properties</tt> file and pass in any properties you want to the <tt>GeneralCacheAdministrator</tt> constructor like so:</p>
<div class="code"><div class="codeContent">
<pre class="code-xml"><span class="code-tag">&lt;bean id=<span class="code-quote">"cacheAdministrator"</span> class=<span class="code-quote">"com.opensymphony.oscache.general.GeneralCacheAdministrator"</span> destroy-method=<span class="code-quote">"destroy"</span>&gt;</span>
<span class="code-tag">&lt;constructor-arg index=<span class="code-quote">"0"</span>&gt;</span>
<span class="code-tag">&lt;props&gt;</span>
<span class="code-tag">&lt;prop key=<span class="code-quote">"cache.memory"</span>&gt;</span>true<span class="code-tag">&lt;/prop&gt;</span>
<span class="code-tag">&lt;/props&gt;</span>
<span class="code-tag">&lt;/constructor-arg&gt;</span>
<span class="code-tag">&lt;/bean&gt;</span></pre>
</div></div>
<h2><a name="Spring-ConfiguringaCache"></a>Configuring a Cache</h2>
<p>You can configure a <tt>Cache</tt> instance directly using the following snippet of code:</p>
<div class="code"><div class="codeContent">
<pre class="code-xml"><span class="code-tag">&lt;bean id=<span class="code-quote">"cache"</span> class=<span class="code-quote">"com.opensymphony.oscache.base.Cache"</span>&gt;</span>
<span class="code-tag">&lt;constructor-arg index=<span class="code-quote">"0"</span>&gt;</span>
<span class="code-tag">&lt;value&gt;</span>true<span class="code-tag">&lt;/value&gt;</span> <span class="code-tag"><span class="code-comment">&lt;!-- useMemoryCaching --&gt;</span></span>
<span class="code-tag">&lt;constructor-arg&gt;</span>
<span class="code-tag">&lt;constructor-arg index=<span class="code-quote">"1"</span>&gt;</span>
<span class="code-tag">&lt;value&gt;</span>true<span class="code-tag">&lt;/value&gt;</span> <span class="code-tag"><span class="code-comment">&lt;!-- unlimitedDiskCache --&gt;</span></span>
<span class="code-tag">&lt;constructor-arg&gt;</span>
<span class="code-tag">&lt;constructor-arg index=<span class="code-quote">"2"</span>&gt;</span>
<span class="code-tag">&lt;value&gt;</span>true<span class="code-tag">&lt;/value&gt;</span> <span class="code-tag"><span class="code-comment">&lt;!-- overflowPersistence --&gt;</span></span>
<span class="code-tag">&lt;constructor-arg&gt;</span>
<span class="code-tag">&lt;/bean&gt;</span></pre>
</div></div>
<p>Alternatively, you can pick up the <tt>Cache</tt> from the <tt>GeneralCacheAdministrator</tt> like so:</p>
<div class="code"><div class="codeContent">
<pre class="code-xml"><span class="code-tag">&lt;bean id=<span class="code-quote">"cacheAdministrator"</span> class=<span class="code-quote">"com.opensymphony.oscache.general.GeneralCacheAdministrator"</span> destroy-method=<span class="code-quote">"destroy"</span>/&gt;</span>
<span class="code-tag">&lt;bean id=<span class="code-quote">"cache"</span> factory-bean=<span class="code-quote">"cacheAdministrator"</span> factory-method=<span class="code-quote">"getCache"</span>/&gt;</span></pre>
</div></div>
</td>
</tr>
</table>
</body>
</html>

249
docs/wiki/Statistics.html Normal file
View file

@ -0,0 +1,249 @@
<html>
<head>
<title>OSCache -
Statistics
</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">
<h3><a name="Statistics-Description"></a>Description</h3>
<p>With the <a href="http://www.opensymphony.com/oscache/api/com/opensymphony/oscache/base/events/package-summary.html" title="Visit page outside Confluence">cache event handlers</a> a listerner can be implemented to provide cache hits and misses information. You can copy and paste the following code to get a statistic of your OSCache integration. Just change the used logger and the sample helps you to improve the cache key creation and to decide which scope to use. The <em>SimpleStatisticListenerImpl</em> should be <a href="Configuration.html" title="Configuration">configured</a> via the <em>cache.event.listeners</em> in the <em>oscache.properties</em>.</p>
<h3><a name="Statistics-SampleCode"></a>Sample Code</h3>
<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>SimpleStatisticListenerImpl.java</b></div><div class="codeContent">
<pre class="code-java">/*
* Copyright (c) 2002-2007 by OpenSymphony
* All rights reserved.
*/
<span class="code-keyword">package</span> com.opensymphony.oscache.extra;
<span class="code-keyword">import</span> org.apache.commons.logging.Log;
<span class="code-keyword">import</span> org.apache.commons.logging.LogFactory;
<span class="code-keyword">import</span> com.opensymphony.oscache.base.Cache;
<span class="code-keyword">import</span> com.opensymphony.oscache.base.events.*;
/**
* A simple implementation of a statistic reporter which uses the
* CacheMapAccessEventListener, CacheEntryEventListener and ScopeEventListener.
* It uses the events to count the cache hit and misses and of course the
* flushes.
* &lt;p&gt;
* We are not using any <span class="code-keyword">synchronized</span> so that <span class="code-keyword">this</span> does not become a bottleneck.
* The consequence is that on retrieving values, the operations that are
* currently being done won't be counted.
*/
<span class="code-keyword">public</span> class SimpleStatisticListenerImpl <span class="code-keyword">implements</span> CacheMapAccessEventListener, CacheEntryEventListener, ScopeEventListener {
<span class="code-keyword">private</span> <span class="code-keyword">static</span> <span class="code-keyword">transient</span> <span class="code-keyword">final</span> Log log = LogFactory.getLog(SimpleStatisticListenerImpl.class);
/**
* Hit counter
*/
<span class="code-keyword">private</span> <span class="code-object">int</span> hitCount = 0;
/**
* Miss counter
*/
<span class="code-keyword">private</span> <span class="code-object">int</span> missCount = 0;
/**
* Stale hit counter
*/
<span class="code-keyword">private</span> <span class="code-object">int</span> staleHitCount = 0;
/**
* Hit counter sum
*/
<span class="code-keyword">private</span> <span class="code-object">int</span> hitCountSum = 0;
/**
* Miss counter sum
*/
<span class="code-keyword">private</span> <span class="code-object">int</span> missCountSum = 0;
/**
* Stale hit counter
*/
<span class="code-keyword">private</span> <span class="code-object">int</span> staleHitCountSum = 0;
/**
* Flush hit counter
*/
<span class="code-keyword">private</span> <span class="code-object">int</span> flushCount = 0;
/**
* Constructor, empty <span class="code-keyword">for</span> us
*/
<span class="code-keyword">public</span> SimpleStatisticListenerImpl() {
log.info(<span class="code-quote">"Creation of SimpleStatisticListenerImpl"</span>);
}
/**
* This method handles an event each time the cache is accessed
*
* @param event The event triggered when the cache was accessed
* @see com.opensymphony.oscache.base.events.CacheMapAccessEventListener#accessed(CacheMapAccessEvent)
*/
<span class="code-keyword">public</span> void accessed(CacheMapAccessEvent event) {
<span class="code-object">String</span> result = <span class="code-quote">"N/A"</span>;
<span class="code-comment">// Retrieve the event type and update the counters
</span> CacheMapAccessEventType type = event.getEventType();
<span class="code-comment">// Handles a hit event
</span> <span class="code-keyword">if</span> (type == CacheMapAccessEventType.HIT) {
hitCount++;
result = <span class="code-quote">"HIT"</span>;
}
<span class="code-comment">// Handles a stale hit event
</span> <span class="code-keyword">else</span> <span class="code-keyword">if</span> (type == CacheMapAccessEventType.STALE_HIT) {
staleHitCount++;
result = <span class="code-quote">"STALE HIT"</span>;
}
<span class="code-comment">// Handles a miss event
</span> <span class="code-keyword">else</span> <span class="code-keyword">if</span> (type == CacheMapAccessEventType.MISS) {
missCount++;
result = <span class="code-quote">"MISS"</span>;
}
<span class="code-keyword">if</span> (log.isDebugEnabled()) {
log.debug(<span class="code-quote">"ACCESS : "</span> + result + <span class="code-quote">": "</span> + event.getCacheEntryKey());
log.debug(<span class="code-quote">"STATISTIC : Hit = "</span> + hitCount + <span class="code-quote">", stale hit ="</span>
+ staleHitCount + <span class="code-quote">", miss = "</span> + missCount);
}
}
/**
* Logs the flush of the cache.
*
* @param info the string to be logged.
*/
<span class="code-keyword">private</span> void flushed(<span class="code-object">String</span> info) {
flushCount++;
hitCountSum += hitCount;
staleHitCountSum += staleHitCount;
missCountSum += missCount;
<span class="code-keyword">if</span> (log.isInfoEnabled()) {
log.info(<span class="code-quote">"FLUSH : "</span> + info);
log.info(<span class="code-quote">"STATISTIC SUM : "</span> + <span class="code-quote">"Hit = "</span> + hitCountSum
+ <span class="code-quote">", stale hit = "</span> + staleHitCountSum + <span class="code-quote">", miss = "</span>
+ missCountSum + <span class="code-quote">", flush = "</span> + flushCount);
}
hitCount = 0;
staleHitCount = 0;
missCount = 0;
}
/**
* Event fired when a specific or all scopes are flushed.
*
* @param event ScopeEvent
* @see com.opensymphony.oscache.base.events.ScopeEventListener#scopeFlushed(ScopeEvent)
*/
<span class="code-keyword">public</span> void scopeFlushed(ScopeEvent event) {
flushed(<span class="code-quote">"scope "</span> + ScopeEventListenerImpl.SCOPE_NAMES[event.getScope()]);
}
/**
* Event fired when an entry is added to the cache.
*
* @param event CacheEntryEvent
* @see com.opensymphony.oscache.base.events.CacheEntryEventListener#cacheEntryAdded(CacheEntryEvent)
*/
<span class="code-keyword">public</span> void cacheEntryAdded(CacheEntryEvent event) {
<span class="code-comment">// <span class="code-keyword">do</span> nothing
</span> }
/**
* Event fired when an entry is flushed from the cache.
*
* @param event CacheEntryEvent
* @see com.opensymphony.oscache.base.events.CacheEntryEventListener#cacheEntryFlushed(CacheEntryEvent)
*/
<span class="code-keyword">public</span> void cacheEntryFlushed(CacheEntryEvent event) {
<span class="code-comment">// <span class="code-keyword">do</span> nothing, because a group or other flush is coming
</span> <span class="code-keyword">if</span> (!Cache.NESTED_EVENT.equals(event.getOrigin())) {
flushed(<span class="code-quote">"entry "</span> + event.getKey() + <span class="code-quote">" / "</span> + event.getOrigin());
}
}
/**
* Event fired when an entry is removed from the cache.
*
* @param event CacheEntryEvent
* @see com.opensymphony.oscache.base.events.CacheEntryEventListener#cacheEntryRemoved(CacheEntryEvent)
*/
<span class="code-keyword">public</span> void cacheEntryRemoved(CacheEntryEvent event) {
<span class="code-comment">// <span class="code-keyword">do</span> nothing
</span> }
/**
* Event fired when an entry is updated in the cache.
*
* @param event CacheEntryEvent
* @see com.opensymphony.oscache.base.events.CacheEntryEventListener#cacheEntryUpdated(CacheEntryEvent)
*/
<span class="code-keyword">public</span> void cacheEntryUpdated(CacheEntryEvent event) {
<span class="code-comment">// <span class="code-keyword">do</span> nothing
</span> }
/**
* Event fired when a group is flushed from the cache.
*
* @param event CacheGroupEvent
* @see com.opensymphony.oscache.base.events.CacheEntryEventListener#cacheGroupFlushed(CacheGroupEvent)
*/
<span class="code-keyword">public</span> void cacheGroupFlushed(CacheGroupEvent event) {
flushed(<span class="code-quote">"group "</span> + event.getGroup());
}
/**
* Event fired when a key pattern is flushed from the cache.
*
* @param event CachePatternEvent
* @see com.opensymphony.oscache.base.events.CacheEntryEventListener#cachePatternFlushed(CachePatternEvent)
*/
<span class="code-keyword">public</span> void cachePatternFlushed(CachePatternEvent event) {
flushed(<span class="code-quote">"pattern "</span> + event.getPattern());
}
/**
* An event that is fired when an entire cache gets flushed.
*
* @param event CachewideEvent
* @see com.opensymphony.oscache.base.events.CacheEntryEventListener#cacheFlushed(CachewideEvent)
*/
<span class="code-keyword">public</span> void cacheFlushed(CachewideEvent event) {
flushed(<span class="code-quote">"wide "</span> + event.getDate());
}
/**
* Return the counters in a string form
*
* @<span class="code-keyword">return</span> <span class="code-object">String</span>
*/
<span class="code-keyword">public</span> <span class="code-object">String</span> toString() {
<span class="code-keyword">return</span> <span class="code-quote">"SimpleStatisticListenerImpl: Hit = "</span> + hitCount + <span class="code-quote">" / "</span> + hitCountSum
+ <span class="code-quote">", stale hit = "</span> + staleHitCount + <span class="code-quote">" / "</span> + staleHitCountSum
+ <span class="code-quote">", miss = "</span> + missCount + <span class="code-quote">" / "</span> + missCountSum
+ <span class="code-quote">", flush = "</span> + flushCount;
}
}</pre>
</div></div>
</td>
</tr>
</table>
</body>
</html>

222
docs/wiki/Statistics_attachments/StatisticListenerImpl.java Normal file
View file

@ -0,0 +1,222 @@
/*
* Copyright (c) 2002-2003 by OpenSymphony
* All rights reserved.
*/
package com.opensymphony.oscache.extra;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import com.opensymphony.oscache.base.Cache;
import com.opensymphony.oscache.base.events.*;
/**
* A simple implementation of a statistic reporter which uses the
* CacheMapAccessEventListener, CacheEntryEventListener and ScopeEventListener.
* It uses the events to count the cache hit and misses and of course the
* flushes.
* <p>
* We are not using any synchronized so that this does not become a bottleneck.
* The consequence is that on retrieving values, the operations that are
* currently being done won't be counted.
*/
public class StatisticListenerImpl implements CacheMapAccessEventListener, CacheEntryEventListener, ScopeEventListener {
private static transient final Log log = LogFactory.getLog(StatisticListenerImpl.class);
/**
* Hit counter
*/
private int hitCount = 0;
/**
* Miss counter
*/
private int missCount = 0;
/**
* Stale hit counter
*/
private int staleHitCount = 0;
/**
* Hit counter sum
*/
private int hitCountSum = 0;
/**
* Miss counter sum
*/
private int missCountSum = 0;
/**
* Stale hit counter
*/
private int staleHitCountSum = 0;
/**
* Flush hit counter
*/
private int flushCount = 0;
/**
* Constructor, empty for us
*/
public StatisticListenerImpl() {
log.info("Creation of StatisticListenerImpl");
}
/**
* This method handles an event each time the cache is accessed
*
* @param event The event triggered when the cache was accessed
* @see com.opensymphony.oscache.base.events.CacheMapAccessEventListener#accessed(CacheMapAccessEvent)
*/
public void accessed(CacheMapAccessEvent event) {
String result = "N/A";
// Retrieve the event type and update the counters
CacheMapAccessEventType type = event.getEventType();
// Handles a hit event
if (type == CacheMapAccessEventType.HIT) {
hitCount++;
result = "HIT";
}
// Handles a stale hit event
else if (type == CacheMapAccessEventType.STALE_HIT) {
staleHitCount++;
result = "STALE HIT";
}
// Handles a miss event
else if (type == CacheMapAccessEventType.MISS) {
missCount++;
result = "MISS";
}
if (log.isDebugEnabled()) {
log.debug("ACCESS : " + result + ": " + event.getCacheEntryKey());
log.debug("STATISTIC : Hit = " + hitCount + ", stale hit ="
+ staleHitCount + ", miss = " + missCount);
}
}
/**
* Logs the flush of the cache.
*
* @param info the string to be logged.
*/
private void flushed(String info) {
flushCount++;
hitCountSum += hitCount;
staleHitCountSum += staleHitCount;
missCountSum += missCount;
if (log.isInfoEnabled()) {
log.info("FLUSH : " + info);
log.info("STATISTIC SUM : " + "Hit = " + hitCountSum
+ ", stale hit = " + staleHitCountSum + ", miss = "
+ missCountSum + ", flush = " + flushCount);
}
hitCount = 0;
staleHitCount = 0;
missCount = 0;
}
/**
* Event fired when a specific or all scopes are flushed.
*
* @param event ScopeEvent
* @see com.opensymphony.oscache.base.events.ScopeEventListener#scopeFlushed(ScopeEvent)
*/
public void scopeFlushed(ScopeEvent event) {
flushed("scope " + ScopeEventListenerImpl.SCOPE_NAMES[event.getScope()]);
}
/**
* Event fired when an entry is added to the cache.
*
* @param event CacheEntryEvent
* @see com.opensymphony.oscache.base.events.CacheEntryEventListener#cacheEntryAdded(CacheEntryEvent)
*/
public void cacheEntryAdded(CacheEntryEvent event) {
// do nothing
}
/**
* Event fired when an entry is flushed from the cache.
*
* @param event CacheEntryEvent
* @see com.opensymphony.oscache.base.events.CacheEntryEventListener#cacheEntryFlushed(CacheEntryEvent)
*/
public void cacheEntryFlushed(CacheEntryEvent event) {
// do nothing, because a group or other flush is coming
if (!Cache.NESTED_EVENT.equals(event.getOrigin())) {
flushed("entry " + event.getKey() + " / " + event.getOrigin());
}
}
/**
* Event fired when an entry is removed from the cache.
*
* @param event CacheEntryEvent
* @see com.opensymphony.oscache.base.events.CacheEntryEventListener#cacheEntryRemoved(CacheEntryEvent)
*/
public void cacheEntryRemoved(CacheEntryEvent event) {
// do nothing
}
/**
* Event fired when an entry is updated in the cache.
*
* @param event CacheEntryEvent
* @see com.opensymphony.oscache.base.events.CacheEntryEventListener#cacheEntryUpdated(CacheEntryEvent)
*/
public void cacheEntryUpdated(CacheEntryEvent event) {
// do nothing
}
/**
* Event fired when a group is flushed from the cache.
*
* @param event CacheGroupEvent
* @see com.opensymphony.oscache.base.events.CacheEntryEventListener#cacheGroupFlushed(CacheGroupEvent)
*/
public void cacheGroupFlushed(CacheGroupEvent event) {
flushed("group " + event.getGroup());
}
/**
* Event fired when a key pattern is flushed from the cache.
*
* @param event CachePatternEvent
* @see com.opensymphony.oscache.base.events.CacheEntryEventListener#cachePatternFlushed(CachePatternEvent)
*/
public void cachePatternFlushed(CachePatternEvent event) {
flushed("pattern " + event.getPattern());
}
/**
* An event that is fired when an entire cache gets flushed.
*
* @param event CachewideEvent
* @see com.opensymphony.oscache.base.events.CacheEntryEventListener#cacheFlushed(CachewideEvent)
*/
public void cacheFlushed(CachewideEvent event) {
flushed("wide " + event.getDate());
}
/**
* Return the counters in a string form
*
* @return String
*/
public String toString() {
return "StatisticListenerImpl: Hit = " + hitCount + " / " + hitCountSum
+ ", stale hit = " + staleHitCount + " / " + staleHitCountSum
+ ", miss = " + missCount + " / " + missCountSum + ", flush = "
+ flushCount;
}
}

55
docs/wiki/What is OSCache.html Normal file
View file

@ -0,0 +1,55 @@
<html>
<head>
<title>OSCache -
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">
<p><b>OSCache</b> is a widely used, high performance J2EE caching framework.</p>
<div class="panel" style="border-style: solid; "><div class="panelHeader" style="border-bottom-style: solid; "><b>The Problems Solved</b></div><div class="panelContent">
<p><b>OSCache</b> solves fundamental problems for dynamic websites:</p>
<ol>
<li><b>Caching Dynamic Content</b> - Dynamic content of some form must often be executed during each request, but sometimes that content doesn't change every request. Caching the whole page does not help because sections of the page change every request.
<ul>
<li><b>OSCache</b> solves this problem by providing a means to cache sections of JSP pages.</li>
</ul>
</li>
<li><b>Caching Binary Content</b> - Generated images and PDFs can be very costly in terms of server load.
<ul>
<li><b>OSCache</b> solves this problem through a Servlet 2.3 CachingFilter which can cache any URI (such as an entire page or a generated image/PDF)</li>
</ul>
</li>
<li><b>Error Tolerance</b> - If one error occurs somewhere on your dynamic page, chances are the whole page will be returned as an error, even if 95% of the page executed correctly.
<ul>
<li><b>OSCache</b> solves this problem by allowing you to serve the cached content in the event of an error, and then reporting the error appropriately.</li>
</ul>
</li>
</ol>
</div></div>
<div class="panel" style="border-style: solid; "><div class="panelHeader" style="border-bottom-style: solid; "><b>Brief Feature List</b></div><div class="panelContent">
<p>In addition to it's servlet-specific features, <b>OSCache</b> can be used as a generic caching solution for any Java application. A few of its generic features include:</p>
<ul>
<li><b>Caching of Arbitrary Objects</b> - You are not restricted to caching portions of JSP pages or HTTP requests. Any Java object can be cached.</li>
<li><b>Comprehensive API</b> - The <b>OSCache</b> API gives you full programmatic control over all of OSCache's features.</li>
<li><b>Persistent Caching</b> - The cache can optionally be disk-based, thereby allowing expensive-to-create data to remain cached even across application restarts.</li>
<li><b>Clustering</b> - Support for clustering of cached data can be enabled with a single configuration parameter. No code changes required.</li>
<li><b>Expiry of Cache Entries</b> - You have a huge amount of control over how cached objects expire, including pluggable RefreshPolicies if the default functionality does not meet your requirements.</li>
</ul>
</div></div>
<p>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>OSCache</b> has to offer.</p>
</td>
</tr>
</table>
</body>
</html>

BIN
docs/wiki/border/border_bottom.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 117 B

BIN
docs/wiki/border/spacer.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 43 B

BIN
docs/wiki/icons/blogentry_16.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 268 B

BIN
docs/wiki/icons/bullet_blue.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 60 B

BIN
docs/wiki/icons/comment_16.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 178 B

BIN
docs/wiki/icons/emoticons/add.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 599 B

BIN
docs/wiki/icons/emoticons/biggrin.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 696 B

BIN
docs/wiki/icons/emoticons/check.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 604 B

BIN
docs/wiki/icons/emoticons/error.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 633 B

BIN
docs/wiki/icons/emoticons/forbidden.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 613 B

BIN
docs/wiki/icons/emoticons/help_16.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 634 B

BIN
docs/wiki/icons/emoticons/information.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 1,005 B

BIN
docs/wiki/icons/emoticons/lightbulb.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 350 B

BIN
docs/wiki/icons/emoticons/lightbulb_on.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 551 B

BIN
docs/wiki/icons/emoticons/sad.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 698 B

BIN
docs/wiki/icons/emoticons/smile.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 699 B

BIN
docs/wiki/icons/emoticons/star_blue.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 569 B

BIN
docs/wiki/icons/emoticons/star_green.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 569 B

BIN
docs/wiki/icons/emoticons/star_red.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 567 B

BIN
docs/wiki/icons/emoticons/star_yellow.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 567 B

BIN
docs/wiki/icons/emoticons/thumbs_down.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 283 B

BIN
docs/wiki/icons/emoticons/thumbs_up.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 280 B

BIN
docs/wiki/icons/emoticons/tongue.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 698 B

Some files were not shown because too many files have changed in this diff Show more