Package | Description |
---|---|
org.apache.commons.jcs |
Contains the class JCS which provides a simple interface for clients to use
JCS.
|
org.apache.commons.jcs.access |
Contains classes for accessing the cache.
|
org.apache.commons.jcs.access.behavior | |
org.apache.commons.jcs.access.exception | |
org.apache.commons.jcs.engine.control |
The primary cache classes and the hub.
|
Modifier and Type | Method and Description |
---|---|
static <K,V> CacheAccess<K,V> |
JCS.defineRegion(String name)
Deprecated.
Duplicate of getInstance(String)
|
static <K,V> CacheAccess<K,V> |
JCS.defineRegion(String name,
ICompositeCacheAttributes cattr)
Deprecated.
Duplicate of getInstance(String, ICompositeCacheAttributes)
|
static <K,V> CacheAccess<K,V> |
JCS.defineRegion(String name,
ICompositeCacheAttributes cattr,
IElementAttributes attr)
Deprecated.
Duplicate of getInstance(String, ICompositeCacheAttributes, IElementAttributes)
|
static <K,V> GroupCacheAccess<K,V> |
JCS.getGroupCacheInstance(String region)
Get a GroupCacheAccess which accesses the provided region.
|
static <K,V> GroupCacheAccess<K,V> |
JCS.getGroupCacheInstance(String region,
ICompositeCacheAttributes icca)
Get a GroupCacheAccess which accesses the provided region.
|
static <K,V> GroupCacheAccess<K,V> |
JCS.getGroupCacheInstance(String region,
ICompositeCacheAttributes icca,
IElementAttributes eattr)
Get a GroupCacheAccess which accesses the provided region.
|
static <K,V> CacheAccess<K,V> |
JCS.getInstance(String region)
Get a CacheAccess which accesses the provided region.
|
static <K,V> CacheAccess<K,V> |
JCS.getInstance(String region,
ICompositeCacheAttributes icca)
Get a CacheAccess which accesses the provided region.
|
static <K,V> CacheAccess<K,V> |
JCS.getInstance(String region,
ICompositeCacheAttributes icca,
IElementAttributes eattr)
Get a CacheAccess which accesses the provided region.
|
Modifier and Type | Method and Description |
---|---|
void |
PartitionedCacheAccess.clear()
Removes all of the elements from a region.
|
void |
AbstractCacheAccess.clear()
Removes all of the elements from a region.
|
int |
PartitionedCacheAccess.freeMemoryElements(int numberToFree)
Calls free on each partition.
|
int |
AbstractCacheAccess.freeMemoryElements(int numberToFree)
This instructs the memory cache to remove the numberToFree according to its eviction
policy.
|
IElementAttributes |
PartitionedCacheAccess.getDefaultElementAttributes() |
IElementAttributes |
AbstractCacheAccess.getDefaultElementAttributes()
Retrieves A COPY OF the default element attributes used by this region.
|
IElementAttributes |
PartitionedCacheAccess.getElementAttributes(K key)
This is no more efficient than simply getting the cache element.
|
void |
PartitionedCacheAccess.put(K key,
V object)
Puts the value into the appropriate cache partition.
|
void |
PartitionedCacheAccess.put(K key,
V object,
IElementAttributes attr)
Puts the value into the appropriate cache partition.
|
void |
GroupCacheAccess.putInGroup(K name,
String groupName,
V value)
Allows the user to put an object into a group within a particular cache
region.
|
void |
GroupCacheAccess.putInGroup(K name,
String groupName,
V value,
IElementAttributes attr)
Allows the user to put an object into a group within a particular cache
region.
|
void |
PartitionedCacheAccess.putSafe(K key,
V object)
Puts in cache if an item does not exist with the name in that region.
|
void |
PartitionedCacheAccess.remove(K key)
Removes the item from the appropriate partition.
|
void |
PartitionedCacheAccess.resetElementAttributes(K key,
IElementAttributes attributes)
Resets the attributes for this item.
|
void |
PartitionedCacheAccess.setDefaultElementAttributes(IElementAttributes attr)
This method is does not reset the attributes for items already in the cache.
|
void |
AbstractCacheAccess.setDefaultElementAttributes(IElementAttributes attr)
This method is does not reset the attributes for items already in the cache.
|
Modifier and Type | Method and Description |
---|---|
void |
ICacheAccessManagement.clear()
Removes all of the elements from a region.
|
int |
ICacheAccessManagement.freeMemoryElements(int numberToFree)
This instructs the memory cache to remove the numberToFree according to its eviction
policy.
|
IElementAttributes |
ICacheAccessManagement.getDefaultElementAttributes()
GetElementAttributes will return an attribute object describing the current attributes
associated with the object name.
|
IElementAttributes |
ICacheAccess.getElementAttributes(K name)
Gets the elementAttributes attribute of the ICacheAccess object
|
void |
ICacheAccess.put(K name,
V obj)
Puts and/or overrides an element with the name in that region.
|
void |
ICacheAccess.put(K name,
V obj,
IElementAttributes attr)
Description of the Method
|
void |
IGroupCacheAccess.putInGroup(K key,
String group,
V obj)
Puts an item in the cache associated with this group.
|
void |
IGroupCacheAccess.putInGroup(K key,
String group,
V obj,
IElementAttributes attr)
Put in the cache associated with this group using these attributes.
|
void |
ICacheAccess.putSafe(K name,
V obj)
Puts in cache if an item does not exist with the name in that region.
|
void |
ICacheAccess.remove(K name)
Remove an object for this key if one exists, else do nothing.
|
void |
ICacheAccess.resetElementAttributes(K name,
IElementAttributes attributes)
Reset the attributes on the object matching this key name.
|
void |
ICacheAccessManagement.setDefaultElementAttributes(IElementAttributes attr)
This method is does not reset the attributes for items already in the cache.
|
Modifier and Type | Class and Description |
---|---|
class |
ConfigurationException
Thrown if there is some severe configuration problem that makes the cache nonfunctional.
|
class |
InvalidArgumentException
InvalidArgumentException is thrown if an argument is passed to the cache that is invalid.
|
class |
InvalidGroupException
InvalidGroupException
|
class |
InvalidHandleException
InvalidHandleException is not used.
|
class |
ObjectExistsException
The putSafe method on the JCS convenience class throws this exception if the object is already
present in the cache.
|
class |
ObjectNotFoundException
ObjectNotFoundException
TODO see if we can remove this.
|
Modifier and Type | Method and Description |
---|---|
void |
CompositeCacheManager.configure()
Configure with default properties file
|
void |
CompositeCacheManager.configure(String propFile)
Configure from specific properties file.
|
IElementAttributes |
CompositeCache.getElementAttributes(K key)
Gets the elementAttributes attribute of the Cache object.
|
static CompositeCacheManager |
CompositeCacheManager.getInstance()
Gets the CacheHub instance.
|
static CompositeCacheManager |
CompositeCacheManager.getInstance(String propsFilename)
Initializes the cache manager using the props file for the given name.
|
Copyright © 2002–2018 The Apache Software Foundation. All rights reserved.