Class GemfireDaoSupport

java.lang.Object
org.springframework.dao.support.DaoSupport
org.springframework.data.gemfire.dao.GemfireDaoSupport
All Implemented Interfaces:
org.springframework.beans.factory.InitializingBean

public abstract class GemfireDaoSupport extends org.springframework.dao.support.DaoSupport
Convenient super class for GemFire Data Access Objects (DAO) implementing the Spring DaoSupport abstract class. Intended for use with GemfireTemplate. Requires a GemFire Region to be set, providing a GemfireTemplate based on it to subclasses. Can alternatively be initialized directly via a GemfireTemplate reusing the template's settings. This class will create its own GemfireTemplate if a GemFire Region reference is passed in. A custom GemfireTemplate instance can be used through overriding createGemfireTemplate.
See Also:
  • Field Summary

    Fields inherited from class org.springframework.dao.support.DaoSupport

    logger
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    protected final void
    Verifies that this DAO has been configured properly.
    protected GemfireTemplate
    createGemfireTemplate(org.apache.geode.cache.Region<?,?> region)
    Creates an instance of the GemfireTemplate for the given GemFire Cache Region.
    Returns the GemfireTemplate for this DAO, pre-initialized with the Region or set explicitly.
    final void
    Set the GemfireTemplate for this DAO explicitly as an alternative to specifying a GemFire Cache Region.
    void
    setRegion(org.apache.geode.cache.Region<?,?> region)
    Sets the GemFire Cache Region to be used by this DAO.

    Methods inherited from class org.springframework.dao.support.DaoSupport

    afterPropertiesSet, initDao

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • GemfireDaoSupport

      public GemfireDaoSupport()
  • Method Details

    • setGemfireTemplate

      public final void setGemfireTemplate(GemfireOperations gemfireTemplate)
      Set the GemfireTemplate for this DAO explicitly as an alternative to specifying a GemFire Cache Region.
      Parameters:
      gemfireTemplate - the GemfireTemplate to be use by this DAO.
      See Also:
    • getGemfireTemplate

      public final GemfireOperations getGemfireTemplate()
      Returns the GemfireTemplate for this DAO, pre-initialized with the Region or set explicitly.
      Returns:
      an instance of the GemfireTemplate to perform data access operations on the GemFire Cache Region.
      See Also:
    • setRegion

      public void setRegion(org.apache.geode.cache.Region<?,?> region)
      Sets the GemFire Cache Region to be used by this DAO. Will automatically create an instance of the GemfireTemplate for the given Region.
      Parameters:
      region - the GemFire Cache Region upon which this DAO operates.
      See Also:
    • createGemfireTemplate

      protected GemfireTemplate createGemfireTemplate(org.apache.geode.cache.Region<?,?> region)
      Creates an instance of the GemfireTemplate for the given GemFire Cache Region.

      Can be overridden in subclasses to provide a GemfireTemplate instance with different configuration, or even a custom GemfireTemplate subclass.

      Parameters:
      region - the GemFire Cache Region for which the GemfireTemplate is created.
      Returns:
      a new GemfireTemplate instance configured with the given GemFire Cache Region.
      See Also:
    • checkDaoConfig

      protected final void checkDaoConfig()
      Verifies that this DAO has been configured properly.
      Specified by:
      checkDaoConfig in class org.springframework.dao.support.DaoSupport