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

A

ALL_SCOPES_FLUSHED - Static variable in class com.opensymphony.oscache.base.events.ScopeEventType
Specifies an event type for the all scope flushed event.
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
 
AbstractCacheAdministrator - class com.opensymphony.oscache.base.AbstractCacheAdministrator.
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 com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.
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 com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.Entry.
AbstractConcurrentReadCache collision list entry.
AbstractConcurrentReadCache.HashIterator - class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.HashIterator.
 
AbstractConcurrentReadCache.HashIterator() - Constructor for class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.HashIterator
 
AbstractConcurrentReadCache.KeyIterator - class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.KeyIterator.
 
AbstractConcurrentReadCache.KeyIterator() - Constructor for class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.KeyIterator
 
AbstractConcurrentReadCache.ValueIterator - class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.ValueIterator.
 
AbstractConcurrentReadCache.ValueIterator() - Constructor for class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.ValueIterator
 
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
addCacheEventListener(CacheEventListener, Class) - Method in class com.opensymphony.oscache.base.Cache
Register a listener for Cache events.
addScopeEventListener(ScopeEventListener) - Method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Register a listener for Cache Map events.
algorithmClass - Variable in class com.opensymphony.oscache.base.AbstractCacheAdministrator
The algorithm class being used, as specified by the AbstractCacheAdministrator.CACHE_ALGORITHM_KEY configuration property.

B

barrierLock - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Lock used only for its memory effects.

C

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 - Static variable in class com.opensymphony.oscache.base.AbstractCacheAdministrator
A String cache configuration property that holds a comma-delimited list of classnames.
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 - class com.opensymphony.oscache.base.Cache.
Provides an interface to the cache itself.
Cache(boolean, boolean) - Constructor for class com.opensymphony.oscache.base.Cache
Create a new Cache
Cache(boolean, boolean, boolean, String, int) - Constructor for class com.opensymphony.oscache.base.Cache
Create a new Cache.
CacheContextListener - class com.opensymphony.oscache.web.CacheContextListener.
 
CacheContextListener() - Constructor for class com.opensymphony.oscache.web.CacheContextListener
 
CacheEntry - class com.opensymphony.oscache.base.CacheEntry.
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.
CacheEntryEvent - class com.opensymphony.oscache.base.events.CacheEntryEvent.
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 com.opensymphony.oscache.base.events.CacheEntryEventListener.
This is the interface to listen to cache entry events.
CacheEntryEventListenerImpl - class com.opensymphony.oscache.extra.CacheEntryEventListenerImpl.
Implementation of a CacheEntryEventListener.
CacheEntryEventListenerImpl() - Constructor for class com.opensymphony.oscache.extra.CacheEntryEventListenerImpl
Constructor, empty for us
CacheEntryEventType - class com.opensymphony.oscache.base.events.CacheEntryEventType.
This is all the possible events that may occur on a cache entry or collection of cache entries.
CacheEvent - class com.opensymphony.oscache.base.events.CacheEvent.
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 com.opensymphony.oscache.base.events.CacheEventListener.
This is the base interface for cache events.
CacheFilter - class com.opensymphony.oscache.web.filter.CacheFilter.
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
 
CacheGroupEvent - class com.opensymphony.oscache.base.events.CacheGroupEvent.
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
CacheHttpServletResponseWrapper - class com.opensymphony.oscache.web.filter.CacheHttpServletResponseWrapper.
CacheServletResponse is a serialized representation of a response
CacheHttpServletResponseWrapper(HttpServletResponse) - Constructor for class com.opensymphony.oscache.web.filter.CacheHttpServletResponseWrapper
Constructor
CacheMapAccessEvent - class com.opensymphony.oscache.base.events.CacheMapAccessEvent.
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 com.opensymphony.oscache.base.events.CacheMapAccessEventListener.
This is the interface to listen to cache map access events.
CacheMapAccessEventListenerImpl - class com.opensymphony.oscache.extra.CacheMapAccessEventListenerImpl.
Implementation of a CacheMapAccessEventListener.
CacheMapAccessEventListenerImpl() - Constructor for class com.opensymphony.oscache.extra.CacheMapAccessEventListenerImpl
Constructor, empty for us
CacheMapAccessEventType - class com.opensymphony.oscache.base.events.CacheMapAccessEventType.
This is an enumeration of the cache events that represent the various outcomes of cache accesses.
CachePatternEvent - class com.opensymphony.oscache.base.events.CachePatternEvent.
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
CachePersistenceException - exception com.opensymphony.oscache.base.persistence.CachePersistenceException.
Exception thrown when an error occurs in a PersistenceListener implementation.
CachePersistenceException() - Constructor for class com.opensymphony.oscache.base.persistence.CachePersistenceException
Creates new CachePersistenceException without detail message.
CachePersistenceException(String) - Constructor for class com.opensymphony.oscache.base.persistence.CachePersistenceException
Constructs an CachePersistenceException with the specified detail message.
CacheTag - class com.opensymphony.oscache.web.tag.CacheTag.
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 com.opensymphony.oscache.base.events.CachewideEvent.
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 com.opensymphony.oscache.base.events.CachewideEventType.
This is an enumeration holding all the events that can occur at the cache-wide level.
ClassLoaderUtil - class com.opensymphony.oscache.util.ClassLoaderUtil.
This code is borrowed directly from OSCore, but is duplicated here to avoid having to add a dependency on the entire OSCore jar.
ClassLoaderUtil() - Constructor for class com.opensymphony.oscache.util.ClassLoaderUtil
 
Config - class com.opensymphony.oscache.base.Config.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
clear() - Method in class com.opensymphony.oscache.base.Cache
Completely clears the cache.
clear() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Removes all mappings from this map.
clear() - Method in interface com.opensymphony.oscache.base.persistence.PersistenceListener
Clear the entire persistent cache (including the root)
clone() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.Entry
 
clone() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Returns a shallow copy of this.
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.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
 
configure(Config) - Method in interface com.opensymphony.oscache.base.persistence.PersistenceListener
Allow the persistence code to initialize itself based on the supplied cache configuration.
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.
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.
currentKey - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.HashIterator
 
currentValue - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.HashIterator
 

D

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.web.filter.CacheFilter
Filter clean-up
destroyInstance(ServletContext) - Static method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Shuts down the cache administrator.
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.GroupTag
 
doStartTag() - Method in class com.opensymphony.oscache.web.tag.UseCachedTag
The start tag.

E

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 com.opensymphony.oscache.base.EntryRefreshPolicy.
Interface that allows custom code to be called when checking to see if a cache entry has expired.
EntryUpdateState - class com.opensymphony.oscache.base.EntryUpdateState.
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
 
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
 
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.
equals(Object) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.Entry
 

F

FIFOCache - class com.opensymphony.oscache.base.algorithm.FIFOCache.
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.
FastCronParser - class com.opensymphony.oscache.util.FastCronParser.
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.
FinalizationException - exception com.opensymphony.oscache.base.FinalizationException.
Thrown by LifecycleAware listeners that are not able to finalize themselves.
FinalizationException() - Constructor for class com.opensymphony.oscache.base.FinalizationException
 
FinalizationException(String) - Constructor for class com.opensymphony.oscache.base.FinalizationException
 
FlushTag - class com.opensymphony.oscache.web.tag.FlushTag.
FlushTag flushes caches created with <cache>.
FlushTag() - Constructor for class com.opensymphony.oscache.web.tag.FlushTag
 
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.
flush() - Method in class com.opensymphony.oscache.base.CacheEntry
Flush the entry from cache.
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.

G

GROUP_FLUSHED - Static variable in class com.opensymphony.oscache.base.events.CacheEntryEventType
Get an event type for a group flush event.
GeneralCacheAdministrator - class com.opensymphony.oscache.general.GeneralCacheAdministrator.
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
GroupTag - class com.opensymphony.oscache.web.tag.GroupTag.
GroupTag is a tag that adds a group to an ancestor CacheTag's groups.
GroupTag() - Constructor for class com.opensymphony.oscache.web.tag.GroupTag
 
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.Config
 
get(Object) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Returns the value to which the specified key is mapped in this table.
getAppScopeCache(ServletContext) - Method in class com.opensymphony.oscache.web.ServletCacheAdministrator
A convenience method to retrieve the application scope cache
getApplicationScopeFlushCount() - Method in class com.opensymphony.oscache.extra.ScopeEventListenerImpl
Gets the flush count for scope ScopeEventListenerImpl.APPLICATION_SCOPE.
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(HttpServletRequest, int) - Method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Grabs the cache for the specified scope
getCacheContent() - Method in class com.opensymphony.oscache.base.NeedsRefreshException
Retrieve current object in the cache
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.
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.
getCacheFlushedCount() - Method in class com.opensymphony.oscache.extra.CacheEntryEventListenerImpl
Gets the cache flush counter
getCacheKey() - Method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Get the cache key from the properties.
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
getCreated() - Method in class com.opensymphony.oscache.base.CacheEntry
Get the date this CacheEntry was created.
getCronExpression() - Method in class com.opensymphony.oscache.util.FastCronParser
Retrieves the current cron expression.
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
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.
getExpressionSummary() - Method in class com.opensymphony.oscache.util.FastCronParser
Recreates the original human-readable cron expression based on the internal datastructure values.
getFlushTime(int) - Method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Get the flush time for a particular scope.
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
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
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
getKey() - Method in class com.opensymphony.oscache.base.CacheEntry
Get the key of this CacheEntry
getKey() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.Entry
 
getKey() - Method in class com.opensymphony.oscache.base.events.CacheEntryEvent
Retrieve the cache entry key
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.
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
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.Cache
Retrieves the currently configured PersistenceListener.
getPersistenceListener() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Get the persistence listener.
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.
getRequestScopeFlushCount() - Method in class com.opensymphony.oscache.extra.ScopeEventListenerImpl
Gets the flush count for scope ScopeEventListenerImpl.REQUEST_SCOPE.
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.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.
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
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
getTimeBefore(long) - Method in class com.opensymphony.oscache.util.FastCronParser
Find the most recent time that matches this cron expression.
getTotalScopeFlushCount() - Method in class com.opensymphony.oscache.extra.ScopeEventListenerImpl
Returns the total flush count.
getUpdateState(String) - Method in class com.opensymphony.oscache.base.Cache
Get the updating cache entry from the update map.
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
groups - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
A HashMap containing the group information.

H

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.
HIT - Static variable in class com.opensymphony.oscache.base.events.CacheMapAccessEventType
Get an event type for a cache hit.
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
 
hash - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.Entry
 
hashCode() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.Entry
 

I

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.
InitializationException - exception com.opensymphony.oscache.base.InitializationException.
Thrown by LifecycleAware listeners that are not able to initialize themselves.
InitializationException() - Constructor for class com.opensymphony.oscache.base.InitializationException
 
InitializationException(String) - Constructor for class com.opensymphony.oscache.base.InitializationException
 
index - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.HashIterator
 
init(String, String) - Method in interface com.opensymphony.oscache.web.WebEntryRefreshPolicy
Initializes the refresh policy.
init(FilterConfig) - Method in class com.opensymphony.oscache.web.filter.CacheFilter
Initialize the filter.
initialize(Cache, Config) - Method in interface com.opensymphony.oscache.base.LifecycleAware
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.
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.
isComplete() - Method in class com.opensymphony.oscache.base.EntryUpdateState
The update of the cache entry has been completed.
isEmpty() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Returns true if this map contains no key-value mappings.
isFlushed(CacheEntry) - Method in class com.opensymphony.oscache.base.Cache
Checks if the cache was flushed more recently than the CacheEntry provided.
isGroupStored(String) - Method in interface com.opensymphony.oscache.base.persistence.PersistenceListener
Verify if a group is currently stored in the persistent 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.
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.
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.
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.

K

key - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache.Entry
 
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.
keys() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Returns an enumeration of the keys in this table.

L

LRUCache - class com.opensymphony.oscache.base.algorithm.LRUCache.
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.
LifecycleAware - interface com.opensymphony.oscache.base.LifecycleAware.
Event handlers implement this so they can be notified when a cache is created and also when it is destroyed.
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.
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
log - Static variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
 
logError(String) - Method in class com.opensymphony.oscache.web.ServletCacheAdministrator
Log error messages to commons logging.

M

MISS - Static variable in class com.opensymphony.oscache.base.events.CacheMapAccessEventType
Get an event type for a cache miss.
maxEntries - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Cache capacity (number of entries).
memoryCaching - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Use memory cache or not.

N

NB_SCOPES - Static variable in class com.opensymphony.oscache.extra.ScopeEventListenerImpl
Number of known scopes
NESTED_EVENT - Static variable in class com.opensymphony.oscache.base.Cache
An event that origininated from within another event.
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
 
NeedsRefreshException - exception com.opensymphony.oscache.base.NeedsRefreshException.
This exception is thrown when retrieving an item from cache and it is expired.
NeedsRefreshException(Object) - Constructor for class com.opensymphony.oscache.base.NeedsRefreshException
Create a NeedsRefreshException
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.
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
 

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.

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.
PERSISTENCE_CLASS - 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 - interface com.opensymphony.oscache.base.persistence.PersistenceListener.
Defines the methods that are required to persist cache data.
persistClear() - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Removes the entire cache from persistent storage.
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.
persistenceListener - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Persistence listener.
put(Object, Object) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
OpenSymphony BEGIN
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

REQUEST_SCOPE - Static variable in class com.opensymphony.oscache.extra.ScopeEventListenerImpl
Request scope number
ResponseContent - class com.opensymphony.oscache.web.filter.ResponseContent.
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
 
readObject(ObjectInputStream) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Reconstitute the AbstractConcurrentReadCache.
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.
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
removeCacheEventListener(CacheEventListener, Class) - 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.
removeGroup(String) - Method in interface com.opensymphony.oscache.base.persistence.PersistenceListener
Removes a group from the persistent 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.
reset() - Method in class com.opensymphony.oscache.extra.CacheMapAccessEventListenerImpl
Resets all of the totals to zero
retrieve(String) - Method in interface com.opensymphony.oscache.base.persistence.PersistenceListener
Retrieves an object from the persistent cache.
retrieveGroup(String) - Method in interface com.opensymphony.oscache.base.persistence.PersistenceListener
Retrieves a group from the persistent cache.
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.
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
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.
ScopeEvent - class com.opensymphony.oscache.base.events.ScopeEvent.
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 com.opensymphony.oscache.base.events.ScopeEventListener.
This is the interface to listen to scope events.
ScopeEventListenerImpl - class com.opensymphony.oscache.extra.ScopeEventListenerImpl.
Implementation of a ScopeEventListener that keeps track of the scope flush events.
ScopeEventListenerImpl() - Constructor for class com.opensymphony.oscache.extra.ScopeEventListenerImpl
 
ScopeEventType - class com.opensymphony.oscache.base.events.ScopeEventType.
This is an enumeration of all the possible events that may occur at the scope level.
ServletCache - class com.opensymphony.oscache.web.ServletCache.
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 com.opensymphony.oscache.web.ServletCacheAdministrator.
A ServletCacheAdministrator creates, flushes and administers the cache.
SplitServletOutputStream - class com.opensymphony.oscache.web.filter.SplitServletOutputStream.
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.
StringUtil - class com.opensymphony.oscache.util.StringUtil.
Provides common utility methods for handling strings.
StringUtil() - Constructor for class com.opensymphony.oscache.util.StringUtil
 
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.
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.
sendRedirect(String) - Method in class com.opensymphony.oscache.web.filter.CacheHttpServletResponseWrapper
 
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).
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.
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.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
setDuration(String) - Method in class com.opensymphony.oscache.web.tag.CacheTag
Set the time this cache entry will be cached for.
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.
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.
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.
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.
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.
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.Cache
Set the listener to use for data persistence.
setPersistenceListener(PersistenceListener) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Set the persistence listener to use.
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.
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.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.
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
startUpdate() - Method in class com.opensymphony.oscache.base.EntryUpdateState
Attempt to change the state to UPDATE_IN_PROGRESS.
store(String, Object) - Method in interface com.opensymphony.oscache.base.persistence.PersistenceListener
Stores an object in the persistent cache.
storeGroup(String, Set) - Method in interface com.opensymphony.oscache.base.persistence.PersistenceListener
Stores a group in the persistent cache.

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

U

UNLIMITED - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Max number of element in cache when considered unlimited.
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
UnlimitedCache - class com.opensymphony.oscache.base.algorithm.UnlimitedCache.
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.
UseCachedTag - class com.opensymphony.oscache.web.tag.UseCachedTag.
UseCachedTag is a tag that tells a <cache> tag to reuse the cached body.
UseCachedTag() - Constructor for class com.opensymphony.oscache.web.tag.UseCachedTag
 
unlimitedDiskCache - Variable in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Use unlimited disk caching.

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

W

WebEntryRefreshPolicy - interface com.opensymphony.oscache.web.WebEntryRefreshPolicy.
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.
writeObject(ObjectOutputStream) - Method in class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache
Save the state of the AbstractConcurrentReadCache instance to a stream.
writeTo(ServletResponse) - 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 K L M N O P R S T U V W
See www.opensymphony.com for more information.