Serialized Form


Package org.apache.commons.jcs.access.exception

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

serialVersionUID: 8725795372935590265L

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

serialVersionUID: 6881044536186097055L

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

serialVersionUID: -6058373692208755562L

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

serialVersionUID: -5219807114008843480L

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

serialVersionUID: -5947822454839845924L

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

serialVersionUID: -3779745827993383872L

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

serialVersionUID: 5684353421076546842L


Package org.apache.commons.jcs.admin.servlet

Class org.apache.commons.jcs.admin.servlet.JCSAdminServlet extends org.apache.velocity.tools.view.VelocityViewServlet implements Serializable

serialVersionUID: -5519844149238645275L


Package org.apache.commons.jcs.auxiliary

Class org.apache.commons.jcs.auxiliary.AbstractAuxiliaryCacheAttributes extends Object implements Serializable

serialVersionUID: -6594609334959187673L

Serialized Fields

cacheName

String cacheName
cacheName


name

String name
name


eventQueueType

String eventQueueType
eventQueueType -- custom classname, pooled, or single threaded


eventQueuePoolName

String eventQueuePoolName
Named when pooled


Package org.apache.commons.jcs.auxiliary.disk

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

serialVersionUID: 8306631920391711229L

Serialized Fields

diskPath

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.commons.jcs.auxiliary.disk.PurgatoryElement extends Object implements Serializable

serialVersionUID: -8152034342684135628L

Serialized Fields

spoolable

boolean spoolable
Is the element ready to be spooled?


cacheElement

ICacheElement<K extends Serializable,V extends Serializable> cacheElement
Wrapped cache Element


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

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

Class org.apache.commons.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.commons.jcs.auxiliary.disk.block.BlockDiskElementDescriptor extends Object implements Serializable

serialVersionUID: -1400659301208101411L

Serialization Methods

readExternal

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

(non-Javadoc)

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

writeExternal

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

(non-Javadoc)

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

Package org.apache.commons.jcs.auxiliary.disk.file

Class org.apache.commons.jcs.auxiliary.disk.file.FileDiskCacheAttributes extends AbstractDiskCacheAttributes implements Serializable

serialVersionUID: -7371586172678836062L

Serialized Fields

maxNumberOfFiles

int maxNumberOfFiles
Max number of files


maxRetriesOnDelete

int maxRetriesOnDelete
Max number of retries on delete


maxRetriesOnTouch

int maxRetriesOnTouch
Max number of retries on touch


touchOnGet

boolean touchOnGet
Should we touch on get. If so, we will reset the last modified time. If you have a max file size set, this will make the removal strategy LRU. If this is false, then the oldest will be removed.


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

Class org.apache.commons.jcs.auxiliary.disk.indexed.IndexedDiskCache.PositionComparator extends Object implements Serializable

serialVersionUID: -8387365338590814113L

Class org.apache.commons.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.


clearDiskOnStartup

boolean clearDiskOnStartup
Should we clear the disk on startup. If true the congtents of disk are cleared.

Class org.apache.commons.jcs.auxiliary.disk.indexed.IndexedDiskElementDescriptor extends 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.commons.jcs.auxiliary.disk.jdbc

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

serialVersionUID: -6535808344813320062L

Serialized Fields

userName

String userName
DB username


password

String password
DB password


url

String url
URL for the db


database

String database
The name of the database.


driverClassName

String driverClassName
The driver


tableName

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

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.commons.jcs.auxiliary.disk.jdbc.TableState extends Object implements Serializable

serialVersionUID: -6625081552084964885L

Serialized Fields

tableName

String tableName
Name of the table whose state this reflects.


state

int state
we might want to add error


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

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

serialVersionUID: -6535808344813320061L

Serialized Fields

optimizationSchedule

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


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

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

serialVersionUID: 1L


Package org.apache.commons.jcs.auxiliary.lateral

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

serialVersionUID: -3408449508837393660L

Serialized Fields

transmissionTypeName

String transmissionTypeName
THe type of lateral


transmissionType

int transmissionType
indicates the lateral type, this needs to change


httpServers

String httpServers
The heep servers


httpServer

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


udpMulticastAddr

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


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.commons.jcs.auxiliary.lateral.LateralElementDescriptor extends Object implements Serializable

serialVersionUID: 5268222498076063575L

Serialized Fields

ce

ICacheElement<K extends Serializable,V extends Serializable> 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

LateralCommand command
The operation has been requested by the client.


valHashCode

int valHashCode
The hashcode value for this element.


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

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

Class org.apache.commons.jcs.auxiliary.lateral.socket.tcp.LateralTCPListener extends 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

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


shutdown

boolean shutdown
is this shut down?


terminated

boolean terminated
is this terminated?

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

serialVersionUID: 1077889204513905220L

Serialized Fields

tcpServers

String tcpServers
TCP --------------------------------------------


tcpServer

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


tcpListenerPort

int tcpListenerPort
The pot


udpDiscoveryAddr

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


socketTimeOut

int socketTimeOut
Only block for socketTimeOut seconds before timing out on a read.


openTimeOut

int openTimeOut
Only block for openTimeOut seconds before timing out on startup.


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

Package org.apache.commons.jcs.auxiliary.remote

Class org.apache.commons.jcs.auxiliary.remote.AbstractRemoteCacheListener extends Object implements Serializable

serialVersionUID: 32442324243243L

Serialized Fields

disposed

boolean disposed
Has this client been shutdown.


irca

IRemoteCacheAttributes irca
The remote cache configuration object.


puts

int puts
Number of put requests received. For debugging only.


removes

int removes
Number of remove requests received. For debugging only.


listenerId

long listenerId
This is set by the remote cache server.

Class org.apache.commons.jcs.auxiliary.remote.CommonRemoteCacheAttributes extends AbstractAuxiliaryCacheAttributes implements Serializable

serialVersionUID: -1555143736942374000L

Serialized Fields

remoteServiceName

String remoteServiceName
The service name


remoteHost

String remoteHost
server host


remotePort

int remotePort
server port


clusterServers

String clusterServers
Cluster chain


remoteType

RemoteType remoteType
THe type of remote cache, local or cluster


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.


rmiSocketFactoryTimeoutMillis

int rmiSocketFactoryTimeoutMillis
read and connect timeout

Class org.apache.commons.jcs.auxiliary.remote.RemoteCacheAttributes extends CommonRemoteCacheAttributes implements Serializable

serialVersionUID: -1555143736942374000L

Serialized Fields

failoverServers

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.


localPort

int localPort
callback


failoverIndex

int failoverIndex
what failover server we are connected to.


failovers

String[] failovers
Array of failover server addresses


threadPoolName

String threadPoolName
default name is remote_cache_client


getTimeoutMillis

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


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.commons.jcs.auxiliary.remote.RemoteCacheListener extends AbstractRemoteCacheListener<K extends Serializable,V extends Serializable> implements Serializable

serialVersionUID: 25345252345322345L

Class org.apache.commons.jcs.auxiliary.remote.RemoteCacheListener_Stub extends RemoteStub implements Serializable

serialVersionUID: 2L


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

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

Class org.apache.commons.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

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

String url
The complete URL to the service.


remoteHttpClientClassName

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

Class org.apache.commons.jcs.auxiliary.remote.http.client.RemoteHttpClientListener extends AbstractRemoteCacheListener<K extends Serializable,V extends Serializable> implements Serializable

serialVersionUID: -9078366610772128010L


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

Class org.apache.commons.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.commons.jcs.auxiliary.remote.http.server.RemoteHttpCacheServlet extends HttpServlet implements Serializable

serialVersionUID: 8752849397531933346L

Serialized Fields

remoteHttpCacheServiceAdaptor

RemoteCacheServiceAdaptor<K extends Serializable,V extends Serializable> 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.commons.jcs.auxiliary.remote.server

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

serialVersionUID: -8072345435941473116L

Serialized Fields

puts

int puts
Number of puts into the cache.


cacheListenersMap

Hashtable<K,V> cacheListenersMap
Maps cache name to CacheListeners object. association of listeners (regions).


clusterListenersMap

Hashtable<K,V> clusterListenersMap
maps cluster listeners to regions.


cacheManager

CompositeCacheManager cacheManager
The central hub


idTypeMap

Hashtable<K,V> idTypeMap
relates listener id with a type


idIPMap

Hashtable<K,V> idIPMap
relates listener id with an ip address


listenerId

int[] listenerId
Used to get the next listener id.


remoteCacheServerAttributes

IRemoteCacheServerAttributes remoteCacheServerAttributes
Configuration settings.


logInterval

int logInterval
The interval at which we will log updates.

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

serialVersionUID: 2L

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

serialVersionUID: -2741662082869155365L

Serialized Fields

servicePort

int servicePort
port the server will listen to


allowClusterGet

boolean allowClusterGet
Can a cluster remote get from other remotes


configFileName

String configFileName
The config file, the initialization is multistage. Remote cache then composite cache.


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.commons.jcs.auxiliary.remote.server.RemoteCacheStartupServlet extends HttpServlet implements Serializable

serialVersionUID: 1L

Serialized Fields

propsFileName

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


fullPropsFileName

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

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

serialVersionUID: 1489909775271203334L

Serialized Fields

readTimeout

int readTimeout
The socket read timeout


openTimeout

int openTimeout
The socket open timeout


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

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

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

serialVersionUID: -8858447417390442569L

Serialized Fields

requestType

RemoteRequestType 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

String cacheName
The name of the region


key

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


keySet

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


pattern

String pattern
The pattern, if this request uses a pattern. Only getMatching requests.


cacheElement

ICacheElement<K extends Serializable,V extends Serializable> cacheElement
The ICacheEleemnt, if this request contains a value. Only update requests will have this.

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

serialVersionUID: -8858447417390442568L

Serialized Fields

success

boolean success
Was the event processed without error


errorMessage

String errorMessage
Simple error messaging


payload

Object payload
The payload. Typically a key / ICacheElement map. A normal get will return a map with one record.


Package org.apache.commons.jcs.engine

Class org.apache.commons.jcs.engine.CacheElement extends Object implements Serializable

serialVersionUID: -6062305728297627263L

Serialized Fields

cacheName

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


key

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


val

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.commons.jcs.engine.CacheElementSerialized extends Object implements Serializable

serialVersionUID: -7265084818647601874L

Serialized Fields

cacheName

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


key

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.commons.jcs.engine.CompositeCacheAttributes extends 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

String cacheName
The name of this cache region.


memoryCacheName

String memoryCacheName
The name of the memory cache implementation class.


diskUsagePattern

ICompositeCacheAttributes.DiskUsagePattern diskUsagePattern
Set via DISK_USAGE_PATTERN_NAME


spoolChunkSize

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

Class org.apache.commons.jcs.engine.ElementAttributes extends 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.commons.jcs.engine.behavior

Package org.apache.commons.jcs.engine.control

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

serialVersionUID: -2838097410378294960L

Serialized Fields

elementEventQ

IElementEventQueue elementEventQ
EventQueue for handling element events. Lazy initialized. One for each region. To be more efficient, the manager should pass a shared queue in.


auxCaches

AuxiliaryCache<K extends Serializable,V extends Serializable>[] auxCaches
Auxiliary caches.


alive

boolean alive
is this alive?


cacheName

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

IMemoryCache<K extends Serializable,V extends Serializable> 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<K extends Serializable> keyMatcher
Key matcher used by the getMatching API

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

serialVersionUID: 7598584393134401756L

Serialized Fields

caches

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


systemCaches

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 element attributes for this cache manager


auxiliaryFactoryRegistry

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


auxiliaryAttributeRegistry

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


configurationProperties

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


defaultAuxValues

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


shutdownObservers

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


scheduledExecutor

ScheduledExecutorService scheduledExecutor
The central background scheduler.


isShutdown

boolean isShutdown
Indicates whether shutdown has been called.


isConfigured

boolean isConfigured
Indicates whether configure has been called.


isJMXRegistered

boolean isJMXRegistered
Indicates whether JMX bean has been registered.


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

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

serialVersionUID: -5364117411457467056L

Serialized Fields

elementEvent

ElementEventType elementEvent
default event code

Class org.apache.commons.jcs.engine.control.event.ElementEventQueue extends Object implements Serializable

serialVersionUID: -2966341524571838475L

Serialized Fields

cacheName

String cacheName
The cache (region) name.


waitToDieMillis

int waitToDieMillis
time to wait for an event before snuffing the background thread if the queue is empty. make configurable later


destroyed

boolean destroyed
shutdown or not


processorThread

Thread processorThread
The worker thread.


queueLock

Object queueLock
Internal queue implementation


head

ElementEventQueue.Node head
Dummy node


tail

ElementEventQueue.Node tail
tail of the doubly linked list


size

int size
Number of items in the queue


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

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

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

serialVersionUID: 1586079686300744198L

Serialized Fields

groupId

GroupId groupId
Description of the Field


attrName

Serializable attrName
the name of the attribute


toString

String toString
Cached toString value

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

serialVersionUID: 4626368486444860133L

Serialized Fields

groupName

String groupName
Description of the Field


cacheName

String cacheName
the name of the region.


toString

String toString
Cached toString value.


Package org.apache.commons.jcs.engine.logging

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

serialVersionUID: -5913139566421714330L

Serialized Fields

createTime

long createTime
The time at which this object was created.


source

String source
The auxiliary or other source of the event.


region

String region
The cache region


eventName

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


optionalDetails

String optionalDetails
disk location, ip, etc.


key

Serializable key
The key that was put or retrieved.


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

Package org.apache.commons.jcs.engine.match

Class org.apache.commons.jcs.engine.match.KeyMatcherPatternImpl extends Object implements Serializable

serialVersionUID: 6667352064144381264L


Package org.apache.commons.jcs.engine.match.behavior

Package org.apache.commons.jcs.engine.memory

Class org.apache.commons.jcs.engine.memory.AbstractDoubleLinkedListMemoryCache extends AbstractMemoryCache<K extends Serializable,V extends Serializable> implements Serializable

serialVersionUID: 1422569420563967389L

Serialized Fields

list

DoubleLinkedList<T extends DoubleLinkedListNode> 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.commons.jcs.engine.memory.AbstractMemoryCache extends Object implements Serializable

serialVersionUID: -4494626991630099575L

Serialized Fields

cacheName

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


map

Map<K,V> map
Map where items are stored by key. This is created by the concrete child class.


elementAttributes

IElementAttributes elementAttributes
Region Elemental Attributes, used as a default and copied for each item.


cacheAttributes

ICompositeCacheAttributes cacheAttributes
Cache Attributes. Regions settings.


cache

CompositeCache<K extends Serializable,V extends Serializable> cache
The cache region this store is associated with


status

CacheStatus status
status


chunkSize

int chunkSize
How many to spool at a time.

Class org.apache.commons.jcs.engine.memory.MemoryCache extends Object implements Serializable


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

Class org.apache.commons.jcs.engine.memory.fifo.FIFOMemoryCache extends AbstractDoubleLinkedListMemoryCache<K extends Serializable,V extends Serializable> implements Serializable

serialVersionUID: 6403738094136424201L


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

Class org.apache.commons.jcs.engine.memory.lru.LHMLRUMemoryCache extends AbstractMemoryCache<K extends Serializable,V extends Serializable> implements Serializable

serialVersionUID: 6403738094136424101L

Serialized Fields

hitCnt

int hitCnt
number of hits


missCnt

int missCnt
number of misses


putCnt

int putCnt
number of puts

Class org.apache.commons.jcs.engine.memory.lru.LHMLRUMemoryCache.LHMSpooler extends LinkedHashMap<K extends Serializable,MemoryElementDescriptor<K extends Serializable,V extends Serializable>> implements Serializable

serialVersionUID: -1255907868906762484L

Class org.apache.commons.jcs.engine.memory.lru.LRUMemoryCache extends AbstractDoubleLinkedListMemoryCache<K extends Serializable,V extends Serializable> implements Serializable

serialVersionUID: 6403738094136424201L


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

Class org.apache.commons.jcs.engine.memory.mru.MRUMemoryCache extends AbstractDoubleLinkedListMemoryCache<K extends Serializable,V extends Serializable> implements Serializable

serialVersionUID: 5013101678192336129L


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

Class org.apache.commons.jcs.engine.memory.util.MemoryElementDescriptor extends DoubleLinkedListNode<ICacheElement<K extends Serializable,V extends Serializable>> implements Serializable

serialVersionUID: -1905161209035522460L

Serialized Fields

ce

ICacheElement<K extends Serializable,V extends Serializable> ce
The CacheElement wrapped by this descriptor


Package org.apache.commons.jcs.engine.stats

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

serialVersionUID: 529914708798168590L

Serialized Fields

regionName

String regionName
The region


auxStats

IStats[] auxStats
What that auxiliaries are reporting.


stats

IStatElement[] stats
stats

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

serialVersionUID: 227327902875154010L

Serialized Fields

stats

IStatElement[] stats
The stats


typeName

String typeName
The type of stat


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

Package org.apache.commons.jcs.utils.config

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

serialVersionUID: -210271658004609028L

Serialized Fields

rootCause

Throwable rootCause
Description of the Field


Package org.apache.commons.jcs.utils.date

Class org.apache.commons.jcs.utils.date.ThreadSafeSimpleDateFormat extends SimpleDateFormat implements Serializable

serialVersionUID: -6394173605134585999L


Package org.apache.commons.jcs.utils.discovery

Class org.apache.commons.jcs.utils.discovery.DiscoveredService extends Object implements Serializable

serialVersionUID: -7810164772089509751L

Serialized Fields

cacheNames

ArrayList<E> cacheNames
region names


serviceAddress

String serviceAddress
service address


servicePort

int servicePort
service port


lastHearFromTime

long lastHearFromTime
last time we heard from this service?

Class org.apache.commons.jcs.utils.discovery.UDPDiscoveryMessage extends Object implements Serializable

serialVersionUID: -5332377899560951793L

Serialized Fields

messageType

int messageType
The message type


port

int port
udp port


host

String host
UDP host


requesterId

long requesterId
Id of the requestor, allows self-filtration


cacheNames

ArrayList<E> cacheNames
Names of regions


Package org.apache.commons.jcs.utils.struct

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

serialVersionUID: -1114934407695836097L

Serialized Fields

payload

Object payload
The object in the node.


prev

DoubleLinkedListNode<T> prev
Double Linked list references


next

DoubleLinkedListNode<T> next
Double Linked list references

Class org.apache.commons.jcs.utils.struct.LRUElementDescriptor extends DoubleLinkedListNode<V> implements Serializable

serialVersionUID: 8249555756363020156L

Serialized Fields

key

Object key
The key value

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

serialVersionUID: -8176116317739129331L

Serialized Fields

key

Object key
key


value

Object value
value



Copyright © 2002–2014 The Apache Software Foundation. All rights reserved.