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 [7/15] - /dev/commons/jcs/site-2.2.1-RC4/
Added: dev/commons/jcs/site-2.2.1-RC4/RemoteAuxCache.html
==============================================================================
--- dev/commons/jcs/site-2.2.1-RC4/RemoteAuxCache.html (added)
+++ dev/commons/jcs/site-2.2.1-RC4/RemoteAuxCache.html Thu Aug 23 13:24:56 2018
@@ -0,0 +1,722 @@
+<!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 – Remote Auxiliary Cache Client / Server</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">
+ <a href="MySQLDiskCacheProperties.html" title="MySQL Disk Properties">
+ MySQL Disk Properties</a>
+ </li>
+ <li class="none active">
+ <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="Remote_Auxiliary_Cache_Client_.2F_Server"></a>Remote Auxiliary Cache Client / Server</h2>
+
+<p>
+ The Remote Auxiliary Cache is an optional plug in for
+ JCS. It is intended for use in multi-tiered systems to
+ maintain cache consistency. It uses a highly reliable
+ RMI client server framework that currently allows for
+ any number of clients. Using a listener id allows
+ multiple clients running on the same machine to connect
+ to the remote cache server. All cache regions on one
+ client share a listener per auxiliary, but register
+ separately. This minimizes the number of connections
+ necessary and still avoids unnecessary updates for
+ regions that are not configured to use the remote cache.
+ </p>
+
+<p>
+ Local remote cache clients connect to the remote cache
+ on a configurable port and register a listener to
+ receive cache update callbacks at a configurable port.
+ </p>
+
+<p>
+ If there is an error connecting to the remote server or
+ if an error occurs in transmission, the client will
+ retry for a configurable number of tries before moving
+ into a failover-recovery mode. If failover servers are
+ configured the remote cache clients will try to register
+ with other failover servers in a sequential order. If a
+ connection is made, the client will broadcast all
+ relevant cache updates to the failover server while
+ trying periodically to reconnect with the primary
+ server. If there are no failovers configured the client
+ will move into a zombie mode while it tries to
+ re-establish the connection. By default, the cache
+ clients run in an optimistic mode and the failure of the
+ communication channel is detected by an attempted update
+ to the server. A pessimistic mode is configurable so
+ that the clients will engage in active status checks.
+ </p>
+
+<p>
+ The remote cache server broadcasts updates to listeners
+ other than the originating source. If the remote cache
+ fails to propagate an update to a client, it will retry
+ for a configurable number of tries before de-registering
+ the client.
+ </p>
+
+<p>
+ The cache hub communicates with a facade that implements
+ a zombie pattern (balking facade) to prevent blocking.
+ Puts and removals are queued and occur asynchronously in
+ the background. Get requests are synchronous and can
+ potentially block if there is a communication problem.
+ </p>
+
+<p>
+ By default client updates are light weight. The client
+ listeners are configured to remove elements form the
+ local cache when there is a put order from the remote.
+ This allows the client memory store to control the
+ memory size algorithm from local usage, rather than
+ having the usage patterns dictated by the usage patterns
+ in the system at large.
+ </p>
+
+<p>
+ When using a remote cache the local cache hub will
+ propagate elements in regions configured for the remote
+ cache if the element attributes specify that the item to
+ be cached can be sent remotely. By default there are no
+ remote restrictions on elements and the region will
+ dictate the behavior. The order of auxiliary requests is
+ dictated by the order in the configuration file. The
+ examples are configured to look in memory, then disk,
+ then remote caches. Most elements will only be retrieved
+ from the remote cache once, when they are not in memory
+ or disk and are first requested, or after they have been
+ invalidated.
+ </p>
+
+<div class="section">
+<h3><a name="Client_Configuration"></a>Client Configuration</h3>
+
+<p>
+ The configuration is fairly straightforward and is
+ done in the auxiliary cache section of the
+ <tt>cache.ccf</tt>
+ configuration file. In the example below, I created
+ a Remote Auxiliary Cache Client referenced by
+ <tt>RFailover</tt>
+ .
+ </p>
+
+<p>
+ This auxiliary cache will use
+ <tt>localhost:1102</tt>
+ as its primary remote cache server and will attempt
+ to failover to
+ <tt>localhost:1103</tt>
+ if the primary is down.
+ </p>
+
+<p>
+ Setting
+ <tt>RemoveUponRemotePut</tt>
+ to
+ <tt>false</tt>
+ would cause remote puts to be translated into put
+ requests to the client region. By default it is
+ <tt>true</tt>
+ , causing remote put requests to be issued as
+ removes at the client level. For groups the put
+ request functions slightly differently: the item
+ will be removed, since it is no longer valid in its
+ current form, but the list of group elements will be
+ updated. This way the client can maintain the
+ complete list of group elements without the burden
+ of storing all of the referenced elements. Session
+ distribution works in this half-lazy replication
+ mode.
+ </p>
+
+<p>
+ Setting
+ <tt>GetOnly</tt>
+ to
+ <tt>true</tt>
+ would cause the remote cache client to stop
+ propagating updates to the remote server, while
+ continuing to get items from the remote store.
+ </p>
+
+<div class="source">
+<pre>
+
+# Remote RMI Cache set up to failover
+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.FailoverServers=
+ localhost:1102,localhost:1103
+jcs.auxiliary.RFailover.attributes.RemoveUponRemotePut=true
+jcs.auxiliary.RFailover.attributes.GetOnly=false
+
+ </pre></div>
+
+<p>
+ This cache region is setup to use a disk cache and
+ the remote cache configured above:
+ </p>
+
+<div class="source">
+<pre>
+
+#Regions preconfirgured for caching
+jcs.region.testCache1=DC,RFailover
+jcs.region.testCache1.cacheattributes=
+ org.apache.commons.jcs.engine.CompositeCacheAttributes
+jcs.region.testCache1.cacheattributes.MaxObjects=1000
+jcs.region.testCache1.cacheattributes.MemoryCacheName=
+ org.apache.commons.jcs.engine.memory.lru.LRUMemoryCache
+
+ </pre></div>
+ </div>
+
+<div class="section">
+<h3><a name="Server_Configuration"></a>Server Configuration</h3>
+
+<p>
+ The remote cache configuration is growing. For now,
+ the configuration is done at the top of the
+ <tt>remote.cache.ccf</tt>
+ file. The
+ <tt>startRemoteCache</tt>
+ script passes the configuration file name to the
+ server when it starts up. The configuration
+ parameters below will create a remote cache server
+ that listens to port
+ <tt>1102</tt>
+ and performs call backs on the
+ <tt>remote.cache.service.port</tt>
+ , also specified as port
+ <tt>1102</tt>
+ .
+ </p>
+
+<div class="source">
+<pre>
+
+# Registry used to register and provide the
+# IRemoteCacheService service.
+registry.host=localhost
+registry.port=1102
+# call back port to local caches.
+remote.cache.service.port=1102
+# rmi socket factory timeout
+remote.cache.rmiSocketFactoryTimeoutMillis=5000
+# cluster setting
+remote.cluster.LocalClusterConsistency=true
+remote.cluster.AllowClusterGet=true
+
+ </pre></div>
+
+<p>
+ Remote servers can be chained (or clustered). This
+ allows gets from local caches to be distributed
+ between multiple remote servers. Since gets are the
+ most common operation for caches, remote server
+ chaining can help scale a caching solution.
+ </p>
+
+<p>
+ The
+ <tt>LocalClusterConsistency</tt>
+ setting tells the remote cache server if it should
+ broadcast updates received from other cluster
+ servers to registered local caches.
+ </p>
+
+<p>
+ The
+ <tt>AllowClusterGet</tt>
+ setting tells the remote cache server whether it
+ should allow the cache to look in non-local
+ auxiliaries for items if they are not present.
+ Basically, if the get request is not from a cluster
+ server, the cache will treat it as if it originated
+ locally. If the get request originated from a
+ cluster client, then the get will be restricted to
+ local (i.e. memory and disk) auxiliaries. Hence,
+ cluster gets can only go one server deep. They
+ cannot be chained. By default this setting is true.
+ </p>
+
+<p>
+ To use remote server clustering, the remote cache
+ will have to be told what regions to cluster. The
+ configuration below will cluster all
+ non-preconfigured regions with
+ <tt>RCluster1</tt>
+ .
+ </p>
+
+<div class="source">
+<pre>
+
+# sets the default aux value for any non configured caches
+jcs.default=DC,RCluster1
+jcs.default.cacheattributes=
+ org.apache.commons.jcs.engine.CompositeCacheAttributes
+jcs.default.cacheattributes.MaxObjects=1000
+
+jcs.auxiliary.RCluster1=
+ org.apache.commons.jcs.auxiliary.remote.RemoteCacheFactory
+jcs.auxiliary.RCluster1.attributes=
+ org.apache.commons.jcs.auxiliary.remote.RemoteCacheAttributes
+jcs.auxiliary.RCluster1.attributes.RemoteTypeName=CLUSTER
+jcs.auxiliary.RCluster1.attributes.RemoveUponRemotePut=false
+jcs.auxiliary.RCluster1.attributes.ClusterServers=localhost:1103
+jcs.auxiliary.RCluster1.attributes.GetOnly=false
+
+ </pre></div>
+
+<p>
+ RCluster1 is configured to talk to a remote server
+ at
+ <tt>localhost:1103</tt>
+ . Additional servers can be added in a comma
+ separated list.
+ </p>
+
+<p>
+ If we startup another remote server listening to
+ port 1103, (ServerB) then we can have that server
+ talk to the server we have been configuring,
+ listening at 1102 (ServerA). This would allow us to
+ set some local caches to talk to ServerA and some to
+ talk to ServerB. The two remote servers will
+ broadcast all puts and removes between themselves,
+ and the get requests from local caches could be
+ divided. The local caches do not need to know
+ anything about the server chaining configuration,
+ unless you want to use a standby, or failover
+ server.
+ </p>
+
+<p>
+ We could also use ServerB as a hot standby. This can
+ be done in two ways. You could have all local caches
+ point to ServerA as a primary and ServerB as a
+ secondary. Alternatively, you can set ServerA as the
+ primary for some local caches and ServerB for the
+ primary for some others.
+ </p>
+
+<p>
+ The local cache configuration below uses ServerA as
+ a primary and ServerB as a backup. More than one
+ backup can be defined, but only one will be used at
+ a time. If the cache is connected to any server
+ except the primary, it will try to restore the
+ primary connection indefinitely, at 20 second
+ intervals.
+ </p>
+
+<div class="source">
+<pre>
+
+ # Remote RMI Cache set up to failover
+ 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.FailoverServers=
+ localhost:1102,localhost:1103
+ jcs.auxiliary.RC.attributes.RemoveUponRemotePut=true
+ jcs.auxiliary.RFailover.attributes.GetOnly=false
+
+ </pre></div>
+ </div>
+
+<div class="section">
+<h3><a name="Server_Startup_.2F_Shutdown"></a>Server Startup / Shutdown</h3>
+
+<p>
+ It is highly recommended that you embed the Remote
+ Cache Server in a Servlet container such as Tomcat.
+ Running inside Tomcat allows you to use the
+ JCSAdmin.jsp page. It also takes care of the
+ complexity of creating working startup and shutdown
+ scripts.
+ </p>
+
+<p>
+ JCS provides a convenient startup servlet for this
+ purpose. It will start the registry and bind the
+ JCS server to the registry. To use the startup
+ servlet, add the following to the web.xml file and
+ make sure you have the cache.ccf file in the
+ WEB-INF/classes directly of your war file.
+ </p>
+
+<div class="source">
+<pre>
+
+ <servlet>
+ <servlet-name>JCSRemoteCacheStartupServlet</servlet-name>
+ <servlet-class>
+ org.apache.commons.jcs.auxiliary.remote.server.RemoteCacheStartupServlet
+ </servlet-class>
+ <load-on-startup>1</load-on-startup>
+ </servlet>
+
+
+ <servlet-mapping>
+ <servlet-name>JCSRemoteCacheStartupServlet</servlet-name>
+ <url-pattern>/jcs</url-pattern>
+ </servlet-mapping>
+
+ </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/RemoteCacheProperties.html
==============================================================================
--- dev/commons/jcs/site-2.2.1-RC4/RemoteCacheProperties.html (added)
+++ dev/commons/jcs/site-2.2.1-RC4/RemoteCacheProperties.html Thu Aug 23 13:24:56 2018
@@ -0,0 +1,540 @@
+<!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 – Remote 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">
+ <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 active">
+ <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="Remote_Auxiliary_Cache_Configuration"></a>Remote Auxiliary Cache Configuration</h2>
+
+
+<p>
+ The following properties apply to the Remote Cache
+ plugin.
+ </p>
+
+
+<div class="section">
+<h3><a name="Remote_Client_Configuration_Properties"></a>Remote Client 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>FailoverServers</td>
+
+<td>
+ This is a comma separated list of remote
+ servers to use. They should be specified in
+ the host:port format. The first server in
+ the list will be used as the primary server.
+ If the connection is lost with the primary,
+ the cache will try to connect to the next
+ server in the list. If a connection is
+ successfully established with a failover
+ server, then the cache will attempt to
+ restore the conenction with the primary
+ server.
+ </td>
+
+<td>Y</td>
+
+<td>n/a</td>
+ </tr>
+
+<tr class="a">
+
+<td>LocalPort</td>
+
+<td>
+ This is the port on which the client will
+ receive callbacks from the remote server. If
+ it is not specified, then some port in the
+ default range used by RMI will be the
+ callback port.
+ </td>
+
+<td>N</td>
+
+<td>default RMI port range</td>
+ </tr>
+
+<tr class="b">
+
+<td>RemoveUponRemotePut</td>
+
+<td>
+ If you configure the cache to remove upon a
+ remote put, this means that the client will
+ translate updates into removes. The client
+ will remove any local copy it has of the
+ object rather than storing the new version.
+ If you have sticky load balancing across
+ your client servers, then it would make
+ sense to set RemoveUponRemotePut to true if
+ the data is mostly client specific. If the
+ data is re-usable, the you should most
+ likely set this option to false, which is
+ the default.
+ </td>
+
+<td>N</td>
+
+<td>true</td>
+ </tr>
+
+<tr class="a">
+
+<td>RmiSocketFactoryTimeoutMillis</td>
+
+<td>
+ If this is greater than 0, then a custom
+ socket factory will be installed in the VM.
+ It will then use this timeout for all RMI
+ communication.
+ </td>
+
+<td>N</td>
+
+<td>5000</td>
+ </tr>
+
+<tr class="b">
+
+<td>GetOnly</td>
+
+<td>
+ GetOnly is somewhat misnamed. If it is set
+ to true, then the client will not send
+ updates or removes to the remote server. It
+ can still receive updates and removes.
+ </td>
+
+<td>N</td>
+
+<td>false</td>
+ </tr>
+
+<tr class="a">
+
+<td>Receive</td>
+
+<td>
+ By default Receive is set to true. This
+ means that the remote client will receive
+ updates and removes from the remote server.
+ If you set Receive to false, the remote
+ client will not register a listener with the
+ remote server. This means that the client
+ can send update and remove requests to the
+ server, and it can get from the server, but
+ it will never receive notifications from the
+ server. You might configure Receive to false
+ if you just want to use the remote server as
+ a data store. For instance, you may back the
+ Remote Cache Server with the JDBC disk cache
+ and set Receive=false when you have a high
+ put and low read region.
+ </td>
+
+<td>N</td>
+
+<td>true</td>
+ </tr>
+
+<tr class="b">
+
+<td>ZombieQueueMaxSize</td>
+
+<td>
+ The number of elements the zombie queue will
+ hold. This queue is used to store events if
+ we lose our connection with the server.
+ </td>
+
+<td>N</td>
+
+<td>1000</td>
+ </tr>
+ </table>
+ </div>
+
+
+<div class="section">
+<h3><a name="Example_Configuration"></a>Example Configuration</h3>
+
+<div class="source">
+<pre>
+
+# This remote client does not receive
+jcs.auxiliary.RC=org.apache.commons.jcs.auxiliary.remote.RemoteCacheFactory
+jcs.auxiliary.RC.attributes=org.apache.commons.jcs.auxiliary.remote.RemoteCacheAttributes
+jcs.auxiliary.RC.attributes.FailoverServers=localhost:1101,localhost:1102
+jcs.auxiliary.RC.attributes.LocalPort=1201
+jcs.auxiliary.RC.attributes.RemoveUponRemotePut=false
+jcs.auxiliary.RC.attributes.RmiSocketFactoryTimeoutMillis=5000
+jcs.auxiliary.RC.attributes.GetOnly=false
+jcs.auxiliary.RC.attributes.Receive=false
+
+ </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/RemoteHttpCacheProperties.html
==============================================================================
--- dev/commons/jcs/site-2.2.1-RC4/RemoteHttpCacheProperties.html (added)
+++ dev/commons/jcs/site-2.2.1-RC4/RemoteHttpCacheProperties.html Thu Aug 23 13:24:56 2018
@@ -0,0 +1,510 @@
+<!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 – Remote Http 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">
+ <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 active">
+ <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="Remote_Auxiliary_Http_Cache_Configuration"></a>Remote Auxiliary Http Cache Configuration</h2>
+
+<p> The following properties apply to the Remote Http Cache plugin.</p>
+
+<div class="section">
+<h3><a name="Remote_Http_Client_Configuration_Properties"></a>Remote Http Client 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>url</td>
+
+<td> This is the full url for the http service.</td>
+
+<td>Y</td>
+
+<td>n/a</td>
+ </tr>
+
+<tr class="a">
+
+<td>maxConnectionsPerHost</td>
+
+<td> Maximum simultaneous connections per host.</td>
+
+<td>N</td>
+
+<td>100</td>
+ </tr>
+
+<tr class="b">
+
+<td>socketTimeoutMillis</td>
+
+<td> Read timeout.</td>
+
+<td>N</td>
+
+<td>3000</td>
+ </tr>
+
+<tr class="a">
+
+<td>connectionTimeoutMillis</td>
+
+<td> Connection timeout.</td>
+
+<td>N</td>
+
+<td>5000</td>
+ </tr>
+
+<tr class="b">
+
+<td>httpVersion</td>
+
+<td> The http version to use.</td>
+
+<td>N</td>
+
+<td>1.1</td>
+ </tr>
+
+<tr class="a">
+
+<td>includeCacheNameAsParameter</td>
+
+<td> Should the cache name be appended to the url.</td>
+
+<td>N</td>
+
+<td>true</td>
+ </tr>
+
+<tr class="b">
+
+<td>includeKeysAndPatternsAsParameter
+ </td>
+
+<td> Should the key be appended to the url.</td>
+
+<td>N</td>
+
+<td>true</td>
+ </tr>
+
+<tr class="a">
+
+<td>includeRequestTypeasAsParameter
+ </td>
+
+<td> Should the request type be appended to the url.</td>
+
+<td>N</td>
+
+<td>true</td>
+ </tr>
+
+<tr class="b">
+
+<td>remoteHttpClientClassName
+ </td>
+
+<td> This allows you to specify your own client implementation.</td>
+
+<td>N</td>
+
+<td>RemoteHttpCacheClient.class.getName()</td>
+ </tr>
+
+<tr class="a">
+
+<td>ZombieQueueMaxSize</td>
+
+<td> The number of elements the zombie queue will hold. This queue
+ is used to store events if we lose our connection with the
+ server.</td>
+
+<td>N</td>
+
+<td>1000</td>
+ </tr>
+ </table>
+ </div>
+
+<div class="section">
+<h3><a name="Example_Configuration"></a>Example Configuration</h3>
+
+<div class="source">
+<pre>
+
+# This remote client does not receive
+jcs.auxiliary.RC=org.apache.commons.jcs.auxiliary.remote.http.client.RemoteCacheFactory
+jcs.auxiliary.RC.attributes=org.apache.commons.jcs.auxiliary.remote.RemoteCacheAttributes
+jcs.auxiliary.RC.attributes.FailoverServers=localhost:1101,localhost:1102
+jcs.auxiliary.RC.attributes.LocalPort=1201
+jcs.auxiliary.RC.attributes.RemoveUponRemotePut=false
+jcs.auxiliary.RC.attributes.RmiSocketFactoryTimeoutMillis=5000
+jcs.auxiliary.RC.attributes.GetOnly=false
+jcs.auxiliary.RC.attributes.Receive=false
+
+ </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/UpgradingFrom13.html
==============================================================================
--- dev/commons/jcs/site-2.2.1-RC4/UpgradingFrom13.html (added)
+++ dev/commons/jcs/site-2.2.1-RC4/UpgradingFrom13.html Thu Aug 23 13:24:56 2018
@@ -0,0 +1,404 @@
+<!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="Thomas Vandahl" />
+ <meta name="Date-Revision-yyyymmdd" content="20180823" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>JCS – Upgrading from JCS 1.3 to 2.0</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 active">
+ <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="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="Upgrading_from_JCS_1.3_to_2.0"></a>Upgrading from JCS 1.3 to 2.0</h2>
+
+<p>
+ This document lists a number of things that changed in Commons JCS
+ 2.0.
+ </p>
+
+<div class="section">
+<h3><a name="Package_Names_and_Maven_Coordinates"></a>Package Names and Maven Coordinates</h3>
+
+<p>
+ The main difference is the move to the Apache Commons project
+ which lead to the change of the package names and Maven coordinates.
+ So in all your code replace
+ </p>
+<div class="source">
+<pre>
+import org.apache.jcs.*;
+</pre></div>
+ with
+
+<div class="source">
+<pre>
+import org.apache.commons.jcs.*;
+</pre></div>
+ The Maven coordinates change from
+
+<div class="source">
+<pre>
+<dependency>
+ <groupId>org.apache.jcs</groupId>
+ <artifactId>jcs</artifactId>
+ <version>1.3</version>
+</dependency>
+</pre></div>
+ to
+
+<div class="source">
+<pre>
+<dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-jcs-core</artifactId>
+ <version>2.0</version>
+</dependency>
+</pre></div>
+
+ </div>
+
+<div class="section">
+<h3><a name="Change_Cache_Access_Object"></a>Change Cache Access Object</h3>
+
+<p>
+ JCS now uses different cache access objects depending on
+ if you want to use cache groups or not. This was necessary
+ because the cache access objects are now generic which saves
+ you all the casts but doesn't allow different objects in the
+ same cache anymore. You now use
+ </p>
+<div class="source">
+<pre>
+import org.apache.commons.jcs.JCS;
+import org.apache.commons.jcs.access.CacheAccess;
+import org.apache.commons.jcs.access.GroupCacheAccess;
+
+CacheAccess<String, City> cityCache = JCS.getInstance( "city" );
+GroupCacheAccess<String, Country> countryCache = JCS.getGroupCacheInstance( "country" );
+</pre></div>
+
+ </div>
+
+<div class="section">
+<h3><a name="Adjusting_the_Configuration"></a>Adjusting the Configuration</h3>
+
+<p>
+ Here again, change all package names in configuration entries
+ from e.g.
+ </p>
+<div class="source">
+<pre>
+jcs.default.cacheattributes=org.apache.jcs.engine.CompositeCacheAttributes
+</pre></div>
+ to
+
+<div class="source">
+<pre>
+jcs.default.cacheattributes=org.apache.commons.jcs.engine.CompositeCacheAttributes
+</pre></div>
+ and all <tt>MaxLifeSeconds</tt> lines to <tt>MaxLife</tt>
+ like
+
+<div class="source">
+<pre>
+jcs.default.elementattributes.MaxLifeSeconds=7
+</pre></div>
+ to
+
+<div class="source">
+<pre>
+jcs.default.elementattributes.MaxLife=7
+</pre></div>
+
+
+<p>
+ The <tt>IndexedDiskCache</tt> recycle bin is no longer limited in size.
+ So remove all references to <tt>MaxRecycleBinSize</tt> from the configuration files.
+ </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>