A B C D E F G H I L M N O P R S T U

A

addCache(String) - Method in class net.sf.ehcache.CacheManager

Adds a Cache based on the defaultCache with the given name.

addCache(Cache) - Method in class net.sf.ehcache.CacheManager

Adds a Cache to the CacheManager.

addCache(CacheConfiguration) - Method in class net.sf.ehcache.config.Configuration

Allows BeanHandler to add Cache Configurations to the configuration.

addCacheEventListenerFactory(CacheConfiguration.CacheEventListenerFactoryConfiguration) - Method in class net.sf.ehcache.config.CacheConfiguration

Used by BeanUtils to add cacheEventListenerFactory elements to the cache configuration.

addCacheManagerEventListenerFactory(FactoryConfiguration) - Method in class net.sf.ehcache.config.Configuration

Allows BeanHandler to add the CacheManagerEventListener to the configuration.

addCacheManagerPeerListenerFactory(FactoryConfiguration) - Method in class net.sf.ehcache.config.Configuration

Adds a CachePeerProviderFactoryConfiguration.

addCacheManagerPeerProviderFactory(FactoryConfiguration) - Method in class net.sf.ehcache.config.Configuration

Adds a CachePeerProviderFactoryConfiguration.

addDefaultCache(CacheConfiguration) - Method in class net.sf.ehcache.config.Configuration

Allows BeanHandler to add a default configuration to the configuration.

addDiskStore(DiskStoreConfiguration) - Method in class net.sf.ehcache.config.Configuration

Allows BeanHandler to add disk store location to the configuration.

addToReplicationQueue(RMIAsynchronousCacheReplicator.CacheEventMessage) - Method in class net.sf.ehcache.distribution.RMIAsynchronousCacheReplicator

Adds a message to the queue.

alive() - Method in interface net.sf.ehcache.distribution.CacheReplicator

Checks that the replicator is is STATUS_ALIVE.

alive() - Method in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator

Checks that the replicator is is STATUS_ALIVE.

assembleUrlList(List) - Static method in class net.sf.ehcache.distribution.PayloadUtil

Assembles a list of URLs

AUTO_DISK_PATH_DIRECTORY_PREFIX - Static variable in class net.sf.ehcache.store.DiskStore

If the CacheManager needs to resolve a conflict with the disk path, it will create a subdirectory in the given disk path with this prefix followed by a number.

B

BeanHandler - Class in net.sf.ehcache.config

A SAX handler that configures a bean.

BeanHandler(Object) - Constructor for class net.sf.ehcache.config.BeanHandler

Constructor.

buildCache(String, Properties) - Method in class net.sf.ehcache.hibernate.EhCacheProvider

Builds a Cache.

C

Cache - Class in net.sf.ehcache

Cache is the central class in ehcache.

Cache(String, int, boolean, boolean, long, long) - Constructor for class net.sf.ehcache.Cache

1.0 Constructor.

Cache(String, int, boolean, boolean, long, long, boolean, long) - Constructor for class net.sf.ehcache.Cache

1.1 Constructor.

Cache(String, int, MemoryStoreEvictionPolicy, boolean, String, boolean, long, long, boolean, long, RegisteredEventListeners) - Constructor for class net.sf.ehcache.Cache

1.2 Constructor

The ConfigurationFactory and clients can create these.

cache - Variable in class net.sf.ehcache.store.MemoryStore

The cache this store is associated with.

CacheConfiguration - Class in net.sf.ehcache.config

A class to represent Cache configuration.

CacheConfiguration() - Constructor for class net.sf.ehcache.config.CacheConfiguration

CacheConfiguration.CacheEventListenerFactoryConfiguration - Class in net.sf.ehcache.config

Configuration for the CachePeerListenerFactoryConfiguration.

CacheConfiguration.CacheEventListenerFactoryConfiguration() - Constructor for class net.sf.ehcache.config.CacheConfiguration.CacheEventListenerFactoryConfiguration

CacheEventListener - Interface in net.sf.ehcache.event

Allows implementers to register callback methods that will be executed when a cache event occurs.

cacheEventListenerConfigurations - Variable in class net.sf.ehcache.config.CacheConfiguration

The event listener factories added by BeanUtils.

CacheEventListenerFactory - Class in net.sf.ehcache.event

An abstract factory for creating listeners.

CacheEventListenerFactory() - Constructor for class net.sf.ehcache.event.CacheEventListenerFactory

CacheException - Exception in net.sf.ehcache

A runtime Cache Exception, compatible with JDK1.3.

CacheException() - Constructor for exception net.sf.ehcache.CacheException

Constructor for the CacheException object.

CacheException(String) - Constructor for exception net.sf.ehcache.CacheException

Constructor for the CacheException object.

CacheException(String, Throwable) - Constructor for exception net.sf.ehcache.CacheException

Constructor for the CacheException object.

cacheExists(String) - Method in class net.sf.ehcache.CacheManager

Checks whether a cache exists.

CacheManager - Class in net.sf.ehcache

A container for Caches that maintain all aspects of their lifecycle.

CacheManager(Configuration) - Constructor for class net.sf.ehcache.CacheManager

An constructor for CacheManager, which takes a configuration object, rather than one created by parsing an ehcache.xml file.

CacheManager(String) - Constructor for class net.sf.ehcache.CacheManager

An ordinary constructor for CacheManager.

CacheManager(URL) - Constructor for class net.sf.ehcache.CacheManager

An ordinary constructor for CacheManager.

CacheManager(InputStream) - Constructor for class net.sf.ehcache.CacheManager

An ordinary constructor for CacheManager.

CacheManager() - Constructor for class net.sf.ehcache.CacheManager

Constructor.

CacheManagerEventListener - Interface in net.sf.ehcache.event

Allows implementers to register callback methods that will be executed when a CacheManager event occurs.

CacheManagerEventListenerFactory - Class in net.sf.ehcache.event

An abstract factory for creating cache manager listeners.

CacheManagerEventListenerFactory() - Constructor for class net.sf.ehcache.event.CacheManagerEventListenerFactory

CacheManagerPeerListener - Interface in net.sf.ehcache.distribution

A listener for updates, which controls remote cache peers.

CacheManagerPeerListenerFactory - Class in net.sf.ehcache.distribution

An abstract factory for creating cache manager peer listeners.

CacheManagerPeerListenerFactory() - Constructor for class net.sf.ehcache.distribution.CacheManagerPeerListenerFactory

CacheManagerPeerProvider - Interface in net.sf.ehcache.distribution

Provides a discovery service to locate CachePeer RMI listener peers for a Cache.

CacheManagerPeerProviderFactory - Class in net.sf.ehcache.distribution

An abstract factory for creating peers.

CacheManagerPeerProviderFactory() - Constructor for class net.sf.ehcache.distribution.CacheManagerPeerProviderFactory

CachePeer - Interface in net.sf.ehcache.distribution

An interface for a cache peer to which updates are made remotely.

CacheReplicator - Interface in net.sf.ehcache.distribution

Replicates cache entries to peers of the CacheManager

calculateDataFileSparseness() - Method in class net.sf.ehcache.store.DiskStore

The design of the layout on the data file means that there will be small gaps created when DiskElements are reused.

calculateInMemorySize() - Method in class net.sf.ehcache.Cache

Gets the size of the memory store for this cache

Warning: This method can be very expensive to run.

ClassLoaderUtil - Class in net.sf.ehcache.util

Keeps all classloading in ehcache consistent.

clear() - Method in class net.sf.ehcache.hibernate.EhCache

Remove all elements in the cache, but leave the cache in a useable state.

clear() - Method in class net.sf.ehcache.store.MemoryStore

Clears any data structures and places it back to its state when it was first created.

clone() - Method in class net.sf.ehcache.Cache

Clones a cache.

clone() - Method in class net.sf.ehcache.Element

Clones an Element.

ConfigurableRMIClientSocketFactory - Class in net.sf.ehcache.distribution

Default socket timeouts are unlikely to be suitable for cache replication.

ConfigurableRMIClientSocketFactory(Integer) - Constructor for class net.sf.ehcache.distribution.ConfigurableRMIClientSocketFactory

Construct a new socket factory with the given timeout.

Configuration - Class in net.sf.ehcache.config

A bean, used by BeanUtils, to set configuration from an XML configuration file.

Configuration() - Constructor for class net.sf.ehcache.config.Configuration

Empty constructor, which is used by ConfigurationFactory, and can be also sued programmatically.

ConfigurationFactory - Class in net.sf.ehcache.config

A utility class which configures beans from XML, using reflection.

ConfigurationHelper - Class in net.sf.ehcache.config

The configuration for ehcache.

ConfigurationHelper(CacheManager, Configuration) - Constructor for class net.sf.ehcache.config.ConfigurationHelper

Only Constructor

containsKey(Object) - Method in class net.sf.ehcache.store.DiskStore

An unsynchronized and very low cost check to see if a key is in the Store.

containsKey(Object) - Method in class net.sf.ehcache.store.MemoryStore

An unsynchronized check to see if a key is in the Store.

containsKey(Object) - Method in interface net.sf.ehcache.store.Store

A check to see if a key is in the Store.

convertIntToStatus(int) - Static method in class net.sf.ehcache.Status

create() - Static method in class net.sf.ehcache.CacheManager

A factory method to create a singleton CacheManager with default config, or return it if it exists.

create(String) - Static method in class net.sf.ehcache.CacheManager

A factory method to create a singleton CacheManager with a specified configuration.

create(URL) - Static method in class net.sf.ehcache.CacheManager

A factory method to create a singleton CacheManager from an URL.

create(InputStream) - Static method in class net.sf.ehcache.CacheManager

A factory method to create a singleton CacheManager from a java.io.InputStream.

create(Cache, DiskStore) - Static method in class net.sf.ehcache.store.MemoryStore

A factory method to create a MemoryStore.

createCache(CacheConfiguration) - Method in class net.sf.ehcache.config.ConfigurationHelper

Create a cache given a cache configuration

createCacheEventListener(Properties) - Method in class net.sf.ehcache.distribution.RMICacheReplicatorFactory

Create a CacheEventListener which is also a CacheReplicator.

createCacheEventListener(Properties) - Method in class net.sf.ehcache.event.CacheEventListenerFactory

Create a CacheEventListener

createCacheFromName(String) - Method in class net.sf.ehcache.config.ConfigurationHelper

Creates a cache from configuration where the configuration cache name matches the given name

createCacheManagerEventListener() - Method in class net.sf.ehcache.config.ConfigurationHelper

Tries to load the class specified.

createCacheManagerEventListener(Properties) - Method in class net.sf.ehcache.event.CacheManagerEventListenerFactory

Create a CacheEventListener

createCachePeerListener() - Method in class net.sf.ehcache.config.ConfigurationHelper

Tries to load the class specified otherwise defaults to null

createCachePeerListener(CacheManager, Properties) - Method in class net.sf.ehcache.distribution.CacheManagerPeerListenerFactory

Creates a peer provider.

createCachePeerListener(CacheManager, Properties) - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListenerFactory

createCachePeerProvider() - Method in class net.sf.ehcache.config.ConfigurationHelper

Tries to load the class specified otherwise defaults to null

createCachePeerProvider(CacheManager, Properties) - Method in class net.sf.ehcache.distribution.CacheManagerPeerProviderFactory

Create a peer provider.

createCachePeerProvider(CacheManager, Properties) - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerProviderFactory

createCaches() - Method in class net.sf.ehcache.config.ConfigurationHelper

Creates unitialised caches for each cache configuration found

createDefaultCache() - Method in class net.sf.ehcache.config.ConfigurationHelper

createNewInstance(String) - Static method in class net.sf.ehcache.util.ClassLoaderUtil

Creates a new class instance.

createSocket(String, int) - Method in class net.sf.ehcache.distribution.ConfigurableRMIClientSocketFactory

Create a client socket connected to the specified host and port.

D

DEFAULT_CACHE_NAME - Static variable in class net.sf.ehcache.Cache

A reserved word for cache names.

DEFAULT_EXPIRY_THREAD_INTERVAL_SECONDS - Static variable in class net.sf.ehcache.Cache

The default interval between runs of the expiry thread.

DEFAULT_SOCKET_TIMEOUT_MILLIS - Static variable in class net.sf.ehcache.distribution.RMICacheManagerPeerListenerFactory

The default timeout for cache replication for a single replication action.

destroy() - Method in class net.sf.ehcache.hibernate.EhCache

Remove the cache and make it unuseable.

diskExpiryThreadIntervalSeconds - Variable in class net.sf.ehcache.config.CacheConfiguration

The interval in seconds between runs of the disk expiry thread.

diskPersistent - Variable in class net.sf.ehcache.config.CacheConfiguration

For caches that overflow to disk, whether the disk cache persists between CacheManager instances.

DiskStore - Class in net.sf.ehcache.store

A disk store implementation.

DiskStore(Cache, String) - Constructor for class net.sf.ehcache.store.DiskStore

Creates a disk store.

diskStore - Variable in class net.sf.ehcache.store.MemoryStore

The DiskStore associated with this MemoryStore.

DiskStore.MemoryEfficientByteArrayOutputStream - Class in net.sf.ehcache.store

This class is designed to minimse the number of System.arraycopy(); methods required to complete.

DiskStore.MemoryEfficientByteArrayOutputStream(int) - Constructor for class net.sf.ehcache.store.DiskStore.MemoryEfficientByteArrayOutputStream

Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes.

DiskStoreConfiguration - Class in net.sf.ehcache.config

A class to represent DiskStore configuration e.g.

DiskStoreConfiguration() - Constructor for class net.sf.ehcache.config.DiskStoreConfiguration

dispose() - Method in class net.sf.ehcache.Cache

Flushes all cache items from memory to auxilliary caches and close the auxilliary caches.

dispose() - Method in interface net.sf.ehcache.distribution.CacheManagerPeerListener

Stop the listener and free any resources.

dispose() - Method in interface net.sf.ehcache.distribution.CacheManagerPeerProvider

Providers may be doing all sorts of exotic things and need to be able to clean up on dispose.

dispose() - Method in class net.sf.ehcache.distribution.MulticastKeepaliveHeartbeatReceiver

Shutdown the heartbeat.

dispose() - Method in class net.sf.ehcache.distribution.MulticastKeepaliveHeartbeatSender

Shutdown this heartbeat sender

dispose() - Method in class net.sf.ehcache.distribution.MulticastRMICacheManagerPeerProvider

Shutdown the heartbeat

dispose() - Method in class net.sf.ehcache.distribution.RMIAsynchronousCacheReplicator

Give the replicator a chance to cleanup and free resources when no longer needed

dispose() - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListener

Stop the listener.

dispose() - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerProvider

Providers may be doing all sorts of exotic things and need to be able to clean up on dispose.

dispose() - Method in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator

Give the replicator a chance to cleanup and free resources when no longer needed

dispose() - Method in interface net.sf.ehcache.event.CacheEventListener

Give the replicator a chance to cleanup and free resources when no longer needed

dispose() - Method in class net.sf.ehcache.event.RegisteredEventListeners

Tell listeners to dispose themselves.

dispose() - Method in class net.sf.ehcache.store.DiskStore

Shuts down the disk store in preparation for cache shutdown

If a VM crash happens, the shutdown hook will not run.

dispose() - Method in class net.sf.ehcache.store.MemoryStore

Prepares for shutdown.

dispose() - Method in interface net.sf.ehcache.store.Store

Prepares for shutdown.

doPut(Element) - Method in class net.sf.ehcache.store.FifoMemoryStore

Allow specialised actions over adding the element to the map

doPut(Element) - Method in class net.sf.ehcache.store.LfuMemoryStore

Puts an element into the cache.

doPut(Element) - Method in class net.sf.ehcache.store.MemoryStore

Allow specialised actions over adding the element to the map.

E

EhCache - Class in net.sf.ehcache.hibernate

EHCache plugin for Hibernate.

EhCache(Cache) - Constructor for class net.sf.ehcache.hibernate.EhCache

Creates a new Hibernate pluggable cache by name.

EhCacheProvider - Class in net.sf.ehcache.hibernate

Cache Provider plugin for Hibernate 3.2 and ehcache-1.2.

EhCacheProvider() - Constructor for class net.sf.ehcache.hibernate.EhCacheProvider

Element - Class in net.sf.ehcache

A Cache Element, consisting of a key, value and attributes.

Element(Serializable, Serializable, long) - Constructor for class net.sf.ehcache.Element

A full constructor.

Element(Object, Object, long) - Constructor for class net.sf.ehcache.Element

A full constructor.

Element(Serializable, Serializable) - Constructor for class net.sf.ehcache.Element

Constructor.

Element(Object, Object) - Constructor for class net.sf.ehcache.Element

Constructor.

endElement(String, String, String) - Method in class net.sf.ehcache.config.BeanHandler

Receive notification of the end of an element.

equals(Object) - Method in class net.sf.ehcache.distribution.ConfigurableRMIClientSocketFactory

The standard hashCode method which is necessary for SocketFactory classes.

equals(Object) - Method in class net.sf.ehcache.Element

Equals comparison with another element, based on the key.

equals(Object) - Method in class net.sf.ehcache.Status

Indicates whether some other object is "equal to" this one.

equals(Status) - Method in class net.sf.ehcache.Status

Equality checker when the comparison object is of the same type.

eternal - Variable in class net.sf.ehcache.config.CacheConfiguration

Sets whether elements are eternal.

EventMessage - Class in net.sf.ehcache.distribution

An Event Message, in respect of a particular cache.

EventMessage(int, Serializable, Element) - Constructor for class net.sf.ehcache.distribution.EventMessage

Full constructor.

evict(Element) - Method in class net.sf.ehcache.store.MemoryStore

Evict the Element.

extractAndLogProperty(String, Properties) - Static method in class net.sf.ehcache.util.PropertyUtil

extractCacheName(String) - Static method in class net.sf.ehcache.distribution.RMICacheManagerPeerProvider

Gets the cache name out of the url

F

FactoryConfiguration - Class in net.sf.ehcache.config

A class to represent the CacheManagerEventListener configuration.

FactoryConfiguration() - Constructor for class net.sf.ehcache.config.FactoryConfiguration

FIFO - Static variable in class net.sf.ehcache.store.MemoryStoreEvictionPolicy

FIFO - first in first out, the oldest element by creation time.

FifoMemoryStore - Class in net.sf.ehcache.store

First-In-First-Out (FIFO) implementation of MemoryStore.

FifoMemoryStore(Cache, DiskStore) - Constructor for class net.sf.ehcache.store.FifoMemoryStore

Constructor for the FifoMemoryStore object.

findRelativelyUnused(Element) - Method in class net.sf.ehcache.store.LfuMemoryStore

Find a "relatively" unused element, but not the element just added.

flush() - Method in class net.sf.ehcache.Cache

Flushes all cache items from memory to the disk store, and from the DiskStore to disk.

flush() - Method in class net.sf.ehcache.store.DiskStore

Flush the spool if persistent, so we don't lose any data.

flush() - Method in class net.sf.ehcache.store.MemoryStore

Flush to disk.

fromString(String) - Static method in class net.sf.ehcache.store.MemoryStoreEvictionPolicy

Converts a string representation of the policy into a policy.

fullyQualifiedClassPath - Variable in class net.sf.ehcache.config.FactoryConfiguration

class name.

G

get(Serializable) - Method in class net.sf.ehcache.Cache

Gets an element from the cache.

get(Object) - Method in class net.sf.ehcache.Cache

Gets an element from the cache.

get(Object) - Method in class net.sf.ehcache.hibernate.EhCache

Gets a value of an element which matches the given key.

get(Object) - Method in class net.sf.ehcache.store.DiskStore

Gets an Element from the Disk Store.

get(Object) - Method in class net.sf.ehcache.store.MemoryStore

Gets an item from the cache.

get(Object) - Method in interface net.sf.ehcache.store.Store

Gets an item from the cache.

getBackingCache() - Method in class net.sf.ehcache.hibernate.EhCache

Package protected method used for testing

getBoundCacheInstance() - Method in class net.sf.ehcache.distribution.RMICachePeer

Gets the cache instance that this listener is bound to

getBoundCachePeers() - Method in interface net.sf.ehcache.distribution.CacheManagerPeerListener

All of the caches which are listenting for remote changes.

getBoundCachePeers() - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListener

All of the caches which are listenting for remote changes.

getBytes() - Method in class net.sf.ehcache.store.DiskStore.MemoryEfficientByteArrayOutputStream

Gets the bytes.

getCache(String) - Method in class net.sf.ehcache.CacheManager

Gets a Cache

getCacheConfigurations() - Method in class net.sf.ehcache.config.Configuration

Gets a Map of cache configurations, keyed by name.

getCacheConfigurationsKeySet() - Method in class net.sf.ehcache.config.Configuration

Gets a Map of cacheConfigurations.

getCacheEventListeners() - Method in class net.sf.ehcache.event.RegisteredEventListeners

Gets a list of the listeners registered to this class

getCacheEventNotificationService() - Method in class net.sf.ehcache.Cache

Use this to access the service in order to register and unregister listeners

getCacheManager() - Method in class net.sf.ehcache.Cache

Gets the CacheManager managing this cache.

getCacheManager() - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerProvider

The cacheManager this provider is bound to

getCacheManagerEventListener() - Method in class net.sf.ehcache.CacheManager

Gets the CacheManager event listener.

getCacheManagerEventListenerFactoryConfiguration() - Method in class net.sf.ehcache.config.Configuration

Gets the CacheManagerEventListener factory configuration.

getCacheManagerPeerListenerFactoryConfiguration() - Method in class net.sf.ehcache.config.Configuration

Gets the CacheManagerPeerListener factory configuration.

getCacheManagerPeerProviderFactoryConfiguration() - Method in class net.sf.ehcache.config.Configuration

Gets the CacheManagerPeerProvider factory configuration.

getCacheNames() - Method in class net.sf.ehcache.CacheManager

Returns a list of the current cache names.

getCachePeer() - Method in class net.sf.ehcache.distribution.MulticastRMICacheManagerPeerProvider.CachePeerEntry

getCachePeerListener() - Method in class net.sf.ehcache.CacheManager

When CacheManage is configured as part of a cluster, a CacheManagerPeerListener will be registered in it.

getCachePeerProvider() - Method in class net.sf.ehcache.CacheManager

Gets the CacheManagerPeerProvider For distributed caches, the peer provider finds other cache managers and their caches in the same cluster

getCachePeers() - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListener

Gets a list of cache peers

getConfigurationBean() - Method in class net.sf.ehcache.config.ConfigurationHelper

getConfigurationSource() - Method in class net.sf.ehcache.config.Configuration

Gets a description of the source from which this configuration was created.

getCreationTime() - Method in class net.sf.ehcache.Element

Gets the creationTime attribute of the ElementAttributes object.

getDataFileName() - Method in class net.sf.ehcache.store.DiskStore

getDataFilePath() - Method in class net.sf.ehcache.store.DiskStore

getDataFileSize() - Method in class net.sf.ehcache.store.DiskStore

getDate() - Method in class net.sf.ehcache.distribution.MulticastRMICacheManagerPeerProvider.CachePeerEntry

getDefaultCacheConfiguration() - Method in class net.sf.ehcache.config.Configuration

getDiskExpiryThreadIntervalSeconds() - Method in class net.sf.ehcache.Cache

getDiskStore() - Method in class net.sf.ehcache.Cache

Gets the internal DiskStore.

getDiskStoreConfiguration() - Method in class net.sf.ehcache.config.Configuration

Gets the disk store configuration.

getDiskStoreHitCount() - Method in class net.sf.ehcache.Cache

Number of times a requested item was found in the Disk Store.

getDiskStorePath() - Method in class net.sf.ehcache.config.ConfigurationHelper

getDiskStoreSize() - Method in class net.sf.ehcache.Cache

Returns the number of elements in the disk store.

getElement() - Method in class net.sf.ehcache.distribution.EventMessage

getElementCountInMemory() - Method in class net.sf.ehcache.hibernate.EhCache

getElementCountOnDisk() - Method in class net.sf.ehcache.hibernate.EhCache

getEvent() - Method in class net.sf.ehcache.distribution.EventMessage

Gets the event.

getFirstElement() - Method in class net.sf.ehcache.store.FifoMemoryStore

Returns the first eligible element that can be taken out of the cache based on the FIFO policy

getFullyQualifiedClassPath() - Method in class net.sf.ehcache.config.FactoryConfiguration

Getter.

getGuid() - Method in class net.sf.ehcache.Cache

The GUID for this cache instance can be used to determine whether two cache instance references are pointing to the same cache.

getGuid() - Method in interface net.sf.ehcache.distribution.CachePeer

Gets the globally unique id for the underlying Cache instance.

getGuid() - Method in class net.sf.ehcache.distribution.RMICachePeer

Gets the globally unique id for the underlying Cache instance.

getHitCount() - Method in class net.sf.ehcache.Cache

The number of times a requested item was found in the cache.

getHitCount() - Method in class net.sf.ehcache.Element

Gets the hit count on this element.

getIndexFileName() - Method in class net.sf.ehcache.store.DiskStore

getIndexFileSize() - Method in class net.sf.ehcache.store.DiskStore

getInitialCause() - Method in exception net.sf.ehcache.CacheException

The intiial cause of this Exception.

getInstance() - Static method in class net.sf.ehcache.CacheManager

A factory method to create a singleton CacheManager with default config, or return it if it exists.

getKey() - Method in class net.sf.ehcache.Element

Gets the key attribute of the Element object.

getKeyArray() - Method in class net.sf.ehcache.store.DiskStore

Gets an Array of the keys for all elements in the disk store.

getKeyArray() - Method in class net.sf.ehcache.store.MemoryStore

Gets an Array of the keys for all elements in the memory cache.

getKeys() - Method in class net.sf.ehcache.Cache

Returns a list of all elements in the cache, whether or not they are expired.

getKeysNoDuplicateCheck() - Method in class net.sf.ehcache.Cache

Returns a list of all elements in the cache, whether or not they are expired.

getKeysWithExpiryCheck() - Method in class net.sf.ehcache.Cache

Returns a list of all elements in the cache.

getLastAccessTime() - Method in class net.sf.ehcache.Element

Gets the last access time.

getMaxElementsInMemory() - Method in class net.sf.ehcache.Cache

Gets the maximum number of elements to hold in memory.

getMemoryStore() - Method in class net.sf.ehcache.Cache

Gets the internal MemoryStore.

getMemoryStoreEvictionPolicy() - Method in class net.sf.ehcache.Cache

The policy used to evict elements from the MemoryStore.

getMemoryStoreHitCount() - Method in class net.sf.ehcache.Cache

Number of times a requested item was found in the Memory Store.

getMemoryStoreSize() - Method in class net.sf.ehcache.Cache

Returns the number of elements in the memory store.

getMissCountExpired() - Method in class net.sf.ehcache.Cache

Number of times a requested element was found but was expired.

getMissCountNotFound() - Method in class net.sf.ehcache.Cache

Number of times a requested element was not found in the cache.

getName() - Method in class net.sf.ehcache.Cache

Gets the cache name.

getName() - Method in interface net.sf.ehcache.distribution.CachePeer

Gets the cache name.

getName() - Method in class net.sf.ehcache.distribution.RMICachePeer

Gets the cache name

getNextToLastAccessTime() - Method in class net.sf.ehcache.Element

Gets the next to last access time.

getObjectKey() - Method in class net.sf.ehcache.Element

Gets the key attribute of the Element object.

getObjectValue() - Method in class net.sf.ehcache.Element

Gets the value attribute of the Element object as an Object.

getPath() - Method in class net.sf.ehcache.config.DiskStoreConfiguration

The diskStore path

getProperties() - Method in class net.sf.ehcache.config.FactoryConfiguration

Getter.

getQuiet(Serializable) - Method in class net.sf.ehcache.Cache

Gets an element from the cache, without updating Element statistics.

getQuiet(Object) - Method in class net.sf.ehcache.Cache

Gets an element from the cache, without updating Element statistics.

getQuiet(Object) - Method in class net.sf.ehcache.store.DiskStore

Gets an Element from the Disk Store, without updating statistics

getQuiet(Object) - Method in class net.sf.ehcache.store.MemoryStore

Gets an item from the cache, without updating Element statistics.

getRegionName() - Method in class net.sf.ehcache.hibernate.EhCache

getSerializableKey() - Method in class net.sf.ehcache.distribution.EventMessage

getSerializedSize() - Method in class net.sf.ehcache.Element

The size of this object in serialized form.

getSize() - Method in class net.sf.ehcache.Cache

Gets the size of the cache.

getSize() - Method in class net.sf.ehcache.store.DiskStore

Returns the current store size.

getSize() - Method in class net.sf.ehcache.store.MemoryStore

Returns the current cache size.

getSize() - Method in interface net.sf.ehcache.store.Store

Returns the current store size.

getSizeInBytes() - Method in class net.sf.ehcache.store.MemoryStore

Measures the size of the memory store by measuring the serialized size of all elements.

getSizeInMemory() - Method in class net.sf.ehcache.hibernate.EhCache

Warning: This method can be very expensive to run.

getStandardClassLoader() - Static method in class net.sf.ehcache.util.ClassLoaderUtil

Gets the ClassLoader that all classes in ehcache, and extensions, should use for classloading.

getStatus() - Method in class net.sf.ehcache.Cache

Gets the status attribute of the Cache.

getStatus() - Method in class net.sf.ehcache.CacheManager

Gets the status attribute of the Cache

getStatus() - Method in class net.sf.ehcache.store.DiskStore

Returns the store status.

getStatus() - Method in class net.sf.ehcache.store.MemoryStore

Gets the status of the MemoryStore.

getStatus() - Method in interface net.sf.ehcache.store.Store

Returns the cache status.

getTimeout() - Method in class net.sf.ehcache.hibernate.EhCache

Returns the lock timeout for this cache, which is 60s

getTimeToIdleSeconds() - Method in class net.sf.ehcache.Cache

Gets timeToIdleSeconds.

getTimeToLiveSeconds() - Method in class net.sf.ehcache.Cache

Gets timeToLiveSeconds.

getTotalFileSize() - Method in class net.sf.ehcache.store.DiskStore

getUrl() - Method in interface net.sf.ehcache.distribution.CachePeer

The URL for the remote replicator to connect.

getUrl() - Method in class net.sf.ehcache.distribution.RMICachePeer

The URL for the remote replicator to connect.

getUrlBase() - Method in interface net.sf.ehcache.distribution.CachePeer

The URL base for the remote replicator to connect.

getUrlBase() - Method in class net.sf.ehcache.distribution.RMICachePeer

The URL base for the remote replicator to connect.

getUsedDataSize() - Method in class net.sf.ehcache.store.DiskStore

When elements are deleted, spaces are left in the file.

getValue() - Method in class net.sf.ehcache.Element

Gets the value attribute of the Element object.

getVersion() - Method in class net.sf.ehcache.Element

Gets the version attribute of the ElementAttributes object.

gzip(byte[]) - Static method in class net.sf.ehcache.distribution.PayloadUtil

Gzips a byte[].

H

hashCode() - Method in class net.sf.ehcache.distribution.ConfigurableRMIClientSocketFactory

Implements the Object hashCode method.

hashCode() - Method in class net.sf.ehcache.Element

Gets the hascode, based on the key.

hashCode() - Method in class net.sf.ehcache.Status

Returns a hash code value for the object.

I

init() - Method in interface net.sf.ehcache.distribution.CacheManagerPeerListener

Call to start the listeners and do any other network initialisation.

init() - Method in interface net.sf.ehcache.distribution.CacheManagerPeerProvider

Notifies providers to initialise themselves.

init() - Method in class net.sf.ehcache.distribution.ManualRMICacheManagerPeerProvider

Notifies providers to initialise themselves.

init() - Method in class net.sf.ehcache.distribution.MulticastKeepaliveHeartbeatReceiver

Start.

init() - Method in class net.sf.ehcache.distribution.MulticastKeepaliveHeartbeatSender

Start the heartbeat thread

init() - Method in class net.sf.ehcache.distribution.MulticastRMICacheManagerPeerProvider

Notifies providers to initialise themselves.

init() - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListener

Call to start the listeners and do any other network initialisation.

init() - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerProvider

Notifies providers to initialise themselves.

initialise() - Method in class net.sf.ehcache.Cache

Newly created caches do not have a MemoryStore or a DiskStore.

intValue() - Method in class net.sf.ehcache.Status

Returns the int value of status, for backward compatibility with ehcache versions below 1.2

isDiskPersistent() - Method in class net.sf.ehcache.Cache

isElementInMemory(Serializable) - Method in class net.sf.ehcache.Cache

Whether an Element is stored in the cache in Memory, indicating a very low cost of retrieval.

isElementInMemory(Object) - Method in class net.sf.ehcache.Cache

Whether an Element is stored in the cache in Memory, indicating a very low cost of retrieval.

isElementOnDisk(Serializable) - Method in class net.sf.ehcache.Cache

Whether an Element is stored in the cache on Disk, indicating a higher cost of retrieval.

isElementOnDisk(Object) - Method in class net.sf.ehcache.Cache

Whether an Element is stored in the cache on Disk, indicating a higher cost of retrieval.

isEternal() - Method in class net.sf.ehcache.Cache

Are elements eternal.

isExpired(Element) - Method in class net.sf.ehcache.Cache

Checks whether this cache element has expired.

isExpiryThreadAlive() - Method in class net.sf.ehcache.store.DiskStore

The expiry thread is started provided the cache is not eternal

If started it will continue to run until the DiskStore.dispose() method is called, at which time it should be interrupted and then die.

isFull() - Method in class net.sf.ehcache.store.MemoryStore

An algorithm to tell if the MemoryStore is at or beyond its carrying capacity.

isKeySerializable() - Method in class net.sf.ehcache.Element

Whether the element's key may be Serialized.

isMinimalPutsEnabledByDefault() - Method in class net.sf.ehcache.hibernate.EhCacheProvider

Not sure what this is supposed to do.

isOverflowToDisk() - Method in class net.sf.ehcache.Cache

Does the overflow go to disk.

isReplicateUpdatesViaCopy() - Method in interface net.sf.ehcache.distribution.CacheReplicator

Returns whether update is through copy or invalidate

isReplicateUpdatesViaCopy() - Method in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator

isSerializable() - Method in class net.sf.ehcache.Element

Whether the element may be Serialized.

isSpoolEmpty() - Method in class net.sf.ehcache.store.DiskStore

Whether there are any elements waiting to be spooled to disk.

L

LFU - Static variable in class net.sf.ehcache.store.MemoryStoreEvictionPolicy

LFU - least frequently used.

LfuMemoryStore - Class in net.sf.ehcache.store

Less Frequently Used (LFU) implementation of the memory store.

LfuMemoryStore(Cache, DiskStore) - Constructor for class net.sf.ehcache.store.LfuMemoryStore

Constructor for the LfuMemoryStore object.

listBoundRMICachePeers() - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListener

Returns a list of bound objects.

listRemoteCachePeers(Cache) - Method in interface net.sf.ehcache.distribution.CacheManagerPeerProvider

listRemoteCachePeers(Cache) - Method in class net.sf.ehcache.distribution.ManualRMICacheManagerPeerProvider

listRemoteCachePeers(Cache) - Method in class net.sf.ehcache.distribution.MulticastRMICacheManagerPeerProvider

listRemoteCachePeers(Cache) - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerProvider

listRemoteCachePeers(Cache) - Static method in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator

Package protected List of cache peers

lock(Object) - Method in class net.sf.ehcache.hibernate.EhCache

Calls to this method should perform their own synchronization.

lookupPeer(String) - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListener

Returns a reference to the remote object.

lookupRemoteCachePeer(String) - Static method in class net.sf.ehcache.distribution.RMICacheManagerPeerProvider

The use of one-time registry creation and Naming.rebind should mean we can create as many listeneres as we like.

LRU - Static variable in class net.sf.ehcache.store.MemoryStoreEvictionPolicy

LRU - least recently used.

LruMemoryStore - Class in net.sf.ehcache.store

An implementation of a LruMemoryStore.

LruMemoryStore(Cache, DiskStore) - Constructor for class net.sf.ehcache.store.LruMemoryStore

Constructor for the LruMemoryStore object The backing LinkedHashMap is created with LRU by access order.

LruMemoryStore.SpoolingLinkedHashMap - Class in net.sf.ehcache.store

An extension of LinkedHashMap which overrides LruMemoryStore.SpoolingLinkedHashMap.removeEldestEntry(java.util.Map.Entry) to persist cache entries to the auxiliary cache before they are removed.

LruMemoryStore.SpoolingLinkedHashMap() - Constructor for class net.sf.ehcache.store.LruMemoryStore.SpoolingLinkedHashMap

Default constructor.

LruMemoryStore.SpoolingLRUMap - Class in net.sf.ehcache.store

An LRU Map implementation based on Apache Commons LRUMap.

LruMemoryStore.SpoolingLRUMap() - Constructor for class net.sf.ehcache.store.LruMemoryStore.SpoolingLRUMap

Constructor.

M

ManualRMICacheManagerPeerProvider - Class in net.sf.ehcache.distribution

A provider of Peer RMI addresses based off manual configuration.

ManualRMICacheManagerPeerProvider() - Constructor for class net.sf.ehcache.distribution.ManualRMICacheManagerPeerProvider

Empty constructor.

map - Variable in class net.sf.ehcache.store.MemoryStore

Map where items are stored by key.

maxElementsInMemory - Variable in class net.sf.ehcache.config.CacheConfiguration

the maximum objects to be held in the MemoryStore.

MemoryStore - Class in net.sf.ehcache.store

An abstract class for the Memory Stores.

MemoryStore(Cache, DiskStore) - Constructor for class net.sf.ehcache.store.MemoryStore

Constructs things that all MemoryStores have in common.

memoryStoreEvictionPolicy - Variable in class net.sf.ehcache.config.CacheConfiguration

The policy used to evict elements from the MemoryStore.

MemoryStoreEvictionPolicy - Class in net.sf.ehcache.store

A typesafe enumeration of eviction policies.

MTU - Static variable in class net.sf.ehcache.distribution.PayloadUtil

The maximum transmission unit.

MulticastKeepaliveHeartbeatReceiver - Class in net.sf.ehcache.distribution

Receives heartbeats from any MulticastKeepaliveHeartbeatSenders out there.

MulticastKeepaliveHeartbeatReceiver(MulticastRMICacheManagerPeerProvider, InetAddress, Integer) - Constructor for class net.sf.ehcache.distribution.MulticastKeepaliveHeartbeatReceiver

Constructor.

MulticastKeepaliveHeartbeatSender - Class in net.sf.ehcache.distribution

Sends heartbeats to a multicast group containing a compressed list of URLs.

MulticastKeepaliveHeartbeatSender(CacheManager, InetAddress, Integer) - Constructor for class net.sf.ehcache.distribution.MulticastKeepaliveHeartbeatSender

Constructor

MulticastRMICacheManagerPeerProvider - Class in net.sf.ehcache.distribution

A peer provider which discovers peers using Multicast.

MulticastRMICacheManagerPeerProvider(CacheManager, InetAddress, Integer) - Constructor for class net.sf.ehcache.distribution.MulticastRMICacheManagerPeerProvider

Creates and starts a multicast peer provider

MulticastRMICacheManagerPeerProvider.CachePeerEntry - Class in net.sf.ehcache.distribution

Entry containing a looked up CachePeer and date

MulticastRMICacheManagerPeerProvider.CachePeerEntry(CachePeer, Date) - Constructor for class net.sf.ehcache.distribution.MulticastRMICacheManagerPeerProvider.CachePeerEntry

Constructor

N

name - Variable in class net.sf.ehcache.config.CacheConfiguration

the name of the cache.

net.sf.ehcache - package net.sf.ehcache

This package contains the public API for using ehcache.

net.sf.ehcache.config - package net.sf.ehcache.config

This package contains the cache configuration code.

net.sf.ehcache.distribution - package net.sf.ehcache.distribution

This package is for cache replication.

net.sf.ehcache.event - package net.sf.ehcache.event

This package contains interfaces and classes for listening to events.

net.sf.ehcache.hibernate - package net.sf.ehcache.hibernate

This package contains interfaces and classes for Hibernate3.1 and higher.

net.sf.ehcache.store - package net.sf.ehcache.store

Store package.

net.sf.ehcache.util - package net.sf.ehcache.util

Util package.

NET_SF_EHCACHE_CONFIGURATION_RESOURCE_NAME - Static variable in class net.sf.ehcache.hibernate.EhCacheProvider

The Hibernate system property specifying the location of the ehcache configuration file name.

NET_SF_EHCACHE_DISABLED - Static variable in class net.sf.ehcache.Cache

System Property based method of disabling ehcache.

nextTimestamp() - Method in class net.sf.ehcache.hibernate.EhCache

Gets the next timestamp;

nextTimestamp() - Method in class net.sf.ehcache.hibernate.EhCacheProvider

Returns the next timestamp.

notAlive() - Method in interface net.sf.ehcache.distribution.CacheReplicator

Returns whether the replicator is not active.

notAlive() - Method in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator

Asserts that the replicator is active.

notifyCacheAdded(String) - Method in interface net.sf.ehcache.event.CacheManagerEventListener

Called immediately after a cache has been added and activated.

notifyCacheRemoved(String) - Method in interface net.sf.ehcache.event.CacheManagerEventListener

Called immediately after a cache has been disposed and removed.

notifyElementExpired(Cache, Element) - Method in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator

Called immediately after an element is found to be expired.

notifyElementExpired(Cache, Element) - Method in interface net.sf.ehcache.event.CacheEventListener

Called immediately after an element is found to be expired.

notifyElementExpiry(Element, boolean) - Method in class net.sf.ehcache.event.RegisteredEventListeners

Notifies all registered listeners, in no guaranteed order, that an element has expired

notifyElementPut(Cache, Element) - Method in class net.sf.ehcache.distribution.RMIAsynchronousCacheReplicator

Called immediately after an element has been put into the cache.

notifyElementPut(Cache, Element) - Method in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator

Called immediately after an element has been put into the cache.

notifyElementPut(Cache, Element) - Method in interface net.sf.ehcache.event.CacheEventListener

Called immediately after an element has been put into the cache.

notifyElementPut(Element, boolean) - Method in class net.sf.ehcache.event.RegisteredEventListeners

Notifies all registered listeners, in no guaranteed order, that an element was put into the cache

notifyElementRemoved(Cache, Element) - Method in class net.sf.ehcache.distribution.RMIAsynchronousCacheReplicator

Called immediately after an element has been removed.

notifyElementRemoved(Cache, Element) - Method in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator

Called immediately after an element has been removed.

notifyElementRemoved(Cache, Element) - Method in interface net.sf.ehcache.event.CacheEventListener

Called immediately after an element has been removed.

notifyElementRemoved(Element, boolean) - Method in class net.sf.ehcache.event.RegisteredEventListeners

Notifies all registered listeners, in no guaranteed order, that an element was removed

notifyElementUpdated(Cache, Element) - Method in class net.sf.ehcache.distribution.RMIAsynchronousCacheReplicator

Called immediately after an element has been put into the cache and the element already existed in the cache.

notifyElementUpdated(Cache, Element) - Method in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator

Called immediately after an element has been put into the cache and the element already existed in the cache.

notifyElementUpdated(Cache, Element) - Method in interface net.sf.ehcache.event.CacheEventListener

Called immediately after an element has been put into the cache and the element already existed in the cache.

notifyElementUpdated(Element, boolean) - Method in class net.sf.ehcache.event.RegisteredEventListeners

Notifies all registered listeners, in no guaranteed order, that an element in the cache was updated

notifyExpiry(Element) - Method in class net.sf.ehcache.store.MemoryStore

Before eviction elements are checked.

notifyingRemoveAll() - Method in class net.sf.ehcache.store.MemoryStore

If there are registered CacheEventListeners they are notified of the expiry or removal of the Element as each is removed.

O

ObjectExistsException - Exception in net.sf.ehcache

Thrown when a duplicate cache is attemtpted to be created

ObjectExistsException() - Constructor for exception net.sf.ehcache.ObjectExistsException

Constructor for the ObjectExistsException object.

ObjectExistsException(String) - Constructor for exception net.sf.ehcache.ObjectExistsException

Constructor for the ObjectExistsException object.

overflowToDisk - Variable in class net.sf.ehcache.config.CacheConfiguration

whether elements can overflow to disk when the in-memory cache has reached the set limit.

P

parseConfiguration(File) - Static method in class net.sf.ehcache.config.ConfigurationFactory

Configures a bean from an XML file.

parseConfiguration(URL) - Static method in class net.sf.ehcache.config.ConfigurationFactory

Configures a bean from an XML file available as an URL.

parseConfiguration() - Static method in class net.sf.ehcache.config.ConfigurationFactory

Configures a bean from an XML file in the classpath.

parseConfiguration(InputStream) - Static method in class net.sf.ehcache.config.ConfigurationFactory

Configures a bean from an XML input stream.

parseProperties(String) - Static method in class net.sf.ehcache.util.PropertyUtil

Parse properties supplied as a comma separated list into a Properties object

PayloadUtil - Class in net.sf.ehcache.distribution

This class provides utility methods for assembling and disassembling a heartbeat payload.

peerUrls - Variable in class net.sf.ehcache.distribution.RMICacheManagerPeerProvider

Contains a RMI URLs of the form: "//" + hostName + ":" + port + "/" + cacheName;

processRemovedLRU(Object, Object) - Method in class net.sf.ehcache.store.LruMemoryStore.SpoolingLRUMap

Called after the element has been removed.

properties - Variable in class net.sf.ehcache.config.FactoryConfiguration

properties.

PropertyUtil - Class in net.sf.ehcache.util

Property utilities.

put(Element) - Method in class net.sf.ehcache.Cache

Put an element in the cache.

put(Element, boolean) - Method in class net.sf.ehcache.Cache

Put an element in the cache.

put(Element) - Method in interface net.sf.ehcache.distribution.CachePeer

Put an element in the cache.

PUT - Static variable in class net.sf.ehcache.distribution.EventMessage

A put or update event.

put(Element) - Method in class net.sf.ehcache.distribution.RMICachePeer

Puts an Element into the underlying cache without notifying listeners or updating statistics.

put(Object, Object) - Method in class net.sf.ehcache.hibernate.EhCache

Puts an object into the cache.

put(Element) - Method in class net.sf.ehcache.store.DiskStore

Puts an element into the disk store.

put(Element) - Method in class net.sf.ehcache.store.MemoryStore

Puts an item in the cache.

put(Element) - Method in interface net.sf.ehcache.store.Store

Puts an item into the cache.

putQuiet(Element) - Method in class net.sf.ehcache.Cache

Put an element in the cache, without updating statistics, or updating listeners.

R

read(Object) - Method in class net.sf.ehcache.hibernate.EhCache

Gets an object from the cache.

registerCacheListeners(CacheConfiguration, RegisteredEventListeners) - Static method in class net.sf.ehcache.config.ConfigurationHelper

A factory method to create a RegisteredEventListeners

RegisteredEventListeners - Class in net.sf.ehcache.event

Registered listeners for registering and unregistering CacheEventListeners and multicasting notifications to registrants.

RegisteredEventListeners(Cache) - Constructor for class net.sf.ehcache.event.RegisteredEventListeners

Constructs a new notification service

registerListener(CacheEventListener) - Method in class net.sf.ehcache.event.RegisteredEventListeners

Adds a listener to the notification service.

registerPeer(String) - Method in interface net.sf.ehcache.distribution.CacheManagerPeerProvider

Register a new peer.

registerPeer(String) - Method in class net.sf.ehcache.distribution.ManualRMICacheManagerPeerProvider

Register a new peer.

registerPeer(String) - Method in class net.sf.ehcache.distribution.MulticastRMICacheManagerPeerProvider

Register a new peer.

registerPeer(String) - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerProvider

Register a new peer

RemoteCacheException - Exception in net.sf.ehcache.distribution

A Cache Exception in the distribution mechanism.

RemoteCacheException() - Constructor for exception net.sf.ehcache.distribution.RemoteCacheException

Constructor for the RemoteCacheException object.

RemoteCacheException(String) - Constructor for exception net.sf.ehcache.distribution.RemoteCacheException

Constructor for the RemoteCacheException object.

removalAll() - Method in class net.sf.ehcache.CacheManager

Removes all caches using CacheManager.removeCache(java.lang.String) for each cache.

remove(Serializable) - Method in class net.sf.ehcache.Cache

Removes an Element from the Cache.

remove(Object) - Method in class net.sf.ehcache.Cache

Removes an Element from the Cache.

remove(Serializable, boolean) - Method in class net.sf.ehcache.Cache

Removes an Element from the Cache.

remove(Object, boolean) - Method in class net.sf.ehcache.Cache

Removes an Element from the Cache.

remove(Serializable) - Method in interface net.sf.ehcache.distribution.CachePeer

Removes an Element from the Cache.

REMOVE - Static variable in class net.sf.ehcache.distribution.EventMessage

A remove or invalidate event.

remove(Serializable) - Method in class net.sf.ehcache.distribution.RMICachePeer

Removes an Element from the underlying cache without notifying listeners or updating statistics.

remove(Object) - Method in class net.sf.ehcache.hibernate.EhCache

Removes the element which matches the key.

remove(Object) - Method in class net.sf.ehcache.store.DiskStore

Removes an item from the disk store.

remove(Object) - Method in class net.sf.ehcache.store.MemoryStore

Removes an Element from the store.

remove(Object) - Method in interface net.sf.ehcache.store.Store

Removes an item from the cache.

removeAll() - Method in class net.sf.ehcache.Cache

Removes all cached items.

removeAll() - Method in interface net.sf.ehcache.distribution.CachePeer

Removes all cached items.

removeAll() - Method in class net.sf.ehcache.distribution.RMICachePeer

Removes all cached items.

removeAll() - Method in class net.sf.ehcache.store.DiskStore

Remove all of the elements from the store.

removeAll() - Method in class net.sf.ehcache.store.MemoryStore

Remove all of the elements from the store.

removeAll() - Method in interface net.sf.ehcache.store.Store

Remove all of the elements from the store.

removeCache(String) - Method in class net.sf.ehcache.CacheManager

Remove a cache from the CacheManager.

removeEldestEntry(Map.Entry) - Method in class net.sf.ehcache.store.LruMemoryStore.SpoolingLinkedHashMap

Returns true if this map should remove its eldest entry.

removeQuiet(Serializable) - Method in class net.sf.ehcache.Cache

Removes an Element from the Cache, without notifying listeners.

removeQuiet(Object) - Method in class net.sf.ehcache.Cache

Removes an Element from the Cache, without notifying listeners.

replicatePuts - Variable in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator

Whether to replicate puts.

replicateRemovals - Variable in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator

Whether to replicate removes

replicateUpdates - Variable in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator

Whether to replicate updates.

replicateUpdatesViaCopy - Variable in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator

Whether an update (a put) should be by copy or by invalidation, (a remove).

REPLICATION_THREAD_INTERVAL - Static variable in class net.sf.ehcache.distribution.RMIAsynchronousCacheReplicator

The amount of time the replication thread sleeps after it detects the replicationQueue is empty before checking again.

replicationQueue - Variable in class net.sf.ehcache.distribution.RMIAsynchronousCacheReplicator

A queue of updates.

replicationThread - Variable in class net.sf.ehcache.distribution.RMIAsynchronousCacheReplicator

A thread which handles replication, so that replication can take place asynchronously and not hold up the cache

resetAccessStatistics() - Method in class net.sf.ehcache.Element

Resets the hit count to 0 and the last access time to 0.

RMIAsynchronousCacheReplicator - Class in net.sf.ehcache.distribution

Listens to CacheManager and Cache events and propagates those to CachePeer peers of the Cache asynchronously.

RMIAsynchronousCacheReplicator(boolean, boolean, boolean, boolean) - Constructor for class net.sf.ehcache.distribution.RMIAsynchronousCacheReplicator

Constructor for internal and subclass use

RMICacheManagerPeerListener - Class in net.sf.ehcache.distribution

A cache server which exposes available cache operations remotely through RMI.

RMICacheManagerPeerListener(String, Integer, CacheManager, Integer) - Constructor for class net.sf.ehcache.distribution.RMICacheManagerPeerListener

Constructor with full arguments.

RMICacheManagerPeerListenerFactory - Class in net.sf.ehcache.distribution

Builds a listener based on RMI.

RMICacheManagerPeerListenerFactory() - Constructor for class net.sf.ehcache.distribution.RMICacheManagerPeerListenerFactory

RMICacheManagerPeerProvider - Class in net.sf.ehcache.distribution

A provider of Peer RMI addresses.

RMICacheManagerPeerProvider(CacheManager) - Constructor for class net.sf.ehcache.distribution.RMICacheManagerPeerProvider

Constructor

RMICacheManagerPeerProvider() - Constructor for class net.sf.ehcache.distribution.RMICacheManagerPeerProvider

Empty constructor

RMICacheManagerPeerProviderFactory - Class in net.sf.ehcache.distribution

Builds a factory based on RMI

RMICacheManagerPeerProviderFactory() - Constructor for class net.sf.ehcache.distribution.RMICacheManagerPeerProviderFactory

RMICachePeer - Class in net.sf.ehcache.distribution

An RMI based implementation of CachePeer.

RMICachePeer(Cache, String, Integer, Integer) - Constructor for class net.sf.ehcache.distribution.RMICachePeer

Construct a new remote peer.

RMICacheReplicatorFactory - Class in net.sf.ehcache.distribution

Creates an RMICacheReplicator using properties.

RMICacheReplicatorFactory() - Constructor for class net.sf.ehcache.distribution.RMICacheReplicatorFactory

RMISynchronousCacheReplicator - Class in net.sf.ehcache.distribution

Listens to CacheManager and Cache events and propagates those to CachePeer peers of the Cache.

RMISynchronousCacheReplicator(boolean, boolean, boolean, boolean) - Constructor for class net.sf.ehcache.distribution.RMISynchronousCacheReplicator

Constructor for internal and subclass use

S

sampleElements(int) - Method in class net.sf.ehcache.store.LfuMemoryStore

Uses random numbers to sample the entire map.

send(List) - Method in interface net.sf.ehcache.distribution.CachePeer

Send the cache peer with an ordered list of EventMessages.

send(List) - Method in class net.sf.ehcache.distribution.RMICachePeer

Send the cache peer with an ordered list of EventMessages

This enables multiple messages to be delivered in one network invocation.

setCacheManager(CacheManager) - Method in class net.sf.ehcache.Cache

Package local setter for use by CacheManager

setCacheManagerEventListener(CacheManagerEventListener) - Method in class net.sf.ehcache.CacheManager

Sets the CacheManager event listener.

setClass(String) - Method in class net.sf.ehcache.config.FactoryConfiguration

Sets the class name.

setCreateTime() - Method in class net.sf.ehcache.Element

Sets the creationTime attribute of the ElementAttributes object.

setDefaultCacheConfiguration(CacheConfiguration) - Method in class net.sf.ehcache.config.Configuration

setDiskExpiryThreadIntervalSeconds(int) - Method in class net.sf.ehcache.config.CacheConfiguration

Sets the interval in seconds between runs of the disk expiry thread.

setDiskPersistent(boolean) - Method in class net.sf.ehcache.config.CacheConfiguration

Sets whether, for caches that overflow to disk, the disk cache persist between CacheManager instances.

setDocumentLocator(Locator) - Method in class net.sf.ehcache.config.BeanHandler

Receive a Locator object for document events.

setEternal(boolean) - Method in class net.sf.ehcache.config.CacheConfiguration

Sets whether elements are eternal.

setMaxElementsInMemory(int) - Method in class net.sf.ehcache.config.CacheConfiguration

Sets the maximum objects to be held in memory.

setMemoryStoreEvictionPolicy(String) - Method in class net.sf.ehcache.config.CacheConfiguration

Sets the eviction policy.

setName(String) - Method in class net.sf.ehcache.Cache

Sets the cache name which will name.

setName(String) - Method in class net.sf.ehcache.config.CacheConfiguration

Sets the name of the cache.

setOverflowToDisk(boolean) - Method in class net.sf.ehcache.config.CacheConfiguration

Sets whether elements can overflow to disk when the in-memory cache has reached the set limit.

setPath(String) - Method in class net.sf.ehcache.config.DiskStoreConfiguration

Translates and sets the path.

setProperties(String) - Method in class net.sf.ehcache.config.FactoryConfiguration

Sets the configuration properties.

setSource(String) - Method in class net.sf.ehcache.config.Configuration

Sets the configuration source.

setTimeToIdleSeconds(int) - Method in class net.sf.ehcache.config.CacheConfiguration

Sets the time to idle for an element before it expires.

setTimeToLiveSeconds(int) - Method in class net.sf.ehcache.config.CacheConfiguration

Sets the time to idle for an element before it expires.

setVersion(long) - Method in class net.sf.ehcache.Element

Sets the version attribute of the ElementAttributes object.

shutdown() - Method in class net.sf.ehcache.CacheManager

Shuts down the CacheManager.

spoolAllToDisk() - Method in class net.sf.ehcache.store.MemoryStore

Spools all elements to disk, in preparation for shutdown.

spoolToDisk(Element) - Method in class net.sf.ehcache.store.MemoryStore

Puts the element in the DiskStore.

stale(Date) - Method in class net.sf.ehcache.distribution.ManualRMICacheManagerPeerProvider

Whether the entry should be considered stale.

stale(Date) - Method in class net.sf.ehcache.distribution.MulticastRMICacheManagerPeerProvider

Whether the entry should be considered stale.

stale(Date) - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerProvider

Whether the entry should be considered stale.

STALE_PEER_TIME_MS - Static variable in class net.sf.ehcache.distribution.MulticastRMICacheManagerPeerProvider

The number of ms until the peer is considered to be offline.

start(Properties) - Method in class net.sf.ehcache.hibernate.EhCacheProvider

Callback to perform any necessary initialization of the underlying cache implementation during SessionFactory construction.

startElement(String, String, String, Attributes) - Method in class net.sf.ehcache.config.BeanHandler

Receive notification of the start of an element.

status - Variable in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator

The status of the replicator.

Status - Class in net.sf.ehcache

A pre JDK1.5 compatible enum class to indicate the status of a CacheManager or Cache.

status - Variable in class net.sf.ehcache.store.MemoryStore

status.

STATUS_ALIVE - Static variable in class net.sf.ehcache.Status

The cache is alive.

STATUS_SHUTDOWN - Static variable in class net.sf.ehcache.Status

The cache is shudown.

STATUS_UNINITIALISED - Static variable in class net.sf.ehcache.Status

The cache is uninitialised.

stop() - Method in class net.sf.ehcache.hibernate.EhCacheProvider

Callback to perform any necessary cleanup of the underlying cache implementation during SessionFactory.close().

Store - Interface in net.sf.ehcache.store

This is the interface for all stores.

T

timeToIdleSeconds - Variable in class net.sf.ehcache.config.CacheConfiguration

the time to idle for an element before it expires.

timeToLiveSeconds - Variable in class net.sf.ehcache.config.CacheConfiguration

Sets the time to idle for an element before it expires.

toMap() - Method in class net.sf.ehcache.hibernate.EhCache

toString() - Method in class net.sf.ehcache.Cache

Returns a String representation of Cache.

toString() - Method in class net.sf.ehcache.Element

Returns a String representation of the Element.

toString() - Method in class net.sf.ehcache.event.RegisteredEventListeners

Returns a string representation of the object.

toString() - Method in class net.sf.ehcache.hibernate.EhCache

toString() - Method in class net.sf.ehcache.Status

Returns a string representation of the object.

toString() - Method in class net.sf.ehcache.store.DiskStore

Returns a String representation of the DiskStore

toString() - Method in class net.sf.ehcache.store.MemoryStoreEvictionPolicy

U

ungzip(byte[]) - Static method in class net.sf.ehcache.distribution.PayloadUtil

The fastest Ungzip implementation.

unlock(Object) - Method in class net.sf.ehcache.hibernate.EhCache

Calls to this method should perform their own synchronization.

unregisterListener(CacheEventListener) - Method in class net.sf.ehcache.event.RegisteredEventListeners

Removes a listener from the notification service.

unregisterPeer(String) - Method in interface net.sf.ehcache.distribution.CacheManagerPeerProvider

Unregisters a peer.

unregisterPeer(String) - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerProvider

Unregisters a peer

update(Object, Object) - Method in class net.sf.ehcache.hibernate.EhCache

Updates an object in the cache, or if it does not exist, inserts it.

updateAccessStatistics() - Method in class net.sf.ehcache.Element

Sets the last access time to now.

URL_DELIMITER - Static variable in class net.sf.ehcache.distribution.PayloadUtil

Delmits URLS sent via heartbeats over sockets

A B C D E F G H I L M N O P R S T U