If configured for a cache, CacheWriter's methods will be called on a cache operation. A cache put will cause a CacheWriter write and a cache remove will cause a writer delete.
Implementers should create an implementation which handles storing and deleting to an underlying resource.
It's important to note that the operations that are handled by the CacheWriter don't have any guaranteed ordering in write-behind mode.
The processing ordering can be different than the scheduling ordering, so your application needs to be written with this
in mind. More information in the CacheWriter chapter of the documentation.
The manner upon which a CacheWriter is actually called is determined by the net. that is set up for cache
that is using the CacheWriter.
See the CacheWriter chapter in the documentation for more information on how to use writers.
| Modifier and Type | Method and Description |
|---|---|
| public CacheWriter | |
| public void | delete(CacheEntry
the cache entry that is used for the delete operation entry)Delete the cache entry from the store |
| public void | deleteAll(Collection<CacheEntry>
the entries that have been removed from the cache entries)Remove data and keys from the underlying store for the given collection of keys, if present. |
| public void | dispose()
Providers may be doing all sorts of exotic things and need to be able to clean up on dispose. |
| public void | |
| public void | throwAway(Element
the Element that triggered the failure, or one of the elements part of the batch that failed element, SingleOperationType the operation we tried to execute operationType, RuntimeException the RuntimeException thrown by the Writer when the last retry attempt was being executed e)This method will be called, whenever an Element couldn't be handled by the writer and all
the |
| public void | |
| public void | writeAll(Collection<Element>
the Elements to be written elements)Write the specified Elements to the underlying store. |
| clone | back to summary |
|---|---|
| public CacheWriter clone(Ehcache cache) throws CloneNotSupportedException Creates a clone of this writer. This method will only be called by ehcache before a cache is initialized. Implementations should throw CloneNotSupportedException if they do not support clone but that will stop them from being used with defaultCache.
| |
| delete | back to summary |
|---|---|
| public void delete(CacheEntry entry) throws CacheException Delete the cache entry from the store
| |
| deleteAll | back to summary |
|---|---|
| public void deleteAll(Collection<CacheEntry> entries) throws CacheException Remove data and keys from the underlying store for the given collection of keys, if present. If this operation fails (by throwing an exception) after a partial success, the convention is that keys which have been erased successfully are to be removed from the specified keys, indicating that the erase operation for the keys left in the collection has failed or has not been attempted.
| |
| dispose | back to summary |
|---|---|
| public void dispose() throws CacheException Providers may be doing all sorts of exotic things and need to be able to clean up on dispose. Cache operations are illegal when this method is called. The cache itself is partly disposed when this method is called. | |
| init | back to summary |
|---|---|
| public void init() Notifies writer to initialise themselves. This method is called during the Cache's initialise method after it has changed it's status to alive. Cache operations are legal in this method. If you register a cache writer manually after a cache has been initialised already, this method will be called on the cache writer as soon as it has been registered.
Note that if you reuse cache writer instances or create a factory that returns the
same cache writer instance as a singleton, your | |
| throwAway | back to summary |
|---|---|
| public void throwAway(Element element, SingleOperationType operationType, RuntimeException e) This method will be called, whenever an Element couldn't be handled by the writer and all
the When batching is enabled all the elements in the failing batch will be passed to this methods Try to not throw RuntimeExceptions from this method. Should an Exception occur, it will be logged, but the element will be lost anyways.
| |
| write | back to summary |
|---|---|
| public void write(Element element) throws CacheException Write the specified value under the specified key to the underlying store. This method is intended to support both key/value creation and value update for a specific key.
| |
| writeAll | back to summary |
|---|---|
| public void writeAll(Collection<Element> elements) throws CacheException Write the specified Elements to the underlying store. This method is intended to support both insert and update. If this operation fails (by throwing an exception) after a partial success, the convention is that entries which have been written successfully are to be removed from the specified mapEntries, indicating that the write operation for the entries left in the map has failed or has not been attempted.
| |