ehcache

Uses of Class
net.sf.ehcache.CacheException

Packages that use CacheException
net.sf.ehcache This package contains the public API for using ehcache. 
net.sf.ehcache.bootstrap This package contains the bootstrap cache loader interface and abstract factory. 
net.sf.ehcache.config This package contains the cache configuration code. 
net.sf.ehcache.constructs.blocking Doug Lea in his book Concurrent Programming in Java talks about concurrency support constructs. 
net.sf.ehcache.constructs.concurrent This package contains the Mutex class and Sync interface taken as is, with fixed for checkstyle and javadoc errors from version 1.3.4 of Doug Lea's concurrency package. 
net.sf.ehcache.constructs.web

Constructs useful for Java EE Web Container environments, specifically the Servlet 2.3 and later specifications. 

net.sf.ehcache.constructs.web.filter

Caching filters compliant with the filters in the Servlet 2.3 specification. 

net.sf.ehcache.distribution This package is for cache replication. 
net.sf.ehcache.distribution.jgroups This package is for cache replication using Jgroups. 
net.sf.ehcache.event This package contains interfaces and classes for listening to events. 
net.sf.ehcache.extension This package contains interfaces and classes for the cache extension mechanism. 
net.sf.ehcache.jcache This package contains an implementation of JSR-107: the JCACHE API. 
net.sf.ehcache.management This package contains JMX MBeans and implementations for management of ehcache. 
net.sf.ehcache.store Store package. 
net.sf.ehcache.util Util package. 
 

Uses of CacheException in net.sf.ehcache
 

Subclasses of CacheException in net.sf.ehcache
 class ObjectExistsException
          Thrown when a duplicate cache is attemtpted to be created
 

Methods in net.sf.ehcache that throw CacheException
 void CacheManager.addCache(Cache cache)
          Adds a Cache to the CacheManager.
 void CacheManager.addCache(Ehcache cache)
          Adds an Ehcache to the CacheManager.
 void CacheManager.addCache(JCache jCache)
          Adds a Cache to the CacheManager.
 void CacheManager.addCache(java.lang.String cacheName)
          Adds a Ehcache based on the defaultCache with the given name.
 long Ehcache.calculateInMemorySize()
          Gets the size of the memory store for this cache

Warning: This method can be very expensive to run.

 long Cache.calculateInMemorySize()
          Gets the size of the memory store for this cache.
 void CacheManager.clearAll()
          Clears the contents of all caches in the CacheManager, but without removing any caches.
static CacheManager CacheManager.create()
          A factory method to create a singleton CacheManager with default config, or return it if it exists.
static CacheManager CacheManager.create(java.io.InputStream inputStream)
          A factory method to create a singleton CacheManager from a java.io.InputStream.
static CacheManager CacheManager.create(java.lang.String configurationFileName)
          A factory method to create a singleton CacheManager with a specified configuration.
static CacheManager CacheManager.create(java.net.URL configurationFileURL)
          A factory method to create a singleton CacheManager from an URL.
 void Ehcache.flush()
          Flushes all cache items from memory to the disk store, and from the DiskStore to disk.
 void Cache.flush()
          Flushes all cache items from memory to the disk store, and from the DiskStore to disk.
 Element Ehcache.get(java.lang.Object key)
          Gets an element from the cache.
 Element Cache.get(java.lang.Object key)
          Gets an element from the cache.
 Element Ehcache.get(java.io.Serializable key)
          Gets an element from the cache.
 Element Cache.get(java.io.Serializable key)
          Gets an element from the cache.
 java.util.Map Ehcache.getAllWithLoader(java.util.Collection keys, java.lang.Object loaderArgument)
          Warning: This method is related to the JSR107 specification, which is in draft.
 java.util.Map Cache.getAllWithLoader(java.util.Collection keys, java.lang.Object loaderArgument)
          Warning: This method is related to the JSR107 specification, which is in draft.
static CacheManager CacheManager.getInstance()
          A factory method to create a singleton CacheManager with default config, or return it if it exists.
 java.util.List Ehcache.getKeys()
          Returns a list of all elements in the cache, whether or not they are expired.
 java.util.List Cache.getKeys()
          Returns a list of all element keys in the cache, whether or not they are expired.
 java.util.List Ehcache.getKeysWithExpiryCheck()
          Returns a list of all elements in the cache.
 java.util.List Cache.getKeysWithExpiryCheck()
          Returns a list of all element keys in the cache.
 Element Ehcache.getQuiet(java.lang.Object key)
          Gets an element from the cache, without updating Element statistics.
 Element Cache.getQuiet(java.lang.Object key)
          Gets an element from the cache, without updating Element statistics.
 Element Ehcache.getQuiet(java.io.Serializable key)
          Gets an element from the cache, without updating Element statistics.
 Element Cache.getQuiet(java.io.Serializable key)
          Gets an element from the cache, without updating Element statistics.
 int Ehcache.getSize()
          Gets the size of the cache.
 int Cache.getSize()
          Gets the size of the cache.
 Element Ehcache.getWithLoader(java.lang.Object key, CacheLoader loader, java.lang.Object loaderArgument)
          Warning: This method is related to the JSR107 specification, which is in draft.
 Element Cache.getWithLoader(java.lang.Object key, CacheLoader loader, java.lang.Object loaderArgument)
          Warning: This method is related to the JSR107 specification, which is in draft.
 void Ehcache.load(java.lang.Object key)
          Warning: This method is related to the JSR107 specification, which is in draft.
 void Cache.load(java.lang.Object key)
          Warning: This method is related to the JSR107 specification, which is in draft.
 void Ehcache.loadAll(java.util.Collection keys, java.lang.Object argument)
          Warning: This method is related to the JSR107 specification, which is in draft.
 void Cache.loadAll(java.util.Collection keys, java.lang.Object argument)
          Warning: This method is related to the JSR107 specification, which is in draft.
 void Ehcache.put(Element element)
          Put an element in the cache.
 void Cache.put(Element element)
          Put an element in the cache.
 void Ehcache.put(Element element, boolean doNotNotifyCacheReplicators)
          Put an element in the cache.
 void Cache.put(Element element, boolean doNotNotifyCacheReplicators)
          Put an element in the cache.
 void Ehcache.putQuiet(Element element)
          Put an element in the cache, without updating statistics, or updating listeners.
 void Cache.putQuiet(Element element)
          Put an element in the cache, without updating statistics, or updating listeners.
 void Ehcache.removeAll()
          Removes all cached items.
 void Cache.removeAll()
          Removes all cached items.
 void Ehcache.removeAll(boolean doNotNotifyCacheReplicators)
          Removes all cached items.
 void Cache.removeAll(boolean doNotNotifyCacheReplicators)
          Removes all cached items.
 void CacheManager.replaceCacheWithDecoratedCache(Ehcache ehcache, Ehcache decoratedCache)
          Replaces in the map of Caches managed by this CacheManager an Ehcache with a decorated version of the same Ehcache.
 void CacheManager.replaceEhcacheWithJCache(Ehcache ehcache, JCache jCache)
          Replaces in the map of Caches managed by this CacheManager an Ehcache with a JCache decorated version of the same (see Ehcache equals method) Ehcache, in a single synchronized method.
 void Ehcache.setBootstrapCacheLoader(BootstrapCacheLoader bootstrapCacheLoader)
          Sets the bootstrap cache loader.
 void Cache.setBootstrapCacheLoader(BootstrapCacheLoader bootstrapCacheLoader)
          Sets the bootstrap cache loader.
 void Ehcache.setDiskStorePath(java.lang.String diskStorePath)
          DiskStore paths can conflict between CacheManager instances.
 void Cache.setDiskStorePath(java.lang.String diskStorePath)
          DiskStore paths can conflict between CacheManager instances.
 

Constructors in net.sf.ehcache that throw CacheException
CacheManager()
          Constructor.
CacheManager(Configuration configuration)
          An constructor for CacheManager, which takes a configuration object, rather than one created by parsing an ehcache.xml file.
CacheManager(java.io.InputStream configurationInputStream)
          An ordinary constructor for CacheManager.
CacheManager(java.lang.String configurationFileName)
          An ordinary constructor for CacheManager.
CacheManager(java.net.URL configurationURL)
          An ordinary constructor for CacheManager.
 

Uses of CacheException in net.sf.ehcache.bootstrap
 

Methods in net.sf.ehcache.bootstrap that throw CacheException
 void BootstrapCacheLoader.load(Ehcache cache)
          Instructs the loader to load the given cache
 

Uses of CacheException in net.sf.ehcache.config
 

Methods in net.sf.ehcache.config that throw CacheException
 BootstrapCacheLoader ConfigurationHelper.createBootstrapCacheLoader(CacheConfiguration.BootstrapCacheLoaderFactoryConfiguration factoryConfiguration)
          Tries to load a BootstrapCacheLoader from the class specified.
 CacheExceptionHandler ConfigurationHelper.createCacheExceptionHandler(CacheConfiguration.CacheExceptionHandlerFactoryConfiguration factoryConfiguration)
          Tries to create a CacheLoader from the configuration using the factory specified.
 CacheLoader ConfigurationHelper.createCacheLoader(CacheConfiguration.CacheLoaderFactoryConfiguration factoryConfiguration)
          Tries to create a CacheLoader from the configuration using the factory specified.
 CacheManagerEventListener ConfigurationHelper.createCacheManagerEventListener()
          Tries to load the class specified.
 Ehcache ConfigurationHelper.createDefaultCache()
           
static Configuration ConfigurationFactory.parseConfiguration()
          Configures a bean from an XML file in the classpath.
static Configuration ConfigurationFactory.parseConfiguration(java.io.File file)
          Configures a bean from an XML file.
static Configuration ConfigurationFactory.parseConfiguration(java.io.InputStream inputStream)
          Configures a bean from an XML input stream.
static Configuration ConfigurationFactory.parseConfiguration(java.net.URL url)
          Configures a bean from an XML file available as an URL.
 

Uses of CacheException in net.sf.ehcache.constructs.blocking
 

Subclasses of CacheException in net.sf.ehcache.constructs.blocking
 class LockTimeoutException
          Indicates that a timeout has occured while attempting to obtain a lock using Mutex.attempt(long)

This is a normal runtime exception which should be handled by calling code.

 

Methods in net.sf.ehcache.constructs.blocking that throw CacheException
 long BlockingCache.calculateInMemorySize()
          Gets the size of the memory store for this cache

Warning: This method can be very expensive to run.

 void BlockingCache.flush()
          Flushes all cache items from memory to the disk store, and from the DiskStore to disk.
 Element BlockingCache.get(java.io.Serializable key)
          Gets an element from the cache.
 java.util.Map BlockingCache.getAllWithLoader(java.util.Collection keys, java.lang.Object loaderArgument)
          This method is not appropriate to use with BlockingCache.
 java.util.List BlockingCache.getKeys()
          Returns the keys for this cache.
 java.util.List BlockingCache.getKeysWithExpiryCheck()
          Returns a list of all elements in the cache.
 Element BlockingCache.getQuiet(java.lang.Object key)
          Gets an element from the cache, without updating Element statistics.
 Element BlockingCache.getQuiet(java.io.Serializable key)
          Gets an element from the cache, without updating Element statistics.
 int BlockingCache.getSize()
          Gets the size of the cache.
 Element BlockingCache.getWithLoader(java.lang.Object key, CacheLoader loader, java.lang.Object loaderArgument)
          This method is not appropriate to use with BlockingCache.
 void BlockingCache.load(java.lang.Object key)
          This method is not appropriate to use with BlockingCache.
 void BlockingCache.loadAll(java.util.Collection keys, java.lang.Object argument)
          This method is not appropriate to use with BlockingCache.
 void BlockingCache.put(Element element, boolean doNotNotifyCacheReplicators)
          Put an element in the cache.
 void BlockingCache.putQuiet(Element element)
          Put an element in the cache, without updating statistics, or updating listeners.
 void UpdatingSelfPopulatingCache.refresh()
          This method should not be used.
 void SelfPopulatingCache.refresh()
          Refresh the elements of this cache.
 void BlockingCache.removeAll()
          Removes all cached items.
 void BlockingCache.removeAll(boolean doNotNotifyCacheReplicators)
          Removes all cached items.
 void BlockingCache.setBootstrapCacheLoader(BootstrapCacheLoader bootstrapCacheLoader)
          Sets the bootstrap cache loader.
 void BlockingCache.setDiskStorePath(java.lang.String diskStorePath)
          DiskStore paths can conflict between CacheManager instances.
 

Constructors in net.sf.ehcache.constructs.blocking that throw CacheException
BlockingCache(Ehcache cache)
          Creates a BlockingCache which decorates the supplied cache.
SelfPopulatingCache(Ehcache cache, CacheEntryFactory factory)
          Creates a SelfPopulatingCache.
UpdatingSelfPopulatingCache(Ehcache cache, UpdatingCacheEntryFactory factory)
          Creates a SelfPopulatingCache.
 

Uses of CacheException in net.sf.ehcache.constructs.concurrent
 

Methods in net.sf.ehcache.constructs.concurrent that throw CacheException
static int ConcurrencyUtil.selectLock(java.lang.Object key, int numberOfLocks)
          Selects a lock for a key.
 

Uses of CacheException in net.sf.ehcache.constructs.web
 

Subclasses of CacheException in net.sf.ehcache.constructs.web
 class AlreadyCommittedException
          

This exception is thrown if, in particular, the ServletResponse.isCommitted() method shows the response has been committed.

 class AlreadyGzippedException
          The web package performs gzipping operations.
 class ResponseHeadersNotModifiableException
          The HttpServletResponse.setHeader(String, String) method sets a response header with the given name and value.
 

Uses of CacheException in net.sf.ehcache.constructs.web.filter
 

Subclasses of CacheException in net.sf.ehcache.constructs.web.filter
 class FilterNonReentrantException
          Thrown when it is detected that a caching filter's Filter.doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain) method is reentered by the same thread.
 

Methods in net.sf.ehcache.constructs.web.filter that throw CacheException
 void CachingFilter.doInit(javax.servlet.FilterConfig filterConfig)
          Initialises blockingCache to use.
 

Uses of CacheException in net.sf.ehcache.distribution
 

Subclasses of CacheException in net.sf.ehcache.distribution
 class RemoteCacheException
          A Cache Exception in the distribution mechanism.
 

Methods in net.sf.ehcache.distribution that throw CacheException
 void RMICacheManagerPeerListener.attemptResolutionOfUniqueResourceConflict()
          If a conflict is detected in unique resource use, this method signals the listener to attempt automatic resolution of the resource conflict.
 void CacheManagerPeerListener.attemptResolutionOfUniqueResourceConflict()
          If a conflict is detected in unique resource use, this method signals the listener to attempt automatic resolution of the resource conflict.
 CacheManagerPeerListener RMICacheManagerPeerListenerFactory.createCachePeerListener(CacheManager cacheManager, java.util.Properties properties)
           
 CacheManagerPeerProvider RMICacheManagerPeerProviderFactory.createCachePeerProvider(CacheManager cacheManager, java.util.Properties properties)
           
 void RMICacheManagerPeerProvider.dispose()
          Providers may be doing all sorts of exotic things and need to be able to clean up on dispose.
 void RMICacheManagerPeerListener.dispose()
          Stop the listener.
 void CacheManagerPeerProvider.dispose()
          Providers may be doing all sorts of exotic things and need to be able to clean up on dispose.
 void RMICacheManagerPeerListener.init()
          Call to start the listeners and do any other required initialisation.
 void MulticastRMICacheManagerPeerProvider.init()
          Notifies providers to initialise themselves.
protected  java.lang.String[] RMICacheManagerPeerListener.listBoundRMICachePeers()
          Returns a list of bound objects.
abstract  java.util.List RMICacheManagerPeerProvider.listRemoteCachePeers(Ehcache cache)
           
 java.util.List MulticastRMICacheManagerPeerProvider.listRemoteCachePeers(Ehcache cache)
           
 java.util.List ManualRMICacheManagerPeerProvider.listRemoteCachePeers(Ehcache cache)
           
 java.util.List CacheManagerPeerProvider.listRemoteCachePeers(Ehcache cache)
           
protected  java.rmi.Remote RMICacheManagerPeerListener.lookupPeer(java.lang.String name)
          Returns a reference to the remote object.
 void RMICacheManagerPeerListener.notifyCacheAdded(java.lang.String cacheName)
          Called immediately after a cache has been added and activated.
 void RMISynchronousCacheReplicator.notifyElementPut(Ehcache cache, Element element)
          Called immediately after an element has been put into the cache.
 void RMIAsynchronousCacheReplicator.notifyElementPut(Ehcache cache, Element element)
          Called immediately after an element has been put into the cache.

This implementation queues the put notification for in-order replication to peers.

 void RMISynchronousCacheReplicator.notifyElementRemoved(Ehcache cache, Element element)
          Called immediately after an attempt to remove an element.
 void RMIAsynchronousCacheReplicator.notifyElementRemoved(Ehcache cache, Element element)
          Called immediately after an attempt to remove an element.
 void RMISynchronousCacheReplicator.notifyElementUpdated(Ehcache cache, Element element)
          Called immediately after an element has been put into the cache and the element already existed in the cache.
 void RMIAsynchronousCacheReplicator.notifyElementUpdated(Ehcache cache, Element element)
          Called immediately after an element has been put into the cache and the element already existed in the cache.
 

Uses of CacheException in net.sf.ehcache.distribution.jgroups
 

Methods in net.sf.ehcache.distribution.jgroups that throw CacheException
 void JGroupManager.dispose()
          Providers may be doing all sorts of exotic things and need to be able to clean up on dispose.
 java.util.List JGroupManager.listRemoteCachePeers(Ehcache cache)
          
 void JGroupsCacheReplicator.notifyElementPut(Ehcache cache, Element element)
          Called immediately after an element has been put into the cache.
 void JGroupsCacheReplicator.notifyElementRemoved(Ehcache cache, Element element)
          Called immediately after an attempt to remove an element.
 void JGroupsCacheReplicator.notifyElementUpdated(Ehcache cache, Element element)
          Called immediately after an element has been put into the cache and the element already existed in the cache.
 

Uses of CacheException in net.sf.ehcache.event
 

Methods in net.sf.ehcache.event that throw CacheException
 void CacheManagerEventListener.dispose()
          Stop the listener and free any resources.
 void CacheManagerEventListener.init()
          Call to start the listeners and do any other required initialisation.
 void CacheEventListener.notifyElementPut(Ehcache cache, Element element)
          Called immediately after an element has been put into the cache.
 void RegisteredEventListeners.notifyElementPut(Element element, boolean remoteEvent)
          Notifies all registered listeners, in no guaranteed order, that an element was put into the cache
 void CacheEventListener.notifyElementRemoved(Ehcache cache, Element element)
          Called immediately after an attempt to remove an element.
 void RegisteredEventListeners.notifyElementRemoved(Element element, boolean remoteEvent)
          Notifies all registered listeners, in no guaranteed order, that an element was removed
 void CacheEventListener.notifyElementUpdated(Ehcache cache, Element element)
          Called immediately after an element has been put into the cache and the element already existed in the cache.
 

Uses of CacheException in net.sf.ehcache.extension
 

Methods in net.sf.ehcache.extension that throw CacheException
 void CacheExtension.dispose()
          Providers may be doing all sorts of exotic things and need to be able to clean up on dispose.
 

Uses of CacheException in net.sf.ehcache.jcache
 

Methods in net.sf.ehcache.jcache that throw CacheException
 void JCacheListenerAdaptor.notifyElementPut(Ehcache cache, Element element)
          Called immediately after an element has been put into the cache.
 void JCacheListenerAdaptor.notifyElementRemoved(Ehcache cache, Element element)
          Called immediately after an element has been removed.
 void JCacheListenerAdaptor.notifyElementUpdated(Ehcache cache, Element element)
          Called immediately after an element has been put into the cache and the element already existed in the cache.
 

Uses of CacheException in net.sf.ehcache.management
 

Methods in net.sf.ehcache.management that throw CacheException
 void ManagementService.dispose()
          Stop the listener and free any resources.
 void CacheMBean.flush()
          Flushes all cache items from memory to the disk store, and from the DiskStore to disk.
 void Cache.flush()
          Flushes all cache items from memory to the disk store, and from the DiskStore to disk.
 void ManagementService.init()
          Call to register the mbeans in the mbean server and start the event listeners and do any other required initialisation.
static void ManagementService.registerMBeans(CacheManager cacheManager, javax.management.MBeanServer mBeanServer, boolean registerCacheManager, boolean registerCaches, boolean registerCacheConfigurations, boolean registerCacheStatistics)
          A convenience static method which creates a ManagementService and initialises it with the supplied parameters.
 void CacheMBean.removeAll()
          Removes all cached items.
 void Cache.removeAll()
          Removes all cached items.
 

Constructors in net.sf.ehcache.management that throw CacheException
Cache(Ehcache cache)
          A constructor for JCache.
CacheManager(CacheManager cacheManager)
          Create a management CacheManager
ManagementService(CacheManager cacheManager, javax.management.MBeanServer mBeanServer, boolean registerCacheManager, boolean registerCaches, boolean registerCacheConfigurations, boolean registerCacheStatistics)
          A constructor for a management service for a range of possible MBeans.
 

Uses of CacheException in net.sf.ehcache.store
 

Methods in net.sf.ehcache.store that throw CacheException
protected  void MemoryStore.doPut(Element element)
          Allow specialised actions over adding the element to the map.
protected  void FifoMemoryStore.doPut(Element element)
          Allow specialised actions over adding the element to the map
protected  void MemoryStore.evict(Element element)
          Evict the Element.
 long MemoryStore.getSizeInBytes()
          Measures the size of the memory store by measuring the serialized size of all elements.
 void Store.put(Element element)
          Puts an item into the cache.
 void MemoryStore.put(Element element)
          Puts an item in the cache.
 void Store.removeAll()
          Remove all of the elements from the store.
 void MemoryStore.removeAll()
          Remove all of the elements from the store.
 

Uses of CacheException in net.sf.ehcache.util
 

Methods in net.sf.ehcache.util that throw CacheException
static java.lang.Object ClassLoaderUtil.createNewInstance(java.lang.String className)
          Creates a new class instance.
 


ehcache