org.ehcache.impl.events

Class CacheEventDispatcherImpl<K,V>

java.lang.Object

org.ehcache.impl.events.CacheEventDispatcherImpl<K,V>

All Implemented Interfaces:

org.ehcache.core.events.CacheEventDispatcher<K,V>, org.ehcache.core.spi.store.ConfigurationChangeSupport

public class CacheEventDispatcherImpl<K,V>
extends java.lang.Object
implements org.ehcache.core.events.CacheEventDispatcher<K,V>

Per-cache component that manages cache event listener registrations, and provides event delivery based on desired firing mode for specified event types.

Use of this class is linked to having cache events on a user managed cache.

Note on event ordering guarantees: Events are received and transmitted to register listeners through the registration of a StoreEventListener on the linked StoreEventSource which is responsible for event ordering.

Constructor Summary

Constructors

Constructor and Description
CacheEventDispatcherImpl(java.util.concurrent.ExecutorService unOrderedExecutor, java.util.concurrent.ExecutorService orderedExecutor) Creates a new CacheEventDispatcher instance that will use the provided ExecutorService to handle events firing.

Method Summary

Modifier and Type	Method and Description
void	deregisterCacheEventListener(org.ehcache.event.CacheEventListener<? super K,? super V> listener)
java.util.List<org.ehcache.core.CacheConfigurationChangeListener>	getConfigurationChangeListeners()
void	registerCacheEventListener(org.ehcache.event.CacheEventListener<? super K,? super V> listener, org.ehcache.event.EventOrdering ordering, org.ehcache.event.EventFiring firing, java.util.EnumSet<org.ehcache.event.EventType> forEventTypes)
void	setListenerSource(org.ehcache.Cache<K,V> source)
void	setStoreEventSource(org.ehcache.core.spi.store.events.StoreEventSource<K,V> eventSource)
void	shutdown()

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheEventDispatcherImpl

public CacheEventDispatcherImpl(java.util.concurrent.ExecutorService unOrderedExecutor,
                                java.util.concurrent.ExecutorService orderedExecutor)

Creates a new CacheEventDispatcher instance that will use the provided ExecutorService to handle events firing.

Parameters:

unOrderedExecutor - the executor service used when ordering is not required

orderedExecutor - the executor service used when ordering is required

Method Detail

registerCacheEventListener

public void registerCacheEventListener(org.ehcache.event.CacheEventListener<? super K,? super V> listener,
                                       org.ehcache.event.EventOrdering ordering,
                                       org.ehcache.event.EventFiring firing,
                                       java.util.EnumSet<org.ehcache.event.EventType> forEventTypes)

Specified by:

registerCacheEventListener in interface org.ehcache.core.events.CacheEventDispatcher<K,V>

deregisterCacheEventListener

public void deregisterCacheEventListener(org.ehcache.event.CacheEventListener<? super K,? super V> listener)

Specified by:

deregisterCacheEventListener in interface org.ehcache.core.events.CacheEventDispatcher<K,V>

shutdown

public void shutdown()

Specified by:

shutdown in interface org.ehcache.core.events.CacheEventDispatcher<K,V>

setListenerSource

public void setListenerSource(org.ehcache.Cache<K,V> source)

Specified by:

setListenerSource in interface org.ehcache.core.events.CacheEventDispatcher<K,V>

getConfigurationChangeListeners

public java.util.List<org.ehcache.core.CacheConfigurationChangeListener> getConfigurationChangeListeners()

Specified by:

getConfigurationChangeListeners in interface org.ehcache.core.spi.store.ConfigurationChangeSupport

setStoreEventSource

public void setStoreEventSource(org.ehcache.core.spi.store.events.StoreEventSource<K,V> eventSource)

Specified by:

setStoreEventSource in interface org.ehcache.core.events.CacheEventDispatcher<K,V>