Serialized Form

Package com.opensymphony.oscache.base

Class com.opensymphony.oscache.base.AbstractCacheAdministrator extends java.lang.Object implements Serializable

Serialized Fields

config

Config config

listenerList

javax.swing.event.EventListenerList listenerList

Holds a list of all the registered event listeners. Event listeners are specified using the AbstractCacheAdministrator.CACHE_ENTRY_EVENT_LISTENERS_KEY configuration key.

algorithmClass

java.lang.String algorithmClass

The algorithm class being used, as specified by the AbstractCacheAdministrator.CACHE_ALGORITHM_KEY configuration property.

cacheCapacity

int cacheCapacity

The cache capacity (number of entries), as specified by the AbstractCacheAdministrator.CACHE_CAPACITY_KEY configuration property.

blocking

boolean blocking

Whether the cache blocks waiting for content to be build, or serves stale content instead. This value can be specified using the AbstractCacheAdministrator.CACHE_BLOCKING_KEY configuration property.

memoryCaching

boolean memoryCaching

Whether or not to store the cache entries in memory. This is configurable using the AbstractCacheAdministrator.CACHE_MEMORY_KEY property.

overflowPersistence

boolean overflowPersistence

Whether the persistent cache should be used immediately or only when the memory capacity has been reached, ie. overflow only. This can be set via the AbstractCacheAdministrator.CACHE_PERSISTENCE_OVERFLOW_KEY configuration property.

unlimitedDiskCache

boolean unlimitedDiskCache

Whether the disk cache should be unlimited in size, or matched 1-1 to the memory cache. This can be set via the AbstractCacheAdministrator.CACHE_DISK_UNLIMITED_KEY configuration property.

Class com.opensymphony.oscache.base.Cache extends java.lang.Object implements Serializable

Serialized Fields

listenerList

javax.swing.event.EventListenerList listenerList

A list of all registered event listeners for this cache.

cacheMap

AbstractConcurrentReadCache cacheMap

The actual cache map. This is where the cached objects are held.

flushDateTime

java.util.Date flushDateTime

Date of last complete cache flush.

updateStates

java.util.Map updateStates

A map that holds keys of cache entries that are currently being built, and EntryUpdateState instance as values. This is used to coordinate threads that modify/access a same key in concurrence. The cache checks against this map when a stale entry is requested, or a cache miss is observed. If the requested key is in here, we know the entry is currently being built by another thread and hence we can either block and wait or serve the stale entry (depending on whether cache blocking is enabled or not).

To avoid data races, values in this map should remain present during the whole time distinct threads deal with the same key. We implement this using explicit reference counting in the EntryUpdateState instance, to be able to clean up the map once all threads have declared they are done accessing/updating a given key. It is not possible to locate this into the CacheEntry because this would require to have a CacheEntry instance for all cache misses, and may therefore generate a memory leak. More over, the CacheEntry instance may not be hold in memory in the case no memory cache is configured.

blocking

boolean blocking

Indicates whether the cache blocks requests until new content has been generated or just serves stale content instead.

Class com.opensymphony.oscache.base.CacheEntry extends java.lang.Object implements Serializable

Serialized Fields

policy

EntryRefreshPolicy policy

The entry refresh policy object to use for this cache entry. This is optional.

content

java.lang.Object content

The actual content that is being cached. Wherever possible this object should be serializable. This allows PersistenceListeners to serialize the cache entries to disk or database.

groups

java.util.Set groups

The set of cache groups that this cache entry belongs to, if any.

key

java.lang.String key

The unique cache key for this entry

wasFlushed

boolean wasFlushed

true if this entry was flushed

created

long created

The time this entry was created.

lastUpdate

long lastUpdate

The time this emtry was last updated.

Class com.opensymphony.oscache.base.Config extends java.lang.Object implements Serializable

Serialized Fields

properties

java.util.Properties properties

Properties map to hold the cache configuration.

Class com.opensymphony.oscache.base.FinalizationException extends java.lang.Exception implements Serializable

Class com.opensymphony.oscache.base.InitializationException extends java.lang.Exception implements Serializable

Class com.opensymphony.oscache.base.NeedsRefreshException extends java.lang.Exception implements Serializable

Serialized Fields

cacheContent

java.lang.Object cacheContent

Current object in the cache

Package com.opensymphony.oscache.base.algorithm

Class com.opensymphony.oscache.base.algorithm.AbstractConcurrentReadCache extends java.util.AbstractMap implements Serializable

Serialization Methods

readObject

private void readObject(java.io.ObjectInputStream s)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException

Reconstitute the AbstractConcurrentReadCache. instance from a stream (i.e., deserialize it).

Throws:

java.io.IOException

java.lang.ClassNotFoundException

writeObject

private void writeObject(java.io.ObjectOutputStream s)
                  throws java.io.IOException

Save the state of the AbstractConcurrentReadCache instance to a stream. (i.e., serialize it).

Serial Data:

The capacity of the AbstractConcurrentReadCache (the length of the bucket array) is emitted (int), followed by the size of the AbstractConcurrentReadCache (the number of key-value mappings), followed by the key (Object) and value (Object) for each key-value mapping represented by the AbstractConcurrentReadCache The key-value mappings are emitted in no particular order.

Throws:

java.io.IOException

Serialized Fields

barrierLock

java.lang.Boolean barrierLock

Lock used only for its memory effects. We use a Boolean because it is serializable, and we create a new one because we need a unique object for each cache instance.

persistenceListener

PersistenceListener persistenceListener

Persistence listener.

memoryCaching

boolean memoryCaching

Use memory cache or not.

unlimitedDiskCache

boolean unlimitedDiskCache

Use unlimited disk caching.

loadFactor

float loadFactor

The load factor for the hash table.

DEFAULT_MAX_ENTRIES

int DEFAULT_MAX_ENTRIES

Default cache capacity (number of entries).

UNLIMITED

int UNLIMITED

Max number of element in cache when considered unlimited.

groups

java.util.HashMap groups

A HashMap containing the group information. Each entry uses the group name as the key, and holds a Set of containing keys of all the cache entries that belong to that particular group.

maxEntries

int maxEntries

Cache capacity (number of entries).

threshold

int threshold

The table is rehashed when its size exceeds this threshold. (The value of this field is always (int)(capacity * loadFactor).)

overflowPersistence

boolean overflowPersistence

Use overflow persistence caching.

Class com.opensymphony.oscache.base.algorithm.FIFOCache extends AbstractConcurrentReadCache implements Serializable

Serialized Fields

list

java.util.Collection list

A queue containing all cache keys

isSet

boolean isSet

A flag indicating whether we are using a List or a Set for the key collection

Class com.opensymphony.oscache.base.algorithm.LRUCache extends AbstractConcurrentReadCache implements Serializable

Serialized Fields

list

java.util.Collection list

Cache queue containing all cache keys.

map

java.util.Map map

Jakarta commons collections unfortunately doesn't provide us with an ordered hash set, so we have to use their ordered map instead.

isList

boolean isList

A flag indicating if we are using a List for the key collection. This happens when we're running under JDK 1.3 or lower and there is no commons-collections in the classpath.

isMap

boolean isMap

A flag indicating if we are using a Map for the key collection. This happens when we're running under JDK 1.3 and commons-collections is available.

isSet

boolean isSet

A flag indicating if we are using a Set for the key collection. This happens when we're running under JDK 1.4 and is the best case scenario.

removeInProgress

boolean removeInProgress

A flag indicating whether there is a removal operation in progress.

Class com.opensymphony.oscache.base.algorithm.UnlimitedCache extends AbstractConcurrentReadCache implements Serializable

Package com.opensymphony.oscache.base.persistence

Class com.opensymphony.oscache.base.persistence.CachePersistenceException extends java.lang.Exception implements Serializable

Package com.opensymphony.oscache.general

Class com.opensymphony.oscache.general.GeneralCacheAdministrator extends AbstractCacheAdministrator implements Serializable

Serialized Fields

applicationCache

Cache applicationCache

Application cache

Package com.opensymphony.oscache.plugins.clustersupport

Class com.opensymphony.oscache.plugins.clustersupport.ClusterNotification extends java.lang.Object implements Serializable

Serialized Fields

data

java.io.Serializable data

Any additional data that may be required

type

int type

The type of notification message.

Package com.opensymphony.oscache.plugins.diskpersistence

Class com.opensymphony.oscache.plugins.diskpersistence.AbstractDiskPersistenceListener extends java.lang.Object implements Serializable

Serialized Fields

cachePath

java.io.File cachePath

Base path where the disk cache reside.

contextTmpDir

java.io.File contextTmpDir

root

java.lang.String root

Root path for disk cache

Class com.opensymphony.oscache.plugins.diskpersistence.DiskPersistenceListener extends AbstractDiskPersistenceListener implements Serializable

Class com.opensymphony.oscache.plugins.diskpersistence.HashDiskPersistenceListener extends AbstractDiskPersistenceListener implements Serializable

Serialized Fields

md

java.security.MessageDigest md

Package com.opensymphony.oscache.web

Class com.opensymphony.oscache.web.ServletCache extends Cache implements Serializable

Serialized Fields

admin

ServletCacheAdministrator admin

The admin for this cache

scope

int scope

The scope of that cache.

Class com.opensymphony.oscache.web.ServletCacheAdministrator extends AbstractCacheAdministrator implements Serializable

Serialized Fields

flushTimes

java.util.Map flushTimes

Map containing the flush times of different scopes

cacheKey

java.lang.String cacheKey

Key to use for storing and retrieving Object in contexts (Servlet, session).

useHostDomainInKey

boolean useHostDomainInKey

Set property cache.use.host.domain.in.key=true to add domain information to key generation for hosting multiple sites.

Package com.opensymphony.oscache.web.filter

Class com.opensymphony.oscache.web.filter.ExpiresRefreshPolicy extends java.lang.Object implements Serializable

Serialized Fields

refreshPeriod

long refreshPeriod

the refresh period (in milliseconds) of a certain cache filter

Class com.opensymphony.oscache.web.filter.ResponseContent extends java.lang.Object implements Serializable

Serialized Fields

locale

java.util.Locale locale

contentEncoding

java.lang.String contentEncoding

contentType

java.lang.String contentType

content

byte[] content

expires

long expires

lastModified

long lastModified

Package com.opensymphony.oscache.web.tag

Class com.opensymphony.oscache.web.tag.CacheTag extends javax.servlet.jsp.tagext.BodyTagSupport implements Serializable

Serialized Fields

cancelUpdateRequired

boolean cancelUpdateRequired

A flag to indicate whether a NeedsRefreshException was thrown and the update needs to be cancelled

cache

Cache cache

groups

java.util.List groups

If no groups are specified, the cached content does not get put into any groups

admin

ServletCacheAdministrator admin

actualKey

java.lang.String actualKey

The actual key to use. This is generated based on the supplied key, scope etc.

content

java.lang.String content

The content that was retrieved from cache

cron

java.lang.String cron

The cron expression that is used to expire cache entries at specific dates and/or times.

key

java.lang.String key

if cache key is null, the request URI is used

language

java.lang.String language

The ISO-639 language code to distinguish different pages in application scope

refreshPolicyClass

java.lang.String refreshPolicyClass

Class used to handle the refresh policy logic

refreshPolicyParam

java.lang.String refreshPolicyParam

Parameters that will be passed to the init method of the refresh policy instance.

refresh

boolean refresh

Whether the cache should be refreshed instantly

useBody

boolean useBody

used for subtags to tell this tag that we should use the cached version

mode

int mode

The cache mode. Valid values are SILENT_MODE

scope

int scope

The cache scope to use

time

int time

time (in seconds) before cache should be refreshed

Class com.opensymphony.oscache.web.tag.FlushTag extends javax.servlet.jsp.tagext.TagSupport implements Serializable

Serialized Fields

admin

ServletCacheAdministrator admin

group

java.lang.String group

A cache group. If specified, all content in that group will be flushed

key

java.lang.String key

Tag key.

pattern

java.lang.String pattern

if pattern value is specified, all keys that contain the pattern are flushed.

scope

java.lang.String scope

cacheScope

int cacheScope

language

java.lang.String language

The ISO-639 language code to distinguish different pages in application scope.

Class com.opensymphony.oscache.web.tag.GroupTag extends javax.servlet.jsp.tagext.TagSupport implements Serializable

Serialized Fields

group

java.lang.Object group

Class com.opensymphony.oscache.web.tag.UseCachedTag extends javax.servlet.jsp.tagext.TagSupport implements Serializable

Serialized Fields

use

boolean use