|
||||||||||
PREV NEXT | FRAMES NO FRAMES |
AbstractCacheAdministrator.CACHE_ALGORITHM_KEY
configuration property.
AbstractCacheAdministrator.CACHE_CAPACITY_KEY
configuration property.
Serializable
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.
- ClassLoaderUtil() -
Constructor for class com.opensymphony.oscache.util.ClassLoaderUtil
-
- 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.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
-
- 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.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
-
- 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
-
- 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
-
HttpServletResponse
object so that the output stream can be caught.
"* * * * *".
- 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_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
-
ScopeEventListenerImpl.APPLICATION_SCOPE
.
CacheEventListener
classes that are specified in the OSCache configuration file.
ScopeEventListenerImpl.PAGE_SCOPE
.
PersistenceListener
.
ScopeEventListenerImpl.REQUEST_SCOPE
.
ScopeEventListenerImpl.SESSION_SCOPE
.
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.
LifecycleAware
listeners that are not able to initialize
themselves.itemPut
with an empty implementation.
itemRetrieved
with an empty implementation.
AbstractBroadcastingListener
based on
the JavaGroups library.CacheEntry
needs to be refreshed.
CacheEntry
needs to be refreshed.
null
since items should
never end up being removed from an unlimited cache!
null
if the group
file could not be found.
ScopeEvent
is created when an event occurs across one or all scopes.setMaxEntries
with an empty implementation.
true
prevents the cache from writing any output
to the response, however the JSP content is still cached as normal.
PersistenceListener
in the configuration
it will be instantiated and applied to the given cache object.
ServletOutputStream
class so that
the stream can be captured as it gets written.UPDATE_IN_PROGRESS
.
UNLIMITED
maximum number of entries.
ServletResponse
.
ServletResponse
.
|
OSCache Project Page | |||||||||
PREV NEXT | FRAMES NO FRAMES |