Package com.ibm.wsspi.cache
Class ConfigEntry
- java.lang.Object
-
- com.ibm.wsspi.cache.ConfigEntry
-
public class ConfigEntry extends java.lang.Object
A ConfigEntry is a struct object that holds the cache policies specifying how to cache an entry.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
ConfigEntry.CacheId
The CacheId defines a rule for caching an object and is composed of the sub-elements component, timeout, inactivity, priority, property, idgenerator, and metadatagenerator.class
ConfigEntry.Component
Component is a subelement to generate a portion of the cache ID.class
ConfigEntry.DependencyId
The DependencyId object specifies additional cache identifiers that associate multiple cache entries to the same group identifier.class
ConfigEntry.Invalidation
To invalidate cached objects, the application server must generate unique invalidation IDs.class
ConfigEntry.Property
Property is defined optionally on a cacheable object.
-
Constructor Summary
Constructors Constructor Description ConfigEntry(com.ibm.ws.cache.config.ConfigEntry ce)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
This method returns a clone of this config entry.java.util.HashSet
getAllNames()
This method returns all the names of cacheable objects.ConfigEntry.CacheId[]
getCacheIds()
This method returns an array of CacheId objects that contain cache ID generation rules used to produce a valid cache ID.java.lang.String
getClassName()
This method returns the name of cache policy definition.ConfigEntry.DependencyId[]
getDependencyIds()
This method returns an array of DependencyId objects that specified addditional cache indentifers that associated multiple cache entries to the same group identiifier.ConfigEntry.Invalidation[]
getInvalidations()
This method returns an array of Invalidation objects that written custom Java code or through rules that are defined in the cache policy of each entry.java.util.ArrayList
getProperties()
This method returns a list of properties defined on a cache-entryint
getSharingPolicy()
This method returns the sharing policy.
-
-
-
Method Detail
-
getClassName
public java.lang.String getClassName()
This method returns the name of cache policy definition. The class name can be "command", "servlet", "webservice", "JAXRPCClient", "static" or "portlet".- Returns:
- The class name
-
getAllNames
public java.util.HashSet getAllNames()
This method returns all the names of cacheable objects.- Returns:
- The class name
-
getSharingPolicy
public int getSharingPolicy()
This method returns the sharing policy.- Returns:
- The sharing policy
-
clone
public java.lang.Object clone()
This method returns a clone of this config entry.- Returns:
- The config entry
-
getProperties
public java.util.ArrayList getProperties()
This method returns a list of properties defined on a cache-entry- Returns:
- A list of properties
-
getCacheIds
public ConfigEntry.CacheId[] getCacheIds()
This method returns an array of CacheId objects that contain cache ID generation rules used to produce a valid cache ID.- Returns:
- Array of CacheId objects
-
getDependencyIds
public ConfigEntry.DependencyId[] getDependencyIds()
This method returns an array of DependencyId objects that specified addditional cache indentifers that associated multiple cache entries to the same group identiifier.- Returns:
- Array of DependencyId objects
-
getInvalidations
public ConfigEntry.Invalidation[] getInvalidations()
This method returns an array of Invalidation objects that written custom Java code or through rules that are defined in the cache policy of each entry.- Returns:
- Array of Invalidation objects
-
-