A B C D E F G H I J K L M N O P R S T U V W

A

AbstractBroadcastingListener - Class in com.opensymphony.oscache.plugins.clustersupport
Implementation of a CacheEntryEventListener.
AbstractBroadcastingListener() - Constructor for class com.opensymphony.oscache.plugins.clustersupport.AbstractBroadcastingListener
 
AbstractCacheAdministrator - Class in com.opensymphony.oscache.base
An AbstractCacheAdministrator defines an abstract cache administrator, implementing all the basic operations related to the configuration of a cache, including assigning any configured event handlers to cache objects.
AbstractCacheAdministrator() - Constructor for class com.opensymphony.oscache.base.AbstractCacheAdministrator
Create the AbstractCacheAdministrator.
AbstractCacheAdministrator(Properties) - Constructor for class com.opensymphony.oscache.base.AbstractCacheAdministrator
Create the AbstractCacheAdministrator.
AbstractConcurrentReadCache - Class in com.opensymphony.oscache.base.algorithm
A version of Hashtable that supports mostly-concurrent reading, but exclusive writing.
AbstractConcurrentReadCache(int, float) - Constructor for class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Constructs a new, empty map with the specified initial capacity and the specified load factor.
AbstractConcurrentReadCache(int) - Constructor for class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Constructs a new, empty map with the specified initial capacity and default load factor.
AbstractConcurrentReadCache() - Constructor for class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Constructs a new, empty map with a default initial capacity and load factor.
AbstractConcurrentReadCache(Map) - Constructor for class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Constructs a new map with the same mappings as the given map.
AbstractConcurrentReadCache.Entry - Class in com.opensymphony.oscache.base.algorithm
AbstractConcurrentReadCache collision list entry.
AbstractConcurrentReadCache.HashIterator - Class in com.opensymphony.oscache.base.algorithm
 
AbstractConcurrentReadCache.HashIterator() - Constructor for class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.HashIterator
 
AbstractConcurrentReadCache.KeyIterator - Class in com.opensymphony.oscache.base.algorithm
 
AbstractConcurrentReadCache.KeyIterator() - Constructor for class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.KeyIterator
 
AbstractConcurrentReadCache.ValueIterator - Class in com.opensymphony.oscache.base.algorithm
 
AbstractConcurrentReadCache.ValueIterator() - Constructor for class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.ValueIterator
 
AbstractDiskPersistenceListener - Class in com.opensymphony.oscache.plugins.diskpersistence
Persist the cache data to disk.
AbstractDiskPersistenceListener() - Constructor for class com.opensymphony.oscache.plugins.diskpersistence.AbstractDiskPersistenceListener
 
acceptsGZipEncoding(HttpServletRequest) - Method in class com.opensymphony.oscache.web.filter.CacheFilter
Check if the client browser support gzip compression.
accessed(CacheMapAccessEvent) - Method in interface com.opensymphony.oscache.base.events.CacheMapAccessEventListener
Event fired when an entry is accessed.
accessed(CacheMapAccessEvent) - Method in class com.opensymphony.oscache.extra.CacheMapAccessEventListenerImpl
This method handles an event each time the cache is accessed
accessed(CacheMapAccessEvent) - Method in class com.opensymphony.oscache.extra.StatisticListenerImpl
This method handles an event each time the cache is accessed.
addCacheEventListener(CacheEventListener) - Method in class com.opensymphony.oscache.base.Cache
Register a listener for Cache events.
addCacheEventListener(CacheEventListener, Class) - Method in class com.opensymphony.oscache.base.Cache
Deprecated. use Cache.addCacheEventListener(CacheEventListener)
addDateHeader(String, long) - Method in class com.opensymphony.oscache.web.filter.CacheHttpServletResponseWrapper
Add the date of a header
addHeader(String, String) - Method in class com.opensymphony.oscache.web.filter.CacheHttpServletResponseWrapper
Add a header field
addScopeEventListener(ScopeEventListener) - Method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Register a listener for Cache Map events.
adjustFileCachePath(String) - Method in class com.opensymphony.oscache.plugins.diskpersistence.AbstractDiskPersistenceListener
Allows to translate to the temp dir of the servlet container if cachePathStr is javax.servlet.context.tempdir.
algorithmClass - Variable in class com.opensymphony.oscache.base.AbstractCacheAdministrator
The algorithm class being used, as specified by the AbstractCacheAdministrator.CACHE_ALGORITHM_KEY configuration property.
ALL_SCOPES_FLUSHED - Static variable in class com.opensymphony.oscache.base.events.ScopeEventType
Specifies an event type for the all scope flushed event.
APPLICATION_CACHE_SUBPATH - Static variable in class com.opensymphony.oscache.plugins.diskpersistence.AbstractDiskPersistenceListener
Sub path name for application cache
APPLICATION_SCOPE - Static variable in class com.opensymphony.oscache.extra.ScopeEventListenerImpl
Application scope number
APPLICATION_SCOPE_NAME - Static variable in class com.opensymphony.oscache.web.ServletCacheAdministrator
 

B

barrierLock - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Lock used only for its memory effects.
buildCache(String, Properties) - Method in class com.opensymphony.oscache.hibernate.OSCacheProvider
Builds a new Cache instance, and gets it's properties from the GeneralCacheAdministrator GeneralCacheAdministrator which reads the properties file (oscache.properties) in the start method:

C

Cache - Class in com.opensymphony.oscache.base
Provides an interface to the cache itself.
Cache(boolean, boolean, boolean) - Constructor for class com.opensymphony.oscache.base.Cache
Create a new Cache
Cache(boolean, boolean, boolean, boolean, String, int) - Constructor for class com.opensymphony.oscache.base.Cache
Create a new Cache.
cache - Variable in class com.opensymphony.oscache.plugins.clustersupport.AbstractBroadcastingListener
 
CACHE_ALGORITHM_KEY - Static variable in class com.opensymphony.oscache.base.AbstractCacheAdministrator
A String cache configuration property that specifies the classname of an alternate caching algorithm.
CACHE_BLOCKING_KEY - Static variable in class com.opensymphony.oscache.base.AbstractCacheAdministrator
The configuration key that specifies whether we should block waiting for new content to be generated, or just serve the old content instead.
CACHE_CAPACITY_KEY - Static variable in class com.opensymphony.oscache.base.AbstractCacheAdministrator
An integer cache configuration property that specifies the maximum number of objects to hold in the cache.
CACHE_DISK_UNLIMITED_KEY - Static variable in class com.opensymphony.oscache.base.AbstractCacheAdministrator
A boolean cache configuration property that indicates whether the persistent cache should be unlimited in size, or should be restricted to the same size as the in-memory cache.
CACHE_ENTRY_EVENT_LISTENERS_KEY - Static variable in class com.opensymphony.oscache.base.AbstractCacheAdministrator
A String cache configuration property that holds a comma-delimited list of classnames.
CACHE_EXTENSION - Static variable in class com.opensymphony.oscache.plugins.diskpersistence.AbstractDiskPersistenceListener
File extension for disk cache file
CACHE_FLUSHED - Static variable in class com.opensymphony.oscache.base.events.CachewideEventType
Get an event type for a cache flush event.
CACHE_MEMORY_KEY - Static variable in class com.opensymphony.oscache.base.AbstractCacheAdministrator
A boolean cache configuration property that indicates whether the cache should cache objects in memory.
CACHE_PATH_KEY - Static variable in class com.opensymphony.oscache.plugins.diskpersistence.AbstractDiskPersistenceListener
 
CACHE_PERSISTENCE_OVERFLOW_KEY - Static variable in class com.opensymphony.oscache.base.AbstractCacheAdministrator
A String cache configuration property that specifies if the cache persistence will only be used in overflow mode, that is, when the memory cache capacity has been reached.
cacheCapacity - Variable in class com.opensymphony.oscache.base.AbstractCacheAdministrator
The cache capacity (number of entries), as specified by the AbstractCacheAdministrator.CACHE_CAPACITY_KEY configuration property.
CacheContextListener - Class in com.opensymphony.oscache.web
Class for a clean startup and shutdown of the ServletCacheAdministrator and its application scoped cache.
CacheContextListener() - Constructor for class com.opensymphony.oscache.web.CacheContextListener
 
CacheEntry - Class in com.opensymphony.oscache.base
A CacheEntry instance represents one entry in the cache.
CacheEntry(String) - Constructor for class com.opensymphony.oscache.base.CacheEntry
Construct a new CacheEntry using the key provided.
CacheEntry(String, EntryRefreshPolicy) - Constructor for class com.opensymphony.oscache.base.CacheEntry
Construct a CacheEntry.
CacheEntry(String, EntryRefreshPolicy, String[]) - Constructor for class com.opensymphony.oscache.base.CacheEntry
Construct a CacheEntry.
cacheEntryAdded(CacheEntryEvent) - Method in interface com.opensymphony.oscache.base.events.CacheEntryEventListener
Event fired when an entry is added to the cache.
cacheEntryAdded(CacheEntryEvent) - Method in class com.opensymphony.oscache.extra.CacheEntryEventListenerImpl
Handles the event fired when an entry is added in the cache.
cacheEntryAdded(CacheEntryEvent) - Method in class com.opensymphony.oscache.extra.StatisticListenerImpl
Event fired when an entry is added to the cache.
cacheEntryAdded(CacheEntryEvent) - Method in class com.opensymphony.oscache.plugins.clustersupport.AbstractBroadcastingListener
 
CacheEntryEvent - Class in com.opensymphony.oscache.base.events
CacheEntryEvent is the object created when an event occurs on a cache entry (Add, update, remove, flush).
CacheEntryEvent(Cache, CacheEntry) - Constructor for class com.opensymphony.oscache.base.events.CacheEntryEvent
Constructs a cache entry event object with no specified origin
CacheEntryEvent(Cache, CacheEntry, String) - Constructor for class com.opensymphony.oscache.base.events.CacheEntryEvent
Constructs a cache entry event object
CacheEntryEventListener - Interface in com.opensymphony.oscache.base.events
This is the interface to listen to cache entry events.
CacheEntryEventListenerImpl - Class in com.opensymphony.oscache.extra
Implementation of a CacheEntryEventListener.
CacheEntryEventListenerImpl() - Constructor for class com.opensymphony.oscache.extra.CacheEntryEventListenerImpl
Constructor, empty for us
CacheEntryEventType - Class in com.opensymphony.oscache.base.events
This is all the possible events that may occur on a cache entry or collection of cache entries.
cacheEntryFlushed(CacheEntryEvent) - Method in interface com.opensymphony.oscache.base.events.CacheEntryEventListener
Event fired when an entry is flushed from the cache.
cacheEntryFlushed(CacheEntryEvent) - Method in class com.opensymphony.oscache.extra.CacheEntryEventListenerImpl
Handles the event fired when an entry is flushed from the cache.
cacheEntryFlushed(CacheEntryEvent) - Method in class com.opensymphony.oscache.extra.StatisticListenerImpl
Event fired when an entry is flushed from the cache.
cacheEntryFlushed(CacheEntryEvent) - Method in class com.opensymphony.oscache.plugins.clustersupport.AbstractBroadcastingListener
Event fired when an entry is flushed from the cache.
cacheEntryRemoved(CacheEntryEvent) - Method in interface com.opensymphony.oscache.base.events.CacheEntryEventListener
Event fired when an entry is removed from the cache.
cacheEntryRemoved(CacheEntryEvent) - Method in class com.opensymphony.oscache.extra.CacheEntryEventListenerImpl
Handles the event fired when an entry is removed from the cache.
cacheEntryRemoved(CacheEntryEvent) - Method in class com.opensymphony.oscache.extra.StatisticListenerImpl
Event fired when an entry is removed from the cache.
cacheEntryRemoved(CacheEntryEvent) - Method in class com.opensymphony.oscache.plugins.clustersupport.AbstractBroadcastingListener
 
cacheEntryUpdated(CacheEntryEvent) - Method in interface com.opensymphony.oscache.base.events.CacheEntryEventListener
Event fired when an entry is updated in the cache.
cacheEntryUpdated(CacheEntryEvent) - Method in class com.opensymphony.oscache.extra.CacheEntryEventListenerImpl
Handles the event fired when an entry is updated in the cache.
cacheEntryUpdated(CacheEntryEvent) - Method in class com.opensymphony.oscache.extra.StatisticListenerImpl
Event fired when an entry is updated in the cache.
cacheEntryUpdated(CacheEntryEvent) - Method in class com.opensymphony.oscache.plugins.clustersupport.AbstractBroadcastingListener
 
CacheEvent - Class in com.opensymphony.oscache.base.events
The root event class for all cache events.
CacheEvent() - Constructor for class com.opensymphony.oscache.base.events.CacheEvent
No-argument constructor so subtypes can easily implement Serializable
CacheEvent(String) - Constructor for class com.opensymphony.oscache.base.events.CacheEvent
Creates a cache event object that came from the specified origin.
CacheEventListener - Interface in com.opensymphony.oscache.base.events
This is the base interface for cache events.
CacheFilter - Class in com.opensymphony.oscache.web.filter
CacheFilter is a filter that allows for server-side caching of post-processed servlet content.
CacheFilter() - Constructor for class com.opensymphony.oscache.web.filter.CacheFilter
 
cacheFlushed(CachewideEvent) - Method in interface com.opensymphony.oscache.base.events.CacheEntryEventListener
An event that is fired when an entire cache gets flushed.
cacheFlushed(CachewideEvent) - Method in class com.opensymphony.oscache.extra.CacheEntryEventListenerImpl
Handles the event fired when a cache flush occurs.
cacheFlushed(CachewideEvent) - Method in class com.opensymphony.oscache.extra.StatisticListenerImpl
An event that is fired when an entire cache gets flushed.
cacheFlushed(CachewideEvent) - Method in class com.opensymphony.oscache.plugins.clustersupport.AbstractBroadcastingListener
 
cacheGroupAdded(CacheGroupEvent) - Method in class com.opensymphony.oscache.plugins.clustersupport.AbstractBroadcastingListener
 
cacheGroupEntryAdded(CacheGroupEvent) - Method in class com.opensymphony.oscache.plugins.clustersupport.AbstractBroadcastingListener
 
cacheGroupEntryRemoved(CacheGroupEvent) - Method in class com.opensymphony.oscache.plugins.clustersupport.AbstractBroadcastingListener
 
CacheGroupEvent - Class in com.opensymphony.oscache.base.events
CacheGroupEvent is an event that occurs at the cache group level (Add, update, remove, flush).
CacheGroupEvent(Cache, String) - Constructor for class com.opensymphony.oscache.base.events.CacheGroupEvent
Constructs a cache group event with no origin
CacheGroupEvent(Cache, String, String) - Constructor for class com.opensymphony.oscache.base.events.CacheGroupEvent
Constructs a cache group event
cacheGroupFlushed(CacheGroupEvent) - Method in interface com.opensymphony.oscache.base.events.CacheEntryEventListener
Event fired when a group is flushed from the cache.
cacheGroupFlushed(CacheGroupEvent) - Method in class com.opensymphony.oscache.extra.CacheEntryEventListenerImpl
Handles the event fired when a group is flushed from the cache.
cacheGroupFlushed(CacheGroupEvent) - Method in class com.opensymphony.oscache.extra.StatisticListenerImpl
Event fired when a group is flushed from the cache.
cacheGroupFlushed(CacheGroupEvent) - Method in class com.opensymphony.oscache.plugins.clustersupport.AbstractBroadcastingListener
Event fired when an entry is removed from the cache.
cacheGroupRemoved(CacheGroupEvent) - Method in class com.opensymphony.oscache.plugins.clustersupport.AbstractBroadcastingListener
 
cacheGroupUpdated(CacheGroupEvent) - Method in class com.opensymphony.oscache.plugins.clustersupport.AbstractBroadcastingListener
 
CacheHttpServletResponseWrapper - Class in com.opensymphony.oscache.web.filter
CacheServletResponse is a serialized representation of a response
CacheHttpServletResponseWrapper(HttpServletResponse) - Constructor for class com.opensymphony.oscache.web.filter.CacheHttpServletResponseWrapper
Constructor
CacheHttpServletResponseWrapper(HttpServletResponse, boolean, long, long, long, long) - Constructor for class com.opensymphony.oscache.web.filter.CacheHttpServletResponseWrapper
Constructor
CacheMapAccessEvent - Class in com.opensymphony.oscache.base.events
Cache map access event.
CacheMapAccessEvent(CacheMapAccessEventType, CacheEntry) - Constructor for class com.opensymphony.oscache.base.events.CacheMapAccessEvent
Constructor.
CacheMapAccessEvent(CacheMapAccessEventType, CacheEntry, String) - Constructor for class com.opensymphony.oscache.base.events.CacheMapAccessEvent
Constructor.
CacheMapAccessEventListener - Interface in com.opensymphony.oscache.base.events
This is the interface to listen to cache map access events.
CacheMapAccessEventListenerImpl - Class in com.opensymphony.oscache.extra
Implementation of a CacheMapAccessEventListener.
CacheMapAccessEventListenerImpl() - Constructor for class com.opensymphony.oscache.extra.CacheMapAccessEventListenerImpl
Constructor, empty for us
CacheMapAccessEventType - Class in com.opensymphony.oscache.base.events
This is an enumeration of the cache events that represent the various outcomes of cache accesses.
CachePatternEvent - Class in com.opensymphony.oscache.base.events
A CachePatternEvent is fired when a pattern has been applied to a cache.
CachePatternEvent(Cache, String) - Constructor for class com.opensymphony.oscache.base.events.CachePatternEvent
Constructs a cache pattern event with no origin
CachePatternEvent(Cache, String, String) - Constructor for class com.opensymphony.oscache.base.events.CachePatternEvent
Constructs a cache pattern event
cachePatternFlushed(CachePatternEvent) - Method in interface com.opensymphony.oscache.base.events.CacheEntryEventListener
Event fired when a key pattern is flushed from the cache.
cachePatternFlushed(CachePatternEvent) - Method in class com.opensymphony.oscache.extra.CacheEntryEventListenerImpl
Handles the event fired when a pattern is flushed from the cache.
cachePatternFlushed(CachePatternEvent) - Method in class com.opensymphony.oscache.extra.StatisticListenerImpl
Event fired when a key pattern is flushed from the cache.
cachePatternFlushed(CachePatternEvent) - Method in class com.opensymphony.oscache.plugins.clustersupport.AbstractBroadcastingListener
 
CachePersistenceException - Exception in com.opensymphony.oscache.base.persistence
Exception thrown when an error occurs in a PersistenceListener implementation.
CachePersistenceException() - Constructor for exception com.opensymphony.oscache.base.persistence.CachePersistenceException
Creates new CachePersistenceException without detail message.
CachePersistenceException(String) - Constructor for exception com.opensymphony.oscache.base.persistence.CachePersistenceException
Constructs an CachePersistenceException with the specified detail message.
CacheTag - Class in com.opensymphony.oscache.web.tag
CacheTag is a tag that allows for server-side caching of post-processed JSP content.
CacheTag() - Constructor for class com.opensymphony.oscache.web.tag.CacheTag
 
CachewideEvent - Class in com.opensymphony.oscache.base.events
A CachewideEvent represents and event that occurs on the the entire cache, eg a cache flush or clear.
CachewideEvent(Cache, Date, String) - Constructor for class com.opensymphony.oscache.base.events.CachewideEvent
Constructs a cachewide event with the specified origin.
CachewideEventType - Class in com.opensymphony.oscache.base.events
This is an enumeration holding all the events that can occur at the cache-wide level.
cancelUpdate(String) - Method in class com.opensymphony.oscache.base.Cache
Cancels any pending update for this cache entry.
cancelUpdate() - Method in class com.opensymphony.oscache.base.EntryUpdateState
Updates the state to UPDATE_CANCELLED.
cancelUpdate(String) - Method in class com.opensymphony.oscache.general.GeneralCacheAdministrator
Cancels a pending cache update.
cancelUpdate(int, HttpServletRequest, String) - Method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Cancels a pending cache update.
capacity() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Return the number of slots in this table.
ClassLoaderUtil - Class in com.opensymphony.oscache.util
This code is borrowed directly from OSCore, but is duplicated here to avoid having to add a dependency on the entire OSCore jar.
clear() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Removes all mappings from this map.
clear() - Method in class com.opensymphony.oscache.base.Cache
Completely clears the cache.
clear() - Method in interface com.opensymphony.oscache.base.persistence.PersistenceListener
Clear the entire persistent cache (including the root)
clear() - Method in class com.opensymphony.oscache.hibernate.OSCache
 
clear() - Method in class com.opensymphony.oscache.plugins.diskpersistence.AbstractDiskPersistenceListener
Clears the whole cache directory, starting from the root
clone() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Returns a shallow copy of this.
clone() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.Entry
 
close() - Method in class com.opensymphony.oscache.web.filter.SplitServletOutputStream
Closes both the output streams.
CLUSTER_ORIGIN - Static variable in class com.opensymphony.oscache.plugins.clustersupport.AbstractBroadcastingListener
The name to use for the origin of cluster events.
ClusterNotification - Class in com.opensymphony.oscache.plugins.clustersupport
A notification message that holds information about a cache event.
ClusterNotification(int, Serializable) - Constructor for class com.opensymphony.oscache.plugins.clustersupport.ClusterNotification
Creates a new notification message object to broadcast to other listening nodes in the cluster.
com.opensymphony.oscache.base - package com.opensymphony.oscache.base
Provides the base classes and interfaces that make up the core of OSCache.
com.opensymphony.oscache.base.algorithm - package com.opensymphony.oscache.base.algorithm
Provides the classes that implement the caching algorithms used by OSCache, all of which are based on a derivative of Doug Lea's ConcurrentReaderHashMap.
com.opensymphony.oscache.base.events - package com.opensymphony.oscache.base.events
Provides the base classes and interfaces that allow pluggable event handlers to be incorporated into OSCache.
com.opensymphony.oscache.base.persistence - package com.opensymphony.oscache.base.persistence
Provides the interfaces that provide persistence storage of cached objects.
com.opensymphony.oscache.extra - package com.opensymphony.oscache.extra
Provides some basic event handler implementations that aren't essential to the core OSCache code, but form a useful starting point for basic logging or further development.
com.opensymphony.oscache.general - package com.opensymphony.oscache.general
Provides a generic administrator class for the cache.
com.opensymphony.oscache.hibernate - package com.opensymphony.oscache.hibernate
Provides Hibernate 3.2 classes for OSCache.
com.opensymphony.oscache.plugins.clustersupport - package com.opensymphony.oscache.plugins.clustersupport
Provides support for broadcasting flush events so that OSCache can function across a cluster.
com.opensymphony.oscache.plugins.diskpersistence - package com.opensymphony.oscache.plugins.diskpersistence
Provides support for persisting cached objects to disk.
com.opensymphony.oscache.util - package com.opensymphony.oscache.util
Provides utility classes that perform fairly general-purpose functions and are required by OSCache.
com.opensymphony.oscache.web - package com.opensymphony.oscache.web
Provides classes and interfaces that make up the base of OSCache's web application support.
com.opensymphony.oscache.web.filter - package com.opensymphony.oscache.web.filter
Provides the caching filter (and its support classes) that allows HTTP responses to be cached by OSCache.
com.opensymphony.oscache.web.tag - package com.opensymphony.oscache.web.tag
Provides the tag libraries that allow OSCache to be accessed via JSP custom tags for caching portions of JSP pages.
commit() - Method in class com.opensymphony.oscache.web.filter.ResponseContent
Called once the response has been written in its entirety.
completeUpdate(String) - Method in class com.opensymphony.oscache.base.Cache
Removes the update state for the specified key and notifies any other threads that are waiting on this object.
completeUpdate() - Method in class com.opensymphony.oscache.base.EntryUpdateState
Updates the state to UPDATE_COMPLETE.
config - Variable in class com.opensymphony.oscache.base.AbstractCacheAdministrator
 
Config - Class in com.opensymphony.oscache.base
Responsible for holding the Cache configuration properties.
Config() - Constructor for class com.opensymphony.oscache.base.Config
Create an OSCache Config that loads properties from oscache.properties.
Config(Properties) - Constructor for class com.opensymphony.oscache.base.Config
Create an OSCache configuration with the specified properties.
configure(Config) - Method in interface com.opensymphony.oscache.base.persistence.PersistenceListener
Allow the persistence code to initialize itself based on the supplied cache configuration.
configure(Config) - Method in class com.opensymphony.oscache.plugins.diskpersistence.AbstractDiskPersistenceListener
Initialises this DiskPersistenceListener using the supplied configuration.
configure(Config) - Method in class com.opensymphony.oscache.plugins.diskpersistence.HashDiskPersistenceListener
Initializes the HashDiskPersistenceListener.
configureStandardListeners(Cache) - Method in class com.opensymphony.oscache.base.AbstractCacheAdministrator
Applies all of the recognised listener classes to the supplied cache object.
contains(Object) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Tests if some key maps into the specified value in this table.
containsKey(Object) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Tests if the specified object is a key in this table.
containsValue(Object) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Returns true if this map maps one or more keys to the specified value.
CONTEXT_TMPDIR - Static variable in class com.opensymphony.oscache.plugins.diskpersistence.AbstractDiskPersistenceListener
Property to get the temporary working directory of the servlet container.
contextDestroyed(ServletContextEvent) - Method in class com.opensymphony.oscache.web.CacheContextListener
This notification occurs when the servlet context is about to be shut down.
contextInitialized(ServletContextEvent) - Method in class com.opensymphony.oscache.web.CacheContextListener
This notification occurs when the webapp is ready to process requests.
count - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
The total number of mappings in the hash table.
createCacheGroups(HttpServletRequest, ServletCacheAdministrator, Cache) - Method in class com.opensymphony.oscache.web.filter.CacheFilter
ICacheGroupsProvider
createCacheGroups(HttpServletRequest, ServletCacheAdministrator, Cache) - Method in interface com.opensymphony.oscache.web.filter.ICacheGroupsProvider
Creates the cache groups for the CacheFilter.
createCacheKey(HttpServletRequest, ServletCacheAdministrator, Cache) - Method in class com.opensymphony.oscache.web.filter.CacheFilter
ICacheKeyProvider
createCacheKey(HttpServletRequest, ServletCacheAdministrator, Cache) - Method in interface com.opensymphony.oscache.web.filter.ICacheKeyProvider
Creates the cache key for the CacheFilter.
currentKey - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.HashIterator
 
currentValue - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.HashIterator
 

D

data - Variable in class com.opensymphony.oscache.plugins.clustersupport.ClusterNotification
Any additional data that may be required
decrementUsageCounter() - Method in class com.opensymphony.oscache.base.EntryUpdateState
Decrements the usage counter by one.
DEFAULT_HASH_ALGORITHM - Static variable in class com.opensymphony.oscache.plugins.diskpersistence.HashDiskPersistenceListener
 
DEFAULT_INITIAL_CAPACITY - Static variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
The default initial number of table slots for this table (32).
DEFAULT_LOAD_FACTOR - Static variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
The default load factor for this table.
DEFAULT_MAX_ENTRIES - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Default cache capacity (number of entries).
destroy() - Method in class com.opensymphony.oscache.general.GeneralCacheAdministrator
Shuts down the cache administrator.
destroy() - Method in class com.opensymphony.oscache.hibernate.OSCache
 
destroy() - Method in class com.opensymphony.oscache.web.filter.CacheFilter
Filter clean-up
destroyInstance(ServletContext) - Static method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Shuts down all servlet cache administrators.
DiskPersistenceListener - Class in com.opensymphony.oscache.plugins.diskpersistence
Persist the cache data to disk.
DiskPersistenceListener() - Constructor for class com.opensymphony.oscache.plugins.diskpersistence.DiskPersistenceListener
 
doAfterBody() - Method in class com.opensymphony.oscache.web.tag.CacheTag
After the cache body, either update the cache, serve new cached content or indicate an error.
doCatch(Throwable) - Method in class com.opensymphony.oscache.web.tag.CacheTag
 
doEndTag() - Method in class com.opensymphony.oscache.web.tag.CacheTag
The end tag - clean up variables used.
doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class com.opensymphony.oscache.web.filter.CacheFilter
The doFilter call caches the response by wrapping the HttpServletResponse object so that the output stream can be caught.
doFinally() - Method in class com.opensymphony.oscache.web.tag.CacheTag
 
doStartTag() - Method in class com.opensymphony.oscache.web.tag.CacheTag
The start of the tag.
doStartTag() - Method in class com.opensymphony.oscache.web.tag.FlushTag
Process the start of the tag.
doStartTag() - Method in class com.opensymphony.oscache.web.tag.GroupsTag
 
doStartTag() - Method in class com.opensymphony.oscache.web.tag.GroupTag
 
doStartTag() - Method in class com.opensymphony.oscache.web.tag.UseCachedTag
The start tag.

E

elements() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Returns an enumeration of the values in this table.
entry - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.HashIterator
 
ENTRY_ADDED - Static variable in class com.opensymphony.oscache.base.events.CacheEntryEventType
Get an event type for an entry added.
ENTRY_FLUSHED - Static variable in class com.opensymphony.oscache.base.events.CacheEntryEventType
Get an event type for an entry flushed.
ENTRY_REMOVED - Static variable in class com.opensymphony.oscache.base.events.CacheEntryEventType
Get an event type for an entry removed.
ENTRY_UPDATED - Static variable in class com.opensymphony.oscache.base.events.CacheEntryEventType
Get an event type for an entry updated.
EntryRefreshPolicy - Interface in com.opensymphony.oscache.base
Interface that allows custom code to be called when checking to see if a cache entry has expired.
entrySet - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
 
entrySet() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Returns a collection view of the mappings contained in this map.
EntryUpdateState - Class in com.opensymphony.oscache.base
Holds the state of a Cache Entry that is in the process of being (re)generated.
EntryUpdateState() - Constructor for class com.opensymphony.oscache.base.EntryUpdateState
 
equals(Object) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.Entry
 
EXPIRES_OFF - Static variable in class com.opensymphony.oscache.web.filter.CacheFilter
 
EXPIRES_ON - Static variable in class com.opensymphony.oscache.web.filter.CacheFilter
 
EXPIRES_TIME - Static variable in class com.opensymphony.oscache.web.filter.CacheFilter
 
ExpiresRefreshPolicy - Class in com.opensymphony.oscache.web.filter
Checks if a cache filter entry has expired.
ExpiresRefreshPolicy(int) - Constructor for class com.opensymphony.oscache.web.filter.ExpiresRefreshPolicy
Constructor ExpiresRefreshPolicy.

F

FastCronParser - Class in com.opensymphony.oscache.util
Parses cron expressions and determines at what time in the past is the most recent match for the supplied expression.
FastCronParser() - Constructor for class com.opensymphony.oscache.util.FastCronParser
Creates a FastCronParser that uses a default cron expression of "* * * * *".
FastCronParser(String) - Constructor for class com.opensymphony.oscache.util.FastCronParser
Constructs a new FastCronParser based on the supplied expression.
FIFOCache - Class in com.opensymphony.oscache.base.algorithm
FIFO (First In First Out) based queue algorithm for the cache.
FIFOCache() - Constructor for class com.opensymphony.oscache.base.algorithm.FIFOCache
Constructs a FIFO Cache.
FIFOCache(int) - Constructor for class com.opensymphony.oscache.base.algorithm.FIFOCache
Constructs a FIFO Cache of the specified capacity.
FinalizationException - Exception in com.opensymphony.oscache.base
Thrown by LifecycleAware listeners that are not able to finalize themselves.
FinalizationException() - Constructor for exception com.opensymphony.oscache.base.FinalizationException
 
FinalizationException(String) - Constructor for exception com.opensymphony.oscache.base.FinalizationException
 
finalizeListeners(Cache) - Method in class com.opensymphony.oscache.base.AbstractCacheAdministrator
Finalizes all the listeners that are associated with the given cache object.
finalizeListeners(Cache) - Method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Finalizes all the listeners that are associated with the given cache object
findAndRemoveEntry(Map.Entry) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Helper method for entrySet remove.
finialize() - Method in interface com.opensymphony.oscache.base.LifecycleAware
Called by the cache administrator class when a cache is destroyed.
finialize() - Method in class com.opensymphony.oscache.plugins.clustersupport.JavaGroupsBroadcastingListener
Shuts down the JavaGroups being managed by this listener.
finialize() - Method in class com.opensymphony.oscache.plugins.clustersupport.JMS10BroadcastingListener
Called by the cache administrator class when a cache is destroyed.
finialize() - Method in class com.opensymphony.oscache.plugins.clustersupport.JMSBroadcastingListener
Called by the cache administrator class when a cache is destroyed.
flush() - Method in class com.opensymphony.oscache.base.CacheEntry
Flush the entry from cache.
flush() - Method in class com.opensymphony.oscache.web.filter.SplitServletOutputStream
Flushes both the output streams.
FLUSH_CACHE - Static variable in class com.opensymphony.oscache.plugins.clustersupport.ClusterNotification
Specifies a notification message indicating that an entire cache should be flushed.
FLUSH_GROUP - Static variable in class com.opensymphony.oscache.plugins.clustersupport.ClusterNotification
Specifies a notification message that indicates an entire cache group should be flushed.
FLUSH_KEY - Static variable in class com.opensymphony.oscache.plugins.clustersupport.ClusterNotification
Specifies a notification message that indicates a particular cache key should be flushed.
FLUSH_PATTERN - Static variable in class com.opensymphony.oscache.plugins.clustersupport.ClusterNotification
Specifies a notification message that indicates all entries in the cache that match the specified pattern should be flushed.
flushAll(Date) - Method in class com.opensymphony.oscache.base.Cache
Flush all entries in the cache on the given date/time.
flushAll(Date, String) - Method in class com.opensymphony.oscache.base.Cache
Flush all entries in the cache on the given date/time.
flushAll() - Method in class com.opensymphony.oscache.general.GeneralCacheAdministrator
Flush the entire cache immediately.
flushAll(Date) - Method in class com.opensymphony.oscache.general.GeneralCacheAdministrator
Flush the entire cache at the given date.
flushAll(Date) - Method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Flush all scopes at a particular time
flushAll() - Method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Flush all scopes instantly.
flushBuffer() - Method in class com.opensymphony.oscache.web.filter.CacheHttpServletResponseWrapper
 
flushEntry(String) - Method in class com.opensymphony.oscache.base.Cache
Flush the cache entry (if any) that corresponds to the cache key supplied.
flushEntry(String, String) - Method in class com.opensymphony.oscache.base.Cache
Flush the cache entry (if any) that corresponds to the cache key supplied.
flushEntry(String) - Method in class com.opensymphony.oscache.general.GeneralCacheAdministrator
Flushes a single cache entry.
flushGroup(String) - Method in class com.opensymphony.oscache.base.Cache
Flushes all objects that belong to the supplied group.
flushGroup(String, String) - Method in class com.opensymphony.oscache.base.Cache
Flushes all unexpired objects that belong to the supplied group.
flushGroup(String) - Method in class com.opensymphony.oscache.general.GeneralCacheAdministrator
Flushes all items that belong to the specified group.
flushPattern(String) - Method in class com.opensymphony.oscache.base.Cache
Deprecated. For performance and flexibility reasons it is preferable to store cache entries in groups and use the Cache.flushGroup(String) method instead of relying on pattern flushing.
flushPattern(String, String) - Method in class com.opensymphony.oscache.base.Cache
Deprecated. For performance and flexibility reasons it is preferable to store cache entries in groups and use the Cache.flushGroup(String, String) method instead of relying on pattern flushing.
flushPattern(String) - Method in class com.opensymphony.oscache.general.GeneralCacheAdministrator
Deprecated. For performance and flexibility reasons it is preferable to store cache entries in groups and use the GeneralCacheAdministrator.flushGroup(String) method instead of relying on pattern flushing.
FlushTag - Class in com.opensymphony.oscache.web.tag
FlushTag flushes caches created with <cache>.
FlushTag() - Constructor for class com.opensymphony.oscache.web.tag.FlushTag
 
FRAGMENT_AUTODETECT - Static variable in class com.opensymphony.oscache.web.filter.CacheFilter
 
FRAGMENT_NO - Static variable in class com.opensymphony.oscache.web.filter.CacheFilter
 
FRAGMENT_YES - Static variable in class com.opensymphony.oscache.web.filter.CacheFilter
 

G

GeneralCacheAdministrator - Class in com.opensymphony.oscache.general
A GeneralCacheAdministrator creates, flushes and administers the cache.
GeneralCacheAdministrator() - Constructor for class com.opensymphony.oscache.general.GeneralCacheAdministrator
Create the cache administrator.
GeneralCacheAdministrator(Properties) - Constructor for class com.opensymphony.oscache.general.GeneralCacheAdministrator
Create the cache administrator with the specified properties
generateEntryKey(String, HttpServletRequest, int) - Method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Generates a cache entry key.
generateEntryKey(String, HttpServletRequest, int, String) - Method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Generates a cache entry key.
generateEntryKey(String, HttpServletRequest, int, String, String) - Method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Generates a cache entry key.
get(Object) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Returns the value to which the specified key is mapped in this table.
get(Object) - Method in class com.opensymphony.oscache.base.Config
 
get(Object) - Method in class com.opensymphony.oscache.hibernate.OSCache
 
getApplicationScopeFlushCount() - Method in class com.opensymphony.oscache.extra.ScopeEventListenerImpl
Gets the flush count for scope ScopeEventListenerImpl.APPLICATION_SCOPE.
getAppScopeCache(ServletContext) - Method in class com.opensymphony.oscache.web.ServletCacheAdministrator
A convenience method to retrieve the application scope cache
getCache() - Method in class com.opensymphony.oscache.base.events.CachewideEvent
Retrieve the cache map that the event occurred on.
getCache() - Method in class com.opensymphony.oscache.general.GeneralCacheAdministrator
Grabs a cache
getCache() - Method in class com.opensymphony.oscache.plugins.clustersupport.JavaGroupsBroadcastingListener
We are not using the caching, so we just return something that identifies us.
getCache(HttpServletRequest, int) - Method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Grabs the cache for the specified scope
getCacheContent() - Method in exception com.opensymphony.oscache.base.NeedsRefreshException
Retrieve current object in the cache
getCacheControlMaxAge() - Method in class com.opensymphony.oscache.web.filter.CacheFilter
 
getCacheEntry(String, EntryRefreshPolicy, String) - Method in class com.opensymphony.oscache.base.Cache
Get an entry from this cache or create one if it doesn't exist.
getCacheEntry() - Method in class com.opensymphony.oscache.base.events.CacheMapAccessEvent
Retrieve the cache entry that the event applies to.
getCacheEntryKey() - Method in class com.opensymphony.oscache.base.events.CacheMapAccessEvent
Retrieve the cache entry key that the event applies to.
getCacheEventListenerList() - Method in class com.opensymphony.oscache.base.Cache
Returns the list of all CacheEventListeners.
getCacheEventListeners() - Method in class com.opensymphony.oscache.base.AbstractCacheAdministrator
Retrieves an array containing instances all of the CacheEventListener classes that are specified in the OSCache configuration file.
getCacheFile(String) - Method in class com.opensymphony.oscache.plugins.diskpersistence.AbstractDiskPersistenceListener
Build fully qualified cache file for the specified cache entry key.
getCacheFileName(String) - Method in class com.opensymphony.oscache.plugins.diskpersistence.AbstractDiskPersistenceListener
Build cache file name for the specified cache entry key.
getCacheFileName(String) - Method in class com.opensymphony.oscache.plugins.diskpersistence.DiskPersistenceListener
Build cache file name for the specified cache entry key.
getCacheFileName(String) - Method in class com.opensymphony.oscache.plugins.diskpersistence.HashDiskPersistenceListener
Generates a file name for the given cache key.
getCacheFlushedCount() - Method in class com.opensymphony.oscache.extra.CacheEntryEventListenerImpl
Gets the cache flush counter
getCacheGroupsProvider() - Method in class com.opensymphony.oscache.web.filter.CacheFilter
 
getCacheKey() - Method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Get the cache key from the properties.
getCacheKeyProvider() - Method in class com.opensymphony.oscache.web.filter.CacheFilter
 
getCachePath() - Method in class com.opensymphony.oscache.plugins.diskpersistence.AbstractDiskPersistenceListener
Get the physical cache path on disk.
getCacheScope() - Method in class com.opensymphony.oscache.web.filter.CacheFilter
Returns PageContext.APPLICATION_SCOPE or PageContext.SESSION_SCOPE.
getCapacity() - Method in class com.opensymphony.oscache.base.Cache
 
getContent() - Method in class com.opensymphony.oscache.base.CacheEntry
Get the cached content from this CacheEntry.
getContent() - Method in class com.opensymphony.oscache.web.filter.CacheHttpServletResponseWrapper
Get a response content
getContentEncoding() - Method in class com.opensymphony.oscache.web.filter.ResponseContent
 
getContentType() - Method in class com.opensymphony.oscache.web.filter.ResponseContent
 
getContextTmpDir() - Method in class com.opensymphony.oscache.plugins.diskpersistence.AbstractDiskPersistenceListener
Get the servlet context tmp directory.
getCreated() - Method in class com.opensymphony.oscache.base.CacheEntry
Get the date this CacheEntry was created.
getCron() - Method in class com.opensymphony.oscache.web.filter.CacheFilter
 
getCronExpression() - Method in class com.opensymphony.oscache.util.FastCronParser
Retrieves the current cron expression.
getData() - Method in class com.opensymphony.oscache.plugins.clustersupport.ClusterNotification
Holds any additional data that was required
getDate() - Method in class com.opensymphony.oscache.base.events.CachewideEvent
Retrieve the date/time that the cache flush is scheduled for.
getDate() - Method in class com.opensymphony.oscache.base.events.ScopeEvent
Retrieve the event date
getDisableCacheOnMethods() - Method in class com.opensymphony.oscache.web.filter.CacheFilter
 
getElementCountInMemory() - Method in class com.opensymphony.oscache.hibernate.OSCache
 
getElementCountOnDisk() - Method in class com.opensymphony.oscache.hibernate.OSCache
 
getEntriesAdded() - Method in class com.opensymphony.oscache.extra.StatisticListenerImpl
 
getEntriesRemoved() - Method in class com.opensymphony.oscache.extra.StatisticListenerImpl
 
getEntriesUpdated() - Method in class com.opensymphony.oscache.extra.StatisticListenerImpl
 
getEntry() - Method in class com.opensymphony.oscache.base.events.CacheEntryEvent
Retrieve the cache entry that the event applies to.
getEntryAddedCount() - Method in class com.opensymphony.oscache.extra.CacheEntryEventListenerImpl
Gets the add counter
getEntryFlushedCount() - Method in class com.opensymphony.oscache.extra.CacheEntryEventListenerImpl
Gets the flushed counter
getEntryRemovedCount() - Method in class com.opensymphony.oscache.extra.CacheEntryEventListenerImpl
Gets the removed counter
getEntryUpdatedCount() - Method in class com.opensymphony.oscache.extra.CacheEntryEventListenerImpl
Gets the updated counter
getEventType() - Method in class com.opensymphony.oscache.base.events.CacheMapAccessEvent
Retrieve the type of the event.
getEventType() - Method in class com.opensymphony.oscache.base.events.ScopeEvent
Retrieve the type of the event.
getExpires() - Method in class com.opensymphony.oscache.web.filter.CacheFilter
 
getExpires() - Method in class com.opensymphony.oscache.web.filter.ResponseContent
 
getExpiresRefreshPolicy() - Method in class com.opensymphony.oscache.web.filter.CacheFilter
 
getExpressionSummary() - Method in class com.opensymphony.oscache.util.FastCronParser
Recreates the original human-readable cron expression based on the internal datastructure values.
getFlushCount() - Method in class com.opensymphony.oscache.extra.StatisticListenerImpl
 
getFlushTime(int) - Method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Get the flush time for a particular scope.
getFragment() - Method in class com.opensymphony.oscache.web.filter.CacheFilter
 
getFromCache(String) - Method in class com.opensymphony.oscache.base.Cache
Retrieve an object from the cache specifying its key.
getFromCache(String, int) - Method in class com.opensymphony.oscache.base.Cache
Retrieve an object from the cache specifying its key.
getFromCache(String, int, String) - Method in class com.opensymphony.oscache.base.Cache
Retrieve an object from the cache specifying its key.
getFromCache(String) - Method in class com.opensymphony.oscache.general.GeneralCacheAdministrator
Get an object from the cache
getFromCache(String, int) - Method in class com.opensymphony.oscache.general.GeneralCacheAdministrator
Get an object from the cache
getFromCache(String, int, String) - Method in class com.opensymphony.oscache.general.GeneralCacheAdministrator
Get an object from the cache
getFromCache(int, HttpServletRequest, String, int) - Method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Retrieve an item from the cache
getGroup(String) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Returns a set of the cache keys that reside in a particular group.
getGroup() - Method in class com.opensymphony.oscache.base.events.CacheGroupEvent
Retrieve the cache group that the event applies to.
getGroupFlushedCount() - Method in class com.opensymphony.oscache.extra.CacheEntryEventListenerImpl
Gets the group flush counter
getGroupForReading(String) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Get ref to group.
getGroups() - Method in class com.opensymphony.oscache.base.CacheEntry
Gets the cache groups that this cache entry belongs to.
getGroupsForReading() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Get ref to groups.
getHitCount() - Method in class com.opensymphony.oscache.extra.CacheMapAccessEventListenerImpl
Returns the cache's current hit count
getHitCount() - Method in class com.opensymphony.oscache.extra.StatisticListenerImpl
 
getHitCountSum() - Method in class com.opensymphony.oscache.extra.StatisticListenerImpl
 
getInitialContext() - Method in class com.opensymphony.oscache.plugins.clustersupport.JMSBroadcastingListener
 
getInstance(ServletContext) - Static method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Obtain an instance of the CacheAdministrator
getInstance(ServletContext, Properties) - Static method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Obtain an instance of the CacheAdministrator
getInstanceFromKey(ServletContext, String) - Static method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Obtain an instance of the CacheAdministrator for the specified key
getKey() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.Entry
 
getKey() - Method in class com.opensymphony.oscache.base.CacheEntry
Get the key of this CacheEntry
getKey() - Method in class com.opensymphony.oscache.base.events.CacheEntryEvent
Retrieve the cache entry key
getLastModified() - Method in class com.opensymphony.oscache.web.filter.CacheFilter
 
getLastModified() - Method in class com.opensymphony.oscache.web.filter.ResponseContent
 
getLastUpdate() - Method in class com.opensymphony.oscache.base.CacheEntry
Get the date this CacheEntry was last updated.
getMap() - Method in class com.opensymphony.oscache.base.events.CacheEntryEvent
Retrieve the cache map where the entry resides.
getMap() - Method in class com.opensymphony.oscache.base.events.CacheGroupEvent
Retrieve the cache map where the group resides.
getMap() - Method in class com.opensymphony.oscache.base.events.CachePatternEvent
Retrieve the cache map that had the pattern applied.
getMaxAge() - Method in class com.opensymphony.oscache.web.filter.ResponseContent
Returns the max age of the content in miliseconds.
getMaxEntries() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Retrieve the cache capacity (number of entries).
getMissCount() - Method in class com.opensymphony.oscache.extra.CacheMapAccessEventListenerImpl
Returns the cache's current miss count
getMissCount() - Method in class com.opensymphony.oscache.extra.StatisticListenerImpl
 
getMissCountSum() - Method in class com.opensymphony.oscache.extra.StatisticListenerImpl
 
getNbEntries() - Method in class com.opensymphony.oscache.base.Cache
Deprecated. use getSize()
getNbUpdateState() - Method in class com.opensymphony.oscache.base.Cache
Test support only: return the number of EntryUpdateState instances within the updateStates map.
getNocache() - Method in class com.opensymphony.oscache.web.filter.CacheFilter
 
getOrigin() - Method in class com.opensymphony.oscache.base.events.CacheEvent
Retrieves the origin of this event, if one was specified.
getOutputStream() - Method in class com.opensymphony.oscache.web.filter.CacheHttpServletResponseWrapper
Get an output stream
getOutputStream() - Method in class com.opensymphony.oscache.web.filter.ResponseContent
Get an output stream.
getPageScopeFlushCount() - Method in class com.opensymphony.oscache.extra.ScopeEventListenerImpl
Gets the flush count for scope ScopeEventListenerImpl.PAGE_SCOPE.
getPattern() - Method in class com.opensymphony.oscache.base.events.CachePatternEvent
Retrieve the pattern that was applied to the cache.
getPatternFlushedCount() - Method in class com.opensymphony.oscache.extra.CacheEntryEventListenerImpl
Gets the pattern flush counter
getPersistenceListener() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Get the persistence listener.
getPersistenceListener() - Method in class com.opensymphony.oscache.base.Cache
Retrieves the currently configured PersistenceListener.
getProperties() - Method in class com.opensymphony.oscache.base.Config
Retrieves all of the configuration properties.
getProperty(String) - Method in class com.opensymphony.oscache.base.AbstractCacheAdministrator
Retrieves the value of one of the configuration properties.
getProperty(String) - Method in class com.opensymphony.oscache.base.Config
Retrieve the value of the named configuration property.
getRefreshPeriod() - Method in class com.opensymphony.oscache.web.filter.ExpiresRefreshPolicy
 
getRegionName() - Method in class com.opensymphony.oscache.hibernate.OSCache
 
getRequestScopeFlushCount() - Method in class com.opensymphony.oscache.extra.ScopeEventListenerImpl
Gets the flush count for scope ScopeEventListenerImpl.REQUEST_SCOPE.
getRoot() - Method in class com.opensymphony.oscache.plugins.diskpersistence.AbstractDiskPersistenceListener
Get the root directory for persisting the cache on disk.
getScope() - Method in class com.opensymphony.oscache.base.events.ScopeEvent
Retrieve the scope that applies to the event.
getScope() - Method in class com.opensymphony.oscache.web.ServletCache
Get the cache scope
getSessionScopeCache(HttpSession) - Method in class com.opensymphony.oscache.web.ServletCacheAdministrator
A convenience method to retrieve the session scope cache
getSessionScopeFlushCount() - Method in class com.opensymphony.oscache.extra.ScopeEventListenerImpl
Gets the flush count for scope ScopeEventListenerImpl.SESSION_SCOPE.
getSize() - Method in class com.opensymphony.oscache.base.Cache
 
getSize() - Method in class com.opensymphony.oscache.base.CacheEntry
Get the size of the cache entry in bytes (roughly).
getSize() - Method in class com.opensymphony.oscache.web.filter.ResponseContent
Gets the size of this cached content.
getSizeInMemory() - Method in class com.opensymphony.oscache.hibernate.OSCache
 
getSortedQueryString(HttpServletRequest) - Method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Creates a string that contains all of the request parameters and their values in a single string.
getStaleHitCount() - Method in class com.opensymphony.oscache.extra.CacheMapAccessEventListenerImpl
Returns the cache's current stale hit count
getStaleHitCount() - Method in class com.opensymphony.oscache.extra.StatisticListenerImpl
 
getStaleHitCountSum() - Method in class com.opensymphony.oscache.extra.StatisticListenerImpl
 
getStatus() - Method in class com.opensymphony.oscache.web.filter.CacheHttpServletResponseWrapper
Retrieves the captured HttpResponse status.
getTableForReading() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Get ref to table; the reference and the cells it accesses will be at least as fresh as from last use of barrierLock
getTime() - Method in class com.opensymphony.oscache.web.filter.CacheFilter
 
getTimeBefore(long) - Method in class com.opensymphony.oscache.util.FastCronParser
Find the most recent time that matches this cron expression.
getTimeout() - Method in class com.opensymphony.oscache.hibernate.OSCache
 
getTotalScopeFlushCount() - Method in class com.opensymphony.oscache.extra.ScopeEventListenerImpl
Returns the total flush count.
getType() - Method in class com.opensymphony.oscache.plugins.clustersupport.ClusterNotification
The type of notification message.
getUpdateState(String) - Method in class com.opensymphony.oscache.base.Cache
Get the updating cache entry from the update map.
getUsageCounter() - Method in class com.opensymphony.oscache.base.EntryUpdateState
Gets the current usage counter value
getValue() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.Entry
Get the value.
getWriter() - Method in class com.opensymphony.oscache.web.filter.CacheHttpServletResponseWrapper
Get a print writer
GROUP_DIRECTORY - Static variable in class com.opensymphony.oscache.plugins.diskpersistence.AbstractDiskPersistenceListener
The directory that cache groups are stored under
GROUP_FLUSHED - Static variable in class com.opensymphony.oscache.base.events.CacheEntryEventType
Get an event type for a group flush event.
groups - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
A HashMap containing the group information.
GroupsTag - Class in com.opensymphony.oscache.web.tag
GroupsTag is a tag that add a comma-delimited list of groups to an ancestor CacheTag's groups.
GroupsTag() - Constructor for class com.opensymphony.oscache.web.tag.GroupsTag
 
GroupTag - Class in com.opensymphony.oscache.web.tag
GroupTag is a tag that adds a group to an ancestor CacheTag's groups.
GroupTag() - Constructor for class com.opensymphony.oscache.web.tag.GroupTag
 

H

handleClusterNotification(ClusterNotification) - Method in class com.opensymphony.oscache.plugins.clustersupport.AbstractBroadcastingListener
Handles incoming notification messages.
handleNotification(Serializable) - Method in class com.opensymphony.oscache.plugins.clustersupport.JavaGroupsBroadcastingListener
Handles incoming notification messages from JavaGroups.
hash - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.Entry
 
HASH_ALGORITHM_KEY - Static variable in class com.opensymphony.oscache.plugins.diskpersistence.HashDiskPersistenceListener
 
HASH_KEY_CONTEXT_TMPDIR - Static variable in class com.opensymphony.oscache.web.ServletCacheAdministrator
Key used to store the servlet container temporary directory in the configuration.
HASH_KEY_SCOPE - Static variable in class com.opensymphony.oscache.web.ServletCacheAdministrator
Key used to store the current scope in the configuration.
HASH_KEY_SESSION_ID - Static variable in class com.opensymphony.oscache.web.ServletCacheAdministrator
Key used to store the current session ID in the configuration.
hashCode() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.Entry
 
HashDiskPersistenceListener - Class in com.opensymphony.oscache.plugins.diskpersistence
Persists cache data to disk.
HashDiskPersistenceListener() - Constructor for class com.opensymphony.oscache.plugins.diskpersistence.HashDiskPersistenceListener
 
hasLength(String) - Static method in class com.opensymphony.oscache.util.StringUtil
 
hasMoreElements() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.HashIterator
 
hasMoreRecentMatch(long) - Method in class com.opensymphony.oscache.util.FastCronParser
Determines whether this cron expression matches a date/time that is more recent than the one supplied.
hasNext() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.HashIterator
 
HEADER_ACCEPT_ENCODING - Static variable in class com.opensymphony.oscache.web.filter.CacheFilter
 
HEADER_CACHE_CONTROL - Static variable in class com.opensymphony.oscache.web.filter.CacheFilter
 
HEADER_CONTENT_ENCODING - Static variable in class com.opensymphony.oscache.web.filter.CacheFilter
 
HEADER_CONTENT_TYPE - Static variable in class com.opensymphony.oscache.web.filter.CacheFilter
 
HEADER_EXPIRES - Static variable in class com.opensymphony.oscache.web.filter.CacheFilter
 
HEADER_IF_MODIFIED_SINCE - Static variable in class com.opensymphony.oscache.web.filter.CacheFilter
 
HEADER_LAST_MODIFIED - Static variable in class com.opensymphony.oscache.web.filter.CacheFilter
 
HIT - Static variable in class com.opensymphony.oscache.base.events.CacheMapAccessEventType
Get an event type for a cache hit.

I

ICacheGroupsProvider - Interface in com.opensymphony.oscache.web.filter
Provider interface for cache groups creation in CacheFilter.
ICacheKeyProvider - Interface in com.opensymphony.oscache.web.filter
Provider interface for cache key creation.
incrementUsageCounter() - Method in class com.opensymphony.oscache.base.EntryUpdateState
Increments the usage counter by one
INDEFINITE_EXPIRY - Static variable in class com.opensymphony.oscache.base.CacheEntry
Specifying this as the refresh period for the CacheEntry.needsRefresh(int) method will ensure an entry does not become stale until it is either explicitly flushed or a custom refresh policy causes the entry to expire.
index - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.HashIterator
 
init(FilterConfig) - Method in class com.opensymphony.oscache.web.filter.CacheFilter
Initialize the filter.
init(String, String) - Method in interface com.opensymphony.oscache.web.WebEntryRefreshPolicy
Initializes the refresh policy.
initFileCaching(String) - Method in class com.opensymphony.oscache.plugins.diskpersistence.AbstractDiskPersistenceListener
Set caching to file on or off.
InitializationException - Exception in com.opensymphony.oscache.base
Thrown by LifecycleAware listeners that are not able to initialize themselves.
InitializationException() - Constructor for exception com.opensymphony.oscache.base.InitializationException
 
InitializationException(String) - Constructor for exception com.opensymphony.oscache.base.InitializationException
 
initialize(Cache, Config) - Method in interface com.opensymphony.oscache.base.LifecycleAware
Called by the cache administrator class when a cache is instantiated.
initialize(Cache, Config) - Method in class com.opensymphony.oscache.plugins.clustersupport.AbstractBroadcastingListener
Called by the cache administrator class when a cache is instantiated.
initialize(Cache, Config) - Method in class com.opensymphony.oscache.plugins.clustersupport.JavaGroupsBroadcastingListener
Initializes the broadcasting listener by starting up a JavaGroups notification bus instance to handle incoming and outgoing messages.
initialize(Cache, Config) - Method in class com.opensymphony.oscache.plugins.clustersupport.JMS10BroadcastingListener
Called by the cache administrator class when a cache is instantiated.
initialize(Cache, Config) - Method in class com.opensymphony.oscache.plugins.clustersupport.JMSBroadcastingListener
Called by the cache administrator class when a cache is instantiated.
isAwaitingUpdate() - Method in class com.opensymphony.oscache.base.EntryUpdateState
This is the initial state when an instance this object is first created.
isBlocking() - Method in class com.opensymphony.oscache.base.AbstractCacheAdministrator
Indicates whether the cache will block waiting for new content to be built, or serve stale content instead of waiting.
isCacheable(ServletRequest) - Method in class com.opensymphony.oscache.web.filter.CacheFilter
isCacheable is a method allowing a subclass to decide if a request is cachable or not.
isCacheable(CacheHttpServletResponseWrapper) - Method in class com.opensymphony.oscache.web.filter.CacheFilter
isCacheable is a method allowing subclass to decide if a response is cachable or not.
isCancelled() - Method in class com.opensymphony.oscache.base.EntryUpdateState
The thread that was responsible for updating the cache entry (ie, the thread that managed to grab the update lock) has decided to give up responsibility for performing the update.
isCommitted() - Method in class com.opensymphony.oscache.web.filter.CacheHttpServletResponseWrapper
Returns a boolean indicating if the response has been committed.
isComplete() - Method in class com.opensymphony.oscache.base.EntryUpdateState
The update of the cache entry has been completed.
isContentGZiped() - Method in class com.opensymphony.oscache.web.filter.ResponseContent
 
isEmpty() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Returns true if this map contains no key-value mappings.
isEmpty(String) - Static method in class com.opensymphony.oscache.util.StringUtil
 
isFilteredBefore(ServletRequest) - Method in class com.opensymphony.oscache.web.filter.CacheFilter
Checks if the request was filtered before, so guarantees to be executed once per request.
isFlushed(CacheEntry) - Method in class com.opensymphony.oscache.base.Cache
Checks if the cache was flushed more recently than the CacheEntry provided.
isFragment(HttpServletRequest) - Method in class com.opensymphony.oscache.web.filter.CacheFilter
Checks if the request is a fragment in a page.
isGroupStored(String) - Method in interface com.opensymphony.oscache.base.persistence.PersistenceListener
Verify if a group is currently stored in the persistent cache.
isGroupStored(String) - Method in class com.opensymphony.oscache.plugins.diskpersistence.AbstractDiskPersistenceListener
Verify if a group exists in the cache
isMemoryCaching() - Method in class com.opensymphony.oscache.base.AbstractCacheAdministrator
Whether entries are cached in memory or not.
isMemoryCaching() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Check if memory caching is used.
isMinimalPutsEnabledByDefault() - Method in class com.opensymphony.oscache.hibernate.OSCacheProvider
This method isn't documented in Hibernate:
isNew() - Method in class com.opensymphony.oscache.base.CacheEntry
Indicates whether this CacheEntry is a freshly created one and has not yet been assigned content or placed in a cache.
isOverflowPersistence() - Method in class com.opensymphony.oscache.base.AbstractCacheAdministrator
Check if we use overflowPersistence
isOverflowPersistence() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Check if we use overflowPersistence
isScopeFlushed(CacheEntry, int) - Method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Checks if the given scope was flushed more recently than the CacheEntry provided.
isStale(CacheEntry, int, String) - Method in class com.opensymphony.oscache.base.Cache
Indicates whether or not the cache entry is stale.
isStale(CacheEntry, int, String) - Method in class com.opensymphony.oscache.web.ServletCache
Indicates whether or not the cache entry is stale.
isStored(String) - Method in interface com.opensymphony.oscache.base.persistence.PersistenceListener
Verify if an object is currently stored in the persistent cache.
isStored(String) - Method in class com.opensymphony.oscache.plugins.diskpersistence.AbstractDiskPersistenceListener
Verify if an object is currently stored in the cache
isUnlimitedDiskCache() - Method in class com.opensymphony.oscache.base.AbstractCacheAdministrator
Indicates whether the unlimited disk cache is enabled or not.
isUnlimitedDiskCache() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Check if we use unlimited disk cache.
isUpdating() - Method in class com.opensymphony.oscache.base.EntryUpdateState
The cache entry is currently being generated by the thread that got hold of the update lock.
itemPut(Object) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Notify the underlying implementation that an item was put in the cache.
itemPut(Object) - Method in class com.opensymphony.oscache.base.algorithm.FIFOCache
An object was put in the cache.
itemPut(Object) - Method in class com.opensymphony.oscache.base.algorithm.LRUCache
An object was put in the cache.
itemPut(Object) - Method in class com.opensymphony.oscache.base.algorithm.UnlimitedCache
Implements itemPut with an empty implementation.
itemRemoved(Object) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Notify the underlying implementation that an item was removed from the cache.
itemRemoved(Object) - Method in class com.opensymphony.oscache.base.algorithm.FIFOCache
Remove specified key since that object has been removed from the cache.
itemRemoved(Object) - Method in class com.opensymphony.oscache.base.algorithm.LRUCache
Remove specified key since that object has been removed from the cache.
itemRemoved(Object) - Method in class com.opensymphony.oscache.base.algorithm.UnlimitedCache
An empty implementation.
itemRetrieved(Object) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Notify any underlying algorithm that an item has been retrieved from the cache.
itemRetrieved(Object) - Method in class com.opensymphony.oscache.base.algorithm.FIFOCache
An object was retrieved from the cache.
itemRetrieved(Object) - Method in class com.opensymphony.oscache.base.algorithm.LRUCache
An item was retrieved from the list.
itemRetrieved(Object) - Method in class com.opensymphony.oscache.base.algorithm.UnlimitedCache
Implements itemRetrieved with an empty implementation.

J

JavaGroupsBroadcastingListener - Class in com.opensymphony.oscache.plugins.clustersupport
A concrete implementation of the AbstractBroadcastingListener based on the JavaGroups library.
JavaGroupsBroadcastingListener() - Constructor for class com.opensymphony.oscache.plugins.clustersupport.JavaGroupsBroadcastingListener
 
JMS10BroadcastingListener - Class in com.opensymphony.oscache.plugins.clustersupport
A JMS 1.0.x based clustering implementation.
JMS10BroadcastingListener() - Constructor for class com.opensymphony.oscache.plugins.clustersupport.JMS10BroadcastingListener
 
JMSBroadcastingListener - Class in com.opensymphony.oscache.plugins.clustersupport
A JMS based clustering implementation.
JMSBroadcastingListener() - Constructor for class com.opensymphony.oscache.plugins.clustersupport.JMSBroadcastingListener
 

K

key - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.Entry
 
keys() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Returns an enumeration of the keys in this table.
keySet - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
 
keySet() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Returns a set view of the keys contained in this map.

L

LAST_MODIFIED_INITIAL - Static variable in class com.opensymphony.oscache.web.filter.CacheFilter
 
LAST_MODIFIED_OFF - Static variable in class com.opensymphony.oscache.web.filter.CacheFilter
 
LAST_MODIFIED_ON - Static variable in class com.opensymphony.oscache.web.filter.CacheFilter
 
lastReturned - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.HashIterator
 
lastWrite - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
field written to only to guarantee lock ordering.
LifecycleAware - Interface in com.opensymphony.oscache.base
Event handlers implement this so they can be notified when a cache is created and also when it is destroyed.
listenerList - Variable in class com.opensymphony.oscache.base.AbstractCacheAdministrator
Holds a list of all the registered event listeners.
listenerList - Variable in class com.opensymphony.oscache.base.Cache
A list of all registered event listeners for this cache.
loadClass(String, Class) - Static method in class com.opensymphony.oscache.util.ClassLoaderUtil
Load a class with a given name.
loadFactor - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
The load factor for the hash table.
loadFactor() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Return the load factor
loadProperties(URL, String) - Static method in class com.opensymphony.oscache.base.Config
Load the properties from the specified URL.
loadProperties(String, String) - Static method in class com.opensymphony.oscache.base.Config
Load the specified properties file from the classpath.
lock(Object) - Method in class com.opensymphony.oscache.hibernate.OSCache
 
logError(String) - Method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Log error messages to commons logging.
LRUCache - Class in com.opensymphony.oscache.base.algorithm
LRU (Least Recently Used) algorithm for the cache.
LRUCache() - Constructor for class com.opensymphony.oscache.base.algorithm.LRUCache
Constructs an LRU Cache.
LRUCache(int) - Constructor for class com.opensymphony.oscache.base.algorithm.LRUCache
Constructors a LRU Cache of the specified capacity.

M

MAX_AGE_NO_INIT - Static variable in class com.opensymphony.oscache.web.filter.CacheFilter
 
MAX_AGE_TIME - Static variable in class com.opensymphony.oscache.web.filter.CacheFilter
 
maxEntries - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Cache capacity (number of entries).
md - Variable in class com.opensymphony.oscache.plugins.diskpersistence.HashDiskPersistenceListener
 
memberJoined(Address) - Method in class com.opensymphony.oscache.plugins.clustersupport.JavaGroupsBroadcastingListener
A callback that is fired when a new member joins the cluster.
memberLeft(Address) - Method in class com.opensymphony.oscache.plugins.clustersupport.JavaGroupsBroadcastingListener
A callback that is fired when an existing member leaves the cluster.
memoryCaching - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Use memory cache or not.
MISS - Static variable in class com.opensymphony.oscache.base.events.CacheMapAccessEventType
Get an event type for a cache miss.

N

NB_SCOPES - Static variable in class com.opensymphony.oscache.extra.ScopeEventListenerImpl
Number of known scopes
needsRefresh(int) - Method in class com.opensymphony.oscache.base.CacheEntry
Check if this CacheEntry needs to be refreshed.
needsRefresh(CacheEntry) - Method in interface com.opensymphony.oscache.base.EntryRefreshPolicy
Indicates whether the supplied CacheEntry needs to be refreshed.
needsRefresh(CacheEntry) - Method in class com.opensymphony.oscache.web.filter.ExpiresRefreshPolicy
Indicates whether the supplied CacheEntry needs to be refreshed.
NeedsRefreshException - Exception in com.opensymphony.oscache.base
This exception is thrown when retrieving an item from cache and it is expired.
NeedsRefreshException(String, Object) - Constructor for exception com.opensymphony.oscache.base.NeedsRefreshException
Create a NeedsRefreshException
NeedsRefreshException(Object) - Constructor for exception com.opensymphony.oscache.base.NeedsRefreshException
Create a NeedsRefreshException
NESTED_EVENT - Static variable in class com.opensymphony.oscache.base.Cache
An event that origininated from within another event.
next - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.Entry
 
next() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.HashIterator
 
nextElement() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.HashIterator
 
nextTimestamp() - Method in class com.opensymphony.oscache.hibernate.OSCache
 
nextTimestamp() - Method in class com.opensymphony.oscache.hibernate.OSCacheProvider
 
NOCACHE_OFF - Static variable in class com.opensymphony.oscache.web.filter.CacheFilter
 
NOCACHE_SESSION_ID_IN_URL - Static variable in class com.opensymphony.oscache.web.filter.CacheFilter
 
NOT_YET_UPDATING - Static variable in class com.opensymphony.oscache.base.EntryUpdateState
The initial state when this object is first created
NULL - Static variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
 

O

origin - Variable in class com.opensymphony.oscache.base.events.CacheEvent
An optional tag that can be attached to the event to specify the event's origin.
OSCache - Class in com.opensymphony.oscache.hibernate
Cache plugin for Hibernate 3.2 and OpenSymphony OSCache 2.4.
OSCache(GeneralCacheAdministrator, int, String, String) - Constructor for class com.opensymphony.oscache.hibernate.OSCache
 
OSCACHE_CONFIGURATION_RESOURCE_NAME - Static variable in class com.opensymphony.oscache.hibernate.OSCacheProvider
In the Hibernate system property you can specify the location of the oscache configuration file name.
OSCACHE_CRON - Static variable in class com.opensymphony.oscache.hibernate.OSCacheProvider
The OSCache CRON expression property suffix.
OSCACHE_REFRESH_PERIOD - Static variable in class com.opensymphony.oscache.hibernate.OSCacheProvider
The OSCache refresh period property suffix.
OSCacheProvider - Class in com.opensymphony.oscache.hibernate
Cache provider plugin for Hibernate 3.2 and OpenSymphony OSCache 2.4.
OSCacheProvider() - Constructor for class com.opensymphony.oscache.hibernate.OSCacheProvider
 

P

PAGE_SCOPE - Static variable in class com.opensymphony.oscache.extra.ScopeEventListenerImpl
Page scope number
PATTERN_FLUSHED - Static variable in class com.opensymphony.oscache.base.events.CacheEntryEventType
Get an event type for a pattern flush event.
persistClear() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Removes the entire cache from persistent storage.
PERSISTENCE_CLASS_KEY - Static variable in class com.opensymphony.oscache.base.AbstractCacheAdministrator
A String cache configuration property that specifies the classname that will be used to provide cache persistence.
persistenceListener - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Persistence listener.
PersistenceListener - Interface in com.opensymphony.oscache.base.persistence
Defines the methods that are required to persist cache data.
persistRemove(Object) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Remove an object from the persistence.
persistRemoveGroup(String) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Removes a cache group using the persistence listener.
persistRetrieve(Object) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Retrieve an object from the persistence listener.
persistRetrieveGroup(String) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Retrieves a cache group using the persistence listener.
persistStore(Object, Object) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Store an object in the cache using the persistence listener.
persistStoreGroup(String, Set) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Creates or Updates a cache group using the persistence listener.
put(Object, Object) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
OpenSymphony BEGIN
put(Object, Object) - Method in class com.opensymphony.oscache.hibernate.OSCache
 
putAll(Map) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Copies all of the mappings from the specified map to this one.
putInCache(String, Object) - Method in class com.opensymphony.oscache.base.Cache
Put an object in the cache specifying the key to use.
putInCache(String, Object, EntryRefreshPolicy) - Method in class com.opensymphony.oscache.base.Cache
Put an object in the cache specifying the key and refresh policy to use.
putInCache(String, Object, String[]) - Method in class com.opensymphony.oscache.base.Cache
Put in object into the cache, specifying both the key to use and the cache groups the object belongs to.
putInCache(String, Object, String[], EntryRefreshPolicy, String) - Method in class com.opensymphony.oscache.base.Cache
Put an object into the cache specifying both the key to use and the cache groups the object belongs to.
putInCache(String, Object, EntryRefreshPolicy) - Method in class com.opensymphony.oscache.general.GeneralCacheAdministrator
Put an object in a cache
putInCache(String, Object) - Method in class com.opensymphony.oscache.general.GeneralCacheAdministrator
Put an object in a cache
putInCache(String, Object, String[]) - Method in class com.opensymphony.oscache.general.GeneralCacheAdministrator
Puts an object in a cache
putInCache(String, Object, String[], EntryRefreshPolicy) - Method in class com.opensymphony.oscache.general.GeneralCacheAdministrator
Puts an object in a cache
putInCache(int, HttpServletRequest, String, Object) - Method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Put an object in the cache.
putInCache(int, HttpServletRequest, String, Object, EntryRefreshPolicy) - Method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Put an object in the cache.

R

read(Object) - Method in class com.opensymphony.oscache.hibernate.OSCache
 
recordModification(Object) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Force a memory synchronization that will cause all readers to see table.
rehash() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Rehashes the contents of this map into a new table with a larger capacity.
releaseUpdateState(EntryUpdateState, String) - Method in class com.opensymphony.oscache.base.Cache
releases the usage that was made of the specified EntryUpdateState.
remove() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.HashIterator
 
remove(Object) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
OpenSymphony BEGIN
remove(String) - Method in interface com.opensymphony.oscache.base.persistence.PersistenceListener
Removes an object from the persistent cache
remove(Object) - Method in class com.opensymphony.oscache.hibernate.OSCache
 
remove(String) - Method in class com.opensymphony.oscache.plugins.diskpersistence.AbstractDiskPersistenceListener
Delete a single cache entry.
remove(File) - Method in class com.opensymphony.oscache.plugins.diskpersistence.AbstractDiskPersistenceListener
 
removeCacheEventListener(CacheEventListener, Class) - Method in class com.opensymphony.oscache.base.Cache
Deprecated. use instead Cache.removeCacheEventListener(CacheEventListener)
removeCacheEventListener(CacheEventListener) - Method in class com.opensymphony.oscache.base.Cache
Unregister a listener for Cache events.
removeEntry(String) - Method in class com.opensymphony.oscache.base.Cache
Completely removes a cache entry from the cache and its associated cache groups.
removeEntry(String, String) - Method in class com.opensymphony.oscache.base.Cache
Completely removes a cache entry from the cache and its associated cache groups.
removeEntry(String) - Method in class com.opensymphony.oscache.general.GeneralCacheAdministrator
Remove an object from the cache
removeForce(Object) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Like remove(Object), but ensures that the entry will be removed from the persistent store, too, even if overflowPersistence or unlimitedDiskcache are true.
removeGroup(String) - Method in interface com.opensymphony.oscache.base.persistence.PersistenceListener
Removes a group from the persistent cache.
removeGroup(String) - Method in class com.opensymphony.oscache.plugins.diskpersistence.AbstractDiskPersistenceListener
Deletes an entire group from the cache.
removeItem() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
The cache has reached its cacpacity and an item needs to be removed.
removeItem() - Method in class com.opensymphony.oscache.base.algorithm.FIFOCache
An item needs to be removed from the cache.
removeItem() - Method in class com.opensymphony.oscache.base.algorithm.LRUCache
An item needs to be removed from the cache.
removeItem() - Method in class com.opensymphony.oscache.base.algorithm.UnlimitedCache
This method just returns null since items should never end up being removed from an unlimited cache!
removeScopeEventListener(ScopeEventListener) - Method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Unregister a listener for Cache Map events.
REQUEST_SCOPE - Static variable in class com.opensymphony.oscache.extra.ScopeEventListenerImpl
Request scope number
reset() - Method in class com.opensymphony.oscache.extra.CacheMapAccessEventListenerImpl
Resets all of the totals to zero
reset() - Method in class com.opensymphony.oscache.web.filter.CacheHttpServletResponseWrapper
Clears any data that exists in the buffer as well as the status code and headers.
resetBuffer() - Method in class com.opensymphony.oscache.web.filter.CacheHttpServletResponseWrapper
Clears the content of the underlying buffer in the response without clearing headers or status code.
ResponseContent - Class in com.opensymphony.oscache.web.filter
Holds the servlet response in a byte array so that it can be held in the cache (and, since this class is serializable, optionally persisted to disk).
ResponseContent() - Constructor for class com.opensymphony.oscache.web.filter.ResponseContent
 
retrieve(String) - Method in interface com.opensymphony.oscache.base.persistence.PersistenceListener
Retrieves an object from the persistent cache.
retrieve(String) - Method in class com.opensymphony.oscache.plugins.diskpersistence.AbstractDiskPersistenceListener
Retrieve an object from the disk
retrieveGroup(String) - Method in interface com.opensymphony.oscache.base.persistence.PersistenceListener
Retrieves a group from the persistent cache.
retrieveGroup(String) - Method in class com.opensymphony.oscache.plugins.diskpersistence.AbstractDiskPersistenceListener
Retrieves a group from the cache, or null if the group file could not be found.
returnValueOfNext() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.HashIterator
 
returnValueOfNext() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.KeyIterator
 
returnValueOfNext() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.ValueIterator
 

S

SCOPE_FLUSHED - Static variable in class com.opensymphony.oscache.base.events.ScopeEventType
Specifies an event type for the flushing of a specific scope.
SCOPE_NAMES - Static variable in class com.opensymphony.oscache.extra.ScopeEventListenerImpl
Scope names
ScopeEvent - Class in com.opensymphony.oscache.base.events
A ScopeEvent is created when an event occurs across one or all scopes.
ScopeEvent(ScopeEventType, int, Date) - Constructor for class com.opensymphony.oscache.base.events.ScopeEvent
Constructs a scope event object with no specified origin.
ScopeEvent(ScopeEventType, int, Date, String) - Constructor for class com.opensymphony.oscache.base.events.ScopeEvent
Constructs a scope event object.
ScopeEventListener - Interface in com.opensymphony.oscache.base.events
This is the interface to listen to scope events.
ScopeEventListenerImpl - Class in com.opensymphony.oscache.extra
Implementation of a ScopeEventListener that keeps track of the scope flush events.
ScopeEventListenerImpl() - Constructor for class com.opensymphony.oscache.extra.ScopeEventListenerImpl
 
ScopeEventType - Class in com.opensymphony.oscache.base.events
This is an enumeration of all the possible events that may occur at the scope level.
scopeFlushed(ScopeEvent) - Method in interface com.opensymphony.oscache.base.events.ScopeEventListener
Event fired when a specific or all scopes are flushed.
scopeFlushed(ScopeEvent) - Method in class com.opensymphony.oscache.extra.ScopeEventListenerImpl
Handles all the scope flush events.
scopeFlushed(ScopeEvent) - Method in class com.opensymphony.oscache.extra.StatisticListenerImpl
Event fired when a specific or all scopes are flushed.
sendError(int, String) - Method in class com.opensymphony.oscache.web.filter.CacheHttpServletResponseWrapper
We override this so we can catch the response status.
sendError(int) - Method in class com.opensymphony.oscache.web.filter.CacheHttpServletResponseWrapper
We override this so we can catch the response status.
sendNotification(ClusterNotification) - Method in class com.opensymphony.oscache.plugins.clustersupport.AbstractBroadcastingListener
Called when a cluster notification message is to be broadcast.
sendNotification(ClusterNotification) - Method in class com.opensymphony.oscache.plugins.clustersupport.JavaGroupsBroadcastingListener
Uses JavaGroups to broadcast the supplied notification message across the cluster.
sendNotification(ClusterNotification) - Method in class com.opensymphony.oscache.plugins.clustersupport.JMS10BroadcastingListener
 
sendNotification(ClusterNotification) - Method in class com.opensymphony.oscache.plugins.clustersupport.JMSBroadcastingListener
 
sendRedirect(String) - Method in class com.opensymphony.oscache.web.filter.CacheHttpServletResponseWrapper
We override this so we can catch the response status.
ServletCache - Class in com.opensymphony.oscache.web
A simple extension of Cache that implements a session binding listener, and deletes it's entries when unbound
ServletCache(ServletCacheAdministrator, int) - Constructor for class com.opensymphony.oscache.web.ServletCache
Create a new ServletCache
ServletCache(ServletCacheAdministrator, String, int, int) - Constructor for class com.opensymphony.oscache.web.ServletCache
Create a new Cache
ServletCacheAdministrator - Class in com.opensymphony.oscache.web
A ServletCacheAdministrator creates, flushes and administers the cache.
SESSION_CACHE_SUBPATH - Static variable in class com.opensymphony.oscache.plugins.diskpersistence.AbstractDiskPersistenceListener
Sub path name for session cache
SESSION_SCOPE - Static variable in class com.opensymphony.oscache.extra.ScopeEventListenerImpl
Session scope number
SESSION_SCOPE_NAME - Static variable in class com.opensymphony.oscache.web.ServletCacheAdministrator
Constants for scope's name
set(Object, Object) - Method in class com.opensymphony.oscache.base.Config
Sets a configuration property.
setAlgorithmClass(String) - Method in class com.opensymphony.oscache.base.AbstractCacheAdministrator
Sets the algorithm to use for the cache.
setCacheCapacity(int) - Method in class com.opensymphony.oscache.base.AbstractCacheAdministrator
Sets the cache capacity (number of items).
setCacheCapacity(int) - Method in class com.opensymphony.oscache.general.GeneralCacheAdministrator
Sets the cache capacity (number of items).
setCacheCapacity(int, HttpServletRequest, int) - Method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Sets the cache capacity (number of items).
setCacheControlMaxAge(long) - Method in class com.opensymphony.oscache.web.filter.CacheFilter
max-age - defines the cache control response header max-age.
setCacheGroupsProvider(ICacheGroupsProvider) - Method in class com.opensymphony.oscache.web.filter.CacheFilter
ICacheGroupsProvider - Class implementing the interface ICacheGroupsProvider.
setCacheKeyProvider(ICacheKeyProvider) - Method in class com.opensymphony.oscache.web.filter.CacheFilter
ICacheKeyProvider - Class implementing the interface ICacheKeyProvider.
setCacheScope(int) - Method in class com.opensymphony.oscache.web.filter.CacheFilter
scope - the default scope to cache content.
setCapacity(int) - Method in class com.opensymphony.oscache.base.Cache
Allows the capacity of the cache to be altered dynamically.
setContent(Object) - Method in class com.opensymphony.oscache.base.CacheEntry
Sets the actual content that is being cached.
setContentEncoding(String) - Method in class com.opensymphony.oscache.web.filter.ResponseContent
 
setContentType(String) - Method in class com.opensymphony.oscache.web.filter.CacheHttpServletResponseWrapper
Set the content type
setContentType(String) - Method in class com.opensymphony.oscache.web.filter.ResponseContent
Set the content type.
setCron(String) - Method in class com.opensymphony.oscache.web.filter.CacheFilter
cron - defines an expression that determines when the page content will expire.
setCron(String) - Method in class com.opensymphony.oscache.web.tag.CacheTag
Sets the cron expression that should be used to expire content at specific dates and/or times.
setCronExpression(String) - Method in class com.opensymphony.oscache.util.FastCronParser
Resets the cron expression to the value supplied.
setDateHeader(String, long) - Method in class com.opensymphony.oscache.web.filter.CacheHttpServletResponseWrapper
Set the date of a header
setDisableCacheOnMethods(List) - Method in class com.opensymphony.oscache.web.filter.CacheFilter
disableCacheOnMethods - Defines the http method name for which cacheing should be disabled.
setDuration(String) - Method in class com.opensymphony.oscache.web.tag.CacheTag
Set the time this cache entry will be cached for.
setExpires(long) - Method in class com.opensymphony.oscache.web.filter.CacheFilter
expires - defines if the expires header will be sent in the response.
setExpires(long) - Method in class com.opensymphony.oscache.web.filter.ResponseContent
Sets the expires date and time in miliseconds.
setExpiresRefreshPolicy(EntryRefreshPolicy) - Method in class com.opensymphony.oscache.web.filter.CacheFilter
EntryRefreshPolicy - Class implementing the interface EntryRefreshPolicy.
setFlushTime(Date, int) - Method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Set the flush time for a specific scope to a specific time
setFlushTime(int) - Method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Set the flush time for a specific scope to the current time.
setFragment(int) - Method in class com.opensymphony.oscache.web.filter.CacheFilter
fragment - defines if this filter handles fragments of a page.
setGroup(String) - Method in class com.opensymphony.oscache.web.tag.FlushTag
The group to be flushed.
setGroup(Object) - Method in class com.opensymphony.oscache.web.tag.GroupTag
 
setGroups(String[]) - Method in class com.opensymphony.oscache.base.CacheEntry
Sets the cache groups for this entry.
setGroups(Collection) - Method in class com.opensymphony.oscache.base.CacheEntry
Sets the cache groups for this entry
setGroups(String) - Method in class com.opensymphony.oscache.web.tag.CacheTag
Sets the groups for this cache entry.
setGroups(Object) - Method in class com.opensymphony.oscache.web.tag.GroupsTag
 
setHeader(String, String) - Method in class com.opensymphony.oscache.web.filter.CacheHttpServletResponseWrapper
Set a header field
setIntHeader(String, int) - Method in class com.opensymphony.oscache.web.filter.CacheHttpServletResponseWrapper
Set the int value of the header
setKey(String) - Method in class com.opensymphony.oscache.web.tag.CacheTag
Set the key for this cache entry.
setKey(String) - Method in class com.opensymphony.oscache.web.tag.FlushTag
The key to be flushed.
setLanguage(String) - Method in class com.opensymphony.oscache.web.tag.CacheTag
Set the ISO-639 language code to distinguish different pages in application scope
setLanguage(String) - Method in class com.opensymphony.oscache.web.tag.FlushTag
Set the ISO-639 language code to distinguish different pages in application scope.
setLastModified(long) - Method in class com.opensymphony.oscache.web.filter.CacheFilter
lastModified - defines if the last modified header will be sent in the response.
setLastModified(long) - Method in class com.opensymphony.oscache.web.filter.ResponseContent
 
setLastUpdate(long) - Method in class com.opensymphony.oscache.base.CacheEntry
Set the date this CacheEntry was last updated.
setLocale(Locale) - Method in class com.opensymphony.oscache.web.filter.CacheHttpServletResponseWrapper
Set the locale
setLocale(Locale) - Method in class com.opensymphony.oscache.web.filter.ResponseContent
Set the Locale.
setMaxAge(long) - Method in class com.opensymphony.oscache.web.filter.ResponseContent
Sets the max age date and time in miliseconds.
setMaxEntries(int) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Set the cache capacity
setMaxEntries(int) - Method in class com.opensymphony.oscache.base.algorithm.UnlimitedCache
Overrides the setMaxEntries with an empty implementation.
setMemoryCaching(boolean) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Sets the memory caching flag.
setMode(String) - Method in class com.opensymphony.oscache.web.tag.CacheTag
Setting this to true prevents the cache from writing any output to the response, however the JSP content is still cached as normal.
setNocache(int) - Method in class com.opensymphony.oscache.web.filter.CacheFilter
nocache - defines which objects shouldn't be cached.
setOverflowPersistence(boolean) - Method in class com.opensymphony.oscache.base.AbstractCacheAdministrator
Sets the overflowPersistence flag
setOverflowPersistence(boolean) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Sets the overflowPersistence flag
setPattern(String) - Method in class com.opensymphony.oscache.web.tag.FlushTag
The key pattern to be flushed.
setPersistenceListener(Cache) - Method in class com.opensymphony.oscache.base.AbstractCacheAdministrator
If there is a PersistenceListener in the configuration it will be instantiated and applied to the given cache object.
setPersistenceListener(PersistenceListener) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Set the persistence listener to use.
setPersistenceListener(PersistenceListener) - Method in class com.opensymphony.oscache.base.Cache
Set the listener to use for data persistence.
setRefresh(boolean) - Method in class com.opensymphony.oscache.web.tag.CacheTag
This method allows the user to programatically decide whether the cached content should be refreshed immediately.
setRefreshPeriod(long) - Method in class com.opensymphony.oscache.web.filter.ExpiresRefreshPolicy
 
setRefreshpolicyclass(String) - Method in class com.opensymphony.oscache.web.tag.CacheTag
Class used to handle the refresh policy logic
setRefreshpolicyparam(String) - Method in class com.opensymphony.oscache.web.tag.CacheTag
Parameters that will be passed to the init method of the refresh policy instance.
setScope(String) - Method in class com.opensymphony.oscache.web.tag.CacheTag
Set the scope of this cache.
setScope(String) - Method in class com.opensymphony.oscache.web.tag.FlushTag
Set the scope of this flush.
setStatus(int) - Method in class com.opensymphony.oscache.web.filter.CacheHttpServletResponseWrapper
We override this so we can catch the response status.
setStatus(int, String) - Method in class com.opensymphony.oscache.web.filter.CacheHttpServletResponseWrapper
We override this so we can catch the response status.
setTime(int) - Method in class com.opensymphony.oscache.web.filter.CacheFilter
time - the default time (in seconds) to cache content for.
setTime(int) - Method in class com.opensymphony.oscache.web.tag.CacheTag
Set the time this cache entry will be cached for (in seconds)
setUnlimitedDiskCache(boolean) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Sets the unlimited disk caching flag.
setUse(boolean) - Method in class com.opensymphony.oscache.web.tag.UseCachedTag
Set the decision to use the body content of the ancestor <cache> or not.
setUseBody(boolean) - Method in class com.opensymphony.oscache.web.tag.CacheTag
This controls whether or not the body of the tag is evaluated or used.
setValue(Object) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.Entry
Set the value of this entry.
size() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Returns the total number of cache entries held in this map.
split(String, char) - Static method in class com.opensymphony.oscache.util.StringUtil
Splits a string into substrings based on the supplied delimiter character.
SplitServletOutputStream - Class in com.opensymphony.oscache.web.filter
Extends the base ServletOutputStream class so that the stream can be captured as it gets written.
SplitServletOutputStream(OutputStream, OutputStream) - Constructor for class com.opensymphony.oscache.web.filter.SplitServletOutputStream
Constructs a split output stream that both captures and passes through the servlet response.
sput(Object, Object, int, boolean) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
OpenSymphony BEGIN
sremove(Object, int, boolean) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
OpenSymphony BEGIN
STALE_HIT - Static variable in class com.opensymphony.oscache.base.events.CacheMapAccessEventType
Get an event type for when the data was found in the cache but was stale.
start(Properties) - Method in class com.opensymphony.oscache.hibernate.OSCacheProvider
 
startUpdate() - Method in class com.opensymphony.oscache.base.EntryUpdateState
Attempt to change the state to UPDATE_IN_PROGRESS.
StatisticListenerImpl - Class in com.opensymphony.oscache.extra
A simple implementation of a statistic reporter which uses the event listeners.
StatisticListenerImpl() - Constructor for class com.opensymphony.oscache.extra.StatisticListenerImpl
Constructor, empty for us.
stop() - Method in class com.opensymphony.oscache.hibernate.OSCacheProvider
 
store(String, Object) - Method in interface com.opensymphony.oscache.base.persistence.PersistenceListener
Stores an object in the persistent cache.
store(String, Object) - Method in class com.opensymphony.oscache.plugins.diskpersistence.AbstractDiskPersistenceListener
Stores an object in cache
store(File, Object) - Method in class com.opensymphony.oscache.plugins.diskpersistence.AbstractDiskPersistenceListener
Stores an object using the supplied file object
storeGroup(String, Set) - Method in interface com.opensymphony.oscache.base.persistence.PersistenceListener
Stores a group in the persistent cache.
storeGroup(String, Set) - Method in class com.opensymphony.oscache.plugins.diskpersistence.AbstractDiskPersistenceListener
Stores a group in the persistent cache.
StringUtil - Class in com.opensymphony.oscache.util
Provides common utility methods for handling strings.

T

tab - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.HashIterator
 
table - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
The hash table data.
threshold - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
The table is rehashed when its size exceeds this threshold.
toMap() - Method in class com.opensymphony.oscache.hibernate.OSCache
 
toString() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.Entry
 
toString() - Method in class com.opensymphony.oscache.base.events.CacheEntryEvent
 
toString() - Method in class com.opensymphony.oscache.base.events.CacheGroupEvent
 
toString() - Method in class com.opensymphony.oscache.base.events.CachePatternEvent
 
toString() - Method in class com.opensymphony.oscache.extra.CacheEntryEventListenerImpl
Returns the internal values in a string form
toString() - Method in class com.opensymphony.oscache.extra.CacheMapAccessEventListenerImpl
Return the counters in a string form
toString() - Method in class com.opensymphony.oscache.extra.ScopeEventListenerImpl
Returns all the flush counter in a string form.
toString() - Method in class com.opensymphony.oscache.extra.StatisticListenerImpl
Return the counters in a string form.
toString() - Method in class com.opensymphony.oscache.plugins.clustersupport.ClusterNotification
 
type - Variable in class com.opensymphony.oscache.plugins.clustersupport.ClusterNotification
The type of notification message.

U

UNLIMITED - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Max number of element in cache when considered unlimited.
UnlimitedCache - Class in com.opensymphony.oscache.base.algorithm
A simple unlimited cache that has no upper bound to the number of cache entries it can contain.
UnlimitedCache() - Constructor for class com.opensymphony.oscache.base.algorithm.UnlimitedCache
Creates an unlimited cache by calling the super class's constructor with an UNLIMITED maximum number of entries.
unlimitedDiskCache - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Use unlimited disk caching.
unlock(Object) - Method in class com.opensymphony.oscache.hibernate.OSCache
 
update(Object, Object) - Method in class com.opensymphony.oscache.hibernate.OSCache
 
UPDATE_CANCELLED - Static variable in class com.opensymphony.oscache.base.EntryUpdateState
Update cancelled state
UPDATE_COMPLETE - Static variable in class com.opensymphony.oscache.base.EntryUpdateState
Update complete state
UPDATE_IN_PROGRESS - Static variable in class com.opensymphony.oscache.base.EntryUpdateState
Update in progress state
UseCachedTag - Class in com.opensymphony.oscache.web.tag
UseCachedTag is a tag that tells a <cache> tag to reuse the cached body.
UseCachedTag() - Constructor for class com.opensymphony.oscache.web.tag.UseCachedTag
 

V

value - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.Entry
 
valueBound(HttpSessionBindingEvent) - Method in class com.opensymphony.oscache.web.ServletCache
When this Cache is bound to the session, do nothing.
values - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
 
values() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Returns a collection view of the values contained in this map.
valueUnbound(HttpSessionBindingEvent) - Method in class com.opensymphony.oscache.web.ServletCache
When the users's session ends, all listeners are finalized and the session cache directory is deleted from disk.

W

WebEntryRefreshPolicy - Interface in com.opensymphony.oscache.web
Interface to implement an entry refresh policy.
write(int) - Method in class com.opensymphony.oscache.web.filter.SplitServletOutputStream
Writes the incoming data to both the output streams.
write(byte[]) - Method in class com.opensymphony.oscache.web.filter.SplitServletOutputStream
Writes the incoming data to both the output streams.
write(byte[], int, int) - Method in class com.opensymphony.oscache.web.filter.SplitServletOutputStream
Writes the incoming data to both the output streams.
writeTo(ServletResponse) - Method in class com.opensymphony.oscache.web.filter.ResponseContent
Writes this cached data out to the supplied ServletResponse.
writeTo(ServletResponse, boolean, boolean) - Method in class com.opensymphony.oscache.web.filter.ResponseContent
Writes this cached data out to the supplied ServletResponse.

A B C D E F G H I J K L M N O P R S T U V W
OSCache Project Page