Package net.sf.ehcache.writer.writebehind

Class WriteBehindQueueManager

java.lang.Object

net.sf.ehcache.writer.writebehind.WriteBehindQueueManager

All Implemented Interfaces:

WriteBehind

public class WriteBehindQueueManager
extends java.lang.Object
implements WriteBehind

Author:

Alex Snaps

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	WriteBehindQueueManager.WriteBehindQueueFactory	Factory used to create write behind queues.

Constructor Summary

Constructors

Modifier	Constructor	Description
	WriteBehindQueueManager(CacheConfiguration config)	Create a new write behind queue manager.
protected	WriteBehindQueueManager(CacheConfiguration config, WriteBehindQueueManager.WriteBehindQueueFactory queueFactory)	Create the write behind queue manager with queues created via the passed in WriteBehindQueueManager.WriteBehindQueueFactory

Method Summary

Modifier and Type	Method	Description
void	delete(CacheEntry entry)	Add a delete operation for the given cache entry
long	getQueueSize()	Gets the best estimate for items in the queue still awaiting processing.
void	setOperationsFilter(OperationsFilter filter)	Set the operations filter that should be used.
void	start(CacheWriter writer)	Start the write behind queue with a cache writer
void	stop()	Stop the coordinator and all the internal data structures.
void	write(Element element)	Add a write operation for a given element.

Methods inherited from class java.lang.Object

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

Constructor Detail

WriteBehindQueueManager

protected WriteBehindQueueManager(CacheConfiguration config,
                                  WriteBehindQueueManager.WriteBehindQueueFactory queueFactory)

Create the write behind queue manager with queues created via the passed in WriteBehindQueueManager.WriteBehindQueueFactory

Parameters:

config - configuration for the cache this write behind queue manager is working with

queueFactory - factory used to create the write behind queues.

WriteBehindQueueManager

public WriteBehindQueueManager(CacheConfiguration config)

Create a new write behind queue manager. Which in turn will create as many queues as required by the CacheWriterConfiguration.getWriteBehindConcurrency()

Parameters:

config - the configuration for the queue

Method Detail

start

public void start(CacheWriter writer)
           throws CacheException

Start the write behind queue with a cache writer

Specified by:

start in interface WriteBehind

Parameters:

writer - the cache writer that should be used to process the operations

Throws:

CacheException

See Also:

WriteBehind.stop()

write

public void write(Element element)

Add a write operation for a given element.

Specified by:

write in interface WriteBehind

Parameters:

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

delete

public void delete(CacheEntry entry)

Add a delete operation for the given cache entry

Specified by:

delete in interface WriteBehind

Parameters:

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

setOperationsFilter

public void setOperationsFilter(OperationsFilter filter)

Set the operations filter that should be used.

Specified by:

setOperationsFilter in interface WriteBehind

Parameters:

filter - the filter that will be used as of now

stop

public void stop()
          throws CacheException

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.

Specified by:

stop in interface WriteBehind

Throws:

CacheException

See Also:

WriteBehind.start(net.sf.ehcache.writer.CacheWriter)

getQueueSize

public long getQueueSize()

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

Specified by:

getQueueSize in interface WriteBehind

Returns:

the amount of elements still awaiting processing.