Package org.springframework.data.gemfire.wan

Class AsyncEventQueueFactoryBean

java.lang.Object
org.springframework.data.gemfire.support.AbstractFactoryBeanSupport<T>
org.springframework.data.gemfire.wan.AbstractWANComponentFactoryBean<org.apache.geode.cache.asyncqueue.AsyncEventQueue>
org.springframework.data.gemfire.wan.AsyncEventQueueFactoryBean
All Implemented Interfaces:
org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<org.apache.geode.cache.asyncqueue.AsyncEventQueue>, org.springframework.beans.factory.InitializingBean
public class AsyncEventQueueFactoryBean extends AbstractWANComponentFactoryBean<org.apache.geode.cache.asyncqueue.AsyncEventQueue>
Spring FactoryBean for constructing, configuring and initializing AsyncEventQueues.
See Also:

  • Constructor Details

    • AsyncEventQueueFactoryBean

      public AsyncEventQueueFactoryBean(org.apache.geode.cache.Cache cache)
      Constructs an instance of the AsyncEventQueueFactoryBean for creating an GemFire AsyncEventQueue.
      Parameters:
      cache - the GemFire Cache reference.
      See Also:

    • AsyncEventQueueFactoryBean

      public AsyncEventQueueFactoryBean(org.apache.geode.cache.Cache cache, org.apache.geode.cache.asyncqueue.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 org.apache.geode.cache.asyncqueue.AsyncEventQueue getObject() throws Exception
      Throws:
      Exception

    • getObjectType

      public Class<?> getObjectType()

    • doInit

      protected void doInit()
      Specified by:
      doInit in class AbstractWANComponentFactoryBean<org.apache.geode.cache.asyncqueue.AsyncEventQueue>

    • destroy

      public void destroy()
      Specified by:
      destroy in interface org.springframework.beans.factory.DisposableBean
      Overrides:
      destroy in class AbstractWANComponentFactoryBean<org.apache.geode.cache.asyncqueue.AsyncEventQueue>

    • setAsyncEventListener

      public final void setAsyncEventListener(org.apache.geode.cache.asyncqueue.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 org.apache.geode.cache.asyncqueue.AsyncEventListener getAsyncEventListener()
      Returns the configured AsyncEventListener for the AsyncEventQueue returned by this FactoryBean.
      Returns:
      the configured AsyncEventListener.
      See Also:

    • setAsyncEventQueue

      public void setAsyncEventQueue(org.apache.geode.cache.asyncqueue.AsyncEventQueue asyncEventQueue)
      Configures the AsyncEventQueue returned by this FactoryBean.
      Parameters:
      asyncEventQueue - overrides the AsyncEventQueue returned by this FactoryBean.
      See Also:
      • AsyncEventQueue

    • getAsyncEventQueue

      public org.apache.geode.cache.asyncqueue.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<org.apache.geode.cache.wan.GatewayEventFilter> eventFilters)

    • setGatewayEventSubstitutionFilter

      public void setGatewayEventSubstitutionFilter(org.apache.geode.cache.wan.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(org.apache.geode.cache.wan.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()