org.apache.jcs.engine.behavior
Interface ICompositeCacheAttributes

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
CompositeCacheAttributes

public interface ICompositeCacheAttributes
extends java.io.Serializable

This defines the minimla behavior for the Cache Configuration settings.


Field Summary
static short DISK_USAGE_PATTERN_SWAP
          Items will only go to disk when the memory limit is reached.
static short DISK_USAGE_PATTERN_UPDATE
          Items will go to disk on a normal put.
 
Method Summary
 ICompositeCacheAttributes copy()
          Clones the attributes.
 java.lang.String getCacheName()
          Gets the cacheName attribute of the ICompositeCacheAttributes object
 short getDiskUsagePattern()
           
 long getMaxMemoryIdleTimeSeconds()
          If UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space.
 int getMaxObjects()
          Gets the maxObjects attribute of the ICompositeCacheAttributes object
 int getMaxSpoolPerRun()
          If UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space.
 java.lang.String getMemoryCacheName()
          Gets the memoryCacheName attribute of the ICompositeCacheAttributes object
 long getShrinkerIntervalSeconds()
          If UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space.
 int getSpoolChunkSize()
          Number to send to disk at at time when memory is full.
 boolean getUseDisk()
          Gets the useDisk attribute of the ICompositeCacheAttributes object
 boolean getUseLateral()
          Gets the useLateral attribute of the ICompositeCacheAttributes object
 boolean getUseMemoryShrinker()
          Whether the memory cache should perform background memory shrinkage.
 boolean getUseRemote()
          returns whether the cache is remote enabled
 void setCacheName(java.lang.String s)
          Sets the name of the cache, referenced by the appropriate manager.
 void setDiskUsagePattern(short diskUsagePattern)
          By default this is SWAP_ONLY.
 void setDiskUsagePatternName(java.lang.String diskUsagePatternName)
          Translates the name to the disk usage pattern short value.
 void setMaxMemoryIdleTimeSeconds(long seconds)
          If UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space.
 void setMaxObjects(int size)
          SetMaxObjects is used to set the attribute to determine the maximum number of objects allowed in the memory cache.
 void setMaxSpoolPerRun(int maxSpoolPerRun)
          If UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space.
 void setMemoryCacheName(java.lang.String s)
          Sets the name of the MemoryCache, referenced by the appropriate manager.
 void setShrinkerIntervalSeconds(long seconds)
          If UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space.
 void setSpoolChunkSize(int spoolChunkSize)
          Number to send to disk at a time.
 void setUseDisk(boolean useDisk)
          Sets the useDisk attribute of the ICompositeCacheAttributes object
 void setUseLateral(boolean d)
          set whether the cache should use a lateral cache
 void setUseMemoryShrinker(boolean useShrinker)
          Whether the memory cache should perform background memory shrinkage.
 void setUseRemote(boolean isRemote)
          Sets whether the cache is remote enabled
 

Field Detail

DISK_USAGE_PATTERN_SWAP

static final short DISK_USAGE_PATTERN_SWAP
Items will only go to disk when the memory limit is reached. This is the default.

See Also:
Constant Field Values

DISK_USAGE_PATTERN_UPDATE

static final short DISK_USAGE_PATTERN_UPDATE
Items will go to disk on a normal put. If The disk usage pattern is UPDATE, the swap will be disabled.

See Also:
Constant Field Values
Method Detail

setMaxObjects

void setMaxObjects(int size)
SetMaxObjects is used to set the attribute to determine the maximum number of objects allowed in the memory cache. If the max number of objects or the cache size is set, the default for the one not set is ignored. If both are set, both are used to determine the capacity of the cache, i.e., object will be removed from the cache if either limit is reached. TODO: move to MemoryCache config file.

Parameters:
size - The new maxObjects value

getMaxObjects

int getMaxObjects()
Gets the maxObjects attribute of the ICompositeCacheAttributes object

Returns:
The maxObjects value

setUseDisk

void setUseDisk(boolean useDisk)
Sets the useDisk attribute of the ICompositeCacheAttributes object

Parameters:
useDisk - The new useDisk value

getUseDisk

boolean getUseDisk()
Gets the useDisk attribute of the ICompositeCacheAttributes object

Returns:
The useDisk value

setUseLateral

void setUseLateral(boolean d)
set whether the cache should use a lateral cache

Parameters:
d - The new useLateral value

getUseLateral

boolean getUseLateral()
Gets the useLateral attribute of the ICompositeCacheAttributes object

Returns:
The useLateral value

setUseRemote

void setUseRemote(boolean isRemote)
Sets whether the cache is remote enabled

Parameters:
isRemote - The new useRemote value

getUseRemote

boolean getUseRemote()
returns whether the cache is remote enabled

Returns:
The useRemote value

setCacheName

void setCacheName(java.lang.String s)
Sets the name of the cache, referenced by the appropriate manager.

Parameters:
s - The new cacheName value

getCacheName

java.lang.String getCacheName()
Gets the cacheName attribute of the ICompositeCacheAttributes object

Returns:
The cacheName value

setMemoryCacheName

void setMemoryCacheName(java.lang.String s)
Sets the name of the MemoryCache, referenced by the appropriate manager. TODO: create a separate memory cache attribute class.

Parameters:
s - The new memoryCacheName value

getMemoryCacheName

java.lang.String getMemoryCacheName()
Gets the memoryCacheName attribute of the ICompositeCacheAttributes object

Returns:
The memoryCacheName value

setUseMemoryShrinker

void setUseMemoryShrinker(boolean useShrinker)
Whether the memory cache should perform background memory shrinkage.

Parameters:
useShrinker - The new UseMemoryShrinker value

getUseMemoryShrinker

boolean getUseMemoryShrinker()
Whether the memory cache should perform background memory shrinkage.

Returns:
The UseMemoryShrinker value

setMaxMemoryIdleTimeSeconds

void setMaxMemoryIdleTimeSeconds(long seconds)
If UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space.

Parameters:
seconds - The new MaxMemoryIdleTimeSeconds value

getMaxMemoryIdleTimeSeconds

long getMaxMemoryIdleTimeSeconds()
If UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space.

Returns:
The MaxMemoryIdleTimeSeconds value

setShrinkerIntervalSeconds

void setShrinkerIntervalSeconds(long seconds)
If UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space. This sets the shrinker interval.

Parameters:
seconds - The new ShrinkerIntervalSeconds value

getShrinkerIntervalSeconds

long getShrinkerIntervalSeconds()
If UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space. This gets the shrinker interval.

Returns:
The ShrinkerIntervalSeconds value

setMaxSpoolPerRun

void setMaxSpoolPerRun(int maxSpoolPerRun)
If UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space. This sets the maximum number of items to spool per run.

Parameters:
maxSpoolPerRun - The new maxSpoolPerRun value

getMaxSpoolPerRun

int getMaxSpoolPerRun()
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.

Returns:
The maxSpoolPerRun value

copy

ICompositeCacheAttributes copy()
Clones the attributes.

Returns:
a new object with the same settings.

setDiskUsagePattern

void setDiskUsagePattern(short diskUsagePattern)
By default this is SWAP_ONLY.

Parameters:
diskUsagePattern - The diskUsagePattern to set.

setDiskUsagePatternName

void setDiskUsagePatternName(java.lang.String diskUsagePatternName)
Translates the name to the disk usage pattern short value.

The allowed values are SWAP and UPDATE.

Parameters:
diskUsagePatternName - The diskUsagePattern to set.

getDiskUsagePattern

short getDiskUsagePattern()
Returns:
Returns the diskUsagePattern.

getSpoolChunkSize

int getSpoolChunkSize()
Number to send to disk at at time when memory is full.

Returns:
int

setSpoolChunkSize

void setSpoolChunkSize(int spoolChunkSize)
Number to send to disk at a time.

Parameters:
spoolChunkSize -


Copyright © 2002-2010 Apache Software Foundation. All Rights Reserved.