Package org.springframework.data.gemfire.wan

Class AsyncEventQueueFactoryBean

java.lang.Object

org.springframework.data.gemfire.support.AbstractFactoryBeanSupport<T>

org.springframework.data.gemfire.wan.AbstractWANComponentFactoryBean<AsyncEventQueue>

org.springframework.data.gemfire.wan.AsyncEventQueueFactoryBean

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, DisposableBean, FactoryBean<AsyncEventQueue>, InitializingBean

public class AsyncEventQueueFactoryBean
extends AbstractWANComponentFactoryBean<AsyncEventQueue>

Spring FactoryBean for constructing, configuring and initializing AsyncEventQueues.

Author:

David Turanski, John Blum

See Also:

• Cache
• Region
• AsyncEvent
• AsyncEventListener
• AsyncEventQueue
• AsyncEventQueueFactory
• FactoryBean
• AbstractWANComponentFactoryBean

Field Summary

Fields inherited from class org.springframework.data.gemfire.wan.AbstractWANComponentFactoryBean

cache, factory, logger

Fields inherited from class org.springframework.data.gemfire.support.AbstractFactoryBeanSupport

DEFAULT_SINGLETON

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Constructor Summary

Constructors

Constructor	Description
AsyncEventQueueFactoryBean(Cache cache)	Constructs an instance of the AsyncEventQueueFactoryBean for creating an GemFire AsyncEventQueue.
AsyncEventQueueFactoryBean(Cache cache, AsyncEventListener asyncEventListener)	Constructs an instance of the AsyncEventQueueFactoryBean for creating an GemFire AsyncEventQueue.

Method Summary

Modifier and Type	Method	Description
void	destroy()
protected void	doInit()
AsyncEventListener	getAsyncEventListener()	Returns the configured AsyncEventListener for the AsyncEventQueue returned by this FactoryBean.
AsyncEventQueue	getAsyncEventQueue()	Returns the AsyncEventQueue created by this FactoryBean.
AsyncEventQueue	getObject()
Class<?>	getObjectType()
boolean	isParallelEventQueue()
boolean	isPauseEventDispatching()
boolean	isSerialEventQueue()
final void	setAsyncEventListener(AsyncEventListener listener)	Configures the AsyncEventListener called when AsyncEvents are enqueued into the AsyncEventQueue created by this FactoryBean.
void	setAsyncEventQueue(AsyncEventQueue asyncEventQueue)	Configures the AsyncEventQueue returned by this FactoryBean.
void	setBatchConflationEnabled(Boolean batchConflationEnabled)	Enable or disable AsyncEventQueue (AEQ) message conflation.
void	setBatchSize(Integer batchSize)
void	setBatchTimeInterval(Integer batchTimeInterval)	Configures the AsyncEventQueue (AEQ) interval between sending batches.
void	setDiskStoreRef(String diskStoreRef)
void	setDiskSynchronous(Boolean diskSynchronous)	Configures the AsyncEventQueue (AEQ) disk write synchronization policy.
void	setDispatcherThreads(Integer dispatcherThreads)	Configures the number of dispatcher threads used to process Region Events from the associated AsyncEventQueue (AEQ).
void	setForwardExpirationDestroy(Boolean forwardExpirationDestroy)	Forwards expiration (action-based) destroy events to the AsyncEventQueue (AEQ).
void	setGatewayEventFilters(List<GatewayEventFilter> eventFilters)
void	setGatewayEventSubstitutionFilter(GatewayEventSubstitutionFilter eventSubstitutionFilter)
void	setMaximumQueueMemory(Integer maximumQueueMemory)
void	setOrderPolicy(String orderPolicy)	Configures the AsyncEventQueue (AEQ) ordering policy (e.g.
void	setOrderPolicy(GatewaySender.OrderPolicy orderPolicy)
void	setParallel(Boolean parallel)
void	setPauseEventDispatching(Boolean pauseEventDispatching)
void	setPersistent(Boolean persistent)

Methods inherited from class org.springframework.data.gemfire.wan.AbstractWANComponentFactoryBean

afterPropertiesSet, getCache, getName, setBeanName, setCache, setFactory, setName

Methods inherited from class org.springframework.data.gemfire.support.AbstractFactoryBeanSupport

getBeanClassLoader, getBeanFactory, getBeanName, getLogger, getOptionalLogger, isDebugLoggingEnabled, isErrorLoggingEnabled, isInfoLoggingEnabled, isSingleton, isWarnLoggingEnabled, logDebug, logDebug, logError, logError, logInfo, logInfo, logWarning, logWarning, newLogger, setBeanClassLoader, setBeanFactory

Methods inherited from class java.lang.Object

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

Constructor Details

AsyncEventQueueFactoryBean

public AsyncEventQueueFactoryBean(Cache cache)

Constructs an instance of the AsyncEventQueueFactoryBean for creating an GemFire AsyncEventQueue.

Parameters:

cache - the GemFire Cache reference.

See Also:

• AsyncEventQueueFactoryBean(org.apache.geode.cache.Cache, org.apache.geode.cache.asyncqueue.AsyncEventListener)

AsyncEventQueueFactoryBean

public AsyncEventQueueFactoryBean(Cache cache,
 AsyncEventListener asyncEventListener)

Constructs an instance of the AsyncEventQueueFactoryBean for creating an GemFire AsyncEventQueue.

Parameters:

cache - the GemFire Cache reference.

asyncEventListener - required AsyncEventListener

Method Details

getObject

public AsyncEventQueue getObject()
                          throws Exception

Throws:

Exception

getObjectType

public Class<?> getObjectType()

doInit

protected void doInit()

Specified by:

doInit in class AbstractWANComponentFactoryBean<AsyncEventQueue>

destroy

public void destroy()

Specified by:

destroy in interface DisposableBean

Overrides:

destroy in class AbstractWANComponentFactoryBean<AsyncEventQueue>

setAsyncEventListener

public final void setAsyncEventListener(AsyncEventListener listener)

Configures the AsyncEventListener called when AsyncEvents are enqueued into the AsyncEventQueue created by this FactoryBean.

Parameters:

listener - the configured AsyncEventListener.

Throws:

IllegalStateException - if the AsyncEventQueue has already bean created.

See Also:

• AsyncEventListener

getAsyncEventListener

public AsyncEventListener getAsyncEventListener()

Returns the configured AsyncEventListener for the AsyncEventQueue returned by this FactoryBean.

Returns:

the configured AsyncEventListener.

See Also:

• AsyncEventListener
• setAsyncEventListener(AsyncEventListener)

setAsyncEventQueue

public void setAsyncEventQueue(AsyncEventQueue asyncEventQueue)

Configures the AsyncEventQueue returned by this FactoryBean.

Parameters:

asyncEventQueue - overrides the AsyncEventQueue returned by this FactoryBean.

See Also:

• AsyncEventQueue

getAsyncEventQueue

public AsyncEventQueue getAsyncEventQueue()

Returns the AsyncEventQueue created by this FactoryBean.

Returns:

a reference to the AsyncEventQueue created by this FactoryBean.

See Also:

• AsyncEventQueue

setBatchConflationEnabled

public void setBatchConflationEnabled(Boolean batchConflationEnabled)

Enable or disable AsyncEventQueue (AEQ) message conflation.

Parameters:

batchConflationEnabled - Boolean indicating whether to conflate queued events.

See Also:

• AsyncEventQueueFactory.setBatchConflationEnabled(boolean)

setBatchSize

public void setBatchSize(Integer batchSize)

setBatchTimeInterval

public void setBatchTimeInterval(Integer batchTimeInterval)

Configures the AsyncEventQueue (AEQ) interval between sending batches.

Parameters:

batchTimeInterval - Integer specifying the maximum number of milliseconds that can elapse between sending batches.

See Also:

• AsyncEventQueueFactory.setBatchTimeInterval(int)

setDiskStoreRef

public void setDiskStoreRef(String diskStoreRef)

setDiskSynchronous

public void setDiskSynchronous(Boolean diskSynchronous)

Configures the AsyncEventQueue (AEQ) disk write synchronization policy.

Parameters:

diskSynchronous - boolean value indicating whether disk writes are synchronous.

See Also:

• AsyncEventQueueFactory.setDiskSynchronous(boolean)

setDispatcherThreads

public void setDispatcherThreads(Integer dispatcherThreads)

Configures the number of dispatcher threads used to process Region Events from the associated AsyncEventQueue (AEQ).

Parameters:

dispatcherThreads - Integer specifying the number of dispatcher threads used to process Region events from the associated queue.

See Also:

• AsyncEventQueueFactory.setDispatcherThreads(int)

setForwardExpirationDestroy

public void setForwardExpirationDestroy(Boolean forwardExpirationDestroy)

Forwards expiration (action-based) destroy events to the AsyncEventQueue (AEQ). By default, destroy events are not added to the AEQ. Setting this attribute to true will add all expiration destroy events to the AEQ.

Parameters:

forwardExpirationDestroy - boolean value indicating whether to forward expiration destroy events.

See Also:

• AsyncEventQueueFactory.setForwardExpirationDestroy(boolean)
• ExpirationAttributes.getAction()
• ExpirationAction.DESTROY

setGatewayEventFilters

public void setGatewayEventFilters(List<GatewayEventFilter> eventFilters)

setGatewayEventSubstitutionFilter

public void setGatewayEventSubstitutionFilter(GatewayEventSubstitutionFilter eventSubstitutionFilter)

setMaximumQueueMemory

public void setMaximumQueueMemory(Integer maximumQueueMemory)

setOrderPolicy

public void setOrderPolicy(String orderPolicy)

Configures the AsyncEventQueue (AEQ) ordering policy (e.g. KEY, PARTITION, THREAD). When dispatcher threads are greater than one, the ordering policy configures the way in which multiple dispatcher threads process Region events from the queue.

Parameters:

orderPolicy - String specifying the name of the AEQ order policy.

See Also:

• AsyncEventQueueFactory.setOrderPolicy(GatewaySender.OrderPolicy)

setOrderPolicy

public void setOrderPolicy(GatewaySender.OrderPolicy orderPolicy)

setParallel

public void setParallel(Boolean parallel)

isParallelEventQueue

public boolean isParallelEventQueue()

setPauseEventDispatching

public void setPauseEventDispatching(Boolean pauseEventDispatching)

isPauseEventDispatching

public boolean isPauseEventDispatching()

setPersistent

public void setPersistent(Boolean persistent)

isSerialEventQueue

public boolean isSerialEventQueue()