net.dontdrinkandroot.cache.impl.disk.indexed

Class AbstractIndexedDiskCache<K extends Serializable,V extends Serializable>

java.lang.Object

net.dontdrinkandroot.cache.impl.AbstractCache<K,V>

net.dontdrinkandroot.cache.impl.AbstractMapBackedCache<K,V,M>

net.dontdrinkandroot.cache.impl.AbstractMapBackedCustomTtlCache<K,V,BlockMetaData>

net.dontdrinkandroot.cache.impl.disk.indexed.AbstractIndexedDiskCache<K,V>

All Implemented Interfaces:

Cache<K,V>, CustomTtlCache<K,V>, RecyclingCache<K,V>

Direct Known Subclasses:

ByteArrayIndexedDiskCache, SerializableIndexedDiskCache

public abstract class AbstractIndexedDiskCache<K extends Serializable,V extends Serializable>
extends AbstractMapBackedCustomTtlCache<K,V,BlockMetaData>

A disk cache that stores its content in a data file and its index in an index file. A writer thread is responsible for writing new data to disk asynchronously. Make sure you call close() in order to shut down the cache correctly.

Author:

Philip Washington Sorst

Field Summary

Fields

Modifier and Type	Field and Description
protected DataFile	dataFile
protected Object	dataFileLock
protected IndexFile	indexFile
protected Object	indexFileLock
protected File	lockFile
protected int	queueSizeWarningLimit

Fields inherited from interface net.dontdrinkandroot.cache.Cache

UNLIMITED_IDLE_TIME

Constructor Summary

Constructors

Constructor and Description
AbstractIndexedDiskCache(String name, long defaultTimeToLive, int maxSize, int recycleSize, File baseDir)
AbstractIndexedDiskCache(String name, long defaultTimeToLive, long defaultMaxIdleTime, int maxSize, int recycleSize, File baseDir)

Method Summary

Modifier and Type	Method and Description
protected void	buildIndex()
void	close() Closes the cache.
protected abstract <T extends V> T	dataFromBytes(byte[] data)
protected abstract <T extends V> byte[]	dataToBytes(T data)
protected void	doDelete(K key, BlockMetaData metaData) Performs deletion of the data belonging to the metadata.
protected <T extends V> T	doGet(K key, BlockMetaData metaData) Performs retrieval of the data belonging to the metadata.
protected <T extends V> T	doPut(K key, T data, long timeToLive, long maxIdleTime) Performs storage of the given data and adds new metadata to the map.
void	flush() Flushes the writer thread.
int	getWriteQueueLength() Get the length of the writer thread queue.
boolean	isWriterThreadAlive() Checks if the writer thread is alive.
void	setQueueSizeWarningLimit(int limit) Set the limit when the writer thread is warning for an excess queue length.

Methods inherited from class net.dontdrinkandroot.cache.impl.AbstractMapBackedCustomTtlCache

doPut, put, put, putWithErrors, putWithErrors

Methods inherited from class net.dontdrinkandroot.cache.impl.AbstractMapBackedCache

cleanUp, delete, delete, expunge, expunge, get, getCleanUpInterval, getComparator, getEntriesMetaData, getEntry, getMaxSize, getMetaData, getRecycleSize, getStatistics, getWithErrors, put, putEntry, putWithErrors, setCleanUpInterval, setMaxSize, setRecycleSize, triggerExpunge

Methods inherited from class net.dontdrinkandroot.cache.impl.AbstractCache

getCleanUpLogger, getDefaultMaxIdleTime, getDefaultTtl, getLogger, getName, setDefaultMaxIdleTime, setDefaultTtl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.dontdrinkandroot.cache.Cache

cleanUp, delete, expunge, get, getDefaultMaxIdleTime, getDefaultTtl, getMetaData, getName, getStatistics, getWithErrors, put, putWithErrors, setDefaultTtl

Field Detail

indexFileLock

protected final Object indexFileLock

dataFileLock

protected final Object dataFileLock

indexFile

protected final IndexFile indexFile

dataFile

protected final DataFile dataFile

lockFile

protected final File lockFile

queueSizeWarningLimit

protected int queueSizeWarningLimit

Constructor Detail

AbstractIndexedDiskCache

public AbstractIndexedDiskCache(String name,
                                long defaultTimeToLive,
                                int maxSize,
                                int recycleSize,
                                File baseDir)
                         throws IOException

Throws:

IOException

AbstractIndexedDiskCache

public AbstractIndexedDiskCache(String name,
                                long defaultTimeToLive,
                                long defaultMaxIdleTime,
                                int maxSize,
                                int recycleSize,
                                File baseDir)
                         throws IOException

Throws:

IOException

Method Detail

setQueueSizeWarningLimit

public void setQueueSizeWarningLimit(int limit)

Set the limit when the writer thread is warning for an excess queue length.

Parameters:

limit - The limit.

getWriteQueueLength

public int getWriteQueueLength()

Get the length of the writer thread queue.

Returns:

The length of the writer thread queue.

isWriterThreadAlive

public boolean isWriterThreadAlive()

Checks if the writer thread is alive.

Returns:

If the writer thread is alive.

flush

public void flush()

Flushes the writer thread.

close

public void close()
           throws IOException

Closes the cache. You need to call this in order to shutdown the writer thread and the index files correctly. Otherwise the cache will remain in locked state.

Throws:

IOException

buildIndex

protected void buildIndex()
                   throws IOException

Throws:

IOException

doDelete

protected void doDelete(K key,
                        BlockMetaData metaData)
                 throws CacheException

Description copied from class: AbstractMapBackedCache

Performs deletion of the data belonging to the metadata. Removal from the map is done by the superclass.

Specified by:

doDelete in class AbstractMapBackedCache<K extends Serializable,V extends Serializable,BlockMetaData>

Throws:

CacheException

doGet

protected <T extends V> T doGet(K key,
                                BlockMetaData metaData)
                         throws CacheException

Description copied from class: AbstractMapBackedCache

Performs retrieval of the data belonging to the metadata.

Specified by:

doGet in class AbstractMapBackedCache<K extends Serializable,V extends Serializable,BlockMetaData>

Throws:

CacheException

doPut

protected <T extends V> T doPut(K key,
                                T data,
                                long timeToLive,
                                long maxIdleTime)
                         throws CacheException

Description copied from class: AbstractMapBackedCustomTtlCache

Performs storage of the given data and adds new metadata to the map.

Specified by:

doPut in class AbstractMapBackedCustomTtlCache<K extends Serializable,V extends Serializable,BlockMetaData>

Throws:

CacheException

dataFromBytes

protected abstract <T extends V> T dataFromBytes(byte[] data)
                                          throws CacheException

Throws:

CacheException

dataToBytes

protected abstract <T extends V> byte[] dataToBytes(T data)
                                             throws CacheException

Throws:

CacheException