com.ibm.wsspi.cache
Interface CacheConfig
- public interface CacheConfig
CacheProvider
via the
CacheProvider.createCache(CacheConfig)
method.
Since:
WAS 6.1.0.27
Nested Class Summary
Modifier and Type | Interface and Description |
---|---|
|
CacheConfig.EvictorAlgorithmType
Eviction algorithm type
EvictorAlgorithmType.LRUEvictor is defined as an evictor type that
uses a least recently used algorithm to decide which entries to evict
when the cache entries map exceeds a maximum number of entries.
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getCacheName()
Returns the name of cache instance.
|
getEvictorAlgorithmType()
Returns the type of evictor algorithm.
|
|
|
getHighThresholdCacheSizeInMB()
Returns the high threshold in percentage of JVM heap space that can be occupied by
the cache entries.
|
|
getLowThresholdCacheSizeInMB()
Returns the low threshold in percentage of JVM heap space that can be occupied by
the cache entries.
|
|
getMaxCacheSize()
Returns the maximum number of cache entries allowed in the memory.
|
|
getMaxCacheSizeInMB()
Returns the maximum space on the JVM heap that can be occupied by
the cache entries.
|
|
getProperties()
Returns additional properties configured for the cacheinstance via the
WebSphere admin console, wsadmin, the cacheinstances.properties file or
the DistributedObjectCacheFactory.getMap(String name, Properties properties)
API.
|
|
isDistributed()
Indicates if this cache is meant to be distributed across the
server instances of the cache provider.
|
Method Detail
getCacheName
- java.lang.String getCacheName()
Returns the name of cache instance.
Returns:
Name of cache instance.
getMaxCacheSize
- long getMaxCacheSize()
Returns the maximum number of cache entries allowed in the memory.
Returns:
The maximum number of cache entries allowed.
getMaxCacheSizeInMB
- long getMaxCacheSizeInMB()
Returns the maximum space on the JVM heap that can be occupied by
the cache entries.
Returns:
The maximum size of cache allowed in terms of JVM heap.
getHighThresholdCacheSizeInMB
- int getHighThresholdCacheSizeInMB( )
Returns the high threshold in percentage of JVM heap space that can be occupied by
the cache entries.
Returns:
The high threshold of JVM heap space that can be occupied by the cache entries
getLowThresholdCacheSizeInMB
- int getLowThresholdCacheSizeInMB( )
Returns the low threshold in percentage of JVM heap space that can be occupied by
the cache entries.
Returns:
The low threshold of JVM heap space that can be occupied by the cache entries
getEvictorAlgorithmType
- CacheConfig.EvictorAlgorithmType getEvictorAlgorithmType( )
Returns the type of evictor algorithm.
isDistributed
- boolean isDistributed()
Indicates if this cache is meant to be distributed across the
server instances of the cache provider.
Returns:
true - Replication is enabled for this cache instance configuration
getProperties
- java.util.Map<java.lang.String,java.lang.String> getProperties( )
Returns additional properties configured for the cacheinstance via the
WebSphere admin console, wsadmin, the cacheinstances.properties file or
the DistributedObjectCacheFactory.getMap(String name, Properties properties)
API.
Returns:
additional properties used for configuring the cache provider's cache instance