Commits

Anonymous committed 3c778c1

update of WIKI pages

Comments (0)

Files changed (7)

docs/wiki/CVS and Compiling OSCache.html

+<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="CVSandCompilingOSCache-CVS">CVS</a></h3>
+
+<p>The OSCache CVS repository is hosted by <a href="http://www.java.net/" title="Visit page outside Confluence">java.net</a>.</p>
+
+<p>How to log in anonymously and to checkout the current CVS HEAD is described in <a href="https://oscache.dev.java.net/servlets/ProjectSource" title="Visit page outside Confluence">CVS client setup</a>.</p>
+
+<p>The repository is also browsable <a href="https://oscache.dev.java.net/source/browse/oscache/" title="Visit page outside Confluence">online</a>.</p>
+
+<h3><a name="CVSandCompilingOSCache-CompilingOSCache">Compiling OSCache</a></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 JDK 1.4 or later. From the OSCache directory, type</p>
+
+<ul>
+	<li>ant - build the oscache.jar</li>
+	<li>ant dist - build the distribution (only for full CVS checkout)</li>
+	<li>ant clean - 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>

docs/wiki/CacheFilter.html

 
 <h4><a name="CacheFilter-Parameter%3Ascope">Parameter: scope</a></h4>
 
-<p>The scope parameter lets you set the scope to cache content in. Valid values for the scope are <em>application</em> and <em>session</em>.</p>
+<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%3Afragment%28NEWin2.2%29">Parameter: fragment (NEW in 2.2)</a></h4>
+<h4><a name="CacheFilter-Parameter%3Afragment%28NEW%21Since2.2RC%29">Parameter: fragment (NEW! Since 2.2 RC)</a></h4>
 
 <p>Defines if the filter handles fragments of a page. Acceptable values are <em>auto</em> (<em>-1</em> in 2.2 RC) for auto detect, <em>no</em> (<em>0</em> in 2.2 RC) for false and <em>yes</em> (<em>1</em>  in 2.2 RC) 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%28NEWin2.2%29">Parameter: nocache (NEW in 2.2)</a></h4>
+<h4><a name="CacheFilter-Parameter%3Anocache%28NEW%21Since2.2RC%29">Parameter: nocache (NEW! Since 2.2 RC)</a></h4>
 
 <p>Defines which objects shouldn't be cached. Acceptable values are <em>off</em> (default) for caching all objects and <em>sessionIdInURL</em> if the session id is contained in the URL.</p>
 
-<h4><a name="CacheFilter-Parameter%3Aexpires%28NEWin2.2final%29">Parameter: expires (NEW in 2.2 final)</a></h4>
+<h4><a name="CacheFilter-Parameter%3Aexpires%28NEW%21Since2.2final%29">Parameter: expires (NEW! Since 2.2 final)</a></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.</p>
 
 <div class="information-block" align='center'><div class='informationMacroPadding'><table cellpadding='5' width='85%' cellspacing='0' class='noteMacro' border='0'><tr><td width='16' valign='top'><img src="/images/icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b class="strong">Value time</b><br />
 <p>The last parameter time 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.</p></td></tr></table></div></div>
 
-<h4><a name="CacheFilter-Parameter%3AICacheKeyProvider%28NEWin2.2%29">Parameter: ICacheKeyProvider (NEW in 2.2)</a></h4>
+<h4><a name="CacheFilter-Parameter%3AICacheKeyProvider%28NEW%21Since2.2RC%29">Parameter: ICacheKeyProvider (NEW! Since 2.2 RC)</a></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%28NEWin2.2final%29">Parameter: ICacheGroupsProvider (NEW in 2.2 final)</a></h4>
+<h4><a name="CacheFilter-Parameter%3AICacheGroupsProvider%28NEW%21Since2.2final%29">Parameter: ICacheGroupsProvider (NEW! Since 2.2 final)</a></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>
 

docs/wiki/Configuration.html

 </pre>
 </div></div>
 
-<h4><a name="Configuration-cache.persistence.overflow.only%28NEW%21%29">cache.persistence.overflow.only  (NEW!)</a></h4>
+<h4><a name="Configuration-cache.persistence.overflow.only%28NEW%21Since2.1%29">cache.persistence.overflow.only  (NEW! Since 2.1)</a></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>
 

docs/wiki/Documentation.html

 <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><a href="http://www.opensymphony.com/ci/oscache" title="Visit page outside Confluence">Build and Test Reports</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>
 
 
 	<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="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="CVS and Compiling OSCache.html" title="CVS and Compiling OSCache">CVS and Compiling OSCache</a> - How to access CVS and compile OSCache</li>
 </ol>
 
 
 <h3><a name="Documentation-6.Links">6. Links</a></h3>
 <ol>
 	<li><a href="http://www.opensymphony.com/oscache/" title="Visit page outside Confluence">Current Release Home</a></li>
+	<li><a href="https://oscache.dev.java.net/servlets/ProjectDocumentList" title="Visit page outside Confluence">Download Source and Binaries</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/source/browse/oscache/" title="Visit page outside Confluence">CVS Access</a></li>
 	<li><a href="https://oscache.dev.java.net/" title="Visit page outside Confluence">dev.java.net Project</a></li>
-	<li><a href="https://oscache.dev.java.net/servlets/ProjectDocumentList" title="Visit page outside Confluence">Download Source and Binaries</a></li>
-	<li><a href="https://oscache.dev.java.net/source/browse/oscache/" title="Visit page outside Confluence">CVS Access</a></li>
 	<li><a href="https://oscache.dev.java.net/servlets/ProjectMailingListList" title="Visit page outside Confluence">Mailing List</a></li>
-	<li><a href="http://forums.opensymphony.com/forum.jspa?forumID=4" title="Visit page outside Confluence">Support Forum</a></li>
 </ol>
 
 

docs/wiki/FAQ.html

 
 <h4><a name="FAQ-CanyougivemesomeexamplesofhowtheOSCachetagsareused%3F"><a name="FAQ-tags"></a>Can you give me some examples of how the OSCache tags are used?</a></h4>
 <div class="code"><div class="codeHeader"><b>Example 1</b></div><div class="codeContent">
-<div class="error"><span class="error">Unable to find source-code formatter for language: xml .</span> Available languages are: xhtml, javascript, java, none, html, actionscript, xml, sql</div><pre class="code-xml ">&lt;cache:cache time=<span class="code-quote">"600"</span>&gt;
-        &lt;%= myBean.getTitle() %&gt;
-    &lt;/cache:cache&gt;</pre>
+<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">
-<div class="error"><span class="error">Unable to find source-code formatter for language: xml .</span> Available languages are: xhtml, javascript, java, none, html, actionscript, xml, sql</div><pre class="code-xml ">&lt;cache:cache key=<span class="code-quote">"foobar"</span> scope=<span class="code-quote">"session"</span>&gt;
-        &lt;%= myBean.getTitle() %&gt;
-    &lt;/cache:cache&gt;</pre>
+<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">
-<div class="error"><span class="error">Unable to find source-code formatter for language: xml .</span> Available languages are: xhtml, javascript, java, none, html, actionscript, xml, sql</div><pre class="code-xml ">(a very powerful &amp; useful way to use the taglibs):
+<pre class="code-xml">(a very powerful &amp; useful way to use the taglibs):
 
-    &lt;cache:cache&gt;
-        &lt;% <span class="code-keyword">try</span> { %&gt;
-            &lt;%= myBean.getTitle() %&gt;&gt;
-        &lt;% } <span class="code-keyword">catch</span> (Exception e) { %&gt;
-            &lt;% application.log(<span class="code-quote">"Exception occurred in myBean.getTitle(): "</span> + e); %&gt;
-            &lt;cache:usecached /&gt;
-        &lt;% } %&gt;
-    &lt;/cache:cache&gt;</pre>
+    <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>
 
 
 
 <div class="code"><div class="codeHeader"><b>Example 1:displayProduct.jsp</b></div><div class="codeContent">
-<div class="error"><span class="error">Unable to find source-code formatter for language: xml .</span> Available languages are: xhtml, javascript, java, none, html, actionscript, xml, sql</div><pre class="code-xml ">...
-    &lt;cache:cache key=<span class="code-quote">"myKey1"</span> groups=<span class="code-quote">"product100,datafeed"</span>&gt;
-        &lt;%= myProductBean.getProduct(100).getName() %&gt;
-        &lt;%= myDatafeedBean.getDataFeed().getTotal() %&gt;
-    &lt;/cache:cache&gt;
+<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">
-<div class="error"><span class="error">Unable to find source-code formatter for language: xml .</span> Available languages are: xhtml, javascript, java, none, html, actionscript, xml, sql</div><pre class="code-xml ">...
-    &lt;%= myDatafeedBean.refreshDatafeed() %&gt;
+<pre class="code-xml">...
+    <span class="code-tag">&lt;%= myDatafeedBean.refreshDatafeed() %&gt;</span>
 
-    &lt;%-- Flush all cache entries that depend on the datafeed --%&gt;
-    &lt;cache:flush group=<span class="code-quote">"datafeed"</span> scope=<span class="code-quote">"application"</span>&gt;
+    <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>
 

docs/wiki/Roadmap.html

 
 <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-OSCache2.2final">OSCache 2.2 final</a></h3>
+
+<p>
+    <table  width="100%" cellspacing="0" class="grid">
+        <tr>
+            <th colspan="4" style="text-align: left;">
+                <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">(6 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-201"><img src="http://jira.opensymphony.com/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/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/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/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/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/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/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/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/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/images/icons/status_resolved.gif" alt="Resolved" border="0" />Resolved
+                                    </td>
+                            </tr>
+                                    <tr class="rowAlternate">
+                                                            <td nowrap="true">
+                                            <a href="http://jira.opensymphony.com/browse/CACHE-194"><img src="http://jira.opensymphony.com/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/images/icons/status_open.gif" alt="Open" border="0" />Open
+                                    </td>
+                            </tr>
+            </table>
+</p>
+
+
 <h3><a name="Roadmap-OSCache2.3">OSCache 2.3</a></h3>
 
 <p>The administration of the cache and the support of the gzip compression in CacheFilter are the focus of this release.</p>

docs/wiki/index.html

            <tr>                <td><a href="#index-0-9">0-9</a> ... 0</td>
                                                                       <td><a href="#index-A">A</a> ... 1</td>
                                                                       <td><a href="#index-B">B</a> ... 0</td>
-                                                                      <td><a href="#index-C">C</a> ... 6</td>
+                                                                      <td><a href="#index-C">C</a> ... 7</td>
                                                                       <td><a href="#index-D">D</a> ... 1</td>
                                                                       <td><a href="#index-E">E</a> ... 0</td>
                                                               </tr><tr>
                                   <a href="/display/CACHE/Cron+Expressions">Cron Expressions</a>
     <br />
              <div class="smalltext" style="margin: 0 0 0 36px">Prior to version 2.0 of OSCache, content expiry could only be specified in terms of how long a piece of content had been in the cache, ie, it was based on the age of the content....</div>
+                                  <a href="/display/CACHE/CVS+and+Compiling+OSCache">CVS and Compiling OSCache</a>
+    <br />
+             <div class="smalltext" style="margin: 0 0 0 36px">CVS  The OSCache CVS repository is hosted by java.net</div>
         </td>
                                       </tr><tr valign="top">
                            <td><h4 style="margin-top: 0px"><a name="index-D"></a>D</h4>