Package net.sf.ehcache.writer
Interface CacheWriterManager
-
- All Known Implementing Classes:
WriteBehindManager,WriteThroughManager
public interface CacheWriterManagerACacheWriterManagercoordinates how element are written to a back-end store.The
CacheWriterManagerwill in its turn call theCacheWriterthat belongs to the relevant cache to perform the actual write logic as it's implemented by the user.- Version:
- $Id$
- Author:
- Geert Bevin
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voiddispose()Cleans up the resources of the cache writer manager.voidinit(Cache cache)Initialize the cache writer manager.voidput(Element element)Schedule a put operation for this element in the CacheWriterManager, which will call the CacheWriter when appropriate.voidremove(CacheEntry entry)Schedule a remove operation for this key in the CacheWriterManager, which will call the CacheWriter when appropriate.
-
-
-
Method Detail
-
init
void init(Cache cache) throws CacheException
Initialize the cache writer manager.This method is called when the cache writer manager is registered to a cache.
- Parameters:
cache- the cache with which the writer manager- Throws:
CacheException- when an exception occurs during the initialisation of the cache
-
put
void put(Element element) throws CacheException
Schedule a put operation for this element in the CacheWriterManager, which will call the CacheWriter when appropriate.- Parameters:
element- the element that should be used for the operation- Throws:
CacheException- when an exception occurs during the writing of the element
-
remove
void remove(CacheEntry entry) throws CacheException
Schedule a remove operation for this key in the CacheWriterManager, which will call the CacheWriter when appropriate.- Parameters:
entry- the entry that should be used for the operation- Throws:
CacheException- when an exception occurs during the removal of the element
-
dispose
void dispose() throws CacheExceptionCleans up the resources of the cache writer manager.This method is called when the manager is unregistered from a cache.
- Throws:
CacheException
-
-