You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by tv...@apache.org on 2018/08/23 13:24:56 UTC
svn commit: r28907 [6/15] - /dev/commons/jcs/site-2.2.1-RC4/
Added: dev/commons/jcs/site-2.2.1-RC4/LocalCacheConfig.html
==============================================================================
--- dev/commons/jcs/site-2.2.1-RC4/LocalCacheConfig.html (added)
+++ dev/commons/jcs/site-2.2.1-RC4/LocalCacheConfig.html Thu Aug 23 13:24:56 2018
@@ -0,0 +1,499 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 23 August 2018
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="author" content="Pete Kazmier" />
+ <meta name="author" content="Aaron Smuts" />
+ <meta name="Date-Revision-yyyymmdd" content="20180823" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>JCS – Configuring the Local Cache</title>
+
+ <link rel="stylesheet" href="./css/bootstrap.min.css" type="text/css" />
+ <link rel="stylesheet" href="./css/site.css" type="text/css" />
+ <link rel="stylesheet" href="./css/print.css" media="print" />
+
+ <script type="text/javascript" src="./js/jquery.min.js"></script>
+ <script type="text/javascript" src="./js/bootstrap.min.js"></script>
+ <script type="text/javascript" src="./js/prettify.min.js"></script>
+ <script type="text/javascript" src="./js/site.js"></script>
+
+
+ </head>
+
+ <body class="composite">
+ <a href="http://commons.apache.org/" id="bannerLeft" title="Apache Commons logo">
+ <img class="logo-left" src="./images/commons-logo.png" alt="Apache Commons logo"/>
+ </a>
+ <a href="index.html" id="bannerRight">
+ <h2>Commons JCSâ¢</h2>
+ </a>
+ <div class="clear"></div>
+
+ <div class="navbar">
+ <div class="navbar-inner">
+ <div class="container-fluid">
+ <a class="brand" href="http://commons.apache.org/proper/commons-jcs/">Apache Commons JCS ™</a>
+ <ul class="nav">
+
+ <li id="publishDate">Last Published: 23 August 2018</li>
+ <li class="divider">|</li> <li id="projectVersion">Version: 2.2.1</li>
+ </ul>
+ <div class="pull-right"> <ul class="nav">
+ <li>
+ <a href="http://www.apachecon.com/" class="externalLink" title="ApacheCon">
+ ApacheCon</a>
+ </li>
+ <li>
+ <a href="http://www.apache.org" class="externalLink" title="Apache">
+ Apache</a>
+ </li>
+ <li>
+ <a href="../../" title="Commons">
+ Commons</a>
+ </li>
+ </ul>
+</div>
+ </div>
+ </div>
+ </div>
+
+ <div class="container-fluid">
+ <table class="layout-table">
+ <tr>
+ <td class="sidebar">
+ <div class="well sidebar-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">JCS</li>
+ <li class="none">
+ <a href="index.html" title="Overview">
+ Overview</a>
+ </li>
+ <li class="none">
+ <a href="JCSandJCACHE.html" title="JCS and JCACHE">
+ JCS and JCACHE</a>
+ </li>
+ <li class="none">
+ <a href="download_jcs.cgi" title="Downloads">
+ Downloads</a>
+ </li>
+ <li class="none">
+ <a href="faq.html" title="FAQ">
+ FAQ</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header"><i class="icon-cog"></i>Development</li>
+ <li class="none">
+ <a href="changes-report.html" title="Release Notes">
+ Release Notes</a>
+ </li>
+ <li class="none">
+ <a href="UpgradingFrom13.html" title="Upgrading from 1.3 to 2.0">
+ Upgrading from 1.3 to 2.0</a>
+ </li>
+ <li class="none">
+ <a href="mail-lists.html" title="Mailing Lists">
+ Mailing Lists</a>
+ </li>
+ <li class="none">
+ <a href="issue-tracking.html" title="Issue Tracking">
+ Issue Tracking</a>
+ </li>
+ <li class="none">
+ <a href="source-repository.html" title="Source Repository">
+ Source Repository</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-core/apidocs/index.html" title="Core Javadoc (SVN latest)">
+ Core Javadoc (SVN latest)</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">Getting Started</li>
+ <li class="none">
+ <a href="getting_started/intro.html" title="Overview">
+ Overview</a>
+ </li>
+ <li class="none">
+ <a href="BasicJCSConfiguration.html" title="Basic JCS Config">
+ Basic JCS Config</a>
+ </li>
+ <li class="none">
+ <a href="JCSPlugins.html" title="Plugin Overview">
+ Plugin Overview</a>
+ </li>
+ <li class="none">
+ <a href="UsingJCSBasicWeb.html" title="Basic Web Example">
+ Basic Web Example</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">JCS User's Guide</li>
+ <li class="expanded active">
+ <a href="LocalCacheConfig.html" title="Core">
+ Core</a>
+ <ul>
+ <li class="none">
+ <a href="BasicJCSConfiguration.html" title="Basic JCS Config">
+ Basic JCS Config</a>
+ </li>
+ <li class="none">
+ <a href="ElementAttributes.html" title="Element Config">
+ Element Config</a>
+ </li>
+ <li class="none">
+ <a href="ElementEventHandling.html" title="Element Event Handling">
+ Element Event Handling</a>
+ </li>
+ <li class="none">
+ <a href="RegionProperties.html" title="Region Properties">
+ Region Properties</a>
+ </li>
+ <li class="none">
+ <a href="UsingJCSBasicWeb.html" title="Basic Web Example">
+ Basic Web Example</a>
+ </li>
+ <li class="none">
+ <a href="ProjectHistory.html" title="Project History">
+ Project History</a>
+ </li>
+ </ul>
+ </li>
+ <li class="collapsed">
+ <a href="JCSPlugins.html" title="Auxiliary">
+ Auxiliary</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">Modules</li>
+ <li class="none">
+ <a href="commons-jcs-core/index.html" title="Apache Commons JCS :: Core">
+ Apache Commons JCS :: Core</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache/index.html" title="Apache Commons JCS :: JCache">
+ Apache Commons JCS :: JCache</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache-tck/index.html" title="Apache Commons JCS :: JCache TCK">
+ Apache Commons JCS :: JCache TCK</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache-extras/index.html" title="Apache Commons JCS :: JCache Extras">
+ Apache Commons JCS :: JCache Extras</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache-openjpa/index.html" title="Apache Commons JCS :: JCache OpenJPA">
+ Apache Commons JCS :: JCache OpenJPA</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-dist/index.html" title="Apache Commons JCS :: Distribution">
+ Apache Commons JCS :: Distribution</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header"><i class="icon-info-sign"></i>Project Documentation</li>
+ <li class="collapsed">
+ <a href="project-info.html" title="Project Information">
+ Project Information</a>
+ </li>
+ <li class="collapsed">
+ <a href="project-reports.html" title="Project Reports">
+ Project Reports</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">Commons</li>
+ <li class="none">
+ <a href="../../" title="Home">
+ Home</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/licenses/" class="externalLink" title="License">
+ License</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../components.html" title="Components">
+ Components</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../sandbox/index.html" title="Sandbox">
+ Sandbox</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../dormant/index.html" title="Dormant">
+ Dormant</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">General Information</li>
+ <li class="none">
+ <a href="../../security.html" title="Security">
+ Security</a>
+ </li>
+ <li class="none">
+ <a href="../../volunteering.html" title="Volunteering">
+ Volunteering</a>
+ </li>
+ <li class="none">
+ <a href="../../patches.html" title="Contributing Patches">
+ Contributing Patches</a>
+ </li>
+ <li class="none">
+ <a href="../../building.html" title="Building Components">
+ Building Components</a>
+ </li>
+ <li class="none">
+ <a href="../../commons-parent-pom.html" title="Commons Parent Pom">
+ Commons Parent Pom</a>
+ </li>
+ <li class="none">
+ <a href="../../build-plugin/index.html" title="Commons Build Plugin">
+ Commons Build Plugin</a>
+ </li>
+ <li class="none">
+ <a href="../../releases/index.html" title="Releasing Components">
+ Releasing Components</a>
+ </li>
+ <li class="none">
+ <a href="http://wiki.apache.org/commons/FrontPage" class="externalLink" title="Wiki">
+ Wiki</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">ASF</li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How the ASF works">
+ How the ASF works</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/getinvolved.html" class="externalLink" title="Get Involved">
+ Get Involved</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/dev/" class="externalLink" title="Developer Resources">
+ Developer Resources</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/policies/conduct.html" class="externalLink" title="Code of Conduct">
+ Code of Conduct</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship">
+ Sponsorship</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">
+ Thanks</a>
+ </li>
+ </ul>
+ </div>
+ <div id="poweredBy">
+ <a href="http://www.apache.org/events/current-event.html" title="ApacheCon" class="builtBy">
+ <img class="builtBy" alt="ApacheCon" src="http://www.apache.org/events/current-event-125x125.png" />
+ </a>
+ <a href="http://maven.apache.org/" title="Maven" class="builtBy">
+ <img class="builtBy" alt="Maven" src="http://maven.apache.org/images/logos/maven-feather.png" />
+ </a>
+ </div>
+ </td>
+ <td class="content">
+
+
+ <div class="section">
+<h2><a name="Configuring_the_Local_Cache"></a>Configuring the Local Cache</h2>
+
+<p>
+ This document is intended to provide various answers to
+ questions regarding the configuration of a local cache. The
+ document is presented in a question / answer format.
+ </p>
+
+<div class="section">
+<h3><a name="Where_is_the_configuration_information.3F"></a>Where is the configuration information?</h3>
+
+<p>
+ Configuration of local caches involves editing the cache
+ configuration file, named <tt>cache.ccf</tt>. The
+ classpath should include the directory where this file is
+ located or the file should be placed at the root of the
+ classpath, since it is discovered automatically.
+ </p>
+ </div>
+
+<div class="section">
+<h3><a name="What_is_in_the_cache.ccf_file.3F"></a>What is in the cache.ccf file?</h3>
+
+<p>
+ The <tt>cache.ccf</tt> file contains default configuration
+ information for cache regions and specific configuration
+ information for regions that you predefine. Regions not using
+ default behaviors should generally be configured via the
+ <tt>cache.ccf</tt> file. If you can put configuration
+ information in a class, you can edit a props file just as
+ easily. This makes modification of the regional setting more
+ efficient and allows for startup error checking.
+ </p>
+
+<p>
+ There are three main sections of the <tt>cache.ccf</tt>
+ file:
+ </p>
+
+<ul>
+
+<li> the default and system settings </li>
+
+<li> the region specific settings </li>
+
+<li> the auxiliary cache definitions </li>
+ </ul>
+ </div>
+
+<div class="section">
+<h3><a name="How_do_I_set_up_default_values_for_regions.3F"></a>How do I set up default values for regions?</h3>
+
+<p>
+ You can establish default values that any non-preconfigured
+ region will inherit. The non-predefined region will be
+ created when you call
+ <tt>CacheAccess.getAccess("cacheName")</tt>. The default
+ setting look like this:
+ </p>
+
+<div class="source">
+<pre>
+# DEFAULT CACHE REGION
+
+# sets the default aux value for any non configured caches
+jcs.default=DC,RFailover
+jcs.default.cacheattributes=
+ org.apache.commons.jcs.engine.CompositeCacheAttributes
+jcs.default.cacheattributes.MaxObjects=1000
+ </pre></div>
+
+<p>
+ The most important line is
+ <tt>jcs.default=DC,Rfailover</tt>. This tells the cache
+ what auxiliary caches should be used. Auxiliary caches are
+ configured in the third section of the <tt>cache.ccf</tt>
+ and are referenced in a comma separated list. You can add as
+ many auxiliary caches as you want, but the behavior of remote
+ and lateral auxiliaries may conflict. This allows you to
+ define different configurations for auxiliary caches and to
+ use these different configurations for different regions.
+ </p>
+ </div>
+
+<div class="section">
+<h3><a name="How_do_I_define_a_region.3F"></a>How do I define a region?</h3>
+
+<p>
+ Defining a region involves specifying which auxiliary caches
+ it will use and how many objects it will store in memory. A
+ typical region definition looks like:
+ </p>
+
+<div class="source">
+<pre>
+jcs.region.testCache=DC,RFailover
+jcs.region.testCache.cacheattributes=
+ org.apache.commons.jcs.engine.CompositeCacheAttributes
+jcs.region.testCache.cacheattributes.MaxObjects=1000
+ </pre></div>
+
+<p>
+ The region name is <tt>testCache</tt>. It will have a
+ 1000 item memory limit and will use the DC and RFailover
+ auxiliary caches. If a typical element for this region was
+ very large, you might want to lower the number of items stored
+ in memory. The size of the memory storage is dependent on the
+ priority of the cache, the size of its elements, and the
+ amount of RAM on the machine.
+ </p>
+ </div>
+
+<div class="section">
+<h3><a name="How_do_I_configure_an_auxiliary_cache.3F"></a>How do I configure an auxiliary cache?</h3>
+
+<p>
+ Each auxiliary cache is created through a factory that passes
+ an attribute object to the constructor. The attributes are
+ set via reflection and should be fairly simple to understand.
+ Each auxiliary cache will be fully documented. Plugging in
+ your own auxiliary cache become a simple matter given the
+ reflexive manner of initialization.
+ </p>
+
+<p>
+ The most important settings for common usage are the disk path
+ and the remote cache location. It is recommended that only
+ disk and remote auxiliaries be used. The lateral caches are
+ functional but not as efficient.
+ </p>
+
+<p>
+ The default configuration code above specifies that
+ non-preconfigured caches use the auxiliary cache by the name
+ DC. This cache is defined in the third section of the file:
+ </p>
+
+<div class="source">
+<pre>
+jcs.auxiliary.DC=
+ org.apache.commons.jcs.auxiliary.disk.DiskCacheFactory
+jcs.auxiliary.DC.attributes=
+ org.apache.commons.jcs.auxiliary.disk.DiskCacheAttributes
+jcs.auxiliary.DC.attributes.DiskPath=c:/dev/cache/raf
+ </pre></div>
+
+<p>
+ The only thing that needs to be set here is the
+ <tt>DiskPath</tt> value. Change it to wherever you want
+ the cache to persist unused items.
+ </p>
+
+<p>
+ The default region is also set to use an auxiliary called
+ <tt>RFailover</tt>. This is a remote cache that is
+ designed to failover to other remote servers in a cluster:
+ </p>
+
+<div class="source">
+<pre>
+jcs.auxiliary.RFailover=
+ org.apache.commons.jcs.auxiliary.remote.RemoteCacheFactory
+jcs.auxiliary.RFailover.attributes=
+ org.apache.commons.jcs.auxiliary.remote.RemoteCacheAttributes
+jcs.auxiliary.RFailover.attributes.RemoteTypeName=LOCAL
+jcs.auxiliary.RFailover.attributes.FailoverServers=
+ localhost:1102,localhost:1101
+ </pre></div>
+
+<p>
+ If you don't have more than one remote server running, just
+ specify it by itself in the <tt>FailoverServers</tt>
+ attribute.
+ </p>
+ </div>
+ </div>
+
+
+ </td>
+ </tr>
+ </table>
+ </div>
+
+ <div class="footer">
+ <p>Copyright © 2002-2018
+ <a href="https://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.</p>
+ </div>
+ </body>
+
+</html>
Added: dev/commons/jcs/site-2.2.1-RC4/MySQLDiskCacheProperties.html
==============================================================================
--- dev/commons/jcs/site-2.2.1-RC4/MySQLDiskCacheProperties.html (added)
+++ dev/commons/jcs/site-2.2.1-RC4/MySQLDiskCacheProperties.html Thu Aug 23 13:24:56 2018
@@ -0,0 +1,564 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 23 August 2018
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="author" content="Aaron Smuts" />
+ <meta name="Date-Revision-yyyymmdd" content="20180823" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>JCS – MySQL Disk Cache Configuration</title>
+
+ <link rel="stylesheet" href="./css/bootstrap.min.css" type="text/css" />
+ <link rel="stylesheet" href="./css/site.css" type="text/css" />
+ <link rel="stylesheet" href="./css/print.css" media="print" />
+
+ <script type="text/javascript" src="./js/jquery.min.js"></script>
+ <script type="text/javascript" src="./js/bootstrap.min.js"></script>
+ <script type="text/javascript" src="./js/prettify.min.js"></script>
+ <script type="text/javascript" src="./js/site.js"></script>
+
+
+ </head>
+
+ <body class="composite">
+ <a href="http://commons.apache.org/" id="bannerLeft" title="Apache Commons logo">
+ <img class="logo-left" src="./images/commons-logo.png" alt="Apache Commons logo"/>
+ </a>
+ <a href="index.html" id="bannerRight">
+ <h2>Commons JCSâ¢</h2>
+ </a>
+ <div class="clear"></div>
+
+ <div class="navbar">
+ <div class="navbar-inner">
+ <div class="container-fluid">
+ <a class="brand" href="http://commons.apache.org/proper/commons-jcs/">Apache Commons JCS ™</a>
+ <ul class="nav">
+
+ <li id="publishDate">Last Published: 23 August 2018</li>
+ <li class="divider">|</li> <li id="projectVersion">Version: 2.2.1</li>
+ </ul>
+ <div class="pull-right"> <ul class="nav">
+ <li>
+ <a href="http://www.apachecon.com/" class="externalLink" title="ApacheCon">
+ ApacheCon</a>
+ </li>
+ <li>
+ <a href="http://www.apache.org" class="externalLink" title="Apache">
+ Apache</a>
+ </li>
+ <li>
+ <a href="../../" title="Commons">
+ Commons</a>
+ </li>
+ </ul>
+</div>
+ </div>
+ </div>
+ </div>
+
+ <div class="container-fluid">
+ <table class="layout-table">
+ <tr>
+ <td class="sidebar">
+ <div class="well sidebar-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">JCS</li>
+ <li class="none">
+ <a href="index.html" title="Overview">
+ Overview</a>
+ </li>
+ <li class="none">
+ <a href="JCSandJCACHE.html" title="JCS and JCACHE">
+ JCS and JCACHE</a>
+ </li>
+ <li class="none">
+ <a href="download_jcs.cgi" title="Downloads">
+ Downloads</a>
+ </li>
+ <li class="none">
+ <a href="faq.html" title="FAQ">
+ FAQ</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header"><i class="icon-cog"></i>Development</li>
+ <li class="none">
+ <a href="changes-report.html" title="Release Notes">
+ Release Notes</a>
+ </li>
+ <li class="none">
+ <a href="UpgradingFrom13.html" title="Upgrading from 1.3 to 2.0">
+ Upgrading from 1.3 to 2.0</a>
+ </li>
+ <li class="none">
+ <a href="mail-lists.html" title="Mailing Lists">
+ Mailing Lists</a>
+ </li>
+ <li class="none">
+ <a href="issue-tracking.html" title="Issue Tracking">
+ Issue Tracking</a>
+ </li>
+ <li class="none">
+ <a href="source-repository.html" title="Source Repository">
+ Source Repository</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-core/apidocs/index.html" title="Core Javadoc (SVN latest)">
+ Core Javadoc (SVN latest)</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">Getting Started</li>
+ <li class="none">
+ <a href="getting_started/intro.html" title="Overview">
+ Overview</a>
+ </li>
+ <li class="none">
+ <a href="BasicJCSConfiguration.html" title="Basic JCS Config">
+ Basic JCS Config</a>
+ </li>
+ <li class="none">
+ <a href="JCSPlugins.html" title="Plugin Overview">
+ Plugin Overview</a>
+ </li>
+ <li class="none">
+ <a href="UsingJCSBasicWeb.html" title="Basic Web Example">
+ Basic Web Example</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">JCS User's Guide</li>
+ <li class="collapsed">
+ <a href="LocalCacheConfig.html" title="Core">
+ Core</a>
+ </li>
+ <li class="expanded">
+ <a href="JCSPlugins.html" title="Auxiliary">
+ Auxiliary</a>
+ <ul>
+ <li class="none">
+ <a href="CacheEventLogging.html" title="Cache Event Logging">
+ Cache Event Logging</a>
+ </li>
+ <li class="none">
+ <a href="IndexedDiskAuxCache.html" title="Indexed Disk Cache">
+ Indexed Disk Cache</a>
+ </li>
+ <li class="none">
+ <a href="IndexedDiskCacheProperties.html" title="Indexed Disk Properties">
+ Indexed Disk Properties</a>
+ </li>
+ <li class="none">
+ <a href="BlockDiskCache.html" title="Block Disk Cache">
+ Block Disk Cache</a>
+ </li>
+ <li class="none">
+ <a href="JDBCDiskCache.html" title="JDBC Disk Cache">
+ JDBC Disk Cache</a>
+ </li>
+ <li class="none">
+ <a href="JDBCDiskCacheProperties.html" title="JDBC Disk Properties">
+ JDBC Disk Properties</a>
+ </li>
+ <li class="none active">
+ <a href="MySQLDiskCacheProperties.html" title="MySQL Disk Properties">
+ MySQL Disk Properties</a>
+ </li>
+ <li class="none">
+ <a href="RemoteAuxCache.html" title="Remote Cache">
+ Remote Cache</a>
+ </li>
+ <li class="none">
+ <a href="RemoteCacheProperties.html" title="Remote Cache Properties">
+ Remote Cache Properties</a>
+ </li>
+ <li class="none">
+ <a href="RemoteHttpCacheProperties.html" title="Remote Http Cache Properties">
+ Remote Http Cache Properties</a>
+ </li>
+ <li class="none">
+ <a href="LateralTCPAuxCache.html" title="Lateral TCP Cache">
+ Lateral TCP Cache</a>
+ </li>
+ <li class="none">
+ <a href="LateralTCPProperties.html" title="Lateral TCP Properties">
+ Lateral TCP Properties</a>
+ </li>
+ <li class="none">
+ <a href="LateralUDPDiscovery.html" title="Lateral UDP Discovery">
+ Lateral UDP Discovery</a>
+ </li>
+ <li class="none">
+ <a href="LateralJavaGroupsAuxCache.html" title="Lateral JGroups Cache">
+ Lateral JGroups Cache</a>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">Modules</li>
+ <li class="none">
+ <a href="commons-jcs-core/index.html" title="Apache Commons JCS :: Core">
+ Apache Commons JCS :: Core</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache/index.html" title="Apache Commons JCS :: JCache">
+ Apache Commons JCS :: JCache</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache-tck/index.html" title="Apache Commons JCS :: JCache TCK">
+ Apache Commons JCS :: JCache TCK</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache-extras/index.html" title="Apache Commons JCS :: JCache Extras">
+ Apache Commons JCS :: JCache Extras</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache-openjpa/index.html" title="Apache Commons JCS :: JCache OpenJPA">
+ Apache Commons JCS :: JCache OpenJPA</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-dist/index.html" title="Apache Commons JCS :: Distribution">
+ Apache Commons JCS :: Distribution</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header"><i class="icon-info-sign"></i>Project Documentation</li>
+ <li class="collapsed">
+ <a href="project-info.html" title="Project Information">
+ Project Information</a>
+ </li>
+ <li class="collapsed">
+ <a href="project-reports.html" title="Project Reports">
+ Project Reports</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">Commons</li>
+ <li class="none">
+ <a href="../../" title="Home">
+ Home</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/licenses/" class="externalLink" title="License">
+ License</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../components.html" title="Components">
+ Components</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../sandbox/index.html" title="Sandbox">
+ Sandbox</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../dormant/index.html" title="Dormant">
+ Dormant</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">General Information</li>
+ <li class="none">
+ <a href="../../security.html" title="Security">
+ Security</a>
+ </li>
+ <li class="none">
+ <a href="../../volunteering.html" title="Volunteering">
+ Volunteering</a>
+ </li>
+ <li class="none">
+ <a href="../../patches.html" title="Contributing Patches">
+ Contributing Patches</a>
+ </li>
+ <li class="none">
+ <a href="../../building.html" title="Building Components">
+ Building Components</a>
+ </li>
+ <li class="none">
+ <a href="../../commons-parent-pom.html" title="Commons Parent Pom">
+ Commons Parent Pom</a>
+ </li>
+ <li class="none">
+ <a href="../../build-plugin/index.html" title="Commons Build Plugin">
+ Commons Build Plugin</a>
+ </li>
+ <li class="none">
+ <a href="../../releases/index.html" title="Releasing Components">
+ Releasing Components</a>
+ </li>
+ <li class="none">
+ <a href="http://wiki.apache.org/commons/FrontPage" class="externalLink" title="Wiki">
+ Wiki</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">ASF</li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How the ASF works">
+ How the ASF works</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/getinvolved.html" class="externalLink" title="Get Involved">
+ Get Involved</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/dev/" class="externalLink" title="Developer Resources">
+ Developer Resources</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/policies/conduct.html" class="externalLink" title="Code of Conduct">
+ Code of Conduct</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship">
+ Sponsorship</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">
+ Thanks</a>
+ </li>
+ </ul>
+ </div>
+ <div id="poweredBy">
+ <a href="http://www.apache.org/events/current-event.html" title="ApacheCon" class="builtBy">
+ <img class="builtBy" alt="ApacheCon" src="http://www.apache.org/events/current-event-125x125.png" />
+ </a>
+ <a href="http://maven.apache.org/" title="Maven" class="builtBy">
+ <img class="builtBy" alt="Maven" src="http://maven.apache.org/images/logos/maven-feather.png" />
+ </a>
+ </div>
+ </td>
+ <td class="content">
+
+
+ <div class="section">
+<h2><a name="MySQL_Disk_Auxiliary_Cache_Configuration"></a>MySQL Disk Auxiliary Cache Configuration</h2>
+
+
+<p>
+ The MySQL Disk Cache uses all of the JDBC Disk Cache
+ properties. It adds a few of its own. The following
+ properties only apply to the MySQL Disk Cache plugin.
+ </p>
+
+
+<div class="section">
+<h3><a name="MySQL_Disk_Configuration_Properties"></a>MySQL Disk Configuration Properties</h3>
+
+<table border="0" class="bodyTable">
+
+<tr class="a">
+
+<th>Property</th>
+
+<th>Description</th>
+
+<th>Required</th>
+
+<th>Default Value</th>
+ </tr>
+
+<tr class="b">
+
+<td>optimizationSchedule</td>
+
+<td>
+ For now this is a simple comma delimited
+ list of HH:MM:SS times to optimize the
+ table. If none is supplied, then no
+ optimizations will be performed.
+
+ In the future we can add a cron like
+ scheduling system. This was created to meet
+ a pressing need to optimize fragmented
+ MyISAM tables. When the table becomes
+ fragmented, it starts to take a long time to
+ run the shrinker that deletes expired
+ elements.
+
+ Setting the value to "03:01,15:00" will
+ cause the optimizer to run at 3 am and at 3
+ pm.
+ </td>
+
+<td>N</td>
+
+<td>null</td>
+ </tr>
+
+
+<tr class="a">
+
+<td>balkDuringOptimization</td>
+
+<td>
+ If this is true, then when JCS is optimizing
+ the table it will return null from get
+ requests and do nothing for put requests.
+
+ If you are using the remote cache and have a
+ failover server configured in a remote cache
+ cluster, and you allow clustered gets, the
+ primary server will act as a proxy to the
+ failover. This way, optimization should have
+ no impact for clients of the remote cache.
+ </td>
+
+<td>N</td>
+
+<td>true</td>
+ </tr>
+
+ </table>
+ </div>
+
+
+<div class="section">
+<h3><a name="Example_Configuration"></a>Example Configuration</h3>
+
+<div class="source">
+<pre>
+
+##############################################################
+################## AUXILIARY CACHES AVAILABLE ################
+# MYSQL disk cache
+jcs.auxiliary.MYSQL=org.apache.commons.jcs.auxiliary.disk.jdbc.mysql.MySQLDiskCacheFactory
+jcs.auxiliary.MYSQL.attributes=org.apache.commons.jcs.auxiliary.disk.jdbc.mysql.MySQLDiskCacheAttributes
+jcs.auxiliary.MYSQL.attributes.userName=sa
+jcs.auxiliary.MYSQL.attributes.password=
+jcs.auxiliary.MYSQL.attributes.url=jdbc:hsqldb:target/cache_hsql_db
+jcs.auxiliary.MYSQL.attributes.driverClassName=org.hsqldb.jdbcDriver
+jcs.auxiliary.MYSQL.attributes.tableName=JCS_STORE_MYSQL
+jcs.auxiliary.MYSQL.attributes.testBeforeInsert=false
+jcs.auxiliary.MYSQL.attributes.maxActive=15
+jcs.auxiliary.MYSQL.attributes.allowRemoveAll=true
+jcs.auxiliary.MYSQL.attributes.MaxPurgatorySize=10000000
+jcs.auxiliary.MYSQL.attributes.optimizationSchedule=12:34:56,02:34:54
+jcs.auxiliary.MYSQL.attributes.balkDuringOptimization=true
+
+ </pre></div>
+ </div>
+
+
+<div class="section">
+<h3><a name="MySQL_Disk_Event_Queue_Configuration"></a>MySQL Disk Event Queue Configuration</h3>
+
+
+<table border="0" class="bodyTable">
+
+<tr class="a">
+
+<th>Property</th>
+
+<th>Description</th>
+
+<th>Required</th>
+
+<th>Default Value</th>
+ </tr>
+
+<tr class="b">
+
+<td>EventQueueType</td>
+
+<td>
+ This should be either SINGLE or POOLED. By
+ default the single style pool is used. The
+ single style pool uses a single thread per
+ event queue. That thread is killed whenever
+ the queue is inactive for 30 seconds. Since
+ the disk cache uses an event queue for every
+ region, if you have many regions and they
+ are all active, you will be using many
+ threads. To limit the number of threads, you
+ can configure the disk cache to use the
+ pooled event queue. Using more threads than
+ regions will not add any benefit for the
+ indexed disk cache, since only one thread
+ can read or write at a time for a single
+ region.
+ </td>
+
+<td>N</td>
+
+<td>SINGLE</td>
+ </tr>
+
+<tr class="a">
+
+<td>EventQueuePoolName</td>
+
+<td>
+ This is the name of the pool to use. It is
+ required if you choose the POOLED event
+ queue type, otherwise it is ignored.
+ </td>
+
+<td>Y</td>
+
+<td>n/a</td>
+ </tr>
+ </table>
+ </div>
+
+
+<div class="section">
+<h3><a name="Example_Configuration_Using_Thread_Pool"></a>Example Configuration Using Thread Pool</h3>
+
+<div class="source">
+<pre>
+
+##############################################################
+################## AUXILIARY CACHES AVAILABLE ################
+# MYSQL disk cache
+jcs.auxiliary.MYSQL=org.apache.commons.jcs.auxiliary.disk.jdbc.mysql.MySQLDiskCacheFactory
+jcs.auxiliary.MYSQL.attributes=org.apache.commons.jcs.auxiliary.disk.jdbc.mysql.MySQLDiskCacheAttributes
+jcs.auxiliary.MYSQL.attributes.userName=sa
+jcs.auxiliary.MYSQL.attributes.password=
+jcs.auxiliary.MYSQL.attributes.url=jdbc:hsqldb:target/cache_hsql_db
+jcs.auxiliary.MYSQL.attributes.driverClassName=org.hsqldb.jdbcDriver
+jcs.auxiliary.MYSQL.attributes.tableName=JCS_STORE_MYSQL
+jcs.auxiliary.MYSQL.attributes.testBeforeInsert=false
+jcs.auxiliary.MYSQL.attributes.maxActive=15
+jcs.auxiliary.MYSQL.attributes.allowRemoveAll=true
+jcs.auxiliary.MYSQL.attributes.MaxPurgatorySize=10000000
+jcs.auxiliary.MYSQL.attributes.optimizationSchedule=12:34:56,02:34:54
+jcs.auxiliary.MYSQL.attributes.balkDuringOptimization=true
+jcs.auxiliary.MYSQL.attributes.EventQueueType=POOLED
+jcs.auxiliary.MYSQL.attributes.EventQueuePoolName=disk_cache_event_queue
+
+##############################################################
+################## OPTIONAL THREAD POOL CONFIGURATION #########
+# Disk Cache pool
+thread_pool.disk_cache_event_queue.useBoundary=false
+thread_pool.disk_cache_event_queue.boundarySize=500
+thread_pool.disk_cache_event_queue.maximumPoolSize=15
+thread_pool.disk_cache_event_queue.minimumPoolSize=10
+thread_pool.disk_cache_event_queue.keepAliveTime=3500
+thread_pool.disk_cache_event_queue.whenBlockedPolicy=RUN
+thread_pool.disk_cache_event_queue.startUpSize=10
+
+ </pre></div>
+ </div>
+
+ </div>
+
+
+ </td>
+ </tr>
+ </table>
+ </div>
+
+ <div class="footer">
+ <p>Copyright © 2002-2018
+ <a href="https://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.</p>
+ </div>
+ </body>
+
+</html>
Added: dev/commons/jcs/site-2.2.1-RC4/ProjectHistory.html
==============================================================================
--- dev/commons/jcs/site-2.2.1-RC4/ProjectHistory.html (added)
+++ dev/commons/jcs/site-2.2.1-RC4/ProjectHistory.html Thu Aug 23 13:24:56 2018
@@ -0,0 +1,337 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 23 August 2018
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="author" content="Romain Manni-Bucau" />
+ <meta name="Date-Revision-yyyymmdd" content="20180823" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>JCS – Project History</title>
+
+ <link rel="stylesheet" href="./css/bootstrap.min.css" type="text/css" />
+ <link rel="stylesheet" href="./css/site.css" type="text/css" />
+ <link rel="stylesheet" href="./css/print.css" media="print" />
+
+ <script type="text/javascript" src="./js/jquery.min.js"></script>
+ <script type="text/javascript" src="./js/bootstrap.min.js"></script>
+ <script type="text/javascript" src="./js/prettify.min.js"></script>
+ <script type="text/javascript" src="./js/site.js"></script>
+
+
+ </head>
+
+ <body class="composite">
+ <a href="http://commons.apache.org/" id="bannerLeft" title="Apache Commons logo">
+ <img class="logo-left" src="./images/commons-logo.png" alt="Apache Commons logo"/>
+ </a>
+ <a href="index.html" id="bannerRight">
+ <h2>Commons JCSâ¢</h2>
+ </a>
+ <div class="clear"></div>
+
+ <div class="navbar">
+ <div class="navbar-inner">
+ <div class="container-fluid">
+ <a class="brand" href="http://commons.apache.org/proper/commons-jcs/">Apache Commons JCS ™</a>
+ <ul class="nav">
+
+ <li id="publishDate">Last Published: 23 August 2018</li>
+ <li class="divider">|</li> <li id="projectVersion">Version: 2.2.1</li>
+ </ul>
+ <div class="pull-right"> <ul class="nav">
+ <li>
+ <a href="http://www.apachecon.com/" class="externalLink" title="ApacheCon">
+ ApacheCon</a>
+ </li>
+ <li>
+ <a href="http://www.apache.org" class="externalLink" title="Apache">
+ Apache</a>
+ </li>
+ <li>
+ <a href="../../" title="Commons">
+ Commons</a>
+ </li>
+ </ul>
+</div>
+ </div>
+ </div>
+ </div>
+
+ <div class="container-fluid">
+ <table class="layout-table">
+ <tr>
+ <td class="sidebar">
+ <div class="well sidebar-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">JCS</li>
+ <li class="none">
+ <a href="index.html" title="Overview">
+ Overview</a>
+ </li>
+ <li class="none">
+ <a href="JCSandJCACHE.html" title="JCS and JCACHE">
+ JCS and JCACHE</a>
+ </li>
+ <li class="none">
+ <a href="download_jcs.cgi" title="Downloads">
+ Downloads</a>
+ </li>
+ <li class="none">
+ <a href="faq.html" title="FAQ">
+ FAQ</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header"><i class="icon-cog"></i>Development</li>
+ <li class="none">
+ <a href="changes-report.html" title="Release Notes">
+ Release Notes</a>
+ </li>
+ <li class="none">
+ <a href="UpgradingFrom13.html" title="Upgrading from 1.3 to 2.0">
+ Upgrading from 1.3 to 2.0</a>
+ </li>
+ <li class="none">
+ <a href="mail-lists.html" title="Mailing Lists">
+ Mailing Lists</a>
+ </li>
+ <li class="none">
+ <a href="issue-tracking.html" title="Issue Tracking">
+ Issue Tracking</a>
+ </li>
+ <li class="none">
+ <a href="source-repository.html" title="Source Repository">
+ Source Repository</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-core/apidocs/index.html" title="Core Javadoc (SVN latest)">
+ Core Javadoc (SVN latest)</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">Getting Started</li>
+ <li class="none">
+ <a href="getting_started/intro.html" title="Overview">
+ Overview</a>
+ </li>
+ <li class="none">
+ <a href="BasicJCSConfiguration.html" title="Basic JCS Config">
+ Basic JCS Config</a>
+ </li>
+ <li class="none">
+ <a href="JCSPlugins.html" title="Plugin Overview">
+ Plugin Overview</a>
+ </li>
+ <li class="none">
+ <a href="UsingJCSBasicWeb.html" title="Basic Web Example">
+ Basic Web Example</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">JCS User's Guide</li>
+ <li class="expanded">
+ <a href="LocalCacheConfig.html" title="Core">
+ Core</a>
+ <ul>
+ <li class="none">
+ <a href="BasicJCSConfiguration.html" title="Basic JCS Config">
+ Basic JCS Config</a>
+ </li>
+ <li class="none">
+ <a href="ElementAttributes.html" title="Element Config">
+ Element Config</a>
+ </li>
+ <li class="none">
+ <a href="ElementEventHandling.html" title="Element Event Handling">
+ Element Event Handling</a>
+ </li>
+ <li class="none">
+ <a href="RegionProperties.html" title="Region Properties">
+ Region Properties</a>
+ </li>
+ <li class="none">
+ <a href="UsingJCSBasicWeb.html" title="Basic Web Example">
+ Basic Web Example</a>
+ </li>
+ <li class="none active">
+ <a href="ProjectHistory.html" title="Project History">
+ Project History</a>
+ </li>
+ </ul>
+ </li>
+ <li class="collapsed">
+ <a href="JCSPlugins.html" title="Auxiliary">
+ Auxiliary</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">Modules</li>
+ <li class="none">
+ <a href="commons-jcs-core/index.html" title="Apache Commons JCS :: Core">
+ Apache Commons JCS :: Core</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache/index.html" title="Apache Commons JCS :: JCache">
+ Apache Commons JCS :: JCache</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache-tck/index.html" title="Apache Commons JCS :: JCache TCK">
+ Apache Commons JCS :: JCache TCK</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache-extras/index.html" title="Apache Commons JCS :: JCache Extras">
+ Apache Commons JCS :: JCache Extras</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache-openjpa/index.html" title="Apache Commons JCS :: JCache OpenJPA">
+ Apache Commons JCS :: JCache OpenJPA</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-dist/index.html" title="Apache Commons JCS :: Distribution">
+ Apache Commons JCS :: Distribution</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header"><i class="icon-info-sign"></i>Project Documentation</li>
+ <li class="collapsed">
+ <a href="project-info.html" title="Project Information">
+ Project Information</a>
+ </li>
+ <li class="collapsed">
+ <a href="project-reports.html" title="Project Reports">
+ Project Reports</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">Commons</li>
+ <li class="none">
+ <a href="../../" title="Home">
+ Home</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/licenses/" class="externalLink" title="License">
+ License</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../components.html" title="Components">
+ Components</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../sandbox/index.html" title="Sandbox">
+ Sandbox</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../dormant/index.html" title="Dormant">
+ Dormant</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">General Information</li>
+ <li class="none">
+ <a href="../../security.html" title="Security">
+ Security</a>
+ </li>
+ <li class="none">
+ <a href="../../volunteering.html" title="Volunteering">
+ Volunteering</a>
+ </li>
+ <li class="none">
+ <a href="../../patches.html" title="Contributing Patches">
+ Contributing Patches</a>
+ </li>
+ <li class="none">
+ <a href="../../building.html" title="Building Components">
+ Building Components</a>
+ </li>
+ <li class="none">
+ <a href="../../commons-parent-pom.html" title="Commons Parent Pom">
+ Commons Parent Pom</a>
+ </li>
+ <li class="none">
+ <a href="../../build-plugin/index.html" title="Commons Build Plugin">
+ Commons Build Plugin</a>
+ </li>
+ <li class="none">
+ <a href="../../releases/index.html" title="Releasing Components">
+ Releasing Components</a>
+ </li>
+ <li class="none">
+ <a href="http://wiki.apache.org/commons/FrontPage" class="externalLink" title="Wiki">
+ Wiki</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">ASF</li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How the ASF works">
+ How the ASF works</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/getinvolved.html" class="externalLink" title="Get Involved">
+ Get Involved</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/dev/" class="externalLink" title="Developer Resources">
+ Developer Resources</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/policies/conduct.html" class="externalLink" title="Code of Conduct">
+ Code of Conduct</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship">
+ Sponsorship</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">
+ Thanks</a>
+ </li>
+ </ul>
+ </div>
+ <div id="poweredBy">
+ <a href="http://www.apache.org/events/current-event.html" title="ApacheCon" class="builtBy">
+ <img class="builtBy" alt="ApacheCon" src="http://www.apache.org/events/current-event-125x125.png" />
+ </a>
+ <a href="http://maven.apache.org/" title="Maven" class="builtBy">
+ <img class="builtBy" alt="Maven" src="http://maven.apache.org/images/logos/maven-feather.png" />
+ </a>
+ </div>
+ </td>
+ <td class="content">
+
+
+ <div class="section">
+<h2><a name="Project_History"></a>Project History</h2>
+
+
+<p>
+ Project was created in 2002. It was first released under
+ maven coordinates org.apache.jcs:jcs[:1.3].
+ </p>
+
+
+<p>
+ Since 2014 and its version 2 it is released under coordinates
+ org.apache.commons:commons-jcs-[core|jcache|*][:2.x].
+ </p>
+
+ </div>
+
+
+ </td>
+ </tr>
+ </table>
+ </div>
+
+ <div class="footer">
+ <p>Copyright © 2002-2018
+ <a href="https://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.</p>
+ </div>
+ </body>
+
+</html>
Added: dev/commons/jcs/site-2.2.1-RC4/RegionProperties.html
==============================================================================
--- dev/commons/jcs/site-2.2.1-RC4/RegionProperties.html (added)
+++ dev/commons/jcs/site-2.2.1-RC4/RegionProperties.html Thu Aug 23 13:24:56 2018
@@ -0,0 +1,650 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 23 August 2018
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="author" content="Aaron Smuts" />
+ <meta name="Date-Revision-yyyymmdd" content="20180823" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>JCS – Cache Region Configuration</title>
+
+ <link rel="stylesheet" href="./css/bootstrap.min.css" type="text/css" />
+ <link rel="stylesheet" href="./css/site.css" type="text/css" />
+ <link rel="stylesheet" href="./css/print.css" media="print" />
+
+ <script type="text/javascript" src="./js/jquery.min.js"></script>
+ <script type="text/javascript" src="./js/bootstrap.min.js"></script>
+ <script type="text/javascript" src="./js/prettify.min.js"></script>
+ <script type="text/javascript" src="./js/site.js"></script>
+
+
+ </head>
+
+ <body class="composite">
+ <a href="http://commons.apache.org/" id="bannerLeft" title="Apache Commons logo">
+ <img class="logo-left" src="./images/commons-logo.png" alt="Apache Commons logo"/>
+ </a>
+ <a href="index.html" id="bannerRight">
+ <h2>Commons JCSâ¢</h2>
+ </a>
+ <div class="clear"></div>
+
+ <div class="navbar">
+ <div class="navbar-inner">
+ <div class="container-fluid">
+ <a class="brand" href="http://commons.apache.org/proper/commons-jcs/">Apache Commons JCS ™</a>
+ <ul class="nav">
+
+ <li id="publishDate">Last Published: 23 August 2018</li>
+ <li class="divider">|</li> <li id="projectVersion">Version: 2.2.1</li>
+ </ul>
+ <div class="pull-right"> <ul class="nav">
+ <li>
+ <a href="http://www.apachecon.com/" class="externalLink" title="ApacheCon">
+ ApacheCon</a>
+ </li>
+ <li>
+ <a href="http://www.apache.org" class="externalLink" title="Apache">
+ Apache</a>
+ </li>
+ <li>
+ <a href="../../" title="Commons">
+ Commons</a>
+ </li>
+ </ul>
+</div>
+ </div>
+ </div>
+ </div>
+
+ <div class="container-fluid">
+ <table class="layout-table">
+ <tr>
+ <td class="sidebar">
+ <div class="well sidebar-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">JCS</li>
+ <li class="none">
+ <a href="index.html" title="Overview">
+ Overview</a>
+ </li>
+ <li class="none">
+ <a href="JCSandJCACHE.html" title="JCS and JCACHE">
+ JCS and JCACHE</a>
+ </li>
+ <li class="none">
+ <a href="download_jcs.cgi" title="Downloads">
+ Downloads</a>
+ </li>
+ <li class="none">
+ <a href="faq.html" title="FAQ">
+ FAQ</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header"><i class="icon-cog"></i>Development</li>
+ <li class="none">
+ <a href="changes-report.html" title="Release Notes">
+ Release Notes</a>
+ </li>
+ <li class="none">
+ <a href="UpgradingFrom13.html" title="Upgrading from 1.3 to 2.0">
+ Upgrading from 1.3 to 2.0</a>
+ </li>
+ <li class="none">
+ <a href="mail-lists.html" title="Mailing Lists">
+ Mailing Lists</a>
+ </li>
+ <li class="none">
+ <a href="issue-tracking.html" title="Issue Tracking">
+ Issue Tracking</a>
+ </li>
+ <li class="none">
+ <a href="source-repository.html" title="Source Repository">
+ Source Repository</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-core/apidocs/index.html" title="Core Javadoc (SVN latest)">
+ Core Javadoc (SVN latest)</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">Getting Started</li>
+ <li class="none">
+ <a href="getting_started/intro.html" title="Overview">
+ Overview</a>
+ </li>
+ <li class="none">
+ <a href="BasicJCSConfiguration.html" title="Basic JCS Config">
+ Basic JCS Config</a>
+ </li>
+ <li class="none">
+ <a href="JCSPlugins.html" title="Plugin Overview">
+ Plugin Overview</a>
+ </li>
+ <li class="none">
+ <a href="UsingJCSBasicWeb.html" title="Basic Web Example">
+ Basic Web Example</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">JCS User's Guide</li>
+ <li class="expanded">
+ <a href="LocalCacheConfig.html" title="Core">
+ Core</a>
+ <ul>
+ <li class="none">
+ <a href="BasicJCSConfiguration.html" title="Basic JCS Config">
+ Basic JCS Config</a>
+ </li>
+ <li class="none">
+ <a href="ElementAttributes.html" title="Element Config">
+ Element Config</a>
+ </li>
+ <li class="none">
+ <a href="ElementEventHandling.html" title="Element Event Handling">
+ Element Event Handling</a>
+ </li>
+ <li class="none active">
+ <a href="RegionProperties.html" title="Region Properties">
+ Region Properties</a>
+ </li>
+ <li class="none">
+ <a href="UsingJCSBasicWeb.html" title="Basic Web Example">
+ Basic Web Example</a>
+ </li>
+ <li class="none">
+ <a href="ProjectHistory.html" title="Project History">
+ Project History</a>
+ </li>
+ </ul>
+ </li>
+ <li class="collapsed">
+ <a href="JCSPlugins.html" title="Auxiliary">
+ Auxiliary</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">Modules</li>
+ <li class="none">
+ <a href="commons-jcs-core/index.html" title="Apache Commons JCS :: Core">
+ Apache Commons JCS :: Core</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache/index.html" title="Apache Commons JCS :: JCache">
+ Apache Commons JCS :: JCache</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache-tck/index.html" title="Apache Commons JCS :: JCache TCK">
+ Apache Commons JCS :: JCache TCK</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache-extras/index.html" title="Apache Commons JCS :: JCache Extras">
+ Apache Commons JCS :: JCache Extras</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache-openjpa/index.html" title="Apache Commons JCS :: JCache OpenJPA">
+ Apache Commons JCS :: JCache OpenJPA</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-dist/index.html" title="Apache Commons JCS :: Distribution">
+ Apache Commons JCS :: Distribution</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header"><i class="icon-info-sign"></i>Project Documentation</li>
+ <li class="collapsed">
+ <a href="project-info.html" title="Project Information">
+ Project Information</a>
+ </li>
+ <li class="collapsed">
+ <a href="project-reports.html" title="Project Reports">
+ Project Reports</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">Commons</li>
+ <li class="none">
+ <a href="../../" title="Home">
+ Home</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/licenses/" class="externalLink" title="License">
+ License</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../components.html" title="Components">
+ Components</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../sandbox/index.html" title="Sandbox">
+ Sandbox</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../dormant/index.html" title="Dormant">
+ Dormant</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">General Information</li>
+ <li class="none">
+ <a href="../../security.html" title="Security">
+ Security</a>
+ </li>
+ <li class="none">
+ <a href="../../volunteering.html" title="Volunteering">
+ Volunteering</a>
+ </li>
+ <li class="none">
+ <a href="../../patches.html" title="Contributing Patches">
+ Contributing Patches</a>
+ </li>
+ <li class="none">
+ <a href="../../building.html" title="Building Components">
+ Building Components</a>
+ </li>
+ <li class="none">
+ <a href="../../commons-parent-pom.html" title="Commons Parent Pom">
+ Commons Parent Pom</a>
+ </li>
+ <li class="none">
+ <a href="../../build-plugin/index.html" title="Commons Build Plugin">
+ Commons Build Plugin</a>
+ </li>
+ <li class="none">
+ <a href="../../releases/index.html" title="Releasing Components">
+ Releasing Components</a>
+ </li>
+ <li class="none">
+ <a href="http://wiki.apache.org/commons/FrontPage" class="externalLink" title="Wiki">
+ Wiki</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">ASF</li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How the ASF works">
+ How the ASF works</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/getinvolved.html" class="externalLink" title="Get Involved">
+ Get Involved</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/dev/" class="externalLink" title="Developer Resources">
+ Developer Resources</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/policies/conduct.html" class="externalLink" title="Code of Conduct">
+ Code of Conduct</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship">
+ Sponsorship</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">
+ Thanks</a>
+ </li>
+ </ul>
+ </div>
+ <div id="poweredBy">
+ <a href="http://www.apache.org/events/current-event.html" title="ApacheCon" class="builtBy">
+ <img class="builtBy" alt="ApacheCon" src="http://www.apache.org/events/current-event-125x125.png" />
+ </a>
+ <a href="http://maven.apache.org/" title="Maven" class="builtBy">
+ <img class="builtBy" alt="Maven" src="http://maven.apache.org/images/logos/maven-feather.png" />
+ </a>
+ </div>
+ </td>
+ <td class="content">
+
+
+ <div class="section">
+<h2><a name="Cache_Region_Configuration"></a>Cache Region Configuration</h2>
+
+
+<p>
+ The following properties apply to any cache region. They
+ can be specified as default values and specified on a
+ region by region basis. There are three types of
+ settings: auxiliary, cache, and element. The cache
+ settings define the memory management for the region.
+ The element settings define default element behavior
+ within the region.
+ </p>
+
+
+<div class="section">
+<h3><a name="Region_.28Auxiliary.29_Properties"></a>Region (Auxiliary) Properties</h3>
+
+<table border="0" class="bodyTable">
+
+<tr class="a">
+
+<th>Property</th>
+
+<th>Description</th>
+
+<th>Required</th>
+
+<th>Default Value</th>
+ </tr>
+
+<tr class="b">
+
+<td></td>
+
+<td>
+ You can specify the list of auxiliaries that
+ regions can use. This has no attribute name.
+ The list can be empty, otherwise it should
+ be comma delimited.
+ </td>
+
+<td>Y</td>
+
+<td>n/a</td>
+ </tr>
+ </table>
+ </div>
+
+
+<div class="section">
+<h3><a name="Region_.28Cache.29_Properties"></a>Region (Cache) Properties</h3>
+
+<table border="0" class="bodyTable">
+
+<tr class="a">
+
+<th>Property</th>
+
+<th>Description</th>
+
+<th>Required</th>
+
+<th>Default Value</th>
+ </tr>
+
+<tr class="b">
+
+<td>MaxObjects</td>
+
+<td>
+ The maximum number of items allowed in
+ memory. Eviction of elements in excess of
+ this number is determined by the memory
+ cache. By default JCS uses the LRU memory
+ cache.
+ </td>
+
+<td>Y</td>
+
+<td>n/a</td>
+ </tr>
+
+<tr class="a">
+
+<td>MemoryCacheName</td>
+
+<td>
+ This property allows you to specify what
+ memory manager you would like to use. You
+ can create your own memory manager by
+ implementing the
+ org.apache.commons.jcs.engine.memory.MemoryCache
+ interface. Alternatively, you can extend the
+ org.apache.commons.jcs.engine.memory.AbstractMemoryCache
+ class. Several different memory caches are
+ available: two LRU implementations, an LFU,
+ and an adaptive replacement algorithm.
+ </td>
+
+<td>N</td>
+
+<td>
+ org.apache.commons.jcs.engine.memory.lru.LRUMemoryCache
+ </td>
+ </tr>
+
+<tr class="b">
+
+<td>UseMemoryShrinker</td>
+
+<td>
+ By default, the memory shrinker is shared by
+ all regions that use the LRU memory cache.
+ The memory shrinker iterates through the
+ items in memory, looking for items that have
+ expired or that have exceeded their max
+ memory idle time.
+ </td>
+
+<td>N</td>
+
+<td>false</td>
+ </tr>
+
+<tr class="a">
+
+<td>MaxMemoryIdleTimeSeconds</td>
+
+<td>
+ This is only used if you are using the
+ memory shrinker. If this value is set above
+ -1, then if an item has not been accessed in
+ this number of seconds, it will be spooled
+ to disk if the disk is available. You can
+ register an event handler on this event.
+ </td>
+
+<td>N</td>
+
+<td>7200</td>
+ </tr>
+
+<tr class="b">
+
+<td>ShrinkerIntervalSeconds</td>
+
+<td>
+ This specifies how often the shrinker should
+ run, if it has been activated. If you set
+ UseMemoryShrinker to false, then this
+ setting has no effect.
+ </td>
+
+<td>N</td>
+
+<td>30</td>
+ </tr>
+
+<tr class="a">
+
+<td>DiskUsagePatternName</td>
+
+<td>
+ SWAP is the default. Under the swap pattern,
+ data is only put to disk when the max memory
+ size is reached. Since items puled from disk
+ are put into memory, if the memory cache is
+ full and you get an item off disk, the lest
+ recently used item will be spooled to disk.
+ If you have a low memory hit ration, you end
+ up thrashing.
+
+ The UPDATE usage pattern allows items to go
+ to disk on an update. It disables the swap.
+ This allows you to persist all items to
+ disk. If you are using the JDBC disk cache
+ for instance, you can put all the items on
+ disk while using the memory cache for
+ performance, and not worry about losing
+ data from a system crash or improper
+ shutdown. Also, since all items are on disk,
+ there is no need to swap to disk. This
+ prevents the possibility of thrashing.
+ </td>
+
+<td>N</td>
+
+<td>SWAP</td>
+ </tr>
+ </table>
+ </div>
+
+
+<div class="section">
+<h3><a name="Region_.28Element.29_Properties"></a>Region (Element) Properties</h3>
+
+<table border="0" class="bodyTable">
+
+<tr class="a">
+
+<th>Property</th>
+
+<th>Description</th>
+
+<th>Required</th>
+
+<th>Default Value</th>
+ </tr>
+
+<tr class="b">
+
+<td>IsEternal</td>
+
+<td>
+ If an element is specified as eternal, then
+ it will never be subject to removal for
+ exceeding its max life.
+ </td>
+
+<td>N</td>
+
+<td>true</td>
+ </tr>
+
+<tr class="a">
+
+<td>MaxLife</td>
+
+<td>
+ If you specify that elements within a region
+ are not eternal, then you can set the max
+ life seconds. If this is exceeded the
+ elements will be removed passively when a
+ client tries to retrieve them. If you are
+ using a memory shrinker, then the items can
+ be removed actively.
+ </td>
+
+<td>N</td>
+
+<td>-1</td>
+ </tr>
+
+<tr class="b">
+
+<td>IsSpool</td>
+
+<td>
+ By default, can elements in this region be
+ sent to a disk cache if one is available.
+ </td>
+
+<td>N</td>
+
+<td>true</td>
+ </tr>
+
+<tr class="a">
+
+<td>IsLateral</td>
+
+<td>
+ By default, can elements in this region be
+ sent to a lateral cache if one is available.
+ </td>
+
+<td>N</td>
+
+<td>true</td>
+ </tr>
+
+<tr class="b">
+
+<td>IsRemote</td>
+
+<td>
+ By default, can elements in this region be
+ sent to a remote cache if one is available.
+ </td>
+
+<td>N</td>
+
+<td>true</td>
+ </tr>
+ </table>
+ </div>
+
+
+<div class="section">
+<h3><a name="Example_Configuration"></a>Example Configuration</h3>
+
+<div class="source">
+<pre>
+
+jcs.default=
+jcs.default.cacheattributes=org.apache.commons.jcs.engine.CompositeCacheAttributes
+jcs.default.cacheattributes.MaxObjects=200001
+jcs.default.cacheattributes.MemoryCacheName=org.apache.commons.jcs.engine.memory.lru.LRUMemoryCache
+jcs.default.cacheattributes.UseMemoryShrinker=true
+jcs.default.cacheattributes.MaxMemoryIdleTimeSeconds=3600
+jcs.default.cacheattributes.ShrinkerIntervalSeconds=60
+jcs.default.elementattributes=org.apache.commons.jcs.engine.ElementAttributes
+jcs.default.elementattributes.IsEternal=false
+jcs.default.elementattributes.MaxLife=700
+jcs.default.elementattributes.IsSpool=true
+jcs.default.elementattributes.IsRemote=true
+jcs.default.elementattributes.IsLateral=true
+
+# optional region "testCache1" specific configuration settings
+jcs.region.testCache1=
+jcs.region.testCache1.cacheattributes=org.apache.commons.jcs.engine.CompositeCacheAttributes
+jcs.region.testCache1.cacheattributes.MaxObjects=123456
+jcs.region.testCache1.cacheattributes.MemoryCacheName=org.apache.commons.jcs.engine.memory.lru.LRUMemoryCache
+jcs.region.testCache1.cacheattributes.UseMemoryShrinker=true
+jcs.region.testCache1.cacheattributes.ShrinkerIntervalSeconds=30
+jcs.region.testCache1.cacheattributes.MaxMemoryIdleTimeSeconds=300
+jcs.region.testCache1.cacheattributes.MaxSpoolPerRun=100
+jcs.region.testCache1.elementattributes=org.apache.commons.jcs.engine.ElementAttributes
+jcs.region.testCache1.elementattributes.IsEternal=false
+jcs.region.testCache1.elementattributes.MaxLife=60000
+jcs.region.testCache1.elementattributes.IsSpool=true
+jcs.region.testCache1.elementattributes.IsLateral=true
+jcs.region.testCache1.elementattributes.IsRemote=true
+
+ </pre></div>
+ </div>
+
+ </div>
+
+
+ </td>
+ </tr>
+ </table>
+ </div>
+
+ <div class="footer">
+ <p>Copyright © 2002-2018
+ <a href="https://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.</p>
+ </div>
+ </body>
+
+</html>