Serialized Form

Package org.apache.jcs.access.exception

Class org.apache.jcs.access.exception.CacheException extends org.apache.commons.lang.exception.NestableException implements Serializable

Class org.apache.jcs.access.exception.InvalidArgumentException extends CacheException implements Serializable

Class org.apache.jcs.access.exception.InvalidGroupException extends CacheException implements Serializable

Class org.apache.jcs.access.exception.InvalidHandleException extends CacheException implements Serializable

Class org.apache.jcs.access.exception.NotARetrievableObjectException extends CacheException implements Serializable

Class org.apache.jcs.access.exception.NullObjectException extends CacheException implements Serializable

Class org.apache.jcs.access.exception.ObjectExistsException extends CacheException implements Serializable

Class org.apache.jcs.access.exception.ObjectNotFoundException extends CacheException implements Serializable

Package org.apache.jcs.access.monitor

Class org.apache.jcs.access.monitor.MonitorAccess extends java.lang.Object implements Serializable

Serialized Fields

cacheMgr

CompositeCacheManager cacheMgr

Description of the Field

Package org.apache.jcs.admin.servlet

Class org.apache.jcs.admin.servlet.JCSAdminServlet extends org.apache.velocity.servlet.VelocityServlet implements Serializable

Serialized Fields

cacheHub

CompositeCacheManager cacheHub

Package org.apache.jcs.auxiliary.disk

Class org.apache.jcs.auxiliary.disk.AbstractDiskCache extends java.lang.Object implements Serializable

Serialized Fields

purgatory

java.util.Hashtable purgatory

Map where elements are stored between being added to this cache and actually spooled to disk. This allows puts to the disk cache to return quickly, and the more expensive operation of serializing the elements to persistent storage queued for later. If the elements are pulled into the memory cache while the are still in purgatory, writing to disk can be cancelled.

cacheEventQueue

ICacheEventQueue cacheEventQueue

The CacheEventQueue where changes will be queued for asynchronous updating of the persistent storage.

lock

ReadWriteLock lock

Each instance of a Disk cache should use this lock to synchronize reads and writes to the underlying storage mechansism.

locker

ReadWriteLockManager locker

Manages locking for purgatory item manipulation.

alive

boolean alive

Indicates whether the cache is 'alive', defined as having been initialized, but not yet disposed.

cacheName

java.lang.String cacheName

Every cache will have a name, subclasses must set this when they are initialized.

purgHits

int purgHits

DEBUG: Keeps a count of the number of purgatory hits for debug messages

Class org.apache.jcs.auxiliary.disk.PurgatoryElement extends java.lang.Object implements Serializable

Serialized Fields

spoolable

boolean spoolable

Is the element ready to be spooled?

cacheElement

ICacheElement cacheElement

Wrapped cache Element

Package org.apache.jcs.auxiliary.disk.hsql

Class org.apache.jcs.auxiliary.disk.hsql.HSQLCache extends AbstractDiskCache implements Serializable

Serialized Fields

numInstances

int numInstances

isAlive

boolean isAlive

cattr

HSQLCacheAttributes cattr

cConn

java.sql.Connection cConn

sStatement

java.sql.Statement sStatement

Class org.apache.jcs.auxiliary.disk.hsql.HSQLCacheAttributes extends java.lang.Object implements Serializable

Serialized Fields

cacheName

java.lang.String cacheName

name

java.lang.String name

diskPath

java.lang.String diskPath

Class org.apache.jcs.auxiliary.disk.hsql.HSQLCacheManager extends java.lang.Object implements Serializable

Package org.apache.jcs.auxiliary.disk.indexed

Class org.apache.jcs.auxiliary.disk.indexed.IndexedDiskCache extends AbstractDiskCache implements Serializable

Serialized Fields

fileName

java.lang.String fileName

dataFile

IndexedDisk dataFile

keyFile

IndexedDisk keyFile

keyHash

java.util.HashMap keyHash

rafDir

java.io.File rafDir

cattr

IndexedDiskCacheAttributes cattr

storageLock

ReadWriteLock storageLock

Each instance of a Disk cache should use this lock to synchronize reads and writes to the underlying storage mechansism.

Class org.apache.jcs.auxiliary.disk.indexed.IndexedDiskCacheAttributes extends java.lang.Object implements Serializable

Serialized Fields

cacheName

java.lang.String cacheName

name

java.lang.String name

diskPath

java.lang.String diskPath

Class org.apache.jcs.auxiliary.disk.indexed.IndexedDiskCacheManager extends java.lang.Object implements Serializable

Serialized Fields

caches

java.util.Hashtable caches

defaultCacheAttributes

IndexedDiskCacheAttributes defaultCacheAttributes

Class org.apache.jcs.auxiliary.disk.indexed.IndexedDiskElementDescriptor extends java.lang.Object implements Serializable

Serialized Fields

pos

long pos

Position of the cache data entry on disk.

len

int len

Number of bytes the serialized form of the cache data takes.

Package org.apache.jcs.auxiliary.disk.jisp

Class org.apache.jcs.auxiliary.disk.jisp.JISPCache extends AbstractDiskCache implements Serializable

Serialized Fields

numInstances

int numInstances

isAlive

boolean isAlive

Description of the Field

cattr

JISPCacheAttributes cattr

database

com.coyotegulch.jisp.IndexedObjectDatabase database

index1

com.coyotegulch.jisp.BTreeIndex index1

jispDataFileName

java.lang.String jispDataFileName

jispIndexFileName

java.lang.String jispIndexFileName

Class org.apache.jcs.auxiliary.disk.jisp.JISPCacheAttributes extends java.lang.Object implements Serializable

Serialized Fields

cacheName

java.lang.String cacheName

name

java.lang.String name

diskPath

java.lang.String diskPath

clearOnStart

boolean clearOnStart

Class org.apache.jcs.auxiliary.disk.jisp.JISPCacheManager extends java.lang.Object implements Serializable

Class org.apache.jcs.auxiliary.disk.jisp.JISPKey extends com.coyotegulch.jisp.KeyObject implements Serializable

Serialization Methods

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Description of the Method

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Description of the Method

Package org.apache.jcs.auxiliary.lateral

Class org.apache.jcs.auxiliary.lateral.LateralCache extends java.lang.Object implements Serializable

Serialized Fields

attr

IElementAttributes attr

keyHash

java.util.HashMap keyHash

cattr

ILateralCacheAttributes cattr

cacheName

java.lang.String cacheName

lateral

ILateralCacheService lateral

either http, socket.udp, or socket.tcp can set in config

Class org.apache.jcs.auxiliary.lateral.LateralCacheAttributes extends java.lang.Object implements Serializable

Serialized Fields

transmissionTypeName

java.lang.String transmissionTypeName

transmissionType

int transmissionType

httpServers

java.lang.String httpServers

httpServer

java.lang.String httpServer

httpReceiveServlet

java.lang.String httpReceiveServlet

httpDeleteServlet

java.lang.String httpDeleteServlet

udpMulticastAddr

java.lang.String udpMulticastAddr

udpMulticastPort

int udpMulticastPort

tcpServers

java.lang.String tcpServers

tcpServer

java.lang.String tcpServer

tcpListenerPort

int tcpListenerPort

httpListenerPort

int httpListenerPort

cacheName

java.lang.String cacheName

name

java.lang.String name

putOnlyMode

boolean putOnlyMode

Class org.apache.jcs.auxiliary.lateral.LateralCacheManager extends java.lang.Object implements Serializable

Serialized Fields

caches

java.util.Map caches

lca

ILateralCacheAttributes lca

Description of the Field

clients

int clients

lateralService

ILateralCacheService lateralService

Handle to the lateral cache service; or a zombie handle if failed to connect.

lateralWatch

LateralCacheWatchRepairable lateralWatch

Wrapper of the lateral cache watch service; or wrapper of a zombie service if failed to connect.

Class org.apache.jcs.auxiliary.lateral.LateralCacheNoWait extends java.lang.Object implements Serializable

Serialized Fields

cache

LateralCache cache

q

ICacheEventQueue q

Class org.apache.jcs.auxiliary.lateral.LateralCacheNoWaitFacade extends java.lang.Object implements Serializable

Serialized Fields

noWaits

LateralCacheNoWait[] noWaits

Description of the Field

cacheName

java.lang.String cacheName

Class org.apache.jcs.auxiliary.lateral.LateralElementDescriptor extends java.lang.Object implements Serializable

Serialized Fields

ce

ICacheElement ce

Description of the Field

requesterId

byte requesterId

Description of the Field

command

int command

Description of the Field

Package org.apache.jcs.auxiliary.lateral.socket.tcp

Class org.apache.jcs.auxiliary.lateral.socket.tcp.LateralTCPListener extends java.lang.Object implements Serializable

Serialized Fields

receiver

LateralTCPListener.ListenerThread receiver

The socket listener

ilca

ILateralCacheAttributes ilca

port

int port

pooledExecutor

EDU.oswego.cs.dl.util.concurrent.PooledExecutor pooledExecutor

Package org.apache.jcs.auxiliary.remote

Class org.apache.jcs.auxiliary.remote.RemoteCache extends java.lang.Object implements Serializable

Serialized Fields

cacheName

java.lang.String cacheName

remote

IRemoteCacheService remote

irca

IRemoteCacheAttributes irca

attr

IElementAttributes attr

Class org.apache.jcs.auxiliary.remote.RemoteCacheAttributes extends java.lang.Object implements Serializable

Serialized Fields

cacheName

java.lang.String cacheName

name

java.lang.String name

remoteServiceName

java.lang.String remoteServiceName

remoteHost

java.lang.String remoteHost

remotePort

int remotePort

failoverServers

java.lang.String failoverServers

clusterServers

java.lang.String clusterServers

getFromCluster

boolean getFromCluster

localPort

int localPort

remoteType

int remoteType

failoverIndex

int failoverIndex

failovers

java.lang.String[] failovers

removeUponRemotePut

boolean removeUponRemotePut

getOnly

boolean getOnly

localClusterConsistency

boolean localClusterConsistency

Class org.apache.jcs.auxiliary.remote.RemoteCacheListener extends java.lang.Object implements Serializable

Serialized Fields

irca

IRemoteCacheAttributes irca

Description of the Field

puts

int puts

Description of the Field

removes

int removes

Description of the Field

Class org.apache.jcs.auxiliary.remote.RemoteCacheManager extends java.lang.Object implements Serializable

Serialized Fields

clients

int clients

caches

java.util.Map caches

host

java.lang.String host

port

int port

service

java.lang.String service

irca

IRemoteCacheAttributes irca

remoteService

IRemoteCacheService remoteService

Handle to the remote cache service; or a zombie handle if failed to connect.

remoteWatch

RemoteCacheWatchRepairable remoteWatch

Wrapper of the remote cache watch service; or wrapper of a zombie service if failed to connect.

Class org.apache.jcs.auxiliary.remote.RemoteCacheNoWait extends java.lang.Object implements Serializable

Serialized Fields

cache

RemoteCache cache

q

ICacheEventQueue q

Class org.apache.jcs.auxiliary.remote.RemoteCacheNoWaitFacade extends java.lang.Object implements Serializable

Serialized Fields

noWaits

RemoteCacheNoWait[] noWaits

Description of the Field

cacheName

java.lang.String cacheName

rca

RemoteCacheAttributes rca

Package org.apache.jcs.auxiliary.remote.server

Class org.apache.jcs.auxiliary.remote.server.RemoteCacheClusterManager extends java.lang.Object implements Serializable

Serialized Fields

clients

int clients

caches

java.util.Map caches

host

java.lang.String host

port

int port

service

java.lang.String service

irca

IRemoteCacheAttributes irca

remoteService

IRemoteCacheService remoteService

Handle to the remote cache service; or a zombie handle if failed to connect.

remoteWatch

RemoteCacheWatchRepairable remoteWatch

Wrapper of the remote cache watch service; or wrapper of a zombie service if failed to connect.

Class org.apache.jcs.auxiliary.remote.server.RemoteCacheServer extends java.rmi.server.UnicastRemoteObject implements Serializable

Serialized Fields

className

java.lang.String className

Description of the Field

puts

int puts

cacheListenersMap

java.util.Hashtable cacheListenersMap

clusterListenersMap

java.util.Hashtable clusterListenersMap

cacheManager

CompositeCacheManager cacheManager

idTypeMap

java.util.Hashtable idTypeMap

listenerId

int[] listenerId

rcsa

IRemoteCacheServerAttributes rcsa

Description of the Field

Class org.apache.jcs.auxiliary.remote.server.RemoteCacheServerAttributes extends java.lang.Object implements Serializable

Serialized Fields

cacheName

java.lang.String cacheName

name

java.lang.String name

remoteServiceName

java.lang.String remoteServiceName

remoteHost

java.lang.String remoteHost

remotePort

int remotePort

clusterServers

java.lang.String clusterServers

getFromCluster

boolean getFromCluster

servicePort

int servicePort

remoteType

int remoteType

removeUponRemotePut

boolean removeUponRemotePut

getOnly

boolean getOnly

localClusterConsistency

boolean localClusterConsistency

allowClusterGet

boolean allowClusterGet

configFileName

java.lang.String configFileName

Class org.apache.jcs.auxiliary.remote.server.RemoteCacheServerListener extends java.lang.Object implements Serializable

Serialized Fields

irca

IRemoteCacheAttributes irca

Description of the Field

puts

int puts

Description of the Field

removes

int removes

Package org.apache.jcs.config

Class org.apache.jcs.config.PropertySetterException extends java.lang.Exception implements Serializable

Serialized Fields

rootCause

java.lang.Throwable rootCause

Description of the Field

Package org.apache.jcs.engine

Class org.apache.jcs.engine.Attributes extends java.lang.Object implements Serializable

Serialized Fields

IS_DISTRIBUTE

boolean IS_DISTRIBUTE

Description of the Field

IS_LATERAL

boolean IS_LATERAL

Description of the Field

IS_NOFLUSH

boolean IS_NOFLUSH

Description of the Field

IS_REPLY

boolean IS_REPLY

Description of the Field

IS_SYNCHRONIZE

boolean IS_SYNCHRONIZE

Description of the Field

IS_SPOOL

boolean IS_SPOOL

Description of the Field

IS_GROUP_TTL_DESTROY

boolean IS_GROUP_TTL_DESTROY

Description of the Field

IS_ORIGINAL

boolean IS_ORIGINAL

Description of the Field

IS_REMOTE

boolean IS_REMOTE

Description of the Field

IS_ETERNAL

boolean IS_ETERNAL

Description of the Field

version

long version

Description of the Field

ttl

long ttl

Description of the Field

default_ttl

long default_ttl

Description of the Field

idle

long idle

Description of the Field

lastAccess

long lastAccess

Description of the Field

size

int size

Description of the Field

createTime

long createTime

Description of the Field

Class org.apache.jcs.engine.CacheElement extends java.lang.Object implements Serializable

Serialized Fields

cacheName

java.lang.String cacheName

Description of the Field

key

java.io.Serializable key

Description of the Field

val

java.io.Serializable val

Description of the Field

attr

ElementAttributes attr

Description of the Field

Class org.apache.jcs.engine.CompositeCacheAttributes extends java.lang.Object implements Serializable

Serialized Fields

useLateral

boolean useLateral

useRemote

boolean useRemote

useDisk

boolean useDisk

useMemoryShrinker

boolean useMemoryShrinker

maxObjs

int maxObjs

maxMemoryIdleTimeSeconds

long maxMemoryIdleTimeSeconds

maxMemoryIdleTimeSeconds

shrinkerIntervalSeconds

long shrinkerIntervalSeconds

shrinkerIntervalSeconds

cacheName

java.lang.String cacheName

memoryCacheName

java.lang.String memoryCacheName

Class org.apache.jcs.engine.ElementAttributes extends java.lang.Object implements Serializable

Serialized Fields

IS_DISTRIBUTE

boolean IS_DISTRIBUTE

Is this item distributable at all.

IS_SPOOL

boolean IS_SPOOL

can this item be flushed to disk

IS_LATERAL

boolean IS_LATERAL

Is this item laterally distributable

IS_REMOTE

boolean IS_REMOTE

Can this item be sent to the remote cache

IS_ETERNAL

boolean IS_ETERNAL

can turn off expiration

version

long version

Description of the Field

mls

long mls

Max life seconds

idle

long idle

Description of the Field

size

int size

The byte size of teh field. Must be manually set.

createTime

long createTime

The creation time

lastAccessTime

long lastAccessTime

The last access time

eventHandlers

java.util.ArrayList eventHandlers

The last access time

Package org.apache.jcs.engine.control

Class org.apache.jcs.engine.control.CompositeCache extends java.lang.Object implements Serializable

Serialized Fields

auxCaches

AuxiliaryCache[] auxCaches

alive

boolean alive

cacheName

java.lang.String cacheName

attr

IElementAttributes attr

Region Elemental Attributes, default

cacheAttr

ICompositeCacheAttributes cacheAttr

Cache Attributes, for hub and memory auxiliary

hitCountRam

int hitCountRam

Memory cache hit count

hitCountAux

int hitCountAux

Auxiliary cache hit count (number of times found in ANY auxiliary)

auxHitCountByIndex

int[] auxHitCountByIndex

Auxiliary hit counts broken down by auxiliary

missCountNotFound

int missCountNotFound

Count of misses where element was not found

missCountExpired

int missCountExpired

Count of misses where element was expired

memCache

MemoryCache memCache

The cache hub can only have one memory cache. This could be made more flexible in the future, but they are tied closely together. More than one doesn't make much sense.

Class org.apache.jcs.engine.control.CompositeCacheManager extends java.lang.Object implements Serializable

Serialized Fields

caches

java.util.Hashtable caches

Caches managed by this cache manager

systemCaches

java.util.Hashtable systemCaches

Internal system caches for this cache manager

clients

int clients

Number of clients accessing this cache manager

defaultCacheAttr

ICompositeCacheAttributes defaultCacheAttr

Default cache attributes for this cache manager

defaultElementAttr

IElementAttributes defaultElementAttr

Default elemeent attributes for this cache manager

auxFacs

java.util.Hashtable auxFacs

Used to keep track of configured auxiliaries

auxAttrs

java.util.Hashtable auxAttrs

???

props

java.util.Properties props

Properties with which this manager was configured

defaultAuxValues

java.lang.String defaultAuxValues

The default auxiliary caches to be used if not preconfigured

Package org.apache.jcs.engine.control.event

Class org.apache.jcs.engine.control.event.ElementEvent extends java.util.EventObject implements Serializable

Serialized Fields

elementEvent

int elementEvent

Class org.apache.jcs.engine.control.event.TestElementEventHandler extends java.lang.Object implements Serializable

Package org.apache.jcs.engine.control.group

Class org.apache.jcs.engine.control.group.GroupAttrName extends java.lang.Object implements Serializable

Serialized Fields

groupId

GroupId groupId

Description of the Field

attrName

java.lang.Object attrName

toString

java.lang.String toString

Class org.apache.jcs.engine.control.group.GroupId extends java.lang.Object implements Serializable

Serialized Fields

groupName

java.lang.String groupName

Description of the Field

cacheName

java.lang.String cacheName

toString

java.lang.String toString

Package org.apache.jcs.engine.memory

Class org.apache.jcs.engine.memory.AbstractMemoryCache extends java.lang.Object implements Serializable

Serialized Fields

cacheName

java.lang.String cacheName

map

java.util.Map map

Map where items are stored by key

attr

IElementAttributes attr

Region Elemental Attributes, used as a default.

cattr

ICompositeCacheAttributes cattr

Cache Attributes

cache

CompositeCache cache

The cache region this store is associated with

status

int status

chunkSize

int chunkSize

shrinker

ShrinkerThread shrinker

The background memory shrinker

Package org.apache.jcs.engine.memory.lru

Class org.apache.jcs.engine.memory.lru.LRUMemoryCache extends AbstractMemoryCache implements Serializable

Serialized Fields

first

MemoryElementDescriptor first

last

MemoryElementDescriptor last

Package org.apache.jcs.engine.memory.mru

Class org.apache.jcs.engine.memory.mru.MRUMemoryCache extends AbstractMemoryCache implements Serializable

Serialized Fields

lockMe

int[] lockMe

Description of the Field

mrulist

java.util.LinkedList mrulist

MRU list.

Package org.apache.jcs.utils.data

Class org.apache.jcs.utils.data.PropertyGroups extends java.util.Hashtable implements Serializable

Serialized Fields

props

java.util.Properties props

fileName

java.lang.String fileName

simpleKeys

int simpleKeys

compoundKeys

int compoundKeys

Package org.apache.jcs.utils.servlet.session

Class org.apache.jcs.utils.servlet.session.SessionInfo extends java.lang.Object implements Serializable

Serialized Fields

creationTime

long creationTime

lastAccessedTime

long lastAccessedTime

maxInactiveInterval

int maxInactiveInterval

At first login this might be twice the set amount, depending on the update ration.