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 2026/03/19 09:13:45 UTC
(commons-jcs) 01/11: Fix documentation and case-sensitive naming of configuration properties
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 8d0bcdf0a9b5969c49e276a43e848ae881bc8681
Author: Thomas Vandahl <tv...@apache.org>
AuthorDate: Tue Mar 17 18:05:25 2026 +0100
Fix documentation and case-sensitive naming of configuration properties
---
.../apache/commons/jcs4/admin/JCSAdminBean.java | 6 +-
.../jcs4/auxiliary/disk/jdbc/JDBCDiskCache.java | 8 +-
.../jcs4/engine/CompositeCacheAttributes.java | 63 ++++-----
.../commons/jcs4/engine/ElementAttributes.java | 40 +++---
.../engine/behavior/ICompositeCacheAttributes.java | 40 ++----
.../jcs4/engine/behavior/IElementAttributes.java | 16 +--
.../jcs4/engine/control/CompositeCache.java | 33 +++--
.../AbstractDoubleLinkedListMemoryCache.java | 4 +-
.../jcs4/engine/memory/AbstractMemoryCache.java | 2 +-
.../jcs4/engine/memory/lru/LHMLRUMemoryCache.java | 6 +-
.../engine/memory/shrinking/ShrinkerThread.java | 6 +-
.../memory/soft/SoftReferenceMemoryCache.java | 4 +-
.../commons/jcs4/access/CacheAccessUnitTest.java | 10 +-
.../jcs4/access/SystemPropertyUnitTest.java | 4 +-
.../remote/RemoteCacheListenerUnitTest.java | 4 +-
.../jcs4/engine/SystemPropertyUsageUnitTest.java | 4 +-
.../jcs4/engine/TestCompositeCacheAttributes.java | 74 +++++------
.../commons/jcs4/engine/TestElementAttributes.java | 14 +-
.../CompositeCacheConfiguratorUnitTest.java | 2 +-
.../control/CompositeCacheDiskUsageUnitTest.java | 20 +--
.../control/event/SimpleEventHandlingUnitTest.java | 4 +-
.../memory/lru/LHMLRUMemoryCacheUnitTest.java | 16 +--
.../engine/memory/mru/MRUMemoryCacheUnitTest.java | 16 +--
.../memory/shrinking/ShrinkerThreadUnitTest.java | 8 +-
.../soft/SoftReferenceMemoryCacheUnitTest.java | 12 +-
.../SerializationConversionUtilUnitTest.java | 8 +-
.../org/apache/commons/jcs4/jcache/JCSCache.java | 24 ++--
src/site/xdoc/ElementAttributes.xml | 146 +++++++++++++--------
src/site/xdoc/RegionProperties.xml | 19 +++
29 files changed, 311 insertions(+), 302 deletions(-)
diff --git a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/admin/JCSAdminBean.java b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/admin/JCSAdminBean.java
index 38a00d20..e32a5a60 100644
--- a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/admin/JCSAdminBean.java
+++ b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/admin/JCSAdminBean.java
@@ -144,10 +144,10 @@ public class JCSAdminBean implements JCSJMXBean
final CacheElementInfo elementInfo = new CacheElementInfo(
key.getKey(),
- attributes.isEternal(),
+ attributes.IsEternal(),
format.format(new Date(attributes.createTime())),
- attributes.maxLife(),
- (now - attributes.createTime() - attributes.maxLife() * 1000 ) / -1000);
+ attributes.MaxLife(),
+ (now - attributes.createTime() - attributes.MaxLife() * 1000 ) / -1000);
records.add( elementInfo );
}
diff --git a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDiskCache.java b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDiskCache.java
index 3a0d9708..731b6aa5 100644
--- a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDiskCache.java
+++ b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDiskCache.java
@@ -427,8 +427,8 @@ public class JDBCDiskCache<K, V>
psInsert.setString( 1, ce.key().toString() );
psInsert.setString( 2, getCacheName() );
psInsert.setBytes( 3, element );
- psInsert.setLong( 4, ce.elementAttributes().maxLife() );
- psInsert.setString( 5, ce.elementAttributes().isEternal() ? "T" : "F" );
+ psInsert.setLong( 4, ce.elementAttributes().MaxLife() );
+ psInsert.setString( 5, ce.elementAttributes().IsEternal() ? "T" : "F" );
final Timestamp createTime = new Timestamp( ce.elementAttributes().createTime() );
psInsert.setTimestamp( 6, createTime );
@@ -436,7 +436,7 @@ public class JDBCDiskCache<K, V>
final long now = System.currentTimeMillis() / 1000;
psInsert.setLong( 7, now );
- final long expireTime = now + ce.elementAttributes().maxLife();
+ final long expireTime = now + ce.elementAttributes().MaxLife();
psInsert.setLong( 8, expireTime );
psInsert.execute();
@@ -483,7 +483,7 @@ public class JDBCDiskCache<K, V>
final long now = System.currentTimeMillis() / 1000;
psUpdate.setLong( 3, now );
- final long expireTime = now + ce.elementAttributes().maxLife();
+ final long expireTime = now + ce.elementAttributes().MaxLife();
psUpdate.setLong( 4, expireTime );
psUpdate.setString( 5, (String) ce.key() );
diff --git a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/CompositeCacheAttributes.java b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/CompositeCacheAttributes.java
index 83348105..6b5484af 100644
--- a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/CompositeCacheAttributes.java
+++ b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/CompositeCacheAttributes.java
@@ -33,34 +33,28 @@ public record CompositeCacheAttributes(
String cacheName,
/** The maximum objects that the memory cache will be allowed to hold. */
- int maxObjects,
-
- /** Allow lateral caches */
- boolean useLateral,
-
- /** Whether we should use a disk cache if it is configured. */
- boolean useDisk,
+ int MaxObjects,
/** Whether or not we should run the memory shrinker thread. */
- boolean useMemoryShrinker,
+ boolean UseMemoryShrinker,
/** ShrinkerIntervalSeconds */
- long shrinkerIntervalSeconds,
+ long ShrinkerIntervalSeconds,
/** The maximum number the shrinker will spool to disk per run. */
- int maxSpoolPerRun,
+ int MaxSpoolPerRun,
/** MaxMemoryIdleTimeSeconds */
- long maxMemoryIdleTimeSeconds,
+ long MaxMemoryIdleTimeSeconds,
/** The name of the memory cache implementation class. */
- String memoryCacheName,
+ String MemoryCacheName,
- /** Set via DISK_USAGE_PATTERN_NAME */
- DiskUsagePattern diskUsagePattern,
+ /** Set via DISK_USAGE_PATTERN */
+ DiskUsagePatternEnum DiskUsagePattern,
/** How many to spool to disk at a time. */
- int spoolChunkSize
+ int SpoolChunkSize
) implements ICompositeCacheAttributes
{
/** Don't change */
@@ -69,12 +63,6 @@ public record CompositeCacheAttributes(
/** Default max objects value */
private static final int DEFAULT_MAX_OBJECTS = 100;
- /** Default lateral switch */
- private static final boolean DEFAULT_USE_LATERAL = true;
-
- /** Default disk switch */
- private static final boolean DEFAULT_USE_DISK = true;
-
/** Default shrinker setting */
private static final boolean DEFAULT_USE_SHRINKER = false;
@@ -97,14 +85,12 @@ public record CompositeCacheAttributes(
private static final CompositeCacheAttributes DEFAULT = new CompositeCacheAttributes(
null,
DEFAULT_MAX_OBJECTS,
- DEFAULT_USE_LATERAL,
- DEFAULT_USE_DISK,
DEFAULT_USE_SHRINKER,
DEFAULT_SHRINKER_INTERVAL_SECONDS,
DEFAULT_MAX_SPOOL_PER_RUN,
DEFAULT_MAX_MEMORY_IDLE_TIME_SECONDS,
DEFAULT_MEMORY_CACHE_NAME,
- DiskUsagePattern.SWAP,
+ DiskUsagePatternEnum.SWAP,
DEFAULT_CHUNK_SIZE
);
@@ -125,16 +111,14 @@ public record CompositeCacheAttributes(
public CompositeCacheAttributes withCacheName(String s)
{
return new CompositeCacheAttributes(s,
- maxObjects(),
- useLateral(),
- useDisk(),
- useMemoryShrinker(),
- shrinkerIntervalSeconds(),
- maxSpoolPerRun(),
- maxMemoryIdleTimeSeconds(),
- memoryCacheName(),
- diskUsagePattern(),
- spoolChunkSize());
+ MaxObjects(),
+ UseMemoryShrinker(),
+ ShrinkerIntervalSeconds(),
+ MaxSpoolPerRun(),
+ MaxMemoryIdleTimeSeconds(),
+ MemoryCacheName(),
+ DiskUsagePattern(),
+ SpoolChunkSize());
}
/**
@@ -147,13 +131,10 @@ public record CompositeCacheAttributes(
{
final StringBuilder dump = new StringBuilder();
- dump.append( "[ " );
- dump.append( "useLateral = " ).append( useLateral );
- dump.append( ", useDisk = " ).append( useDisk );
- dump.append( ", maxObjects = " ).append( maxObjects );
- dump.append( ", maxSpoolPerRun = " ).append( maxSpoolPerRun );
- dump.append( ", diskUsagePattern = " ).append( diskUsagePattern );
- dump.append( ", spoolChunkSize = " ).append( spoolChunkSize );
+ dump.append( "[ MaxObjects = " ).append( MaxObjects() );
+ dump.append( ", MaxSpoolPerRun = " ).append( MaxSpoolPerRun() );
+ dump.append( ", DiskUsagePattern = " ).append( DiskUsagePattern() );
+ dump.append( ", SpoolChunkSize = " ).append( SpoolChunkSize() );
dump.append( " ]" );
return dump.toString();
diff --git a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/ElementAttributes.java b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/ElementAttributes.java
index ecb05138..d593dc3e 100644
--- a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/ElementAttributes.java
+++ b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/ElementAttributes.java
@@ -39,28 +39,28 @@ import org.apache.commons.jcs4.engine.control.event.behavior.IElementEventHandle
*/
public record ElementAttributes(
/** Can this item be flushed to disk */
- boolean isSpool,
+ boolean IsSpool,
/** Is this item laterally distributable */
- boolean isLateral,
+ boolean IsLateral,
/** Can this item be sent to the remote cache */
- boolean isRemote,
+ boolean IsRemote,
/**
* You can turn off expiration by setting this to true. This causes the cache to bypass both max
* life and idle time expiration.
*/
- boolean isEternal,
+ boolean IsEternal,
- /** Max life seconds */
- long maxLife,
+ /** Max life */
+ long MaxLife,
/**
* The maximum time an entry can be idle. Setting this to -1 causes the idle time check to be
* ignored.
*/
- long maxIdleTime,
+ long MaxIdleTime,
/** The creation time. This is used to enforce the max life. */
long createTime,
@@ -134,12 +134,12 @@ public record ElementAttributes(
*/
public ElementAttributes(IElementAttributes from)
{
- this(from.isSpool(),
- from.isLateral(),
- from.isRemote(),
- from.isEternal(),
- from.maxLife(),
- from.maxIdleTime(),
+ this(from.IsSpool(),
+ from.IsLateral(),
+ from.IsRemote(),
+ from.IsEternal(),
+ from.MaxLife(),
+ from.MaxIdleTime(),
System.currentTimeMillis(),
new AtomicLong(from.lastAccessTime()),
from.timeFactorForMilliseconds(),
@@ -210,7 +210,7 @@ public record ElementAttributes(
private long getTimeToLiveSeconds()
{
final long now = System.currentTimeMillis();
- return ( createTime() + maxLife() * timeFactorForMilliseconds() - now ) / 1000;
+ return ( createTime() + MaxLife() * timeFactorForMilliseconds() - now ) / 1000;
}
/**
@@ -223,12 +223,12 @@ public record ElementAttributes(
{
final StringBuilder dump = new StringBuilder();
- dump.append( "[ isLateral = " ).append( isLateral() );
- dump.append( ", isSpool = " ).append( isSpool() );
- dump.append( ", isRemote = " ).append( isRemote() );
- dump.append( ", isEternal = " ).append( isEternal() );
- dump.append( ", MaxLifeSeconds = " ).append( maxLife() );
- dump.append( ", MaxIdleTime = " ).append( maxIdleTime() );
+ dump.append( "[ isLateral = " ).append( IsLateral() );
+ dump.append( ", isSpool = " ).append( IsSpool() );
+ dump.append( ", isRemote = " ).append( IsRemote() );
+ dump.append( ", isEternal = " ).append( IsEternal() );
+ dump.append( ", MaxLifeSeconds = " ).append( MaxLife() );
+ dump.append( ", MaxIdleTime = " ).append( MaxIdleTime() );
dump.append( ", CreateTime = " ).append( createTime() );
dump.append( ", LastAccessTime = " ).append( lastAccessTime() );
dump.append( ", getTimeToLiveSeconds() = " ).append(getTimeToLiveSeconds());
diff --git a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICompositeCacheAttributes.java b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICompositeCacheAttributes.java
index ea955d4e..e7727720 100644
--- a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICompositeCacheAttributes.java
+++ b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICompositeCacheAttributes.java
@@ -27,7 +27,7 @@ import java.io.Serializable;
public interface ICompositeCacheAttributes
extends Serializable
{
- enum DiskUsagePattern
+ enum DiskUsagePatternEnum
{
/** Items will only go to disk when the memory limit is reached. This is the default. */
SWAP,
@@ -47,9 +47,9 @@ public interface ICompositeCacheAttributes
String cacheName();
/**
- * @return the diskUsagePattern.
+ * @return the DiskUsagePattern.
*/
- DiskUsagePattern diskUsagePattern();
+ DiskUsagePatternEnum DiskUsagePattern();
/**
* If UseMemoryShrinker is true the memory cache should auto-expire elements
@@ -57,30 +57,30 @@ public interface ICompositeCacheAttributes
*
* @return The MaxMemoryIdleTimeSeconds value
*/
- long maxMemoryIdleTimeSeconds();
+ long MaxMemoryIdleTimeSeconds();
/**
* Gets the maxObjects attribute of the ICompositeCacheAttributes object
*
- * @return The maxObjects value
+ * @return The MaxObjects value
*/
- int maxObjects();
+ int MaxObjects();
/**
* If UseMemoryShrinker is true the memory cache should auto-expire elements
* to reclaim space. This gets the maximum number of items to spool per run.
*
- * @return The maxSpoolPerRun value
+ * @return The MaxSpoolPerRun value
*/
- int maxSpoolPerRun();
+ int MaxSpoolPerRun();
/**
* Gets the memoryCacheName attribute of the ICompositeCacheAttributes
* object
*
- * @return The memoryCacheName value
+ * @return The MemoryCacheName value
*/
- String memoryCacheName();
+ String MemoryCacheName();
/**
* If UseMemoryShrinker is true the memory cache should auto-expire elements
@@ -88,35 +88,21 @@ public interface ICompositeCacheAttributes
*
* @return The ShrinkerIntervalSeconds value
*/
- long shrinkerIntervalSeconds();
+ long ShrinkerIntervalSeconds();
/**
* Number to send to disk at time when memory is full.
*
* @return int
*/
- int spoolChunkSize();
-
- /**
- * Gets the useDisk attribute of the ICompositeCacheAttributes object
- *
- * @return The useDisk value
- */
- boolean useDisk();
-
- /**
- * Gets the useLateral attribute of the ICompositeCacheAttributes object
- *
- * @return The useLateral value
- */
- boolean useLateral();
+ int SpoolChunkSize();
/**
* Tests whether the memory cache should perform background memory shrinkage.
*
* @return The UseMemoryShrinker value
*/
- boolean useMemoryShrinker();
+ boolean UseMemoryShrinker();
/**
* Sets the name of the cache, referenced by the appropriate manager.
diff --git a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/IElementAttributes.java b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/IElementAttributes.java
index 5e5af150..317ea27d 100644
--- a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/IElementAttributes.java
+++ b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/IElementAttributes.java
@@ -62,13 +62,13 @@ public interface IElementAttributes extends Serializable
* Gets the idleTime attribute of the IAttributes object
* @return The idleTime value
*/
- long maxIdleTime();
+ long MaxIdleTime();
/**
* This turns off expiration if it is true.
* @return The IsEternal value
*/
- boolean isEternal();
+ boolean IsEternal();
/**
* Is this item laterally distributable. Can it be sent to auxiliaries of type lateral.
@@ -76,7 +76,7 @@ public interface IElementAttributes extends Serializable
* By default this is true.
* @return The isLateral value
*/
- boolean isLateral();
+ boolean IsLateral();
/**
* Can this item be sent to the remote cache.
@@ -84,7 +84,7 @@ public interface IElementAttributes extends Serializable
* By default this is true.
* @return The isRemote value
*/
- boolean isRemote();
+ boolean IsRemote();
/**
* Can this item be spooled to disk
@@ -92,7 +92,7 @@ public interface IElementAttributes extends Serializable
* By default this is true.
* @return The spoolable value
*/
- boolean isSpool();
+ boolean IsSpool();
/**
* Gets the LastAccess attribute of the IAttributes object.
@@ -102,14 +102,14 @@ public interface IElementAttributes extends Serializable
long lastAccessTime();
/**
- * Sets the maxLife attribute of the IAttributes object. How many seconds it can live after
+ * Sets the MaxLife attribute of the IAttributes object. How many seconds it can live after
* creation.
* <p>
* If this is exceeded the element will not be returned, instead it will be removed. It will be
* removed on retrieval, or removed actively if the memory shrinker is turned on.
- * @return The MaxLifeSeconds value
+ * @return The MaxLife value
*/
- long maxLife();
+ long MaxLife();
/**
* Get the time factor to convert durations to milliseconds
diff --git a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/control/CompositeCache.java b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/control/CompositeCache.java
index 69062179..7ce1642d 100644
--- a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/control/CompositeCache.java
+++ b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/control/CompositeCache.java
@@ -44,7 +44,7 @@ import org.apache.commons.jcs4.engine.CacheStatus;
import org.apache.commons.jcs4.engine.behavior.ICache;
import org.apache.commons.jcs4.engine.behavior.ICacheElement;
import org.apache.commons.jcs4.engine.behavior.ICompositeCacheAttributes;
-import org.apache.commons.jcs4.engine.behavior.ICompositeCacheAttributes.DiskUsagePattern;
+import org.apache.commons.jcs4.engine.behavior.ICompositeCacheAttributes.DiskUsagePatternEnum;
import org.apache.commons.jcs4.engine.behavior.IElementAttributes;
import org.apache.commons.jcs4.engine.behavior.IRequireScheduler;
import org.apache.commons.jcs4.engine.control.event.ElementEvent;
@@ -158,7 +158,7 @@ public class CompositeCache<K, V>
private void copyAuxiliaryRetrievedItemToMemory(final ICacheElement<K, V> element)
throws IOException
{
- if (memCache.getCacheAttributes().maxObjects() > 0)
+ if (memCache.getCacheAttributes().MaxObjects() > 0)
{
memCache.update(element);
}
@@ -181,7 +181,7 @@ public class CompositeCache<K, V>
{
try
{
- final Class<?> c = Class.forName(cattr.memoryCacheName());
+ final Class<?> c = Class.forName(cattr.MemoryCacheName());
@SuppressWarnings("unchecked") // Need cast
final
IMemoryCache<K, V> newInstance =
@@ -994,10 +994,10 @@ public class CompositeCache<K, V>
{
final IElementAttributes attributes = element.elementAttributes();
- if (!attributes.isEternal())
+ if (!attributes.IsEternal())
{
// Remove if maxLifeSeconds exceeded
- final long maxLifeSeconds = attributes.maxLife();
+ final long maxLifeSeconds = attributes.MaxLife();
final long createTime = attributes.createTime();
final long timeFactorForMilliseconds = attributes.timeFactorForMilliseconds();
@@ -1008,7 +1008,7 @@ public class CompositeCache<K, V>
handleElementEvent(element, eventMaxlife);
return true;
}
- final long idleTime = attributes.maxIdleTime();
+ final long idleTime = attributes.MaxIdleTime();
final long lastAccessTime = attributes.lastAccessTime();
// Remove if maxIdleTime exceeded
@@ -1410,10 +1410,10 @@ public class CompositeCache<K, V>
@Override
public void setScheduledExecutorService(final ScheduledExecutorService scheduledExecutor)
{
- if (cacheAttr.useMemoryShrinker())
+ if (cacheAttr.UseMemoryShrinker())
{
future = scheduledExecutor.scheduleAtFixedRate(
- new ShrinkerThread<>(this), 0, cacheAttr.shrinkerIntervalSeconds(),
+ new ShrinkerThread<>(this), 0, cacheAttr.ShrinkerIntervalSeconds(),
TimeUnit.SECONDS);
}
@@ -1435,7 +1435,7 @@ public class CompositeCache<K, V>
public void spoolToDisk(final ICacheElement<K, V> ce)
{
// if the item is not spoolable, return
- if (!ce.elementAttributes().isSpool())
+ if (!ce.elementAttributes().IsSpool())
{
// there is an event defined for this.
handleElementEvent(ce, ElementEventType.SPOOLED_NOT_ALLOWED);
@@ -1451,7 +1451,7 @@ public class CompositeCache<K, V>
{
diskAvailable = true;
- if (cacheAttr.diskUsagePattern() == DiskUsagePattern.SWAP)
+ if (cacheAttr.DiskUsagePattern() == DiskUsagePatternEnum.SWAP)
{
// write the last items to disk.2
try
@@ -1586,9 +1586,9 @@ public class CompositeCache<K, V>
// SEND TO REMOTE STORE
case REMOTE_CACHE:
log.debug("ce.getElementAttributes().getIsRemote() = {0}",
- cacheElement.elementAttributes()::isRemote);
+ cacheElement.elementAttributes()::IsRemote);
- if (cacheElement.elementAttributes().isRemote() && !localOnly)
+ if (cacheElement.elementAttributes().IsRemote() && !localOnly)
{
try
{
@@ -1609,8 +1609,7 @@ public class CompositeCache<K, V>
case LATERAL_CACHE:
// lateral can't do the checking since it is dependent on the
// cache region restrictions
- log.debug("lateralcache in aux list: cattr {0}", cacheAttr::useLateral);
- if (cacheAttr.useLateral() && cacheElement.elementAttributes().isLateral() && !localOnly)
+ if (cacheElement.elementAttributes().IsLateral() && !localOnly)
{
// DISTRIBUTE LATERALLY
// Currently always multicast even if the value is
@@ -1622,10 +1621,8 @@ public class CompositeCache<K, V>
// update disk if the usage pattern permits
case DISK_CACHE:
- log.debug("diskcache in aux list: cattr {0}", cacheAttr::useDisk);
- if (cacheAttr.useDisk()
- && cacheAttr.diskUsagePattern() == DiskUsagePattern.UPDATE
- && cacheElement.elementAttributes().isSpool())
+ if (cacheAttr.DiskUsagePattern() == DiskUsagePatternEnum.UPDATE
+ && cacheElement.elementAttributes().IsSpool())
{
aux.update(cacheElement);
log.debug("updated disk cache for {0}", cacheElement::key);
diff --git a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/AbstractDoubleLinkedListMemoryCache.java b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/AbstractDoubleLinkedListMemoryCache.java
index 6d669ea3..dba36124 100644
--- a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/AbstractDoubleLinkedListMemoryCache.java
+++ b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/AbstractDoubleLinkedListMemoryCache.java
@@ -274,7 +274,7 @@ public abstract class AbstractDoubleLinkedListMemoryCache<K, V> extends Abstract
final int size = map.size();
// If the element limit is reached, we need to spool
- if (size <= getCacheAttributes().maxObjects())
+ if (size <= getCacheAttributes().MaxObjects())
{
return;
}
@@ -286,7 +286,7 @@ public abstract class AbstractDoubleLinkedListMemoryCache<K, V> extends Abstract
log.debug("About to spool to disk cache, map size: {0}, max objects: {1}, "
+ "maximum items to spool: {2}", () -> size,
- getCacheAttributes()::maxObjects,
+ getCacheAttributes()::MaxObjects,
() -> chunkSizeCorrected);
// The spool will put them in a disk event queue, so there is no
diff --git a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/AbstractMemoryCache.java b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/AbstractMemoryCache.java
index 1639d939..708a4212 100644
--- a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/AbstractMemoryCache.java
+++ b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/AbstractMemoryCache.java
@@ -310,7 +310,7 @@ public abstract class AbstractMemoryCache<K, V>
putCnt = new AtomicLong();
this.cacheAttributes = hub.getCacheAttributes();
- this.chunkSize = cacheAttributes.spoolChunkSize();
+ this.chunkSize = cacheAttributes.SpoolChunkSize();
this.cache = hub;
this.map = createMap();
diff --git a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/lru/LHMLRUMemoryCache.java b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/lru/LHMLRUMemoryCache.java
index fcd3eecb..4d90c189 100644
--- a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/lru/LHMLRUMemoryCache.java
+++ b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/lru/LHMLRUMemoryCache.java
@@ -51,7 +51,7 @@ public class LHMLRUMemoryCache<K, V>
*/
public LHMSpooler()
{
- super( (int) ( getCacheAttributes().maxObjects() * .5 ), .75F, true );
+ super( (int) ( getCacheAttributes().MaxObjects() * .5 ), .75F, true );
}
/**
@@ -66,12 +66,12 @@ public class LHMLRUMemoryCache<K, V>
{
final ICacheElement<K, V> element = eldest.getValue().getCacheElement();
- if ( size() <= getCacheAttributes().maxObjects() )
+ if ( size() <= getCacheAttributes().MaxObjects() )
{
return false;
}
log.debug( "LHMLRU max size: {0}. Spooling element, key: {1}",
- () -> getCacheAttributes().maxObjects(), element::key);
+ () -> getCacheAttributes().MaxObjects(), element::key);
waterfall( element );
diff --git a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/shrinking/ShrinkerThread.java b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/shrinking/ShrinkerThread.java
index dc2a3d34..d946f406 100644
--- a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/shrinking/ShrinkerThread.java
+++ b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/shrinking/ShrinkerThread.java
@@ -59,7 +59,7 @@ public class ShrinkerThread<K, V>
{
this.cache = cache;
- final long maxMemoryIdleTimeSeconds = cache.getCacheAttributes().maxMemoryIdleTimeSeconds();
+ final long maxMemoryIdleTimeSeconds = cache.getCacheAttributes().MaxMemoryIdleTimeSeconds();
if ( maxMemoryIdleTimeSeconds < 0 )
{
@@ -70,7 +70,7 @@ public class ShrinkerThread<K, V>
this.maxMemoryIdleTime = maxMemoryIdleTimeSeconds * 1000;
}
- this.maxSpoolPerRun = cache.getCacheAttributes().maxSpoolPerRun();
+ this.maxSpoolPerRun = cache.getCacheAttributes().MaxSpoolPerRun();
if ( this.maxSpoolPerRun != -1 )
{
this.spoolLimit = true;
@@ -133,7 +133,7 @@ public class ShrinkerThread<K, V>
// If the element is not eternal, check if it should be
// removed and remove it if so.
- if ( !attributes.isEternal() )
+ if ( !attributes.IsEternal() )
{
remove = cache.isExpired( cacheElement, now,
ElementEventType.EXCEEDED_MAXLIFE_BACKGROUND,
diff --git a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/soft/SoftReferenceMemoryCache.java b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/soft/SoftReferenceMemoryCache.java
index 0fb13e23..3a97004b 100644
--- a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/soft/SoftReferenceMemoryCache.java
+++ b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/soft/SoftReferenceMemoryCache.java
@@ -39,7 +39,7 @@ import org.apache.commons.jcs4.log.Log;
/**
* A JCS IMemoryCache that has {@link SoftReference} to all its values.
- * This cache does not respect {@link ICompositeCacheAttributes#maxObjects()}
+ * This cache does not respect {@link ICompositeCacheAttributes#MaxObjects()}
* as overflowing is handled by Java GC.
* <p>
* The cache also has strong references to a maximum number of objects given by
@@ -196,7 +196,7 @@ public class SoftReferenceMemoryCache<K, V> extends AbstractMemoryCache<K, V>
*/
private void trimStrongReferences()
{
- final int max = getCacheAttributes().maxObjects();
+ final int max = getCacheAttributes().MaxObjects();
final int startsize = strongReferences.size();
for (int cursize = startsize; cursize > max; cursize--)
diff --git a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/access/CacheAccessUnitTest.java b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/access/CacheAccessUnitTest.java
index 216a486f..85b3abb4 100644
--- a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/access/CacheAccessUnitTest.java
+++ b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/access/CacheAccessUnitTest.java
@@ -314,7 +314,7 @@ class CacheAccessUnitTest
assertNotNull( access, "We should have an access class" );
final ICompositeCacheAttributes ca2 = access.getCacheAttributes();
- assertEquals( ca.maxMemoryIdleTimeSeconds(), ca2.maxMemoryIdleTimeSeconds(), "Wrong idle time setting." );
+ assertEquals( ca.MaxMemoryIdleTimeSeconds(), ca2.MaxMemoryIdleTimeSeconds(), "Wrong idle time setting." );
}
/**
@@ -337,7 +337,7 @@ class CacheAccessUnitTest
assertNotNull( access, "We should have an access class" );
final ICompositeCacheAttributes ca2 = access.getCacheAttributes();
- assertEquals( ca.maxMemoryIdleTimeSeconds(), ca2.maxMemoryIdleTimeSeconds(), "Wrong idle time setting." );
+ assertEquals( ca.MaxMemoryIdleTimeSeconds(), ca2.MaxMemoryIdleTimeSeconds(), "Wrong idle time setting." );
}
/**
@@ -356,8 +356,8 @@ class CacheAccessUnitTest
access.setDefaultElementAttributes( attr );
- assertEquals( attr.maxLife(), access.getDefaultElementAttributes()
- .maxLife(), "Wrong element attributes." );
+ assertEquals( attr.MaxLife(), access.getDefaultElementAttributes()
+ .MaxLife(), "Wrong element attributes." );
final String key = "mykey";
final String value = "myvalue";
@@ -367,6 +367,6 @@ class CacheAccessUnitTest
final ICacheElement<String, String> element = access.getCacheElement( key );
assertEquals( maxLife, element.elementAttributes()
- .maxLife(), "Wrong max life. Should have the new value." );
+ .MaxLife(), "Wrong max life. Should have the new value." );
}
}
diff --git a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/access/SystemPropertyUnitTest.java b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/access/SystemPropertyUnitTest.java
index c2c4aa28..7d5cbe1c 100644
--- a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/access/SystemPropertyUnitTest.java
+++ b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/access/SystemPropertyUnitTest.java
@@ -71,7 +71,7 @@ class SystemPropertyUnitTest
System.setProperty( "MY_SYSTEM_PROPERTY_MAX_SIZE", String.valueOf( maxMemory ) );
final CacheAccess<String, String> cache = JCS.getInstance( "test1" );
- assertEquals( maxMemory, cache.getCacheAttributes().maxObjects(),
+ assertEquals( maxMemory, cache.getCacheAttributes().MaxObjects(),
"We should have used the system property for the memory size" );
}
@@ -88,7 +88,7 @@ class SystemPropertyUnitTest
System.setProperty( "MY_SYSTEM_PROPERTY_DISK_DIR", "system_set" );
final CacheAccess<String, String> cache = JCS.getInstance( "missing" );
- assertEquals( 100, cache.getCacheAttributes().maxObjects(),
+ assertEquals( 100, cache.getCacheAttributes().MaxObjects(),
"We should have used the default property for the memory size" );
}
}
diff --git a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/remote/RemoteCacheListenerUnitTest.java b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/remote/RemoteCacheListenerUnitTest.java
index 0820ac35..16c700b9 100644
--- a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/remote/RemoteCacheListenerUnitTest.java
+++ b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/remote/RemoteCacheListenerUnitTest.java
@@ -77,8 +77,8 @@ class RemoteCacheListenerUnitTest
assertNotNull( after, "Should have a deserialized object." );
assertEquals( value, after.value(), "Values should be the same." );
- assertEquals( attr.maxLife(), after
- .elementAttributes().maxLife(), "Attributes should be the same." );
+ assertEquals( attr.MaxLife(), after
+ .elementAttributes().MaxLife(), "Attributes should be the same." );
assertEquals( key, after.key(), "Keys should be the same." );
assertEquals( cacheName, after.cacheName(), "Cache name should be the same." );
}
diff --git a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/SystemPropertyUsageUnitTest.java b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/SystemPropertyUsageUnitTest.java
index f67b1d90..75101129 100644
--- a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/SystemPropertyUsageUnitTest.java
+++ b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/SystemPropertyUsageUnitTest.java
@@ -78,7 +78,7 @@ class SystemPropertyUsageUnitTest
manager = CompositeCacheManager.getInstance();
- assertEquals( testValue, jcs.getCacheAttributes().maxObjects(), "System property value is not reflected." );
+ assertEquals( testValue, jcs.getCacheAttributes().MaxObjects(), "System property value is not reflected." );
}
/**
@@ -101,7 +101,7 @@ class SystemPropertyUsageUnitTest
final CacheAccess<String, String> jcs = JCS.getInstance( "someCacheNotInFile" );
assertEquals( Integer.parseInt( props.getProperty( JCS_DEFAULT_CACHEATTRIBUTES_MAX_OBJECTS ) ),
- jcs.getCacheAttributes().maxObjects(),
+ jcs.getCacheAttributes().MaxObjects(),
"System property value should not be reflected" );
}
}
diff --git a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/TestCompositeCacheAttributes.java b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/TestCompositeCacheAttributes.java
index b40b0b3c..4e3ff276 100644
--- a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/TestCompositeCacheAttributes.java
+++ b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/TestCompositeCacheAttributes.java
@@ -40,15 +40,13 @@ public class TestCompositeCacheAttributes
{
return new CompositeCacheAttributes(CompositeCacheAttributes.defaults().cacheName(),
maxObjects,
- CompositeCacheAttributes.defaults().useLateral(),
- CompositeCacheAttributes.defaults().useDisk(),
- CompositeCacheAttributes.defaults().useMemoryShrinker(),
- CompositeCacheAttributes.defaults().shrinkerIntervalSeconds(),
- CompositeCacheAttributes.defaults().maxSpoolPerRun(),
- CompositeCacheAttributes.defaults().maxMemoryIdleTimeSeconds(),
+ CompositeCacheAttributes.defaults().UseMemoryShrinker(),
+ CompositeCacheAttributes.defaults().ShrinkerIntervalSeconds(),
+ CompositeCacheAttributes.defaults().MaxSpoolPerRun(),
+ CompositeCacheAttributes.defaults().MaxMemoryIdleTimeSeconds(),
memoryCacheName,
- CompositeCacheAttributes.defaults().diskUsagePattern(),
- CompositeCacheAttributes.defaults().spoolChunkSize());
+ CompositeCacheAttributes.defaults().DiskUsagePattern(),
+ CompositeCacheAttributes.defaults().SpoolChunkSize());
}
/**
@@ -62,16 +60,14 @@ public class TestCompositeCacheAttributes
String memoryCacheName, long maxMemoryIdleTimeSeconds, int maxSpoolPerRun)
{
return new CompositeCacheAttributes(CompositeCacheAttributes.defaults().cacheName(),
- CompositeCacheAttributes.defaults().maxObjects(),
- CompositeCacheAttributes.defaults().useLateral(),
- CompositeCacheAttributes.defaults().useDisk(),
- CompositeCacheAttributes.defaults().useMemoryShrinker(),
- CompositeCacheAttributes.defaults().shrinkerIntervalSeconds(),
+ CompositeCacheAttributes.defaults().MaxObjects(),
+ CompositeCacheAttributes.defaults().UseMemoryShrinker(),
+ CompositeCacheAttributes.defaults().ShrinkerIntervalSeconds(),
maxSpoolPerRun,
maxMemoryIdleTimeSeconds,
memoryCacheName,
- CompositeCacheAttributes.defaults().diskUsagePattern(),
- CompositeCacheAttributes.defaults().spoolChunkSize());
+ CompositeCacheAttributes.defaults().DiskUsagePattern(),
+ CompositeCacheAttributes.defaults().SpoolChunkSize());
}
/**
@@ -84,14 +80,12 @@ public class TestCompositeCacheAttributes
{
return new CompositeCacheAttributes(CompositeCacheAttributes.defaults().cacheName(),
maxObjects,
- CompositeCacheAttributes.defaults().useLateral(),
- CompositeCacheAttributes.defaults().useDisk(),
- CompositeCacheAttributes.defaults().useMemoryShrinker(),
- CompositeCacheAttributes.defaults().shrinkerIntervalSeconds(),
- CompositeCacheAttributes.defaults().maxSpoolPerRun(),
- CompositeCacheAttributes.defaults().maxMemoryIdleTimeSeconds(),
- CompositeCacheAttributes.defaults().memoryCacheName(),
- CompositeCacheAttributes.defaults().diskUsagePattern(),
+ CompositeCacheAttributes.defaults().UseMemoryShrinker(),
+ CompositeCacheAttributes.defaults().ShrinkerIntervalSeconds(),
+ CompositeCacheAttributes.defaults().MaxSpoolPerRun(),
+ CompositeCacheAttributes.defaults().MaxMemoryIdleTimeSeconds(),
+ CompositeCacheAttributes.defaults().MemoryCacheName(),
+ CompositeCacheAttributes.defaults().DiskUsagePattern(),
spoolChunkSize);
}
@@ -103,16 +97,14 @@ public class TestCompositeCacheAttributes
public static CompositeCacheAttributes withMaxMemoryIdleTimeSeconds(long maxMemoryIdleTimeSeconds)
{
return new CompositeCacheAttributes(CompositeCacheAttributes.defaults().cacheName(),
- CompositeCacheAttributes.defaults().maxObjects(),
- CompositeCacheAttributes.defaults().useLateral(),
- CompositeCacheAttributes.defaults().useDisk(),
- CompositeCacheAttributes.defaults().useMemoryShrinker(),
- CompositeCacheAttributes.defaults().shrinkerIntervalSeconds(),
- CompositeCacheAttributes.defaults().maxSpoolPerRun(),
+ CompositeCacheAttributes.defaults().MaxObjects(),
+ CompositeCacheAttributes.defaults().UseMemoryShrinker(),
+ CompositeCacheAttributes.defaults().ShrinkerIntervalSeconds(),
+ CompositeCacheAttributes.defaults().MaxSpoolPerRun(),
maxMemoryIdleTimeSeconds,
- CompositeCacheAttributes.defaults().memoryCacheName(),
- CompositeCacheAttributes.defaults().diskUsagePattern(),
- CompositeCacheAttributes.defaults().spoolChunkSize());
+ CompositeCacheAttributes.defaults().MemoryCacheName(),
+ CompositeCacheAttributes.defaults().DiskUsagePattern(),
+ CompositeCacheAttributes.defaults().SpoolChunkSize());
}
/**
@@ -120,18 +112,16 @@ public class TestCompositeCacheAttributes
*
* @param diskUsagePattern the new diskUsagePattern value
*/
- public static CompositeCacheAttributes withDiskUsagePattern(ICompositeCacheAttributes.DiskUsagePattern diskUsagePattern)
+ public static CompositeCacheAttributes withDiskUsagePattern(ICompositeCacheAttributes.DiskUsagePatternEnum diskUsagePattern)
{
return new CompositeCacheAttributes(CompositeCacheAttributes.defaults().cacheName(),
- CompositeCacheAttributes.defaults().maxObjects(),
- CompositeCacheAttributes.defaults().useLateral(),
- CompositeCacheAttributes.defaults().useDisk(),
- CompositeCacheAttributes.defaults().useMemoryShrinker(),
- CompositeCacheAttributes.defaults().shrinkerIntervalSeconds(),
- CompositeCacheAttributes.defaults().maxSpoolPerRun(),
- CompositeCacheAttributes.defaults().maxMemoryIdleTimeSeconds(),
- CompositeCacheAttributes.defaults().memoryCacheName(),
+ CompositeCacheAttributes.defaults().MaxObjects(),
+ CompositeCacheAttributes.defaults().UseMemoryShrinker(),
+ CompositeCacheAttributes.defaults().ShrinkerIntervalSeconds(),
+ CompositeCacheAttributes.defaults().MaxSpoolPerRun(),
+ CompositeCacheAttributes.defaults().MaxMemoryIdleTimeSeconds(),
+ CompositeCacheAttributes.defaults().MemoryCacheName(),
diskUsagePattern,
- CompositeCacheAttributes.defaults().spoolChunkSize());
+ CompositeCacheAttributes.defaults().SpoolChunkSize());
}
}
diff --git a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/TestElementAttributes.java b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/TestElementAttributes.java
index 92007acd..29947fbb 100644
--- a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/TestElementAttributes.java
+++ b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/TestElementAttributes.java
@@ -35,12 +35,12 @@ public class TestElementAttributes
public static ElementAttributes withEternalFalseAndMaxLife(long maxLife)
{
ElementAttributes element = new ElementAttributes(
- ElementAttributes.defaults().isSpool(),
- ElementAttributes.defaults().isLateral(),
- ElementAttributes.defaults().isRemote(),
+ ElementAttributes.defaults().IsSpool(),
+ ElementAttributes.defaults().IsLateral(),
+ ElementAttributes.defaults().IsRemote(),
false,
maxLife,
- ElementAttributes.defaults().maxIdleTime(),
+ ElementAttributes.defaults().MaxIdleTime(),
System.currentTimeMillis(),
new AtomicLong(),
ElementAttributes.defaults().timeFactorForMilliseconds(),
@@ -59,9 +59,9 @@ public class TestElementAttributes
public static ElementAttributes withEternalFalseAndMaxLifeAndMaxIdleTime(long maxLife, long maxIdleTime)
{
ElementAttributes element = new ElementAttributes(
- ElementAttributes.defaults().isSpool(),
- ElementAttributes.defaults().isLateral(),
- ElementAttributes.defaults().isRemote(),
+ ElementAttributes.defaults().IsSpool(),
+ ElementAttributes.defaults().IsLateral(),
+ ElementAttributes.defaults().IsRemote(),
false,
maxLife,
maxIdleTime,
diff --git a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/CompositeCacheConfiguratorUnitTest.java b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/CompositeCacheConfiguratorUnitTest.java
index 0a2e71a9..e24e4050 100644
--- a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/CompositeCacheConfiguratorUnitTest.java
+++ b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/CompositeCacheConfiguratorUnitTest.java
@@ -98,6 +98,6 @@ class CompositeCacheConfiguratorUnitTest
// VERIFY
final CompositeCache<String, String> cache = manager.getCache( regionName );
- assertEquals( cache.getCacheAttributes().spoolChunkSize(), chunkSize, "Wrong chunkSize" );
+ assertEquals( cache.getCacheAttributes().SpoolChunkSize(), chunkSize, "Wrong chunkSize" );
}
}
diff --git a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/CompositeCacheDiskUsageUnitTest.java b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/CompositeCacheDiskUsageUnitTest.java
index b787301d..7c634f57 100644
--- a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/CompositeCacheDiskUsageUnitTest.java
+++ b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/CompositeCacheDiskUsageUnitTest.java
@@ -240,7 +240,7 @@ class CompositeCacheDiskUsageUnitTest
{
// SETUP
final CompositeCacheAttributes cattr = TestCompositeCacheAttributes
- .withDiskUsagePattern(ICompositeCacheAttributes.DiskUsagePattern.SWAP)
+ .withDiskUsagePattern(ICompositeCacheAttributes.DiskUsagePatternEnum.SWAP)
.withCacheName(CACHE_NAME);
final IElementAttributes attr = new ElementAttributes();
@@ -270,7 +270,7 @@ class CompositeCacheDiskUsageUnitTest
{
// SETUP
final CompositeCacheAttributes cattr = TestCompositeCacheAttributes
- .withDiskUsagePattern(ICompositeCacheAttributes.DiskUsagePattern.UPDATE)
+ .withDiskUsagePattern(ICompositeCacheAttributes.DiskUsagePatternEnum.UPDATE)
.withCacheName(CACHE_NAME);
final IElementAttributes attr = new ElementAttributes();
@@ -300,8 +300,8 @@ class CompositeCacheDiskUsageUnitTest
throws CacheException
{
final CacheAccess<String, String> swap = JCS.getInstance( "Swap" );
- assertEquals( ICompositeCacheAttributes.DiskUsagePattern.SWAP,
- swap.getCacheAttributes().diskUsagePattern() );
+ assertEquals( ICompositeCacheAttributes.DiskUsagePatternEnum.SWAP,
+ swap.getCacheAttributes().DiskUsagePattern() );
}
/**
@@ -318,7 +318,7 @@ class CompositeCacheDiskUsageUnitTest
{
// SETUP
final CompositeCacheAttributes cattr = TestCompositeCacheAttributes
- .withDiskUsagePattern(ICompositeCacheAttributes.DiskUsagePattern.UPDATE)
+ .withDiskUsagePattern(ICompositeCacheAttributes.DiskUsagePatternEnum.UPDATE)
.withCacheName(CACHE_NAME);
final IElementAttributes attr = new ElementAttributes();
@@ -354,7 +354,7 @@ class CompositeCacheDiskUsageUnitTest
{
// SETUP
final CompositeCacheAttributes cattr = TestCompositeCacheAttributes
- .withDiskUsagePattern(ICompositeCacheAttributes.DiskUsagePattern.UPDATE)
+ .withDiskUsagePattern(ICompositeCacheAttributes.DiskUsagePatternEnum.UPDATE)
.withCacheName(CACHE_NAME);
final IElementAttributes attr = new ElementAttributes();
@@ -389,7 +389,7 @@ class CompositeCacheDiskUsageUnitTest
{
// SETUP
final CompositeCacheAttributes cattr = TestCompositeCacheAttributes
- .withDiskUsagePattern(ICompositeCacheAttributes.DiskUsagePattern.UPDATE)
+ .withDiskUsagePattern(ICompositeCacheAttributes.DiskUsagePatternEnum.UPDATE)
.withCacheName(CACHE_NAME);
final IElementAttributes attr = new ElementAttributes();
@@ -426,8 +426,8 @@ class CompositeCacheDiskUsageUnitTest
throws CacheException
{
final CacheAccess<String, String> swap = JCS.getInstance( "Update" );
- assertEquals( ICompositeCacheAttributes.DiskUsagePattern.UPDATE,
- swap.getCacheAttributes().diskUsagePattern() );
+ assertEquals( ICompositeCacheAttributes.DiskUsagePatternEnum.UPDATE,
+ swap.getCacheAttributes().DiskUsagePattern() );
}
/**
@@ -445,7 +445,7 @@ class CompositeCacheDiskUsageUnitTest
{
// SETUP
final CompositeCacheAttributes cattr = TestCompositeCacheAttributes
- .withDiskUsagePattern(ICompositeCacheAttributes.DiskUsagePattern.SWAP)
+ .withDiskUsagePattern(ICompositeCacheAttributes.DiskUsagePatternEnum.SWAP)
.withCacheName(CACHE_NAME);
final IElementAttributes attr = new ElementAttributes();
diff --git a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/event/SimpleEventHandlingUnitTest.java b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/event/SimpleEventHandlingUnitTest.java
index 8476d3f3..e70b5497 100644
--- a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/event/SimpleEventHandlingUnitTest.java
+++ b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/event/SimpleEventHandlingUnitTest.java
@@ -204,7 +204,7 @@ class SimpleEventHandlingUnitTest
}
// wait a bit for the items to expire
- Thread.sleep(attributes.maxIdleTime() * 1000 + 100);
+ Thread.sleep(attributes.MaxIdleTime() * 1000 + 100);
for ( int i = 0; i < 200; i++ )
{
@@ -242,7 +242,7 @@ class SimpleEventHandlingUnitTest
}
// wait a bit for the items to expire
- Thread.sleep(attributes.maxLife() * 1000 + 100);
+ Thread.sleep(attributes.MaxLife() * 1000 + 100);
for ( int i = 0; i < 200; i++ )
{
diff --git a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/memory/lru/LHMLRUMemoryCacheUnitTest.java b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/memory/lru/LHMLRUMemoryCacheUnitTest.java
index 74b46a0d..90a98e98 100644
--- a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/memory/lru/LHMLRUMemoryCacheUnitTest.java
+++ b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/memory/lru/LHMLRUMemoryCacheUnitTest.java
@@ -61,7 +61,7 @@ class LHMLRUMemoryCacheUnitTest
{
final CacheAccess<String, String> cache = JCS.getInstance( "testClearThroughHub" );
- final int max = cache.getCacheAttributes().maxObjects();
+ final int max = cache.getCacheAttributes().MaxObjects();
final int items = max * 2;
for ( int i = 0; i < items; i++ )
@@ -96,7 +96,7 @@ class LHMLRUMemoryCacheUnitTest
final LHMLRUMemoryCache<String, String> mru = new LHMLRUMemoryCache<>();
mru.initialize( cache );
- final int max = cache.getCacheAttributes().maxObjects();
+ final int max = cache.getCacheAttributes().MaxObjects();
final int items = max / 2;
for ( int i = 0; i < items; i++ )
@@ -122,7 +122,7 @@ class LHMLRUMemoryCacheUnitTest
{
final CacheAccess<String, String> cache = JCS.getInstance( "testGetStatsThroughHub" );
- final int max = cache.getCacheAttributes().maxObjects();
+ final int max = cache.getCacheAttributes().MaxObjects();
final int items = max * 2;
for ( int i = 0; i < items; i++ )
@@ -149,7 +149,7 @@ class LHMLRUMemoryCacheUnitTest
throws CacheException
{
final CacheAccess<String, String> cache = JCS.getInstance( "testLoadFromCCF" );
- final String memoryCacheName = cache.getCacheAttributes().memoryCacheName();
+ final String memoryCacheName = cache.getCacheAttributes().MemoryCacheName();
assertTrue( memoryCacheName.indexOf( "LHMLRUMemoryCache" ) != -1, "Cache name should have LHMLRU in it." );
}
@@ -164,7 +164,7 @@ class LHMLRUMemoryCacheUnitTest
{
final CacheAccess<String, String> cache = JCS.getInstance( "testPutGetThroughHub" );
- final int max = cache.getCacheAttributes().maxObjects();
+ final int max = cache.getCacheAttributes().MaxObjects();
final int items = max * 2;
for ( int i = 0; i < items; i++ )
@@ -219,7 +219,7 @@ class LHMLRUMemoryCacheUnitTest
{
final CacheAccess<String, String> cache = JCS.getInstance( "testPutGetThroughHubTwice" );
- final int max = cache.getCacheAttributes().maxObjects();
+ final int max = cache.getCacheAttributes().MaxObjects();
final int items = max * 2;
for ( int i = 0; i < items; i++ )
@@ -260,7 +260,7 @@ class LHMLRUMemoryCacheUnitTest
{
final CacheAccess<String, String> cache = JCS.getInstance( "testPutRemoveThroughHub" );
- final int max = cache.getCacheAttributes().maxObjects();
+ final int max = cache.getCacheAttributes().MaxObjects();
final int items = max * 2;
for ( int i = 0; i < items; i++ )
@@ -292,7 +292,7 @@ class LHMLRUMemoryCacheUnitTest
{
final CacheAccess<String, String> cache = JCS.getInstance( "testRemovePartialThroughHub" );
- final int max = cache.getCacheAttributes().maxObjects();
+ final int max = cache.getCacheAttributes().MaxObjects();
final int items = max / 2;
cache.put( "test", "data" );
diff --git a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/memory/mru/MRUMemoryCacheUnitTest.java b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/memory/mru/MRUMemoryCacheUnitTest.java
index 265011c5..c49ee88f 100644
--- a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/memory/mru/MRUMemoryCacheUnitTest.java
+++ b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/memory/mru/MRUMemoryCacheUnitTest.java
@@ -61,7 +61,7 @@ class MRUMemoryCacheUnitTest
{
final CacheAccess<String, String> cache = JCS.getInstance( "testPutGetThroughHub" );
- final int max = cache.getCacheAttributes().maxObjects();
+ final int max = cache.getCacheAttributes().MaxObjects();
final int items = max * 2;
for ( int i = 0; i < items; i++ )
@@ -96,7 +96,7 @@ class MRUMemoryCacheUnitTest
final MRUMemoryCache<String, String> mru = new MRUMemoryCache<>();
mru.initialize( cache );
- final int max = cache.getCacheAttributes().maxObjects();
+ final int max = cache.getCacheAttributes().MaxObjects();
final int items = max / 2;
for ( int i = 0; i < items; i++ )
@@ -122,7 +122,7 @@ class MRUMemoryCacheUnitTest
{
final CacheAccess<String, String> cache = JCS.getInstance( "testGetStatsThroughHub" );
- final int max = cache.getCacheAttributes().maxObjects();
+ final int max = cache.getCacheAttributes().MaxObjects();
final int items = max * 2;
for ( int i = 0; i < items; i++ )
@@ -147,7 +147,7 @@ class MRUMemoryCacheUnitTest
throws CacheException
{
final CacheAccess<String, String> cache = JCS.getInstance( "testPutGet" );
- final String memoryCacheName = cache.getCacheAttributes().memoryCacheName();
+ final String memoryCacheName = cache.getCacheAttributes().MemoryCacheName();
assertTrue( memoryCacheName.indexOf( "MRUMemoryCache" ) != -1, "Cache name should have MRU in it." );
}
@@ -162,7 +162,7 @@ class MRUMemoryCacheUnitTest
{
final CacheAccess<String, String> cache = JCS.getInstance( "testPutGetThroughHub" );
- final int max = cache.getCacheAttributes().maxObjects();
+ final int max = cache.getCacheAttributes().MaxObjects();
final int items = max * 2;
for ( int i = 0; i < items; i++ )
@@ -217,7 +217,7 @@ class MRUMemoryCacheUnitTest
{
final CacheAccess<String, String> cache = JCS.getInstance( "testPutGetThroughHub" );
- final int max = cache.getCacheAttributes().maxObjects();
+ final int max = cache.getCacheAttributes().MaxObjects();
final int items = max * 2;
for ( int i = 0; i < items; i++ )
@@ -258,7 +258,7 @@ class MRUMemoryCacheUnitTest
{
final CacheAccess<String, String> cache = JCS.getInstance( "testPutGetThroughHub" );
- final int max = cache.getCacheAttributes().maxObjects();
+ final int max = cache.getCacheAttributes().MaxObjects();
final int items = max * 2;
for ( int i = 0; i < items; i++ )
@@ -290,7 +290,7 @@ class MRUMemoryCacheUnitTest
{
final CacheAccess<String, String> cache = JCS.getInstance( "testGetStatsThroughHub" );
- final int max = cache.getCacheAttributes().maxObjects();
+ final int max = cache.getCacheAttributes().MaxObjects();
final int items = max / 2;
cache.put( "test", "data" );
diff --git a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/memory/shrinking/ShrinkerThreadUnitTest.java b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/memory/shrinking/ShrinkerThreadUnitTest.java
index cf10cbb6..946bdd04 100644
--- a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/memory/shrinking/ShrinkerThreadUnitTest.java
+++ b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/memory/shrinking/ShrinkerThreadUnitTest.java
@@ -54,7 +54,7 @@ class ShrinkerThreadUnitTest
// SETUP
final CompositeCacheAttributes cacheAttr = TestCompositeCacheAttributes
.withMemoryCacheNameMaxMemoryIdleTimeSecondsAndMaxSpoolPerRun(
- CompositeCacheAttributes.defaults().memoryCacheName(), 10, 10)
+ CompositeCacheAttributes.defaults().MemoryCacheName(), 10, 10)
.withCacheName("testRegion");
final CompositeCache<String, String> cache = new CompositeCache<>(cacheAttr, new ElementAttributes());
@@ -88,7 +88,7 @@ class ShrinkerThreadUnitTest
// SETUP
final CompositeCacheAttributes cacheAttr = TestCompositeCacheAttributes
.withMemoryCacheNameMaxMemoryIdleTimeSecondsAndMaxSpoolPerRun(
- CompositeCacheAttributes.defaults().memoryCacheName(), 10, 10)
+ CompositeCacheAttributes.defaults().MemoryCacheName(), 10, 10)
.withCacheName("testRegion");
final CompositeCache<String, String> cache = new CompositeCache<>(cacheAttr, new ElementAttributes());
@@ -122,7 +122,7 @@ class ShrinkerThreadUnitTest
// SETUP
final CompositeCacheAttributes cacheAttr = TestCompositeCacheAttributes
.withMemoryCacheNameMaxMemoryIdleTimeSecondsAndMaxSpoolPerRun(
- CompositeCacheAttributes.defaults().memoryCacheName(), 10, 10)
+ CompositeCacheAttributes.defaults().MemoryCacheName(), 10, 10)
.withCacheName("testRegion");
final CompositeCache<String, String> cache = new CompositeCache<>(cacheAttr, new ElementAttributes());
@@ -156,7 +156,7 @@ class ShrinkerThreadUnitTest
// SETUP
final CompositeCacheAttributes cacheAttr = TestCompositeCacheAttributes
.withMemoryCacheNameMaxMemoryIdleTimeSecondsAndMaxSpoolPerRun(
- CompositeCacheAttributes.defaults().memoryCacheName(), 10, 10)
+ CompositeCacheAttributes.defaults().MemoryCacheName(), 10, 10)
.withCacheName("testRegion");
final CompositeCache<String, String> cache = new CompositeCache<>(cacheAttr, new ElementAttributes());
diff --git a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/memory/soft/SoftReferenceMemoryCacheUnitTest.java b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/memory/soft/SoftReferenceMemoryCacheUnitTest.java
index f9bfced1..20578d7f 100644
--- a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/memory/soft/SoftReferenceMemoryCacheUnitTest.java
+++ b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/memory/soft/SoftReferenceMemoryCacheUnitTest.java
@@ -72,7 +72,7 @@ class SoftReferenceMemoryCacheUnitTest
{
final CacheAccess<String, String> cache = JCS.getInstance( "testPutGetThroughHub" );
- final int max = cache.getCacheAttributes().maxObjects();
+ final int max = cache.getCacheAttributes().MaxObjects();
final int items = max * 2;
for ( int i = 0; i < items; i++ )
@@ -107,7 +107,7 @@ class SoftReferenceMemoryCacheUnitTest
final SoftReferenceMemoryCache<String, String> srmc = new SoftReferenceMemoryCache<>();
srmc.initialize( cache );
- final int max = cache.getCacheAttributes().maxObjects();
+ final int max = cache.getCacheAttributes().MaxObjects();
final int items = max / 2;
for ( int i = 0; i < items; i++ )
@@ -133,7 +133,7 @@ class SoftReferenceMemoryCacheUnitTest
throws CacheException
{
final CacheAccess<String, String> cache = JCS.getInstance( "testPutGet" );
- final String memoryCacheName = cache.getCacheAttributes().memoryCacheName();
+ final String memoryCacheName = cache.getCacheAttributes().MemoryCacheName();
assertTrue( memoryCacheName.indexOf( "SoftReferenceMemoryCache" ) != -1,
"Cache name should have SoftReference in it." );
}
@@ -149,7 +149,7 @@ class SoftReferenceMemoryCacheUnitTest
{
final CacheAccess<String, String> cache = JCS.getInstance( "testPutGetThroughHub" );
- final int max = cache.getCacheAttributes().maxObjects();
+ final int max = cache.getCacheAttributes().MaxObjects();
final int items = max * 2;
for ( int i = 0; i < items; i++ )
@@ -193,7 +193,7 @@ class SoftReferenceMemoryCacheUnitTest
{
final CacheAccess<String, String> cache = JCS.getInstance( "testPutGetThroughHub" );
- final int max = cache.getCacheAttributes().maxObjects();
+ final int max = cache.getCacheAttributes().MaxObjects();
final int items = max * 2;
for ( int i = 0; i < items; i++ )
@@ -225,7 +225,7 @@ class SoftReferenceMemoryCacheUnitTest
{
final CacheAccess<String, String> cache = JCS.getInstance( "testGetStatsThroughHub" );
- final int max = cache.getCacheAttributes().maxObjects();
+ final int max = cache.getCacheAttributes().MaxObjects();
final int items = max / 2;
cache.put( "test", "data" );
diff --git a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/utils/serialization/SerializationConversionUtilUnitTest.java b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/utils/serialization/SerializationConversionUtilUnitTest.java
index 641b7920..9706a59a 100644
--- a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/utils/serialization/SerializationConversionUtilUnitTest.java
+++ b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/utils/serialization/SerializationConversionUtilUnitTest.java
@@ -75,8 +75,8 @@ class SerializationConversionUtilUnitTest
// VERIFY
assertNotNull( after, "Should have a deserialized object." );
assertEquals( before.value(), after.value(), "Values should be the same." );
- assertEquals( before.elementAttributes().maxLife(), after
- .elementAttributes().maxLife(), "Attributes should be the same." );
+ assertEquals( before.elementAttributes().MaxLife(), after
+ .elementAttributes().MaxLife(), "Attributes should be the same." );
assertEquals( before.key(), after.key(), "Keys should be the same." );
assertEquals( before.cacheName(), after.cacheName(), "Cache name should be the same." );
}
@@ -188,8 +188,8 @@ class SerializationConversionUtilUnitTest
// VERIFY
assertNotNull( after, "Should have a deserialized object." );
assertEquals( before.value(), after.value(), "Values should be the same." );
- assertEquals( before.elementAttributes().maxLife(), after
- .elementAttributes().maxLife(), "Attributes should be the same." );
+ assertEquals( before.elementAttributes().MaxLife(), after
+ .elementAttributes().MaxLife(), "Attributes should be the same." );
assertEquals( before.key(), after.key(), "Keys should be the same." );
assertEquals( before.cacheName(), after.cacheName(), "Cache name should be the same." );
}
diff --git a/commons-jcs4-jcache/src/main/java/org/apache/commons/jcs4/jcache/JCSCache.java b/commons-jcs4-jcache/src/main/java/org/apache/commons/jcs4/jcache/JCSCache.java
index 0ff59e10..4fbc36da 100644
--- a/commons-jcs4-jcache/src/main/java/org/apache/commons/jcs4/jcache/JCSCache.java
+++ b/commons-jcs4-jcache/src/main/java/org/apache/commons/jcs4/jcache/JCSCache.java
@@ -323,7 +323,7 @@ public class JCSCache<K, V> implements Cache<K, V>
{
forceExpires(key);
}
- else if (expiryForAccess != null && (!elt.elementAttributes().isEternal() || !expiryForAccess.isEternal()))
+ else if (expiryForAccess != null && (!elt.elementAttributes().IsEternal() || !expiryForAccess.isEternal()))
{
try
{
@@ -701,8 +701,8 @@ public class JCSCache<K, V> implements Cache<K, V>
if (created && duration != null) { // set maxLife
final long timeFactorForMilliseconds = 1;
final boolean eternal = duration.isEternal();
- long maxIdleTime = attributes.maxIdleTime();
- long maxLife = attributes.maxLife();
+ long maxIdleTime = attributes.MaxIdleTime();
+ long maxLife = attributes.MaxLife();
if (!eternal)
{
if (duration == expiryPolicy.getExpiryForAccess())
@@ -715,9 +715,9 @@ public class JCSCache<K, V> implements Cache<K, V>
}
}
attributes = new ElementAttributes(
- attributes.isSpool(),
- attributes.isLateral(),
- attributes.isRemote(),
+ attributes.IsSpool(),
+ attributes.IsLateral(),
+ attributes.IsRemote(),
eternal,
maxLife,
maxIdleTime,
@@ -917,7 +917,7 @@ public class JCSCache<K, V> implements Cache<K, V>
if (value != null)
{
final Duration expiryForAccess = expiryPolicy.getExpiryForAccess();
- if (expiryForAccess != null && (!elt.elementAttributes().isEternal() || !expiryForAccess.isEternal()))
+ if (expiryForAccess != null && (!elt.elementAttributes().IsEternal() || !expiryForAccess.isEternal()))
{
try
{
@@ -973,12 +973,12 @@ public class JCSCache<K, V> implements Cache<K, V>
IElementAttributes newAttributes = (duration != null) ?
// MaxLife = -1 to use IdleTime excepted if jcache.ccf asked for something else
new ElementAttributes(
- attrs.isSpool(),
- attrs.isLateral(),
- attrs.isRemote(),
+ attrs.IsSpool(),
+ attrs.IsLateral(),
+ attrs.IsRemote(),
duration.isEternal(),
- attrs.maxLife(),
- attrs.maxIdleTime(),
+ attrs.MaxLife(),
+ attrs.MaxIdleTime(),
1)
: attrs;
diff --git a/src/site/xdoc/ElementAttributes.xml b/src/site/xdoc/ElementAttributes.xml
index 5b9164c9..fbfb6162 100644
--- a/src/site/xdoc/ElementAttributes.xml
+++ b/src/site/xdoc/ElementAttributes.xml
@@ -72,63 +72,99 @@ jcs.default.elementattributes.MaxIdleTime=1800
settings). In addition, by default all regions will
take these element configuration settings.
</p>
- <p>
- These settings specify that elements are not
- eternal, i.e. they can expire. By default elements
- are considered eternal.
- </p>
- <p>
- You can define the maximum life of an item by
- setting the
- <code>MaxLife</code>
- parameter. If an item has been in the cache for
- longer than the set number of seconds it will not be
- retrieved on a get request. If you use the memory
- shrinker the item will be actively removed from
- memory. Currently there is no background disk
- shrinker, but the disk cache does allow for a
- maximum number of keys (see
- <a href="IndexedDiskAuxCache.html">
- Indexed Disk Cache
- </a>
- for more information on the disk cache settings).
- </p>
- <p>
- 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>MaxMemoryIdleTimeSeconds</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.
- </p>
+ </subsection>
+
+ <subsection name="Properties Reference">
+ <table>
+ <tr>
+ <th>Property</th>
+ <th>Description</th>
+ <th>Required</th>
+ <th>Default Value</th>
+ </tr>
+ <tr>
+ <td>IsEternal</td>
+ <td>
+ This setting specifies that elements are not
+ eternal, i.e. they can expire. By default elements
+ are considered eternal.
+ </td>
+ <td>N</td>
+ <td>true</td>
+ </tr>
+ <tr>
+ <td>MaxLife</td>
+ <td>
+ You can define the maximum life of an item by setting the
+ <code>MaxLife</code>
+ parameter. If an item has been in the cache for
+ longer than the set duration it will not be
+ retrieved on a get request. If you use the memory
+ shrinker the item will be actively removed from
+ memory. Currently there is no background disk
+ shrinker, but the disk cache does allow for a
+ maximum number of keys (see
+ <a href="IndexedDiskAuxCache.html">
+ Indexed Disk Cache
+ </a>
+ for more information on the disk cache settings).
+ </td>
+ <td>N</td>
+ <td>-1 (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>MaxMemoryIdleTimeSeconds</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>-1 (unlimited)</td>
+ </tr>
+ <tr>
+ <td>IsSpool</td>
+ <td>
+ <code>IsSpool</code>
+ determines whether or not the element can go to disk, if
+ a disk cache is configured for the region.
+ </td>
+ <td>N</td>
+ <td>true</td>
+ </tr>
+ <tr>
+ <td>IsRemote</td>
+ <td>
+ <code>IsRemote</code>
+ determines whether or not the element can be sent to a
+ remote server, if one is configured for the region.
+ </td>
+ <td>N</td>
+ <td>true</td>
+ </tr>
+ <tr>
+ <td>IsLateral</td>
+ <td>
+ <code>IsLateral</code>
+ determines whether or not the element can be laterally
+ distributed, if a lateral auxiliary is configured for
+ the region.
+ </td>
+ <td>N</td>
+ <td>true</td>
+ </tr>
+ </table>
</subsection>
- <p>
- <code>IsSpool</code>
- determines whether or not the element can go to disk, if
- a disk cache is configured for the region.
- The default is <code>true</code>.
- </p>
- <p>
- <code>IsRemote</code>
- determines whether or not the element can be sent to a
- remote server, if one is configured for the region.
- The default is <code>true</code>.
- </p>
- <p>
- <code>IsLateral</code>
- determines whether or not the element can be laterally
- distributed, if a lateral auxiliary is configured for
- the region.
- The default is <code>true</code>.
- </p>
-
<subsection name="Programmatic Configuration">
<p>
Every element put into the cache has its own set of
diff --git a/src/site/xdoc/RegionProperties.xml b/src/site/xdoc/RegionProperties.xml
index 1f5a3813..9e479841 100644
--- a/src/site/xdoc/RegionProperties.xml
+++ b/src/site/xdoc/RegionProperties.xml
@@ -142,6 +142,16 @@
<td>N</td>
<td>30</td>
</tr>
+ <tr>
+ <td>MaxSpoolPerRun</td>
+ <td>
+ If UseMemoryShrinker is true the memory cache should
+ auto-expire elements to reclaim space. This gets the
+ maximum number of items to spool per run.
+ </td>
+ <td>N</td>
+ <td>-1 (unlimited)</td>
+ </tr>
<tr>
<td>DiskUsagePattern</td>
<td>
@@ -169,6 +179,15 @@
<td>N</td>
<td>SWAP</td>
</tr>
+ <tr>
+ <td>SpoolChunkSize</td>
+ <td>
+ Number of items to send to disk at time when
+ memory is full.
+ </td>
+ <td>N</td>
+ <td>2</td>
+ </tr>
</table>
</subsection>