You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jcs-dev@jakarta.apache.org by tv...@apache.org on 2007/05/10 18:04:27 UTC
svn commit: r536904 [37/38] - in /jakarta/jcs/trunk: ./
auxiliary-builds/javagroups/
auxiliary-builds/javagroups/src/java/org/apache/jcs/auxiliary/javagroups/
auxiliary-builds/javagroups/src/test/org/apache/jcs/auxiliary/javagroups/
auxiliary-builds/jd...
Modified: jakarta/jcs/trunk/xdocs/LocalCacheConfig.xml
URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/xdocs/LocalCacheConfig.xml?view=diff&rev=536904&r1=536903&r2=536904
==============================================================================
--- jakarta/jcs/trunk/xdocs/LocalCacheConfig.xml (original)
+++ jakarta/jcs/trunk/xdocs/LocalCacheConfig.xml Thu May 10 09:03:42 2007
@@ -1,4 +1,22 @@
<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
<document>
<properties>
@@ -8,8 +26,8 @@
</properties>
<body>
- <section name="Configuring the Local Cache">
- <p>
+ <section name="Configuring the Local Cache">
+ <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.
@@ -53,7 +71,7 @@
setting look like this:
</p>
<source><![CDATA[
-# DEFAULT CACHE REGION
+# DEFAULT CACHE REGION
# sets the default aux value for any non configured caches
jcs.default=DC,RFailover
@@ -137,7 +155,7 @@
org.apache.jcs.auxiliary.remote.RemoteCacheFactory
jcs.auxiliary.RFailover.attributes=
org.apache.jcs.auxiliary.remote.RemoteCacheAttributes
-jcs.auxiliary.RFailover.attributes.RemoteTypeName=LOCAL
+jcs.auxiliary.RFailover.attributes.RemoteTypeName=LOCAL
jcs.auxiliary.RFailover.attributes.FailoverServers=
localhost:1102,localhost:1101
]]></source>
Modified: jakarta/jcs/trunk/xdocs/MySQLDiskCacheProperties.xml
URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/xdocs/MySQLDiskCacheProperties.xml?view=diff&rev=536904&r1=536903&r2=536904
==============================================================================
--- jakarta/jcs/trunk/xdocs/MySQLDiskCacheProperties.xml (original)
+++ jakarta/jcs/trunk/xdocs/MySQLDiskCacheProperties.xml Thu May 10 09:03:42 2007
@@ -1,177 +1,195 @@
-<?xml version="1.0"?>
-
-<document>
- <properties>
- <title>MySQL Disk Cache Configuration</title>
- <author email="asmuts@apache.org">Aaron Smuts</author>
- </properties>
-
- <body>
- <section name="MySQL Disk Auxiliary Cache Configuration">
-
- <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>
-
- <subsection name="MySQL Disk Configuration Properties">
- <table>
- <tr>
- <th>Property</th>
- <th>Description</th>
- <th>Required</th>
- <th>Default Value</th>
- </tr>
- <tr>
- <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>
- <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>
- </subsection>
-
- <subsection name="Example Configuration">
- <source>
- <![CDATA[
-##############################################################
-################## AUXILIARY CACHES AVAILABLE ################
-# MYSQL disk cache
-jcs.auxiliary.MYSQL=org.apache.jcs.auxiliary.disk.jdbc.mysql.MySQLDiskCacheFactory
-jcs.auxiliary.MYSQL.attributes=org.apache.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
- ]]>
- </source>
- </subsection>
-
- <subsection name="MySQL Disk Event Queue Configuration">
-
- <table>
- <tr>
- <th>Property</th>
- <th>Description</th>
- <th>Required</th>
- <th>Default Value</th>
- </tr>
- <tr>
- <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>
- <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>
- </subsection>
-
- <subsection
- name="Example Configuration Using Thread Pool">
- <source>
- <![CDATA[
-##############################################################
-################## AUXILIARY CACHES AVAILABLE ################
-# MYSQL disk cache
-jcs.auxiliary.MYSQL=org.apache.jcs.auxiliary.disk.jdbc.mysql.MySQLDiskCacheFactory
-jcs.auxiliary.MYSQL.attributes=org.apache.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
- ]]>
- </source>
- </subsection>
-
- </section>
- </body>
-</document>
\ No newline at end of file
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+<document>
+ <properties>
+ <title>MySQL Disk Cache Configuration</title>
+ <author email="asmuts@apache.org">Aaron Smuts</author>
+ </properties>
+
+ <body>
+ <section name="MySQL Disk Auxiliary Cache Configuration">
+
+ <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>
+
+ <subsection name="MySQL Disk Configuration Properties">
+ <table>
+ <tr>
+ <th>Property</th>
+ <th>Description</th>
+ <th>Required</th>
+ <th>Default Value</th>
+ </tr>
+ <tr>
+ <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>
+ <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>
+ </subsection>
+
+ <subsection name="Example Configuration">
+ <source>
+ <![CDATA[
+##############################################################
+################## AUXILIARY CACHES AVAILABLE ################
+# MYSQL disk cache
+jcs.auxiliary.MYSQL=org.apache.jcs.auxiliary.disk.jdbc.mysql.MySQLDiskCacheFactory
+jcs.auxiliary.MYSQL.attributes=org.apache.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
+ ]]>
+ </source>
+ </subsection>
+
+ <subsection name="MySQL Disk Event Queue Configuration">
+
+ <table>
+ <tr>
+ <th>Property</th>
+ <th>Description</th>
+ <th>Required</th>
+ <th>Default Value</th>
+ </tr>
+ <tr>
+ <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>
+ <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>
+ </subsection>
+
+ <subsection
+ name="Example Configuration Using Thread Pool">
+ <source>
+ <![CDATA[
+##############################################################
+################## AUXILIARY CACHES AVAILABLE ################
+# MYSQL disk cache
+jcs.auxiliary.MYSQL=org.apache.jcs.auxiliary.disk.jdbc.mysql.MySQLDiskCacheFactory
+jcs.auxiliary.MYSQL.attributes=org.apache.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
+ ]]>
+ </source>
+ </subsection>
+
+ </section>
+ </body>
+</document>
Modified: jakarta/jcs/trunk/xdocs/Plugins.xml
URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/xdocs/Plugins.xml?view=diff&rev=536904&r1=536903&r2=536904
==============================================================================
--- jakarta/jcs/trunk/xdocs/Plugins.xml (original)
+++ jakarta/jcs/trunk/xdocs/Plugins.xml Thu May 10 09:03:42 2007
@@ -1,4 +1,22 @@
<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
<document>
<properties>
@@ -7,47 +25,47 @@
</properties>
<body>
- <section name="JCS Plugin Overview">
- <p>
- JCS provides multiple auxiliaries which can be plugged into a cache region, in a manner similar to adding Log4j appenders to a logger.
+ <section name="JCS Plugin Overview">
+ <p>
+ JCS provides multiple auxiliaries which can be plugged into a cache region, in a manner similar to adding Log4j appenders to a logger.
JCS auxiliaries are defined in the cache.ccf file. You can specify which plugins a particular cache region should use.
</p>
- <p>
- There are four types of auxiliaries: (1) memory, (2) disk, (3) lateral, and (4) remote. Each region is required to have one and only one memory auxiliary. No other auxiliaries are required and any possible combination of disk, lateral, and remote auxiliaries is allowed. If you
+ <p>
+ There are four types of auxiliaries: (1) memory, (2) disk, (3) lateral, and (4) remote. Each region is required to have one and only one memory auxiliary. No other auxiliaries are required and any possible combination of disk, lateral, and remote auxiliaries is allowed. If you
do not want to store items in memory, then the maximum size for the memory
caches can be set to 0 on a per region basis.
</p>
</section>
- <section name="Memory Plugins">
- <p>
+ <section name="Memory Plugins">
+ <p>
Currently, JCS provides four memory management options: (1) LRUMemoryCache, (2) LHMLRUMemoryCache, (3) MRUMemoryCache, and (4) ARCMemoryCache. All memory caches restrict the number of items that can be stored in memory per region. If a disk cache is configured for the region, the items will be spooled to disk when the memory capacity is reached. JCS enforces configurable parameters such as time to live and maximum idle time. Expired elements can be cleaned up by the ShrinkerThread, otherwise they will be removed at the next retrieval attempt or when the capacity is reached.
</p>
<p>
- The LRUMemoryCache is the currently recommended plugin. Upon misconfiguration it is used as the default. The LRUMemoryCache removes the least recently used items when the cache is full.
+ The LRUMemoryCache is the currently recommended plugin. Upon misconfiguration it is used as the default. The LRUMemoryCache removes the least recently used items when the cache is full.
</p>
<p>
- The ARCMemoryCache is currently experimental, but will be fully tested soon. It implements an adaptive replacement caching algorithm that combines an LRU and an LFU that adapt to usage patterns.
+ The ARCMemoryCache is currently experimental, but will be fully tested soon. It implements an adaptive replacement caching algorithm that combines an LRU and an LFU that adapt to usage patterns.
</p>
</section>
- <section name="Disk Plugins">
- <p>
+ <section name="Disk Plugins">
+ <p>
JCS provides several disk swap options: indexed disk, HSQL, JISP, and Berkeley DB JE. The IndexedDiskCache is the recommended disk cache. It maintains the cached data on disk and the keys in memory for the fastest possible lookup times. Writing to disk is done asynchronously. Items are typically put in purgatory and queued for background disk writing. While in purgatory, the items remain available.
</p>
- <p>
+ <p>
In addition, JCS provides a disk auxiliary that uses the Berkeley DB Java Edition for disk storage. JCS can effectively function as an expiration manager and distribution mechanism on top of a Berkeley DB JE.
</p>
</section>
- <section name="Lateral Plugins">
- <p>
+ <section name="Lateral Plugins">
+ <p>
JCS provides two recommended lateral distribution options: TCP socket server distribution and JGroups (or JavaGroups). There are also several other experimental lateral distribution auxiliaries using servlets, UDP, and xmlrpc.
</p>
</section>
<section name="Remote Plugins">
- <p>
+ <p>
JCS also provides an RMI based remote server to manage distribution of cached data.
</p>
</section>
Modified: jakarta/jcs/trunk/xdocs/RegionProperties.xml
URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/xdocs/RegionProperties.xml?view=diff&rev=536904&r1=536903&r2=536904
==============================================================================
--- jakarta/jcs/trunk/xdocs/RegionProperties.xml (original)
+++ jakarta/jcs/trunk/xdocs/RegionProperties.xml Thu May 10 09:03:42 2007
@@ -1,250 +1,268 @@
-<?xml version="1.0"?>
-
-<document>
- <properties>
- <title>Cache Region Configuration</title>
- <author email="ASmuts@apache.org">Aaron Smuts</author>
- </properties>
-
- <body>
- <section name="Cache Region Configuration">
-
- <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>
-
- <subsection name="Region (Auxiliary) Properties">
- <table>
- <tr>
- <th>Property</th>
- <th>Description</th>
- <th>Required</th>
- <th>Default Value</th>
- </tr>
- <tr>
- <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>
- </subsection>
-
- <subsection name="Region (Cache) Properties">
- <table>
- <tr>
- <th>Property</th>
- <th>Description</th>
- <th>Required</th>
- <th>Default Value</th>
- </tr>
- <tr>
- <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>
- <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.jcs.engine.memory.MemoryCache
- interface. Alternatively, you can extend the
- org.apache.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.jcs.engine.memory.lru.LRUMemoryCache
- </td>
- </tr>
- <tr>
- <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>
- <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>-1</td>
- </tr>
- <tr>
- <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>60</td>
- </tr>
- <tr>
- <td>DiskUsagePattern</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 lossing
- 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>
- </subsection>
-
- <subsection name="Region (Element) Properties">
- <table>
- <tr>
- <th>Property</th>
- <th>Description</th>
- <th>Required</th>
- <th>Default Value</th>
- </tr>
- <tr>
- <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>
- <td>MaxLifeSeconds</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
- elmenets 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>
- <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>
- <td>IsRemote</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>
- <td>IsLateral</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>
- </subsection>
-
- <subsection name="Example Configuration">
- <source>
- <![CDATA[
-jcs.default=
-jcs.default.cacheattributes=org.apache.jcs.engine.CompositeCacheAttributes
-jcs.default.cacheattributes.MaxObjects=200001
-jcs.default.cacheattributes.MemoryCacheName=org.apache.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.jcs.engine.ElementAttributes
-jcs.default.elementattributes.IsEternal=false
-jcs.default.elementattributes.MaxLifeSeconds=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.jcs.engine.CompositeCacheAttributes
-jcs.region.testCache1.cacheattributes.MaxObjects=123456
-jcs.region.testCache1.cacheattributes.MemoryCacheName=org.apache.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.jcs.engine.ElementAttributes
-jcs.region.testCache1.elementattributes.IsEternal=false
-jcs.region.testCache1.elementattributes.MaxLifeSeconds=60000
-jcs.region.testCache1.elementattributes.IsSpool=true
-jcs.region.testCache1.elementattributes.IsLateral=true
-jcs.region.testCache1.elementattributes.IsRemote=true
- ]]>
- </source>
- </subsection>
-
- </section>
- </body>
-</document>
\ No newline at end of file
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+<document>
+ <properties>
+ <title>Cache Region Configuration</title>
+ <author email="ASmuts@apache.org">Aaron Smuts</author>
+ </properties>
+
+ <body>
+ <section name="Cache Region Configuration">
+
+ <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>
+
+ <subsection name="Region (Auxiliary) Properties">
+ <table>
+ <tr>
+ <th>Property</th>
+ <th>Description</th>
+ <th>Required</th>
+ <th>Default Value</th>
+ </tr>
+ <tr>
+ <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>
+ </subsection>
+
+ <subsection name="Region (Cache) Properties">
+ <table>
+ <tr>
+ <th>Property</th>
+ <th>Description</th>
+ <th>Required</th>
+ <th>Default Value</th>
+ </tr>
+ <tr>
+ <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>
+ <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.jcs.engine.memory.MemoryCache
+ interface. Alternatively, you can extend the
+ org.apache.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.jcs.engine.memory.lru.LRUMemoryCache
+ </td>
+ </tr>
+ <tr>
+ <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>
+ <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>-1</td>
+ </tr>
+ <tr>
+ <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>60</td>
+ </tr>
+ <tr>
+ <td>DiskUsagePattern</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 lossing
+ 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>
+ </subsection>
+
+ <subsection name="Region (Element) Properties">
+ <table>
+ <tr>
+ <th>Property</th>
+ <th>Description</th>
+ <th>Required</th>
+ <th>Default Value</th>
+ </tr>
+ <tr>
+ <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>
+ <td>MaxLifeSeconds</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
+ elmenets 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>
+ <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>
+ <td>IsRemote</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>
+ <td>IsLateral</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>
+ </subsection>
+
+ <subsection name="Example Configuration">
+ <source>
+ <![CDATA[
+jcs.default=
+jcs.default.cacheattributes=org.apache.jcs.engine.CompositeCacheAttributes
+jcs.default.cacheattributes.MaxObjects=200001
+jcs.default.cacheattributes.MemoryCacheName=org.apache.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.jcs.engine.ElementAttributes
+jcs.default.elementattributes.IsEternal=false
+jcs.default.elementattributes.MaxLifeSeconds=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.jcs.engine.CompositeCacheAttributes
+jcs.region.testCache1.cacheattributes.MaxObjects=123456
+jcs.region.testCache1.cacheattributes.MemoryCacheName=org.apache.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.jcs.engine.ElementAttributes
+jcs.region.testCache1.elementattributes.IsEternal=false
+jcs.region.testCache1.elementattributes.MaxLifeSeconds=60000
+jcs.region.testCache1.elementattributes.IsSpool=true
+jcs.region.testCache1.elementattributes.IsLateral=true
+jcs.region.testCache1.elementattributes.IsRemote=true
+ ]]>
+ </source>
+ </subsection>
+
+ </section>
+ </body>
+</document>
Modified: jakarta/jcs/trunk/xdocs/RemoteAuxCache.xml
URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/xdocs/RemoteAuxCache.xml?view=diff&rev=536904&r1=536903&r2=536904
==============================================================================
--- jakarta/jcs/trunk/xdocs/RemoteAuxCache.xml (original)
+++ jakarta/jcs/trunk/xdocs/RemoteAuxCache.xml Thu May 10 09:03:42 2007
@@ -1,4 +1,22 @@
<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
<document>
<properties>
@@ -177,7 +195,7 @@
</p>
<source>
<![CDATA[
-# Registry used to register and provide the
+# Registry used to register and provide the
# IRemoteCacheService service.
registry.host=localhost
registry.port=1102
@@ -320,8 +338,8 @@
</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
-
-
+
+
<servlet-mapping>
<servlet-name>JCSRemoteCacheStartupServlet</servlet-name>
<url-pattern>/jcs</url-pattern>
Modified: jakarta/jcs/trunk/xdocs/RemoteCacheProperties.xml
URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/xdocs/RemoteCacheProperties.xml?view=diff&rev=536904&r1=536903&r2=536904
==============================================================================
--- jakarta/jcs/trunk/xdocs/RemoteCacheProperties.xml (original)
+++ jakarta/jcs/trunk/xdocs/RemoteCacheProperties.xml Thu May 10 09:03:42 2007
@@ -1,149 +1,167 @@
-<?xml version="1.0"?>
-
-<document>
- <properties>
- <title>Remote Cache Configuration</title>
- <author email="ASmuts@apache.org">Aaron Smuts</author>
- </properties>
-
- <body>
- <section name="Remote Auxiliary Cache Configuration">
-
- <p>
- The following properties apply to the Remote Cache
- plugin.
- </p>
-
- <subsection name="Remote Client Configuration Properties">
- <table>
- <tr>
- <th>Property</th>
- <th>Description</th>
- <th>Required</th>
- <th>Default Value</th>
- </tr>
- <tr>
- <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>
- <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>
- <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>false</td>
- </tr>
- <tr>
- <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>
- <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>
- <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>
- <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>
- </subsection>
-
- <subsection name="Example Configuration">
- <source>
- <![CDATA[
-# This remote client does not receive
-jcs.auxiliary.RC=org.apache.jcs.auxiliary.remote.RemoteCacheFactory
-jcs.auxiliary.RC.attributes=org.apache.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
- ]]>
- </source>
- </subsection>
-
- </section>
- </body>
-</document>
\ No newline at end of file
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+<document>
+ <properties>
+ <title>Remote Cache Configuration</title>
+ <author email="ASmuts@apache.org">Aaron Smuts</author>
+ </properties>
+
+ <body>
+ <section name="Remote Auxiliary Cache Configuration">
+
+ <p>
+ The following properties apply to the Remote Cache
+ plugin.
+ </p>
+
+ <subsection name="Remote Client Configuration Properties">
+ <table>
+ <tr>
+ <th>Property</th>
+ <th>Description</th>
+ <th>Required</th>
+ <th>Default Value</th>
+ </tr>
+ <tr>
+ <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>
+ <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>
+ <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>false</td>
+ </tr>
+ <tr>
+ <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>
+ <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>
+ <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>
+ <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>
+ </subsection>
+
+ <subsection name="Example Configuration">
+ <source>
+ <![CDATA[
+# This remote client does not receive
+jcs.auxiliary.RC=org.apache.jcs.auxiliary.remote.RemoteCacheFactory
+jcs.auxiliary.RC.attributes=org.apache.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
+ ]]>
+ </source>
+ </subsection>
+
+ </section>
+ </body>
+</document>
Modified: jakarta/jcs/trunk/xdocs/UsingJCSBasicWeb.xml
URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/xdocs/UsingJCSBasicWeb.xml?view=diff&rev=536904&r1=536903&r2=536904
==============================================================================
--- jakarta/jcs/trunk/xdocs/UsingJCSBasicWeb.xml (original)
+++ jakarta/jcs/trunk/xdocs/UsingJCSBasicWeb.xml Thu May 10 09:03:42 2007
@@ -1,4 +1,22 @@
<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
<document>
<properties>
Modified: jakarta/jcs/trunk/xdocs/changes.xml
URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/xdocs/changes.xml?view=diff&rev=536904&r1=536903&r2=536904
==============================================================================
--- jakarta/jcs/trunk/xdocs/changes.xml (original)
+++ jakarta/jcs/trunk/xdocs/changes.xml Thu May 10 09:03:42 2007
@@ -1,253 +1,272 @@
-<document>
- <properties>
- <title>JCS Change Log</title>
- <author email="asmuts@apache.org">Aaron Smuts</author>
- </properties>
- <body>
-
- <release version="1.2.7.9.3" date="in CVS">
- <action dev="asmuts" type="fix" issue="JCS-15"
- due-to="Kevin Preece">
- Fixed partial key and group id removal bug in indexed disk cache.
- </action>
- <action dev="asmuts" type="fix" issue="JCS-20"
- due-to="Alistair Forbes">
- Fixed partial key removal SQL syntax problem with the
- JDBC disk cache.
- </action>
- <action dev="asmuts" type="fix" issue="JCS-21"
- due-to="Michael Stevens">
- Fixed a few minor missing locks.
- </action>
- </release>
-
- <release version="1.2.7.9.2" date="in CVS">
- <action dev="asmuts" type="update">
- Added a summary page to the JCSAdmin.jsp that just dumps
- the stats for a region. It doesn't display all the keys.
- </action>
- <action dev="asmuts" type="update">
- Added get, put, and remove counts to the lateral and
- remote stats. Added hit count to disk cache stats.
- </action>
- <action dev="asmuts" type="fix" issue="JCS-12"
- due-to="John Klame">
- Fixed non thread safe OOS writes in the TCP Lateral
- Sender. This was causing endless loops deep down in the
- OOS code.
- </action>
-
- </release>
-
- <release version="1.2.7.9" date="in CVS">
- <action dev="asmuts" type="fix" issue="JCS-1">
- Fixed last element too small recycle bin bug.
- </action>
- <action dev="asmuts" type="update" issue="JCS-2">
- Added the ability to send all items to disk or to use
- the disk merely as a swap. This is done by setting the
- DiskUsagePattern on the cache attributes for a region.
- </action>
- <action dev="asmuts" type="fix" issue="JCS-3"
- due-to="Peter Schwarz">
- Disk optimization now occurs in place, without using
- additional files. It is far more efficient.
- </action>
- <action dev="asmuts" type="fix" issue="JCS-4">
- The disk cache will not optimize on shutdown if the
- freedata size is 0.
- </action>
- <action dev="asmuts" type="fix" issue="JCS-8">
- Remote cache client will now shutdown properly.
- </action>
- <action dev="asmuts" type="fix" issue="JCS-9">
- Only send memory items to disk auxiliaries on shutdown.
- </action>
- </release>
-
- <release version="1.2.7.8" date="in CVS">
- <action dev="asmuts" type="update">
- Added the ability to schedule optimizations for the
- MySQL disk cache. It can also recover from optimization
- failure and repair the table. It's been tested and is
- running in a production environment.
- </action>
- </release>
-
- <release version="1.2.7.7" date="in CVS">
- <action dev="asmuts" type="fix"
- due-to="Brian Crow @noteworthyms.com">
- Fixed the array index out of bounds exception in the
- Sorted Preferential Array.
- </action>
- </release>
-
- <release version="1.2.7.6" date="in CVS">
- <action dev="asmuts" type="fix"
- due-to="Rick Szeto @vizible.com">
- Fixed UDP discovery configuration problem. The discovery
- address was not being used. It was broken in the last
- release.
- </action>
- <action dev="asmuts" type="fix" due-to="Alistair Forbes">
- Fixed disk cache class cast problem when running inside
- the remote cache. The disk cache was casting to an
- instance and not the ICacheElement interface.
- </action>
- </release>
-
- <release version="1.2.7.3" date="in CVS">
- <action dev="asmuts" type="update" due-to="">
- You can now configure the remote cache client to not
- receive from the remote server.
- </action>
- <action dev="asmuts" type="update" due-to="">
- Added a new xdoc for the Remote Cache properties.
- </action>
- <action dev="asmuts" type="update" due-to="">
- Improved the jcs admin jsp: added stats details, better
- navigation, item lookup, and remove confirmation.
- </action>
- </release>
-
- <release version="1.2.7.2" date="in CVS">
- <action dev="asmuts" type="update" due-to="">
- You can configure the remote cache to use a custom RMI
- Socket Factory with socket timeouts.
- </action>
- <action dev="hchar" type="fix" due-to="">
- Removed redundant system out logging from remote cache
- server.
- </action>
- <action dev="asmuts" type="update" due-to="">
- Added additional stats for remote cache.
- </action>
- </release>
-
- <release version="1.2.7.1" date="in CVS">
- <action dev="asmuts" type="update" due-to="">
- Added a JDBC disk cache. It has been tested with MYSql
- and HSQL.
- </action>
- <action dev="asmuts" type="update" due-to="">
- Added a special HSQL implementation of the JDBC disk
- cache. This replaces the previous experimental HSQL
- implementation.
- </action>
- <action dev="asmuts" type="update" due-to="">
- Added a new xdoc for the JDBC Disk Cache properties.
- </action>
- </release>
-
- <release version="1.2.7.0" date="in CVS">
- <action dev="asmuts" type="update" due-to="">
- Removed dependencies on commons-lang and on
- commons-collections from the core of JCS.
- </action>
- <action dev="asmuts" type="update" due-to="">
- Increased test coverage.
- </action>
- <action dev="asmuts" type="fix" due-to="">
- Fixed entry set creation problem in LRUMap.
- </action>
- </release>
-
- <release version="1.2.6.9" date="in CVS">
- <action dev="asmuts" type="update" due-to="">
- The remote cache now sends a byte array to the server
- instead of the class. This allows you to run the remote
- server without copies of your objects in its classpath.
- This makes the remote server far easier to use.
- </action>
- <action dev="asmuts" type="update" due-to="">
- Created an interface for cache element serializers and
- made a default implementation. This will allow use to
- use other serialization mechanisms in the future. I
- converted the remote cache to use the standard
- serializer.
- </action>
- <action dev="asmuts" type="update" due-to="">
- Added several new unit tests.
- </action>
- <action dev="asmuts" type="update" due-to="">
- Improved Javadocs throughout.
- </action>
- </release>
-
- <release version="1.2.6.8" date="in CVS">
- <action dev="asmuts" type="fix" due-to="">
- Moved synchronization from the client to the sorted
- preferential array. This solved the index out of bounds
- exception that appeared periodically on disk cleanup.
- </action>
- <action dev="asmuts" type="update" due-to="">
- Improved Javadocs throughout.
- </action>
- </release>
-
- <release version="1.2.6.7" date="in CVS">
- <action dev="asmuts" type="fix"
- due-to="Adam Siefker @amazon.com">
- Fixed shutdown for lateral. Added shutdown observer
- framework. Changed listener thread to a daemon. Made
- executor on listener use a daemon setting thread
- factory.
- </action>
- <action dev="asmuts" type="fix" due-to="">
- Fixed abstract inner class references for Jikes.
- </action>
- <action dev="asmuts" type="update" due-to="">
- Improved Javadocs throughout.
- </action>
- </release>
-
- <release version="1.2.6.6" date="in CVS">
- <action dev="asmuts" type="fix">
- Properties are loaded using the current thread's
- classloader by default.
- </action>
- <action dev="asmuts" type="fix">
- When a config file is not found a descriptive error
- message is printed to the logs.
- </action>
- <action dev="asmuts" type="update">
- Made an interface for the cache manager to improve
- testability.
- </action>
- <action dev="asmuts" type="update">
- Auxiliaries are assigned a cache manager and the lateral
- TCP has a settable source id, so it can be tested.
- </action>
- <action dev="asmuts" type="update">
- Increased JGroups version to 2.2.8. It works again. The
- old JGroups didn't work for unknown reasons.
- </action>
- <action dev="asmuts" type="update">
- Cleaned up some javadocs.
- </action>
- <action dev="asmuts" type="update">
- Improved info level logging for TCP lateral.
- </action>
- <action dev="asmuts" type="update">
- Added configuration properties xdocs for TCP lateral,
- indexed disk, and memory cache.
- </action>
- <action dev="asmuts" type="update">
- Created concurrent tests for TCP lateral to verify
- correct region behavior.
- </action>
- <action dev="asmuts" type="update">
- Made BDBJE work with new auxiliary changes.
- </action>
- <action dev="asmuts" type="fix">
- UDP discovery no longer activates if the lateral type
- isn't TCP.
- </action>
- <action dev="asmuts" type="fix">
- Reduced lateral get timeout to 1 second, rather than 10.
- We still need to disable gets when a timeout occurs.
- </action>
- </release>
-
- </body>
-</document>
\ No newline at end of file
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<document>
+ <properties>
+ <title>JCS Change Log</title>
+ <author email="asmuts@apache.org">Aaron Smuts</author>
+ </properties>
+ <body>
+
+ <release version="1.2.7.9.3" date="in CVS">
+ <action dev="asmuts" type="fix" issue="JCS-15"
+ due-to="Kevin Preece">
+ Fixed partial key and group id removal bug in indexed disk cache.
+ </action>
+ <action dev="asmuts" type="fix" issue="JCS-20"
+ due-to="Alistair Forbes">
+ Fixed partial key removal SQL syntax problem with the
+ JDBC disk cache.
+ </action>
+ <action dev="asmuts" type="fix" issue="JCS-21"
+ due-to="Michael Stevens">
+ Fixed a few minor missing locks.
+ </action>
+ </release>
+
+ <release version="1.2.7.9.2" date="in CVS">
+ <action dev="asmuts" type="update">
+ Added a summary page to the JCSAdmin.jsp that just dumps
+ the stats for a region. It doesn't display all the keys.
+ </action>
+ <action dev="asmuts" type="update">
+ Added get, put, and remove counts to the lateral and
+ remote stats. Added hit count to disk cache stats.
+ </action>
+ <action dev="asmuts" type="fix" issue="JCS-12"
+ due-to="John Klame">
+ Fixed non thread safe OOS writes in the TCP Lateral
+ Sender. This was causing endless loops deep down in the
+ OOS code.
+ </action>
+
+ </release>
+
+ <release version="1.2.7.9" date="in CVS">
+ <action dev="asmuts" type="fix" issue="JCS-1">
+ Fixed last element too small recycle bin bug.
+ </action>
+ <action dev="asmuts" type="update" issue="JCS-2">
+ Added the ability to send all items to disk or to use
+ the disk merely as a swap. This is done by setting the
+ DiskUsagePattern on the cache attributes for a region.
+ </action>
+ <action dev="asmuts" type="fix" issue="JCS-3"
+ due-to="Peter Schwarz">
+ Disk optimization now occurs in place, without using
+ additional files. It is far more efficient.
+ </action>
+ <action dev="asmuts" type="fix" issue="JCS-4">
+ The disk cache will not optimize on shutdown if the
+ freedata size is 0.
+ </action>
+ <action dev="asmuts" type="fix" issue="JCS-8">
+ Remote cache client will now shutdown properly.
+ </action>
+ <action dev="asmuts" type="fix" issue="JCS-9">
+ Only send memory items to disk auxiliaries on shutdown.
+ </action>
+ </release>
+
+ <release version="1.2.7.8" date="in CVS">
+ <action dev="asmuts" type="update">
+ Added the ability to schedule optimizations for the
+ MySQL disk cache. It can also recover from optimization
+ failure and repair the table. It's been tested and is
+ running in a production environment.
+ </action>
+ </release>
+
+ <release version="1.2.7.7" date="in CVS">
+ <action dev="asmuts" type="fix"
+ due-to="Brian Crow @noteworthyms.com">
+ Fixed the array index out of bounds exception in the
+ Sorted Preferential Array.
+ </action>
+ </release>
+
+ <release version="1.2.7.6" date="in CVS">
+ <action dev="asmuts" type="fix"
+ due-to="Rick Szeto @vizible.com">
+ Fixed UDP discovery configuration problem. The discovery
+ address was not being used. It was broken in the last
+ release.
+ </action>
+ <action dev="asmuts" type="fix" due-to="Alistair Forbes">
+ Fixed disk cache class cast problem when running inside
+ the remote cache. The disk cache was casting to an
+ instance and not the ICacheElement interface.
+ </action>
+ </release>
+
+ <release version="1.2.7.3" date="in CVS">
+ <action dev="asmuts" type="update" due-to="">
+ You can now configure the remote cache client to not
+ receive from the remote server.
+ </action>
+ <action dev="asmuts" type="update" due-to="">
+ Added a new xdoc for the Remote Cache properties.
+ </action>
+ <action dev="asmuts" type="update" due-to="">
+ Improved the jcs admin jsp: added stats details, better
+ navigation, item lookup, and remove confirmation.
+ </action>
+ </release>
+
+ <release version="1.2.7.2" date="in CVS">
+ <action dev="asmuts" type="update" due-to="">
+ You can configure the remote cache to use a custom RMI
+ Socket Factory with socket timeouts.
+ </action>
+ <action dev="hchar" type="fix" due-to="">
+ Removed redundant system out logging from remote cache
+ server.
+ </action>
+ <action dev="asmuts" type="update" due-to="">
+ Added additional stats for remote cache.
+ </action>
+ </release>
+
+ <release version="1.2.7.1" date="in CVS">
+ <action dev="asmuts" type="update" due-to="">
+ Added a JDBC disk cache. It has been tested with MYSql
+ and HSQL.
+ </action>
+ <action dev="asmuts" type="update" due-to="">
+ Added a special HSQL implementation of the JDBC disk
+ cache. This replaces the previous experimental HSQL
+ implementation.
+ </action>
+ <action dev="asmuts" type="update" due-to="">
+ Added a new xdoc for the JDBC Disk Cache properties.
+ </action>
+ </release>
+
+ <release version="1.2.7.0" date="in CVS">
+ <action dev="asmuts" type="update" due-to="">
+ Removed dependencies on commons-lang and on
+ commons-collections from the core of JCS.
+ </action>
+ <action dev="asmuts" type="update" due-to="">
+ Increased test coverage.
+ </action>
+ <action dev="asmuts" type="fix" due-to="">
+ Fixed entry set creation problem in LRUMap.
+ </action>
+ </release>
+
+ <release version="1.2.6.9" date="in CVS">
+ <action dev="asmuts" type="update" due-to="">
+ The remote cache now sends a byte array to the server
+ instead of the class. This allows you to run the remote
+ server without copies of your objects in its classpath.
+ This makes the remote server far easier to use.
+ </action>
+ <action dev="asmuts" type="update" due-to="">
+ Created an interface for cache element serializers and
+ made a default implementation. This will allow use to
+ use other serialization mechanisms in the future. I
+ converted the remote cache to use the standard
+ serializer.
+ </action>
+ <action dev="asmuts" type="update" due-to="">
+ Added several new unit tests.
+ </action>
+ <action dev="asmuts" type="update" due-to="">
+ Improved Javadocs throughout.
+ </action>
+ </release>
+
+ <release version="1.2.6.8" date="in CVS">
+ <action dev="asmuts" type="fix" due-to="">
+ Moved synchronization from the client to the sorted
+ preferential array. This solved the index out of bounds
+ exception that appeared periodically on disk cleanup.
+ </action>
+ <action dev="asmuts" type="update" due-to="">
+ Improved Javadocs throughout.
+ </action>
+ </release>
+
+ <release version="1.2.6.7" date="in CVS">
+ <action dev="asmuts" type="fix"
+ due-to="Adam Siefker @amazon.com">
+ Fixed shutdown for lateral. Added shutdown observer
+ framework. Changed listener thread to a daemon. Made
+ executor on listener use a daemon setting thread
+ factory.
+ </action>
+ <action dev="asmuts" type="fix" due-to="">
+ Fixed abstract inner class references for Jikes.
+ </action>
+ <action dev="asmuts" type="update" due-to="">
+ Improved Javadocs throughout.
+ </action>
+ </release>
+
+ <release version="1.2.6.6" date="in CVS">
+ <action dev="asmuts" type="fix">
+ Properties are loaded using the current thread's
+ classloader by default.
+ </action>
+ <action dev="asmuts" type="fix">
+ When a config file is not found a descriptive error
+ message is printed to the logs.
+ </action>
+ <action dev="asmuts" type="update">
+ Made an interface for the cache manager to improve
+ testability.
+ </action>
+ <action dev="asmuts" type="update">
+ Auxiliaries are assigned a cache manager and the lateral
+ TCP has a settable source id, so it can be tested.
+ </action>
+ <action dev="asmuts" type="update">
+ Increased JGroups version to 2.2.8. It works again. The
+ old JGroups didn't work for unknown reasons.
+ </action>
+ <action dev="asmuts" type="update">
+ Cleaned up some javadocs.
+ </action>
+ <action dev="asmuts" type="update">
+ Improved info level logging for TCP lateral.
+ </action>
+ <action dev="asmuts" type="update">
+ Added configuration properties xdocs for TCP lateral,
+ indexed disk, and memory cache.
+ </action>
+ <action dev="asmuts" type="update">
+ Created concurrent tests for TCP lateral to verify
+ correct region behavior.
+ </action>
+ <action dev="asmuts" type="update">
+ Made BDBJE work with new auxiliary changes.
+ </action>
+ <action dev="asmuts" type="fix">
+ UDP discovery no longer activates if the lateral type
+ isn't TCP.
+ </action>
+ <action dev="asmuts" type="fix">
+ Reduced lateral get timeout to 1 second, rather than 10.
+ We still need to disable gets when a timeout occurs.
+ </action>
+ </release>
+
+ </body>
+</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: jcs-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: jcs-dev-help@jakarta.apache.org