Serialized Form


Package org.apache.jcs.access.exception

Class org.apache.jcs.access.exception.CacheException extends java.lang.Exception implements Serializable

serialVersionUID: 8725795372935590265L

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

serialVersionUID: -6058373692208755562L

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

serialVersionUID: -5219807114008843480L

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

serialVersionUID: -5947822454839845924L

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

serialVersionUID: 4501711027054012410L

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

serialVersionUID: 827922769279844194L

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

serialVersionUID: -3779745827993383872L

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

serialVersionUID: 5684353421076546842L


Package org.apache.jcs.access.monitor

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

serialVersionUID: 1002037665133774391L

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

serialVersionUID: -5519844149238645275L


Package org.apache.jcs.auxiliary

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

serialVersionUID: -1285708398502576617L

Serialized Fields

cacheEventLogger

ICacheEventLogger cacheEventLogger
An optional event logger


elementSerializer

IElementSerializer elementSerializer
The serializer. Uses a standard serializer by default.


keyMatcher

IKeyMatcher keyMatcher
Key matcher used by the getMatching API

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

serialVersionUID: -6594609334959187673L

Serialized Fields

cacheName

java.lang.String cacheName
cacheName


name

java.lang.String name
name


eventQueueType

java.lang.String eventQueueType
eventQueueType -- custom classname, pooled, or single threaded


eventQueuePoolName

java.lang.String eventQueuePoolName
Named when pooled

Class org.apache.jcs.auxiliary.AbstractAuxiliaryCacheEventLogging extends AbstractAuxiliaryCache implements Serializable

serialVersionUID: -3921738303365238919L


Package org.apache.jcs.auxiliary.disk

Class org.apache.jcs.auxiliary.disk.AbstractDiskCache extends AbstractAuxiliaryCacheEventLogging implements Serializable

serialVersionUID: 6541664080877628324L

Serialized Fields

dcattr

IDiskCacheAttributes dcattr
Generic disk cache attributes


purgatory

java.util.Map<K,V> 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 canceled.


cacheEventQueue

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


alive

boolean alive
Indicates whether the cache is 'alive': 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


removeAllLock

EDU.oswego.cs.dl.util.concurrent.WriterPreferenceReadWriteLock removeAllLock
We lock here, so that we cannot get an update after a remove all. an individual removal locks the item.

Class org.apache.jcs.auxiliary.disk.AbstractDiskCacheAttributes extends AbstractAuxiliaryCacheAttributes implements Serializable

serialVersionUID: 8306631920391711229L

Serialized Fields

diskPath

java.lang.String diskPath
path to disk


allowRemoveAll

boolean allowRemoveAll
if this is false, we will not execute remove all


maxPurgatorySize

int maxPurgatorySize
default to 5000


shutdownSpoolTimeLimit

int shutdownSpoolTimeLimit
This default determines how long the shutdown will wait for the key spool and data defrag to finish.

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

serialVersionUID: 7562753543611662136L

Serialized Fields

cacheEventLogger

ICacheEventLogger cacheEventLogger
The event logger.


elementSerializer

IElementSerializer elementSerializer
The serializer.

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

serialVersionUID: -8152034342684135628L

Serialized Fields

spoolable

boolean spoolable
Is the element ready to be spooled?


cacheElement

ICacheElement cacheElement
Wrapped cache Element


Package org.apache.jcs.auxiliary.disk.behavior

Package org.apache.jcs.auxiliary.disk.block

Class org.apache.jcs.auxiliary.disk.block.BlockDiskCache extends AbstractDiskCache implements Serializable

serialVersionUID: 1L

Serialized Fields

logCacheName

java.lang.String logCacheName
The name to prefix all log messages with.


fileName

java.lang.String fileName
The name of the file to store data.


dataFile

BlockDisk dataFile
The data access object


blockDiskCacheAttributes

BlockDiskCacheAttributes blockDiskCacheAttributes
Attributes governing the behavior of the block disk cache.


rootDirectory

java.io.File rootDirectory
The root directory for keys and data.


keyStore

BlockDiskKeyStore keyStore
Store, loads, and persists the keys


storageLock

EDU.oswego.cs.dl.util.concurrent.WriterPreferenceReadWriteLock storageLock
Use this lock to synchronize reads and writes to the underlying storage mechansism. We don't need a reentrant lock, since we only lock one level.

Class org.apache.jcs.auxiliary.disk.block.BlockDiskCacheAttributes extends AbstractDiskCacheAttributes implements Serializable

serialVersionUID: 6568840097657265989L

Serialized Fields

blockSizeBytes

int blockSizeBytes
The size per block in bytes.


maxKeySize

int maxKeySize
-1 means no limit.


keyPersistenceIntervalSeconds

long keyPersistenceIntervalSeconds
The keys will be persisted at this interval. -1 mean never.

Class org.apache.jcs.auxiliary.disk.block.BlockDiskCacheManager extends AbstractDiskCacheManager implements Serializable

serialVersionUID: -4153287154512274626L

Serialized Fields

caches

java.util.Hashtable<K,V> caches
block disks for a region.


defaultCacheAttributes

BlockDiskCacheAttributes defaultCacheAttributes
Attributes.

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

serialVersionUID: -1400659301208101411L

Serialization Methods

readExternal

public void readExternal(java.io.ObjectInput input)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Saves on reflection.

(non-Javadoc)

Throws:
java.io.IOException
java.lang.ClassNotFoundException
See Also:
Externalizable.readExternal(java.io.ObjectInput)

writeExternal

public void writeExternal(java.io.ObjectOutput output)
                   throws java.io.IOException
Saves on reflection.

(non-Javadoc)

Throws:
java.io.IOException
See Also:
Externalizable.writeExternal(java.io.ObjectOutput)

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

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

serialVersionUID: -265035607729729629L

Serialized Fields

logCacheName

java.lang.String logCacheName
Cache name used in log messages


fileName

java.lang.String fileName
The name of the file where the data is stored


dataFile

org.apache.jcs.auxiliary.disk.indexed.IndexedDisk dataFile
The IndexedDisk manages reads and writes to the data file.


keyFile

org.apache.jcs.auxiliary.disk.indexed.IndexedDisk keyFile
The IndexedDisk manages reads and writes to the key file.


keyHash

java.util.Map<K,V> keyHash
Map containing the keys and disk offsets.


maxKeySize

int maxKeySize
The maximum number of keys that we will keep in memory.


rafDir

java.io.File rafDir
A handle on the data file.


doRecycle

boolean doRecycle
Should we keep adding to the recycle bin. False during optimization.


isRealTimeOptimizationEnabled

boolean isRealTimeOptimizationEnabled
Should we optimize real time


isShutdownOptimizationEnabled

boolean isShutdownOptimizationEnabled
Should we optimize on shutdown.


isOptimizing

boolean isOptimizing
are we currently optimizing the files


timesOptimized

int timesOptimized
The numer of times the file has been optimized.


currentOptimizationThread

java.lang.Thread currentOptimizationThread
The thread optimizing the file.


removeCount

int removeCount
used for counting the number of requests


queueInput

boolean queueInput
Should we queue puts. True when optimizing. We write the queue post optimization.


queuedPutList

java.util.LinkedList<E> queuedPutList
list where puts made during optimization are made


recycle

SortedPreferentialArray recycle
RECYLCE BIN -- array of empty spots


cattr

IndexedDiskCacheAttributes cattr
User configurable parameters


recycleCnt

int recycleCnt
How many slots have we recycled.


startupSize

int startupSize
How many items were there on startup.


bytesFree

long bytesFree
the number of bytes free on disk.


hitCount

int hitCount
simple stat


storageLock

EDU.oswego.cs.dl.util.concurrent.ReentrantWriterPreferenceReadWriteLock storageLock
Use this lock to synchronize reads and writes to the underlying storage mechansism.

Class org.apache.jcs.auxiliary.disk.indexed.IndexedDiskCacheAttributes extends AbstractDiskCacheAttributes implements Serializable

serialVersionUID: -2190863599358782950L

Serialized Fields

maxKeySize

int maxKeySize
-1 means no limit.


maxRecycleBinSize

int maxRecycleBinSize
Cannot be larger than the max size. If max is less than 0, this will be 5000


optimizeAtRemoveCount

int optimizeAtRemoveCount
default to -1, i.e., don't optimize until shutdown


optimizeOnShutdown

boolean optimizeOnShutdown
Should we optimize on shutdown.

Class org.apache.jcs.auxiliary.disk.indexed.IndexedDiskCacheManager extends AbstractDiskCacheManager implements Serializable

serialVersionUID: -4153287154512274626L

Serialized Fields

caches

java.util.Hashtable<K,V> caches
Each region has an entry here.


defaultCacheAttributes

IndexedDiskCacheAttributes defaultCacheAttributes
User configurable attributes

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

serialVersionUID: -3029163572847659450L

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

Class org.apache.jcs.auxiliary.disk.jdbc.JDBCDiskCache extends AbstractDiskCache implements Serializable

serialVersionUID: -7169488308515823492L

Serialized Fields

elementSerializer

IElementSerializer elementSerializer
custom serialization


jdbcDiskCacheAttributes

JDBCDiskCacheAttributes jdbcDiskCacheAttributes
configuration


updateCount

int updateCount
# of times update was called


getCount

int getCount
# of times get was called


getMatchingCount

int getMatchingCount
# of times getMatching was called


poolAccess

JDBCDiskCachePoolAccess poolAccess
db connection pool


tableState

TableState tableState
tracks optimization

Class org.apache.jcs.auxiliary.disk.jdbc.JDBCDiskCacheAttributes extends AbstractDiskCacheAttributes implements Serializable

serialVersionUID: -6535808344813320062L

Serialized Fields

userName

java.lang.String userName
DB username


password

java.lang.String password
DB password


url

java.lang.String url
URL for the db


database

java.lang.String database
The name of the database.


driverClassName

java.lang.String driverClassName
The driver


tableName

java.lang.String tableName
The table name


testBeforeInsert

boolean testBeforeInsert
If false we will insert and if it fails we will update.


maxActive

int maxActive
Max connections allowed


shrinkerIntervalSeconds

int shrinkerIntervalSeconds
How often should we remove expired.


UseDiskShrinker

boolean UseDiskShrinker
Should we remove expired in the background.


connectionPoolName

java.lang.String connectionPoolName
If a pool name is supplied, the manager will attempt to load it. It should be configured in a separate section as follows. Assuming the name is "MyPool":
 jcs.jdbcconnectionpool.MyPool.attributes.userName=MyUserName
 jcs.jdbcconnectionpool.MyPool.attributes.password=MyPassword
 jcs.jdbcconnectionpool.MyPool.attributes.url=MyUrl
 jcs.jdbcconnectionpool.MyPool.attributes.maxActive=MyMaxActive
 jcs.jdbcconnectionpool.MyPool.attributes.driverClassName=MyDriverClassName
 

Class org.apache.jcs.auxiliary.disk.jdbc.JDBCDiskCacheManager extends JDBCDiskCacheManagerAbstractTemplate implements Serializable

serialVersionUID: -8258856770927857896L

Serialized Fields

defaultJDBCDiskCacheAttributes

JDBCDiskCacheAttributes defaultJDBCDiskCacheAttributes
User configurable settings.


compositeCacheManager

ICompositeCacheManager compositeCacheManager
The cache manager instance

Class org.apache.jcs.auxiliary.disk.jdbc.JDBCDiskCacheManagerAbstractTemplate extends AbstractDiskCacheManager implements Serializable

serialVersionUID: 218557927622128905L

Serialized Fields

shrinkerDaemon

EDU.oswego.cs.dl.util.concurrent.ClockDaemon shrinkerDaemon
The background disk shrinker, one for all regions.


shrinkerThreadMap

java.util.Map<K,V> shrinkerThreadMap
A map of table name to shrinker threads. This allows each table to have a different setting. It assumes that there is only one jdbc disk cache auxiliary defined per table.

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

serialVersionUID: -6625081552084964885L

Serialized Fields

tableName

java.lang.String tableName
Name of the table whose state this reflects.


state

int state
we might want to add error


Package org.apache.jcs.auxiliary.disk.jdbc.mysql

Class org.apache.jcs.auxiliary.disk.jdbc.mysql.MySQLDiskCache extends JDBCDiskCache implements Serializable

serialVersionUID: -7169488308515823491L

Serialized Fields

mySQLDiskCacheAttributes

MySQLDiskCacheAttributes mySQLDiskCacheAttributes
config attributes

Class org.apache.jcs.auxiliary.disk.jdbc.mysql.MySQLDiskCacheAttributes extends JDBCDiskCacheAttributes implements Serializable

serialVersionUID: -6535808344813320061L

Serialized Fields

optimizationSchedule

java.lang.String optimizationSchedule
For now this is a simple comma delimited list of HH:MM:SS times to optimize the table. If none is supplied, then no optimizations will be performed.

In the future we can add a chron like scheduling system. This is to meet a pressing current need.

03:01,15:00 will cause the optimizer to run at 3 am and at 3 pm.


balkDuringOptimization

boolean balkDuringOptimization
If true, we will balk, that is return null during optimization rather than block.

Balking

Class org.apache.jcs.auxiliary.disk.jdbc.mysql.MySQLDiskCacheManager extends JDBCDiskCacheManagerAbstractTemplate implements Serializable

serialVersionUID: -8258856770927857896L

Serialized Fields

defaultJDBCDiskCacheAttributes

MySQLDiskCacheAttributes defaultJDBCDiskCacheAttributes
User configurable atributes.


daemon

java.util.Timer daemon
for schedule optimizations


compositeCacheManager

ICompositeCacheManager compositeCacheManager
The cache manager instance


Package org.apache.jcs.auxiliary.disk.jdbc.mysql.util

Class org.apache.jcs.auxiliary.disk.jdbc.mysql.util.ScheduleFormatException extends java.lang.Exception implements Serializable

serialVersionUID: 1L


Package org.apache.jcs.auxiliary.lateral

Class org.apache.jcs.auxiliary.lateral.LateralCache extends AbstractAuxiliaryCacheEventLogging implements Serializable

serialVersionUID: 6274549256562382782L

Serialized Fields

cattr

ILateralCacheAttributes cattr
generalize this, use another interface


cacheName

java.lang.String cacheName
The region name


lateral

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


monitor

LateralCacheMonitor monitor
Monitors the connection.

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

serialVersionUID: -515393179178435508L

Serialized Fields

caches

java.util.Map<K,V> caches
Each manager instance has caches.


lca

ILateralCacheAttributes lca
Configuration


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.


cacheEventLogger

ICacheEventLogger cacheEventLogger
The event logger.


elementSerializer

IElementSerializer elementSerializer
The serializer.

Class org.apache.jcs.auxiliary.lateral.LateralCacheAttributes extends AbstractAuxiliaryCacheAttributes implements Serializable

serialVersionUID: -3408449508837393660L

Serialized Fields

transmissionTypeName

java.lang.String transmissionTypeName
THe type of lateral


transmissionType

int transmissionType
indicates the lateral type, this needs to change


httpServers

java.lang.String httpServers
The heep servers


httpServer

java.lang.String httpServer
used to identify the service that this manager will be operating on


udpMulticastAddr

java.lang.String udpMulticastAddr
this needs to change


udpMulticastPort

int udpMulticastPort
this needs to change


httpListenerPort

int httpListenerPort
this needs to change


putOnlyMode

boolean putOnlyMode
disables gets from laterals


receive

boolean receive
do we receive and broadcast or only broadcast this is useful when you don't want to get any notifications

Class org.apache.jcs.auxiliary.lateral.LateralCacheNoWait extends AbstractAuxiliaryCache implements Serializable

serialVersionUID: -7251187566116178475L

Serialized Fields

cache

LateralCache cache
The cache


eventQueue

ICacheEventQueue eventQueue
The event queue


getCount

int getCount
times get called


removeCount

int removeCount
times remove called


putCount

int putCount
times put called

Class org.apache.jcs.auxiliary.lateral.LateralCacheNoWaitFacade extends AbstractAuxiliaryCache implements Serializable

serialVersionUID: -9047687810358008955L

Serialized Fields

noWaits

LateralCacheNoWait[] noWaits
The queuing facade to the client.


cacheName

java.lang.String cacheName
The region name


lateralCacheAttributes

ILateralCacheAttributes lateralCacheAttributes
User configurable attributes.

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

serialVersionUID: 5268222498076063575L

Serialized Fields

ce

ICacheElement ce
The Cache Element that we are distributing.


requesterId

long requesterId
The id of the the source of the request. This is used to prevent infinite loops.


command

int command
The operation has been requested by the client.


valHashCode

int valHashCode
The hashcode value for this element.


Package org.apache.jcs.auxiliary.lateral.behavior

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

Class org.apache.jcs.auxiliary.lateral.socket.tcp.LateralTCPCacheManager extends LateralCacheAbstractManager implements Serializable

serialVersionUID: -9213011856644392480L

Serialized Fields

lca

ITCPLateralCacheAttributes lca
ITCPLateralCacheAttributes


clients

int clients
number of clients, we can remove this.


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.


cacheMgr

ICompositeCacheManager cacheMgr
This is set in the constructor.

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

serialVersionUID: -9107062664967131738L

Serialized Fields

receiver

LateralTCPListener.ListenerThread receiver
The socket listener


tcpLateralCacheAttributes

ITCPLateralCacheAttributes tcpLateralCacheAttributes
Configuration attributes


port

int port
Listening port


pooledExecutor

EDU.oswego.cs.dl.util.concurrent.PooledExecutor pooledExecutor
The processor. We should probably use an event queue here.


putCnt

int putCnt
put count


removeCnt

int removeCnt
remove count


getCnt

int getCnt
get count


listenerId

long listenerId
Use the vmid by default. This can be set for testing. If we ever need to run more than one per vm, then we need a new technique.

Class org.apache.jcs.auxiliary.lateral.socket.tcp.TCPLateralCacheAttributes extends LateralCacheAttributes implements Serializable

serialVersionUID: 1077889204513905220L

Serialized Fields

tcpServers

java.lang.String tcpServers
TCP --------------------------------------------


tcpServer

java.lang.String tcpServer
used to identify the service that this manager will be operating on


tcpListenerPort

int tcpListenerPort
The pot


udpDiscoveryAddr

java.lang.String udpDiscoveryAddr
udp discovery for tcp server


udpDiscoveryPort

int udpDiscoveryPort
discovery port


udpDiscoveryEnabled

boolean udpDiscoveryEnabled
discovery switch


allowPut

boolean allowPut
can we put


allowGet

boolean allowGet
can we go laterally for a get


issueRemoveOnPut

boolean issueRemoveOnPut
call remove when there is a put


filterRemoveByHashCode

boolean filterRemoveByHashCode
don't remove it the hashcode is the same


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

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

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

serialVersionUID: -5332377899560951794L

Serialized Fields

messageType

int messageType
The message type


port

int port
udp port


host

java.lang.String host
UDP host


requesterId

long requesterId
Id of the requestor, allows self-filtration


cacheNames

java.util.ArrayList<E> cacheNames
Names of regions


Package org.apache.jcs.auxiliary.remote

Class org.apache.jcs.auxiliary.remote.AbstractRemoteAuxiliaryCache extends AbstractAuxiliaryCacheEventLogging implements Serializable

serialVersionUID: -5329231850422826461L

Serialized Fields

remoteCacheService

IRemoteCacheService remoteCacheService
This does the work. In an RMI instances, it will be a remote reference. In an http remote cache it will be an http client. In zombie mode it is replaced with a balking facade.


cacheName

java.lang.String cacheName
The cacheName


remoteCacheListener

IRemoteCacheListener remoteCacheListener
The listener. This can be null.


remoteCacheAttributes

IRemoteCacheAttributes remoteCacheAttributes
The configuration values. TODO, we'll need a base here.


pool

ThreadPool pool
A thread pool for gets if configured.


usePoolForGet

boolean usePoolForGet
Should we get asynchronously using a pool.

Class org.apache.jcs.auxiliary.remote.AbstractRemoteCacheNoWaitFacade extends AbstractAuxiliaryCache implements Serializable

serialVersionUID: -4529970797620747110L

Serialized Fields

noWaits

RemoteCacheNoWait[] noWaits
The connection to a remote server, or a zombie.


cacheName

java.lang.String cacheName
The cache name


remoteCacheAttributes

IRemoteCacheAttributes remoteCacheAttributes
holds failover and cluster information


compositeCacheManager

ICompositeCacheManager compositeCacheManager
A cache manager

Class org.apache.jcs.auxiliary.remote.RemoteCache extends AbstractRemoteAuxiliaryCache implements Serializable

serialVersionUID: -5329231850422826460L

Class org.apache.jcs.auxiliary.remote.RemoteCacheAttributes extends AbstractAuxiliaryCacheAttributes implements Serializable

serialVersionUID: -1555143736942374000L

Serialized Fields

remoteServiceName

java.lang.String remoteServiceName
The service name


remoteHost

java.lang.String remoteHost
server host


remotePort

int remotePort
server port


failoverServers

java.lang.String failoverServers
Failover servers will be used by local caches one at a time. Listeners will be registered with all cluster servers. If we add a get from cluster attribute we will have the ability to chain clusters and have them get from each other.


clusterServers

java.lang.String clusterServers
Cluster chain


localPort

int localPort
callback


remoteType

int remoteType
THe type of remote cache, local or cluster


failoverIndex

int failoverIndex
what failover server we are connected to.


failovers

java.lang.String[] failovers
Array of failover server addresses


removeUponRemotePut

boolean removeUponRemotePut
Should we issue a local remove if we get a put from a remote server


getOnly

boolean getOnly
Can we receive from or put to the remote. this probably shouldn't be used. Use receive.


localClusterConsistency

boolean localClusterConsistency
Should we put and get from the clusters.


threadPoolName

java.lang.String threadPoolName
default name is remote_cache_client


getTimeoutMillis

int getTimeoutMillis
must be greater than 0 for a pool to be used.


rmiSocketFactoryTimeoutMillis

int rmiSocketFactoryTimeoutMillis
read and connect timeout


receive

boolean receive
Can we receive from the server. You might have a 0 local store and keep everything on the remote. If so, you don't want to be notified of updates.


zombieQueueMaxSize

int zombieQueueMaxSize
If the primary fails, we will queue items before reconnect. This limits the number of items that can be queued.

Class org.apache.jcs.auxiliary.remote.RemoteCacheListener extends AbsractRemoteCacheListener implements Serializable

serialVersionUID: 25345252345322345L

Class org.apache.jcs.auxiliary.remote.RemoteCacheListener_Stub extends java.rmi.server.RemoteStub implements Serializable

serialVersionUID: 2L

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

serialVersionUID: 798077557166389498L

Serialized Fields

clients

int clients
Not so useful. How many getCaches over releases were called.


caches

java.util.Map<K,V> caches
Contains instances of RemoteCacheNoWait managed by a RemoteCacheManager instance.


host

java.lang.String host
The remote host


port

int port
The remote port


service

java.lang.String service
The service name


remoteCacheAttributes

IRemoteCacheAttributes remoteCacheAttributes
The configuration attributes.


cacheEventLogger

ICacheEventLogger cacheEventLogger
The event logger.


elementSerializer

IElementSerializer elementSerializer
The serializer.


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.


cacheMgr

ICompositeCacheManager cacheMgr
The cache manager listeners will need to use to get a cache.


registry

java.lang.String registry
The service found through lookup

Class org.apache.jcs.auxiliary.remote.RemoteCacheNoWait extends AbstractAuxiliaryCache implements Serializable

serialVersionUID: -3104089136003714717L

Serialized Fields

remoteCacheClient

IRemoteCacheClient remoteCacheClient
The remote cache client


cacheEventQueue

ICacheEventQueue cacheEventQueue
Event queue for queueing up calls like put and remove.


getCount

int getCount
how many times get has been called.


getMatchingCount

int getMatchingCount
how many times getMatching has been called.


getMultipleCount

int getMultipleCount
how many times getMultiple has been called.


removeCount

int removeCount
how many times remove has been called.


putCount

int putCount
how many times put has been called.

Class org.apache.jcs.auxiliary.remote.RemoteCacheNoWaitFacade extends AbstractRemoteCacheNoWaitFacade implements Serializable

serialVersionUID: -4529970797620747111L


Package org.apache.jcs.auxiliary.remote.behavior

Package org.apache.jcs.auxiliary.remote.http.client

Class org.apache.jcs.auxiliary.remote.http.client.RemoteHttpCache extends AbstractRemoteAuxiliaryCache implements Serializable

serialVersionUID: -5329231850422826461L

Serialized Fields

remoteHttpCacheAttributes

RemoteHttpCacheAttributes remoteHttpCacheAttributes
Keep the child copy here for the restore process.

Class org.apache.jcs.auxiliary.remote.http.client.RemoteHttpCacheAttributes extends RemoteCacheAttributes implements Serializable

serialVersionUID: -5944327125140505212L

Serialized Fields

maxConnectionsPerHost

int maxConnectionsPerHost
The max connections allowed per host


socketTimeoutMillis

int socketTimeoutMillis
The socket timeout.


connectionTimeoutMillis

int connectionTimeoutMillis
The socket connections timeout


httpVersion

java.lang.String httpVersion
http verison to use.


includeCacheNameAsParameter

boolean includeCacheNameAsParameter
The cache name will be included on the parameters


includeKeysAndPatternsAsParameter

boolean includeKeysAndPatternsAsParameter
keys and patterns will be included in the parameters


includeRequestTypeasAsParameter

boolean includeRequestTypeasAsParameter
keys and patterns will be included in the parameters


url

java.lang.String url
The complete URL to the service.


remoteHttpClientClassName

java.lang.String remoteHttpClientClassName
This allows users to inject their own client implementation.

Class org.apache.jcs.auxiliary.remote.http.client.RemoteHttpCacheManager extends java.lang.Object implements Serializable

serialVersionUID: 798077557166389498L

Serialized Fields

remoteCacheAttributes

IRemoteCacheAttributes remoteCacheAttributes
The configuration attributes.


cacheEventLogger

ICacheEventLogger cacheEventLogger
The event logger.


elementSerializer

IElementSerializer elementSerializer
The serializer.


cacheMgr

ICompositeCacheManager cacheMgr
The cache manager listeners will need to use to get a cache.


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

Class org.apache.jcs.auxiliary.remote.http.server.RemoteHttpCacheServerAttributes extends AbstractAuxiliaryCacheAttributes implements Serializable

serialVersionUID: -3987239306108780496L

Serialized Fields

localClusterConsistency

boolean localClusterConsistency
Can a cluster remote put to other remotes


allowClusterGet

boolean allowClusterGet
Can a cluster remote get from other remotes

Class org.apache.jcs.auxiliary.remote.http.server.RemoteHttpCacheServlet extends javax.servlet.http.HttpServlet implements Serializable

serialVersionUID: 8752849397531933346L

Serialized Fields

remoteHttpCacheServiceAdaptor

RemoteCacheServiceAdaptor remoteHttpCacheServiceAdaptor
Processes requests


serializer

StandardSerializer serializer
This needs to be standard, since the other side is standard


serviceCalls

int serviceCalls
Number of service calls.


logInterval

int logInterval
The interval at which we will log the count.


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

Class org.apache.jcs.auxiliary.remote.server.RemoteCacheServer_Stub extends java.rmi.server.RemoteStub implements Serializable

serialVersionUID: 2L

Class org.apache.jcs.auxiliary.remote.server.RemoteCacheServerAttributes extends AbstractAuxiliaryCacheAttributes implements Serializable

serialVersionUID: -2741662082869155365L

Serialized Fields

remoteServiceName

java.lang.String remoteServiceName
Name of the remote service.


remoteHost

java.lang.String remoteHost
The remote host.


remotePort

int remotePort
The registry remote port.


clusterServers

java.lang.String clusterServers
Failover servers will be used by local caches one at a time. Listeners will be registered with all cluster servers. If we add a get from cluster attribute we will have the ability to chain clusters and have them get from each other.


servicePort

int servicePort
port the server will listen to


remoteType

int remoteType
Cluster or local


removeUponRemotePut

boolean removeUponRemotePut
Remove item when put


getOnly

boolean getOnly
Ony get, don't put


localClusterConsistency

boolean localClusterConsistency
Can a cluster remote put to other remotes


allowClusterGet

boolean allowClusterGet
Can a cluster remote get from other remotes


configFileName

java.lang.String configFileName
The config file, the initializationis multistage. Remote cache then composite cache.


rmiSocketFactoryTimeoutMillis

int rmiSocketFactoryTimeoutMillis
Connect and read timeout.


DEFAULT_START_REGISTRY

boolean DEFAULT_START_REGISTRY
Should we start the registry


startRegistry

boolean startRegistry
Should we start the registry


DEFAULT_USE_REGISTRY_KEEP_ALIVE

boolean DEFAULT_USE_REGISTRY_KEEP_ALIVE
Should we try to keep the registry alive


useRegistryKeepAlive

boolean useRegistryKeepAlive
Should we try to keep the registry alive


registryKeepAliveDelayMillis

long registryKeepAliveDelayMillis
The delay between runs

Class org.apache.jcs.auxiliary.remote.server.RemoteCacheStartupServlet extends javax.servlet.http.HttpServlet implements Serializable

serialVersionUID: 1L

Serialized Fields

propsFileName

java.lang.String propsFileName
properties file name, must set prior to calling get instance


fullPropsFileName

java.lang.String fullPropsFileName
properties file name, must set prior to calling get instance

Class org.apache.jcs.auxiliary.remote.server.TimeoutConfigurableRMIScoketFactory extends java.rmi.server.RMISocketFactory implements Serializable

serialVersionUID: 1489909775271203334L

Serialized Fields

readTimeout

int readTimeout
The socket read timeout


openTimeout

int openTimeout
The socket open timeout


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

Package org.apache.jcs.auxiliary.remote.value

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

serialVersionUID: -8858447417390442569L

Serialized Fields

requestType

byte requestType
The request type specifies the type of request: get, put, remove, . .


requesterId

long requesterId
Used to identify the source. Same as listener id on the client side.


cacheName

java.lang.String cacheName
The name of the region


key

java.io.Serializable key
The key, if this request has a key.


keySet

java.util.Set<E> keySet
The keySet, if this request has a keySet. Only getMultiple requests.


pattern

java.lang.String pattern
The pattern, if this request uses a pattern. Ony getMatching requests.


cacheElement

ICacheElement cacheElement
The ICacheEleemnt, if this request contains a value. Only update requests will have this.

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

serialVersionUID: -8858447417390442568L

Serialized Fields

success

boolean success
Was the event processed without error


errorMessage

java.lang.String errorMessage
Simple error messaging


payload

java.util.Map<K,V> payload
The payload. Typically a key / ICacheElement map. A normal get will return a map with one record.


Package org.apache.jcs.engine

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

serialVersionUID: -6062305728297627263L

Serialized Fields

cacheName

java.lang.String cacheName
The name of the cache region. This is a namespace.


key

java.io.Serializable key
This is the cache key by which the value can be referenced.


val

java.io.Serializable val
This is the cached value, reference by the key.


attr

IElementAttributes attr
These attributes hold information about the element and what it is allowed to do.

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

serialVersionUID: -7265084818647601874L

Serialized Fields

cacheName

java.lang.String cacheName
The name of the cache region. This is a namespace.


key

java.io.Serializable key
This is the cache key by which the value can be referenced.


serializedValue

byte[] serializedValue
The serialized value.


elementAttributes

IElementAttributes elementAttributes
These attributes hold information about the element and what it is allowed to do.

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

serialVersionUID: 6754049978134196787L

Serialized Fields

useLateral

boolean useLateral
allow lateral caches


useRemote

boolean useRemote
allow remote caches


useDisk

boolean useDisk
Whether we should use a disk cache if it is configured.


useMemoryShrinker

boolean useMemoryShrinker
Whether or not we should run the memory shrinker thread.


maxObjs

int maxObjs
The maximum objects that the memory cache will be allowed to hold.


maxMemoryIdleTimeSeconds

long maxMemoryIdleTimeSeconds
maxMemoryIdleTimeSeconds


shrinkerIntervalSeconds

long shrinkerIntervalSeconds
shrinkerIntervalSeconds


maxSpoolPerRun

int maxSpoolPerRun
The maximum number the shrinker will spool to disk per run.


cacheName

java.lang.String cacheName
The name of this cache region.


memoryCacheName

java.lang.String memoryCacheName
The name of the memory cache implementation class.


diskUsagePattern

short diskUsagePattern
Set via DISK_USAGE_PATTERN_NAME


spoolChunkSize

int spoolChunkSize
How many to spool to disk at a time.

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

serialVersionUID: 7814990748035017441L

Serialized Fields

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
You can turn off expiration by setting this to true. This causes the cache to bypass both max life and idle time expiration.


maxLifeSeconds

long maxLifeSeconds
Max life seconds


maxIdleTimeSeconds

long maxIdleTimeSeconds
The maximum time an entry can be idle. Setting this to -1 causes the idle time check to be ignored.


size

int size
The byte size of the field. Must be manually set.


createTime

long createTime
The creation time. This is used to enforce the max life.


lastAccessTime

long lastAccessTime
The last access time. This is used to enforce the max idel time.


Package org.apache.jcs.engine.behavior

Package org.apache.jcs.engine.control

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

serialVersionUID: -2838097410378294960L

Serialized Fields

auxCaches

AuxiliaryCache[] auxCaches
Auxiliary caches.


alive

boolean alive
is this alive?


cacheName

java.lang.String cacheName
TODO - this is in the cacheAttr, shouldn't be used, remove


attr

IElementAttributes attr
Region Elemental Attributes, default.


cacheAttr

ICompositeCacheAttributes cacheAttr
Cache Attributes, for hub and memory auxiliary.


updateCount

int updateCount
How many times update was called.


removeCount

int removeCount
How many times remove was called.


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.


keyMatcher

IKeyMatcher keyMatcher
Key matcher used by the getMatching API

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

serialVersionUID: 7598584393134401756L

Serialized Fields

caches

java.util.Hashtable<K,V> caches
Caches managed by this cache manager


systemCaches

java.util.Hashtable<K,V> 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


auxiliaryFactoryRegistry

java.util.Hashtable<K,V> auxiliaryFactoryRegistry
Used to keep track of configured auxiliaries


auxiliaryAttributeRegistry

java.util.Hashtable<K,V> auxiliaryAttributeRegistry
Used to keep track of attributes for auxiliaries.


configurationProperties

java.util.Properties configurationProperties
Properties with which this manager was configured. This is exposed for other managers.


defaultAuxValues

java.lang.String defaultAuxValues
The default auxiliary caches to be used if not preconfigured


shutdownObservers

java.util.Set<E> shutdownObservers
Those waiting for notification of a shutdown.


isShutdown

boolean isShutdown
Indicates whether shutdown has been called.


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

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

serialVersionUID: -5364117411457467056L

Serialized Fields

elementEvent

int elementEvent
default event code


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

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

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

serialVersionUID: 1586079686300744198L

Serialized Fields

groupId

GroupId groupId
Description of the Field


attrName

java.lang.Object attrName
the name of the attribute


toString

java.lang.String toString
Cached toString value

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

serialVersionUID: 4626368486444860133L

Serialized Fields

groupName

java.lang.String groupName
Description of the Field


cacheName

java.lang.String cacheName
the name of the region.


toString

java.lang.String toString
Cached toString value.


Package org.apache.jcs.engine.logging

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

serialVersionUID: -5913139566421714330L

Serialized Fields

createTime

long createTime
The time at which this object was created.


source

java.lang.String source
The auxiliary or other source of the event.


region

java.lang.String region
The cache region


eventName

java.lang.String eventName
The event name: update, get, remove, etc.


optionalDetails

java.lang.String optionalDetails
disk location, ip, etc.


key

java.io.Serializable key
The key that was put or retrieved.


Package org.apache.jcs.engine.logging.behavior

Package org.apache.jcs.engine.memory

Class org.apache.jcs.engine.memory.AbstractDoulbeLinkedListMemoryCache extends AbstractMemoryCache implements Serializable

serialVersionUID: 1422569420563967389L

Serialized Fields

list

DoubleLinkedList list
thread-safe double linked list for lru


hitCnt

int hitCnt
number of hits


missCnt

int missCnt
number of misses


putCnt

int putCnt
number of puts

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

serialVersionUID: -4494626991630099575L

Serialized Fields

cacheName

java.lang.String cacheName
The region name. This defines a namespace of sorts.


map

java.util.Map<K,V> 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
status


chunkSize

int chunkSize
How many to spool at a time.


Package org.apache.jcs.engine.memory.fifo

Class org.apache.jcs.engine.memory.fifo.FIFOMemoryCache extends AbstractDoulbeLinkedListMemoryCache implements Serializable

serialVersionUID: 6403738094136424201L


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

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

serialVersionUID: 6403738094136424201L


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

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

serialVersionUID: 5013101678192336129L


Package org.apache.jcs.engine.memory.util

Class org.apache.jcs.engine.memory.util.MemoryElementDescriptor extends DoubleLinkedListNode implements Serializable

serialVersionUID: -1905161209035522460L

Serialized Fields

ce

ICacheElement ce
The CacheElement wrapped by this descriptor


Package org.apache.jcs.engine.stats

Class org.apache.jcs.engine.stats.CacheStats extends Stats implements Serializable

serialVersionUID: 529914708798168590L

Serialized Fields

regionName

java.lang.String regionName
The region


auxStats

IStats[] auxStats
What that auxiliaries are reporting.


stats

IStatElement[] stats
stats

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

serialVersionUID: 227327902875154010L

Serialized Fields

stats

IStatElement[] stats
The stats


typeName

java.lang.String typeName
The type of stat


Package org.apache.jcs.engine.stats.behavior

Package org.apache.jcs.utils.config

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

serialVersionUID: -210271658004609028L

Serialized Fields

rootCause

java.lang.Throwable rootCause
Description of the Field


Package org.apache.jcs.utils.struct

Class org.apache.jcs.utils.struct.DoubleLinkedListNode extends java.lang.Object implements Serializable

serialVersionUID: -1114934407695836097L

Serialized Fields

payload

java.lang.Object payload
The object in the node.


prev

DoubleLinkedListNode prev
Double Linked list references


next

DoubleLinkedListNode next
Double Linked list references

Class org.apache.jcs.utils.struct.LRUElementDescriptor extends DoubleLinkedListNode implements Serializable

serialVersionUID: 8249555756363020156L

Serialized Fields

key

java.lang.Object key
The key value

Class org.apache.jcs.utils.struct.LRUMapEntry extends java.lang.Object implements Serializable

serialVersionUID: -8176116317739129331L

Serialized Fields

key

java.lang.Object key
key


value

java.lang.Object value
value



Copyright © 2002-2011 Apache Software Foundation. All Rights Reserved.