com.ibm.wsspi.cache

Class ConfigEntry

  1. java.lang.Object
  2. extended bycom.ibm.wsspi.cache.ConfigEntry

  1. public class ConfigEntry
  2. extends java.lang.Object
A ConfigEntry is a struct object that holds the cache policies specifying how to cache an entry.

Nested Class Summary

Modifier and Type Class and Description
  1. 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.
  1. class
ConfigEntry.Component
Component is a subelement to generate a portion of the cache ID.
  1. class
ConfigEntry.DependencyId
The DependencyId object specifies additional cache identifiers that associate multiple cache entries to the same group identifier.
  1. class
ConfigEntry.Invalidation
To invalidate cached objects, the application server must generate unique invalidation IDs.
  1. class
ConfigEntry.Property
Property is defined optionally on a cacheable object.

Constructor Summary

Constructor and Description
ConfigEntry(com.ibm.ws.cache.config.ConfigEntry ce)

Method Summary

Modifier and Type Method and Description
  1. java.lang.Object
clone()
This method returns a clone of this config entry.
  1. java.util.HashSet
getAllNames()
This method returns all the names of cacheable objects.
  1. ConfigEntry.CacheId[]
getCacheIds()
This method returns an array of CacheId objects that contain cache ID generation rules used to produce a valid cache ID.
  1. java.lang.String
getClassName()
This method returns the name of cache policy definition.
  1. 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.
  1. 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.
  1. java.util.ArrayList
getProperties()
This method returns a list of properties defined on a cache-entry
  1. int
getSharingPolicy()
This method returns the sharing policy.
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfigEntry

  1. public ConfigEntry(com.ibm.ws.cache.config.ConfigEntry ce)

Method Detail

getClassName

  1. 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

  1. public java.util.HashSet getAllNames( )
This method returns all the names of cacheable objects.
Returns:
The class name

getSharingPolicy

  1. public int getSharingPolicy()
This method returns the sharing policy.
Returns:
The sharing policy

clone

  1. public java.lang.Object clone()
This method returns a clone of this config entry.
Overrides:
clone in class java.lang.Object
Returns:
The config entry

getProperties

  1. public java.util.ArrayList getProperties( )
This method returns a list of properties defined on a cache-entry
Returns:
A list of properties

getCacheIds

  1. 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

  1. 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

  1. 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