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
commit e51b9d2bacaad04dad542940f20902a3829c324a Author: Thomas Vandahl <[email protected]> AuthorDate: Thu Mar 19 15:04:07 2026 +0100 Document jdbc disk cache attributes --- .../disk/jdbc/JDBCDiskCacheAttributes.java | 4 +- .../dsfactory/SharedPoolDataSourceFactory.java | 1 + src/site/xdoc/BlockDiskCache.xml | 2 +- src/site/xdoc/JDBCDiskCache.xml | 2 +- src/site/xdoc/JDBCDiskCacheProperties.xml | 73 ++++++++++++---------- 5 files changed, 44 insertions(+), 38 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 166fad77..c26897a7 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 @@ -78,14 +78,14 @@ public class JDBCDiskCacheAttributes private boolean useDiskShrinker = true; /** - * If a pool name is supplied, the manager will attempt to load it. It should be configured in a + * If a pool name is supplied, the factory will attempt to load it. It should be configured in a * separate section as follows. 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.maxActive=MyMaxActive + * jcs.jdbcconnectionpool.MyPool.attributes.maxTotal=MyMaxTotal * jcs.jdbcconnectionpool.MyPool.attributes.driverClassName=MyDriverClassName * </pre> */ diff --git a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/dsfactory/SharedPoolDataSourceFactory.java b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/dsfactory/SharedPoolDataSourceFactory.java index 89d43079..5364dc1b 100644 --- a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/dsfactory/SharedPoolDataSourceFactory.java +++ b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/dsfactory/SharedPoolDataSourceFactory.java @@ -83,6 +83,7 @@ public class SharedPoolDataSourceFactory implements DataSourceFactory log.debug("Starting initJdbc2Pool"); dataSource.setDescription(config.getConnectionPoolName()); + dataSource.setDefaultMaxTotal(config.getMaxTotal()); } /** The name of the factory. */ diff --git a/src/site/xdoc/BlockDiskCache.xml b/src/site/xdoc/BlockDiskCache.xml index 81ac3e63..0d302561 100644 --- a/src/site/xdoc/BlockDiskCache.xml +++ b/src/site/xdoc/BlockDiskCache.xml @@ -97,7 +97,7 @@ <td>PT1m</td> </tr> <tr> - <td>AllowRemoveAll</td> + <td>allowRemoveAll</td> <td>If this is false, we will not execute remove all.</td> <td>N</td> <td>true</td> diff --git a/src/site/xdoc/JDBCDiskCache.xml b/src/site/xdoc/JDBCDiskCache.xml index 9d24961e..f0b2a550 100644 --- a/src/site/xdoc/JDBCDiskCache.xml +++ b/src/site/xdoc/JDBCDiskCache.xml @@ -130,7 +130,7 @@ jcs.jdbcconnectionpool.MySharedPool.attributes.userName=sa jcs.jdbcconnectionpool.MySharedPool.attributes.password= jcs.jdbcconnectionpool.MySharedPool.attributes.url=jdbc:hsqldb:target/cache_hsql_db jcs.jdbcconnectionpool.MySharedPool.attributes.driverClassName=org.hsqldb.jdbcDriver -jcs.jdbcconnectionpool.MySharedPool.attributes.maxActive=15 +jcs.jdbcconnectionpool.MySharedPool.attributes.maxTotal=15 # ############################################################# # ################# OPTIONAL THREAD POOL CONFIGURATION ######### diff --git a/src/site/xdoc/JDBCDiskCacheProperties.xml b/src/site/xdoc/JDBCDiskCacheProperties.xml index dc0fb242..5cdc7554 100644 --- a/src/site/xdoc/JDBCDiskCacheProperties.xml +++ b/src/site/xdoc/JDBCDiskCacheProperties.xml @@ -40,16 +40,44 @@ <th>Required</th> <th>Default Value</th> </tr> - <tr> - <td>MaxPurgatorySize</td> - <td> - The maximum number of items allowed in the - queue of items to be written to disk. - </td> - <td>N</td> - <td>5000</td> - </tr> - + <tr> + <td>MaxPurgatorySize</td> + <td>The maximum number of items allowed in the queue of items to + be written to disk.</td> + <td>N</td> + <td>5000</td> + </tr> + <tr> + <td>ShutdownSpoolTimeLimit</td> + <td>Sets the amount of time we will wait for elements to move to + disk during shutdown for a particular region.</td> + <td>N</td> + <td>PT1m</td> + </tr> + <tr> + <td>allowRemoveAll</td> + <td>If this is false, we will not execute remove all.</td> + <td>N</td> + <td>true</td> + </tr> + <tr> + <td>connectionPoolName</td> + <td> + If a pool name is supplied, the factory will attempt to use it. + It should be configured in a separate section as follows. + 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> + </td> + <td>N</td> + <td></td> + </tr> <tr> <td>url</td> <td> @@ -60,7 +88,6 @@ <td>N</td> <td></td> </tr> - <tr> <td>driverClassName</td> <td> @@ -70,21 +97,18 @@ <td>N</td> <td></td> </tr> - <tr> <td>userName</td> <td>The database user name.</td> <td>N</td> <td></td> </tr> - <tr> <td>password</td> <td>The database user password.</td> <td>N</td> <td></td> </tr> - <tr> <td>jndiPath</td> <td> @@ -95,21 +119,18 @@ <td>N</td> <td></td> </tr> - <tr> <td>jndiTTL</td> <td>The time between two JNDI lookups in ms.</td> <td>N</td> <td>0</td> </tr> - <tr> <td>tableName</td> <td>The name of the table.</td> <td>N</td> <td>JCS_STORE</td> </tr> - <tr> <td>testBeforeInsert</td> <td> @@ -121,9 +142,8 @@ <td>N</td> <td>true</td> </tr> - <tr> - <td>maxActive</td> + <td>maxTotal</td> <td> This sets the maximum number of connections allowed. @@ -131,19 +151,6 @@ <td>Y</td> <td></td> </tr> - - <tr> - <td>allowRemoveAll</td> - <td> - Should the disk cache honor remove all (i.e. - clear) requests. You might set this to false - to prevent someone from accidentally - clearing out an entire database. - </td> - <td>N</td> - <td>true</td> - </tr> - <tr> <td>UseDiskShrinker</td> <td> @@ -153,14 +160,12 @@ <td>N</td> <td>true</td> </tr> - <tr> <td>ShrinkerInterval</td> <td>Interval between disk shrinker runs.</td> <td>N</td> <td>PT5M</td> </tr> - </table> </subsection>
