Modifier and Type	Class and Description
private class	AbstractWriteBehindQueue.ProcessingThread Thread this will continuously process the items in the queue.

Field Summary

Modifier and Type	Field and Description
private final AtomicBoolean	busyProcessing
private final String	cacheName
private CacheWriter	cacheWriter
private volatile OperationsFilter<T>	filter
private final AtomicLong	lastProcessing
private final AtomicLong	lastWorkDone
private static final Logger	LOGGER
private final int	maxQueueSize
private final long	maxWriteDelayMs
private final long	minWriteDelayMs
private static final int	MS_IN_SEC
private final Thread	processingThread
private final Condition	queueIsEmpty
private final Condition	queueIsFull
private final Condition	queueIsStopped
private final ReentrantReadWriteLock	queueLock
private final ReentrantReadWriteLock.ReadLock	queueReadLock
private final ReentrantReadWriteLock.WriteLock	queueWriteLock
private final int	rateLimitPerSecond
private final int	retryAttemptDelaySeconds
private final int	retryAttempts
private boolean	stopped
private boolean	stopping
private final boolean	writeBatching
private final int	writeBatchSize

Constructor Summary

Access	Constructor and Description
public	AbstractWriteBehindQueue(CacheConfiguration the configuration for the queue config) Create a new write behind queue.

Method Summary

Modifier and Type	Method and Description
protected abstract void	addItem(SingleOperation operation to be done operation) Add an item to the write behind queue
private List<List<? extends SingleOperation>>	createMonomorphicBatches(List<SingleOperation> batch)
public void	delete(CacheEntry the cache entry for which a delete operation will be added to the write behind queue entry) Implements net.sf.ehcache.writer.writebehind.WriteBehind.delete. Add a delete operation for the given cache entry
private int	determineBatchSize(List<SingleOperation> quarantined)
private void	filterQuarantined(List<SingleOperation> quarantined)
private long	getLastProcessing()
protected Thread	getProcessingThread() Backdoor to allow killing the processing thread for testing purposes.
public abstract long	Returns: the amount of elements still awaiting processing. getQueueSize() Redeclares net.sf.ehcache.writer.writebehind.WriteBehind.getQueueSize. Gets the best estimate for items in the queue still awaiting processing.
private String	getThreadName()
private boolean	isStopped()
private void	processBatchedOperations(List<SingleOperation> quarantined)
private void	processItems()
private void	processQuarantinedItems(List<SingleOperation> quarantined)
private void	processSingleOperation(List<SingleOperation> quarantined)
protected abstract List<SingleOperation>	Returns: list of operations quarantineItems() Quarantine items to be processed.
private void	reassemble(List<SingleOperation> quarantined)
protected abstract void	reinsertUnprocessedItems(List<SingleOperation> list of unfinished operations operations) Reinsert any unfinished operations into the queue.
public void	setOperationsFilter(OperationsFilter<T> the filter that will be used as of now filter) Implements net.sf.ehcache.writer.writebehind.WriteBehind.setOperationsFilter. Set the operations filter that should be used.
public void	start(CacheWriter the cache writer that should be used to process the operations writer) Implements net.sf.ehcache.writer.writebehind.WriteBehind.start. Start the write behind queue with a cache writer
public void	stop() Implements net.sf.ehcache.writer.writebehind.WriteBehind.stop. Stop the coordinator and all the internal data structures.
private void	waitForQueueSizeToDrop()
private void	waitUntilEnoughTimeHasPassed(List<SingleOperation> quarantined, int batchSize, long secondsSinceLastWorkDone)
private void	waitUntilEnoughWorkItemsAvailable(List<SingleOperation> quarantined, int workSize)
public void	write(Element the element for which a write operation will be added to the write behind queue element) Implements net.sf.ehcache.writer.writebehind.WriteBehind.write. Add a write operation for a given element.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

busyProcessing	back to summary
private final AtomicBoolean busyProcessing

cacheName	back to summary
private final String cacheName

cacheWriter	back to summary
private CacheWriter cacheWriter

filter	back to summary
private volatile OperationsFilter<T> filter

lastProcessing	back to summary
private final AtomicLong lastProcessing

lastWorkDone	back to summary
private final AtomicLong lastWorkDone

LOGGER	back to summary
private static final Logger LOGGER

maxQueueSize	back to summary
private final int maxQueueSize

maxWriteDelayMs	back to summary
private final long maxWriteDelayMs

minWriteDelayMs	back to summary
private final long minWriteDelayMs

MS_IN_SEC	back to summary
private static final int MS_IN_SEC

processingThread	back to summary
private final Thread processingThread

queueIsEmpty	back to summary
private final Condition queueIsEmpty

queueIsFull	back to summary
private final Condition queueIsFull

queueIsStopped	back to summary
private final Condition queueIsStopped

queueLock	back to summary
private final ReentrantReadWriteLock queueLock

queueReadLock	back to summary
private final ReentrantReadWriteLock.ReadLock queueReadLock

queueWriteLock	back to summary
private final ReentrantReadWriteLock.WriteLock queueWriteLock

rateLimitPerSecond	back to summary
private final int rateLimitPerSecond

retryAttemptDelaySeconds	back to summary
private final int retryAttemptDelaySeconds

retryAttempts	back to summary
private final int retryAttempts

stopped	back to summary
private boolean stopped

stopping	back to summary
private boolean stopping

writeBatching	back to summary
private final boolean writeBatching

writeBatchSize	back to summary
private final int writeBatchSize

Constructor Detail

AbstractWriteBehindQueue	back to summary
public AbstractWriteBehindQueue(CacheConfiguration config) Create a new write behind queue. Parameters config:CacheConfiguration the configuration for the queue

AbstractWriteBehindQueue

back to summary

public AbstractWriteBehindQueue(CacheConfiguration config)

Create a new write behind queue.

Parameters

config:CacheConfiguration: the configuration for the queue

Method Detail

addItem	back to summary
protected abstract void addItem(SingleOperation operation) Add an item to the write behind queue Parameters operation:SingleOperation operation to be done

addItem

back to summary

protected abstract void addItem(SingleOperation operation)

Add an item to the write behind queue

Parameters

operation:SingleOperation: operation to be done

createMonomorphicBatches	back to summary
private List<List<? extends SingleOperation>> createMonomorphicBatches(List<SingleOperation> batch)

delete	back to summary
public void delete(CacheEntry entry) Implements net.sf.ehcache.writer.writebehind.WriteBehind.delete. Doc from net.sf.ehcache.writer.writebehind.WriteBehind.delete. Add a delete operation for the given cache entry Parameters entry:CacheEntry the cache entry for which a delete operation will be added to the write behind queue

delete

back to summary

public void delete(CacheEntry entry)

Implements net.sf.ehcache.writer.writebehind.WriteBehind.delete.

Doc from net.sf.ehcache.writer.writebehind.WriteBehind.delete.

Add a delete operation for the given cache entry

Parameters

entry:CacheEntry: the cache entry for which a delete operation will be added to the write behind queue

determineBatchSize	back to summary
private int determineBatchSize(List<SingleOperation> quarantined)

filterQuarantined	back to summary
private void filterQuarantined(List<SingleOperation> quarantined)

getLastProcessing	back to summary
private long getLastProcessing()

getProcessingThread	back to summary
protected Thread getProcessingThread() Backdoor to allow killing the processing thread for testing purposes.

getQueueSize	back to summary
public abstract long getQueueSize() Redeclares net.sf.ehcache.writer.writebehind.WriteBehind.getQueueSize. Gets the best estimate for items in the queue still awaiting processing. Not including elements currently processed Returns:long the amount of elements still awaiting processing.

getQueueSize

back to summary

public abstract long getQueueSize()

Redeclares net.sf.ehcache.writer.writebehind.WriteBehind.getQueueSize.

Gets the best estimate for items in the queue still awaiting processing. Not including elements currently processed

Returns:long: the amount of elements still awaiting processing.

getThreadName	back to summary
private String getThreadName()

isStopped	back to summary
private boolean isStopped()

processBatchedOperations	back to summary
private void processBatchedOperations(List<SingleOperation> quarantined)

processItems	back to summary
private void processItems() throws CacheException

processQuarantinedItems	back to summary
private void processQuarantinedItems(List<SingleOperation> quarantined)

processSingleOperation	back to summary
private void processSingleOperation(List<SingleOperation> quarantined)

quarantineItems	back to summary
protected abstract List<SingleOperation> quarantineItems() Quarantine items to be processed. Returns:List<SingleOperation> list of operations

quarantineItems

back to summary

protected abstract List<SingleOperation> quarantineItems()

Quarantine items to be processed.

Returns:List<SingleOperation>: list of operations

reassemble	back to summary
private void reassemble(List<SingleOperation> quarantined)

reinsertUnprocessedItems	back to summary
protected abstract void reinsertUnprocessedItems(List<SingleOperation> operations) Reinsert any unfinished operations into the queue. Parameters operations:List<SingleOperation> list of unfinished operations

reinsertUnprocessedItems

back to summary

protected abstract void reinsertUnprocessedItems(List<SingleOperation> operations)

Reinsert any unfinished operations into the queue.

Parameters

operations:List<SingleOperation>: list of unfinished operations

setOperationsFilter	back to summary
public void setOperationsFilter(OperationsFilter<T> filter) Implements net.sf.ehcache.writer.writebehind.WriteBehind.setOperationsFilter. Doc from net.sf.ehcache.writer.writebehind.WriteBehind.setOperationsFilter. Set the operations filter that should be used. Parameters filter:OperationsFilter<T> the filter that will be used as of now

setOperationsFilter

back to summary

public void setOperationsFilter(OperationsFilter<T> filter)

Implements net.sf.ehcache.writer.writebehind.WriteBehind.setOperationsFilter.

Doc from net.sf.ehcache.writer.writebehind.WriteBehind.setOperationsFilter.

Set the operations filter that should be used.

Parameters

filter:OperationsFilter<T>: the filter that will be used as of now

start	back to summary
public void start(CacheWriter writer) Implements net.sf.ehcache.writer.writebehind.WriteBehind.start. Doc from net.sf.ehcache.writer.writebehind.WriteBehind.start. Start the write behind queue with a cache writer Parameters writer:CacheWriter the cache writer that should be used to process the operations

start

back to summary

public void start(CacheWriter writer)

Implements net.sf.ehcache.writer.writebehind.WriteBehind.start.

Doc from net.sf.ehcache.writer.writebehind.WriteBehind.start.

Start the write behind queue with a cache writer

Parameters

writer:CacheWriter: the cache writer that should be used to process the operations

stop	back to summary
public void stop() throws CacheException Implements net.sf.ehcache.writer.writebehind.WriteBehind.stop. Doc from net.sf.ehcache.writer.writebehind.WriteBehind.stop. Stop the coordinator and all the internal data structures. This stops as quickly as possible without losing any previously added items. However, no guarantees are made towards the processing of these items. It's highly likely that items are still inside the internal data structures and not processed.

stop

back to summary

public void stop() throws CacheException

Implements net.sf.ehcache.writer.writebehind.WriteBehind.stop.

Doc from net.sf.ehcache.writer.writebehind.WriteBehind.stop.

Stop the coordinator and all the internal data structures.

This stops as quickly as possible without losing any previously added items. However, no guarantees are made towards the processing of these items. It's highly likely that items are still inside the internal data structures and not processed.

waitForQueueSizeToDrop	back to summary
private void waitForQueueSizeToDrop()

waitUntilEnoughTimeHasPassed	back to summary
private void waitUntilEnoughTimeHasPassed(List<SingleOperation> quarantined, int batchSize, long secondsSinceLastWorkDone)

waitUntilEnoughWorkItemsAvailable	back to summary
private void waitUntilEnoughWorkItemsAvailable(List<SingleOperation> quarantined, int workSize)

write

back to summary

public void write(Element element)

Implements net.sf.ehcache.writer.writebehind.WriteBehind.write.

Doc from net.sf.ehcache.writer.writebehind.WriteBehind.write.

Add a write operation for a given element.

Parameters

element:Element: the element for which a write operation will be added to the write behind queue

net.sf.ehcache.writer.writebehind back to summary

private final Class AbstractWriteBehindQueue.ProcessingThread

Class Inheritance

extends Object
implements Runnable

java.lang.Object
net.sf.ehcache.writer.writebehind.AbstractWriteBehindQueue.ProcessingThread

All Implemented Interfaces

java.lang.Runnable

Thread this will continuously process the items in the queue.

Constructor Summary

Access	Constructor and Description
private	ProcessingThread()

Method Summary

Modifier and Type	Method and Description
public void	run() Implements java.lang.Runnable.run. Runs this operation.
private void	stopTheQueueThread()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

ProcessingThread	back to summary
private ProcessingThread()

Method Detail

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

stopTheQueueThread	back to summary
private void stopTheQueueThread()

public abstract Class AbstractWriteBehindQueue

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class AbstractWriteBehindQueue.ProcessingThread

Constructor Summary

Method Summary

Constructor Detail

Method Detail