This is an automated email from the ASF dual-hosted git repository.
tv pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-jcs.git
The following commit(s) were added to refs/heads/master by this push:
new 75a8c2bd Fix documentation
75a8c2bd is described below
commit 75a8c2bd1a734e2ef474ad83364dd35790d074f7
Author: Thomas Vandahl <[email protected]>
AuthorDate: Thu Mar 19 19:32:31 2026 +0100
Fix documentation
---
.../disk/jdbc/JDBCDiskCacheAttributes.java | 10 +++++-----
.../disk/jdbc/JDBCDataSourceFactoryUnitTest.java | 6 +++---
.../auxiliary/disk/jdbc/JDBCDiskCacheUnitTest.java | 2 +-
src/site/xdoc/JDBCDiskCache.xml | 2 +-
src/site/xdoc/JDBCDiskCacheProperties.xml | 15 +++++++--------
src/site/xdoc/MySQLDiskCacheProperties.xml | 2 +-
src/site/xdoc/RegionProperties.xml | 21 ++++++++++++++++++++-
7 files changed, 38 insertions(+), 20 deletions(-)
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDiskCacheAttributes.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDiskCacheAttributes.java
index 6c2ede34..42e77576 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDiskCacheAttributes.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDiskCacheAttributes.java
@@ -220,11 +220,11 @@ public class JDBCDiskCacheAttributes
}
/**
- * @param maxActive The maxTotal to set.
+ * @param maxTotal The maxTotal to set.
*/
- public void setMaxTotal( final int maxActive )
+ public void setMaxTotal( final int maxTotal )
{
- this.maxTotal = maxActive;
+ this.maxTotal = maxTotal;
}
/**
@@ -301,10 +301,10 @@ public class JDBCDiskCacheAttributes
buf.append( "\n DriverClassName [" + getDriverClassName() + "]" );
buf.append( "\n TableName [" + getTableName() + "]" );
buf.append( "\n TestBeforeInsert [" + isTestBeforeInsert() + "]" );
- buf.append( "\n MaxActive [" + getMaxTotal() + "]" );
+ buf.append( "\n MaxTotal [" + getMaxTotal() + "]" );
buf.append( "\n AllowRemoveAll [" + isAllowRemoveAll() + "]" );
buf.append( "\n ShrinkerInterval [" + getShrinkerInterval() + "]" );
- buf.append( "\n useDiskShrinker [" + isUseDiskShrinker() + "]" );
+ buf.append( "\n UseDiskShrinker [" + isUseDiskShrinker() + "]" );
return buf.toString();
}
}
diff --git
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDataSourceFactoryUnitTest.java
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDataSourceFactoryUnitTest.java
index 6fafd1aa..5de969f8 100644
---
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDataSourceFactoryUnitTest.java
+++
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDataSourceFactoryUnitTest.java
@@ -116,7 +116,7 @@ class JDBCDataSourceFactoryUnitTest
final String url = "adfads";
final String userName = "zvzvz";
final String password = "qewrrewq";
- final int maxActive = 10;
+ final int maxTotal = 10;
final String driverClassName = "org.hsqldb.jdbcDriver";
final JDBCDiskCacheFactory factory = new JDBCDiskCacheFactory();
@@ -126,7 +126,7 @@ class JDBCDataSourceFactoryUnitTest
cattr.setUrl(url);
cattr.setUserName(userName);
cattr.setPassword(password);
- cattr.setMaxTotal(maxActive);
+ cattr.setMaxTotal(maxTotal);
cattr.setDriverClassName(driverClassName);
// DO WORK
@@ -137,7 +137,7 @@ class JDBCDataSourceFactoryUnitTest
assertNotNull( spds, "Should have a data source class" );
// VERIFY
- assertEquals( maxActive, spds.getMaxTotal(), "Wrong maxActive value" );
+ assertEquals( maxTotal, spds.getMaxTotal(), "Wrong maxActive value" );
}
/**
diff --git
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDiskCacheUnitTest.java
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDiskCacheUnitTest.java
index 56a2b019..d64a2065 100644
---
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDiskCacheUnitTest.java
+++
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDiskCacheUnitTest.java
@@ -130,7 +130,7 @@ public class JDBCDiskCacheUnitTest
props.put( prefix + ".url", "jdbc:hsqldb:target/cache_hsql_db" );
props.put( prefix + ".userName", "sa" );
props.put( prefix + ".password", "" );
- props.put( prefix + ".maxActive", String.valueOf(10) );
+ props.put( prefix + ".maxTotal", String.valueOf(10) );
props.put( prefix + ".driverClassName", "org.hsqldb.jdbcDriver" );
final JDBCDiskCacheAttributes cattr = new JDBCDiskCacheAttributes();
diff --git a/src/site/xdoc/JDBCDiskCache.xml b/src/site/xdoc/JDBCDiskCache.xml
index f0b2a550..35be2f3d 100644
--- a/src/site/xdoc/JDBCDiskCache.xml
+++ b/src/site/xdoc/JDBCDiskCache.xml
@@ -59,7 +59,7 @@
jcs.auxiliary.MYSQL.attributes.url=jdbc:mysql://localhost:3306/YOURDBNAME?autoRe
jcs.auxiliary.MYSQL.attributes.driverClassName=com.mysql.jdbc.Driver
jcs.auxiliary.MYSQL.attributes.tableName=JCS_STORE
jcs.auxiliary.MYSQL.attributes.testBeforeInsert=false
-jcs.auxiliary.MYSQL.attributes.maxActive=100
+jcs.auxiliary.MYSQL.attributes.maxTotal=100
jcs.auxiliary.MYSQL.attributes.MaxPurgatorySize=10000000
jcs.auxiliary.MYSQL.attributes.UseDiskShrinker=true
jcs.auxiliary.MYSQL.attributes.ShrinkerInterval=PT30m
diff --git a/src/site/xdoc/JDBCDiskCacheProperties.xml
b/src/site/xdoc/JDBCDiskCacheProperties.xml
index 7456f70b..0ee85ce8 100644
--- a/src/site/xdoc/JDBCDiskCacheProperties.xml
+++ b/src/site/xdoc/JDBCDiskCacheProperties.xml
@@ -68,12 +68,11 @@
Assuming the name is "MyPool":
<pre>
-
jcs.jdbcconnectionpool.MyPool.attributes.userName=MyUserName
-
jcs.jdbcconnectionpool.MyPool.attributes.password=MyPassword
- jcs.jdbcconnectionpool.MyPool.attributes.url=MyUrl
-
jcs.jdbcconnectionpool.MyPool.attributes.maxTotal=MyMaxTotal
-
jcs.jdbcconnectionpool.MyPool.attributes.driverClassName=MyDriverClassName
- </pre>
+jcs.jdbcconnectionpool.MyPool.attributes.userName=MyUserName
+jcs.jdbcconnectionpool.MyPool.attributes.password=MyPassword
+jcs.jdbcconnectionpool.MyPool.attributes.url=MyUrl
+jcs.jdbcconnectionpool.MyPool.attributes.maxTotal=MyMaxTotal
+jcs.jdbcconnectionpool.MyPool.attributes.driverClassName=MyDriverClassName</pre>
</td>
<td>N</td>
<td></td>
@@ -182,7 +181,7 @@ jcs.auxiliary.JDBC.attributes.url=jdbc:hsqldb:
jcs.auxiliary.JDBC.attributes.driverClassName=org.hsqldb.jdbcDriver
jcs.auxiliary.JDBC.attributes.tableName=JCS_STORE2
jcs.auxiliary.JDBC.attributes.testBeforeInsert=false
-jcs.auxiliary.JDBC.attributes.maxActive=15
+jcs.auxiliary.JDBC.attributes.maxTotal=15
jcs.auxiliary.JDBC.attributes.allowRemoveAll=true
jcs.auxiliary.JDBC.attributes.MaxPurgatorySize=10000000
jcs.auxiliary.JDBC.attributes.UseDiskShrinker=true
@@ -250,7 +249,7 @@ jcs.auxiliary.JDBC.attributes.database=target/cache_hsql_db
jcs.auxiliary.JDBC.attributes.driverClassName=org.hsqldb.jdbcDriver
jcs.auxiliary.JDBC.attributes.tableName=JCS_STORE2
jcs.auxiliary.JDBC.attributes.testBeforeInsert=false
-jcs.auxiliary.JDBC.attributes.maxActive=15
+jcs.auxiliary.JDBC.attributes.maxTotal=15
jcs.auxiliary.JDBC.attributes.allowRemoveAll=true
jcs.auxiliary.JDBC.attributes.MaxPurgatorySize=10000000
jcs.auxiliary.JDBC.attributes.UseDiskShrinker=true
diff --git a/src/site/xdoc/MySQLDiskCacheProperties.xml
b/src/site/xdoc/MySQLDiskCacheProperties.xml
index 559d0fb6..f1f38eb6 100644
--- a/src/site/xdoc/MySQLDiskCacheProperties.xml
+++ b/src/site/xdoc/MySQLDiskCacheProperties.xml
@@ -99,7 +99,7 @@
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.maxTotal=15
jcs.auxiliary.MYSQL.attributes.allowRemoveAll=true
jcs.auxiliary.MYSQL.attributes.MaxPurgatorySize=10000000
jcs.auxiliary.MYSQL.attributes.optimizationSchedule=12:34:56,02:34:54
diff --git a/src/site/xdoc/RegionProperties.xml
b/src/site/xdoc/RegionProperties.xml
index cb3743dc..dd5cedaa 100644
--- a/src/site/xdoc/RegionProperties.xml
+++ b/src/site/xdoc/RegionProperties.xml
@@ -221,8 +221,27 @@
be removed actively.
</td>
<td>N</td>
- <td>-1</td>
+ <td>PT-0.001s (unlimited)</td>
</tr>
+ <tr>
+ <td>MaxIdleTime</td>
+ <td>
+ You can define the maximum time an item can live
+ without being accessed by setting the
+ <code>MaxIdleTime</code>
+ parameter. This is different than the
+ <code>MaxMemoryIdleTime</code>
+ parameter, which just specifies how long an object
+ can be in memory before it is subjected to removal
+ or being spooled to a disk cache if it is
available.
+ Note: the
+ <code>MaxIdleTime</code>
+ parameter may not function properly for items
+ retrieved from disk, if you have a memory size of
0.
+ </td>
+ <td>N</td>
+ <td>PT-0.001s (unlimited)</td>
+ </tr>
<tr>
<td>IsSpool</td>
<td>
