Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
 PREV   NEXT FRAMES    NO FRAMES    
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, int) - 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.
CachePersistenceException(String, Throwable) - Constructor for exception com.opensymphony.oscache.base.persistence.CachePersistenceException
 
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
 
ETAG_OFF - Static variable in class com.opensymphony.oscache.web.filter.CacheFilter
 
ETAG_WEAK - Static variable in class com.opensymphony.oscache.web.filter.CacheFilter
 
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
getContentDisposition() - Method in class com.opensymphony.oscache.web.filter.ResponseContent
 
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.