|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Cache
Interface specification for performance caches as used in Castor. Please implement this interface if you wish to provide your own cache implementation.
At initialization each cache implementation gets passed a properties map containing key/value pairs. Apart of 3 reserved standard properties, individual once can be used to configure the cache behavier. The standard properties are:
type which is evaluated by the CacheFactoryRegistry and defines the requested
cache type. If not set count-limited cahce will be used as default.
debug is also evaluated by the CacheFactoryRegistry and defines if the cache
instance will be wrapped by a DebuggingCacheProxy to log debug messages at every
access to the cache. If not set no debugging will take place.
name is used by AbstractBaseCache to set the name of the cache instance. At
the moment every cache type available extends this AbstractBaseCache. The name does
not influence internal behavier of the cache but is usefull to identify from which
cache instance debug messages are coming from. By default castor uses the classname
of the cached objects as name for the cache. If not present the name will be empty.
For a description of the individual properties you should have a look at the javadoc of the different cache types. It needs to be noted that only string keys and values are allowed.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface java.util.Map |
---|
java.util.Map.Entry<K,V> |
Field Summary | |
---|---|
static java.lang.String |
DEFAULT_DEBUG
Default is debugging switched off. |
static java.lang.String |
DEFAULT_NAME
Default cache name to be used. |
static java.lang.String |
DEFAULT_TYPE
Default cache type to be used. |
static java.lang.String |
PARAM_DEBUG
Mapped initialization parameter debug . |
static java.lang.String |
PARAM_NAME
Mapped initialization parameter name . |
static java.lang.String |
PARAM_TYPE
Mapped initialization parameter type . |
Method Summary | |
---|---|
void |
close()
Life-cycle method to allow custom resource cleanup for a cache implementation. |
void |
expire(java.lang.Object key)
Remove the mapping identified by key from the cache. |
void |
expireAll()
Removes all mappings from the cache. |
java.lang.String |
getName()
Get virtual name of this cache. |
java.lang.String |
getType()
Indicates the type of this cache. |
void |
initialize(java.util.Properties params)
Lyfe-cycle method to allow custom initialization of cache implementations. |
Methods inherited from interface java.util.Map |
---|
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values |
Field Detail |
---|
static final java.lang.String PARAM_TYPE
type
.
static final java.lang.String DEFAULT_TYPE
static final java.lang.String PARAM_NAME
name
.
static final java.lang.String DEFAULT_NAME
static final java.lang.String PARAM_DEBUG
debug
.
static final java.lang.String DEFAULT_DEBUG
Method Detail |
---|
void initialize(java.util.Properties params) throws CacheAcquireException
params
- Parameters to initialize the cache (e.g. name, capacity).
CacheAcquireException
- If cache can not be initialized.void close()
java.lang.String getType()
java.lang.String getName()
void expire(java.lang.Object key)
key
- the key that needs to be removed.void expireAll()
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |