Package org.springframework.data.gemfire.config.annotation

Annotation Interface PeerCacheApplication

@Target({ANNOTATION_TYPE,TYPE}) @Retention(RUNTIME) @Inherited @Documented @Configuration @Import(PeerCacheConfiguration.class) public @interface PeerCacheApplication
The PeerCacheApplication annotation enables an embedded GemFire peer Cache instance in a Spring Data GemFire based application.
Since:
1.9.0
Author:
John Blum
See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    copyOnRead
    Indicates whether the "copy on read" is enabled for this cache.
    float
    criticalHeapPercentage
    Configures the percentage of heap at or above which the cache is considered in danger of becoming inoperable.
    float
    criticalOffHeapPercentage
    Configures the percentage of off-heap at or above which the cache is considered in danger of becoming inoperable.
    boolean
    enableAutoReconnect
    By default, a GemFire member (both locators and servers) will attempt to reconnect and reinitialize the cache after it has been forced out of the distributed system by a network partition event or has otherwise been shunned by other members.
    float
    evictionHeapPercentage
    Configures the percentage of heap at or above which the eviction should begin on Regions configured for HeapLRU eviction.
    float
    evictionOffHeapPercentage
    Configures the percentage of off-heap at or above which the eviction should begin on Regions configured for HeapLRU eviction.
    String
    locators
    Configures the list of Locators defining the cluster to which this Spring cache application will connect.
    int
    lockLease
    Configures the length, in seconds, of distributed lock leases obtained by this cache.
    int
    lockTimeout
    Configures the number of seconds a cache operation will wait to obtain a distributed lock lease.
    String
    logLevel
    Configures the log level used to output log messages at GemFire cache runtime.
    int
    messageSyncInterval
    Configures the frequency (in seconds) at which a message will be sent by the primary cache-server to all the secondary cache-server nodes to remove the events which have already been dispatched from the queue.
    String
    name
    Configures the name of this GemFire member in the cluster (distributed system).
    int
    searchTimeout
    Configures the number of seconds a cache get operation can spend searching for a value before it times out.
    boolean
    useBeanFactoryLocator
    Determines whether the GemfireBeanFactoryLocator should be enabled to lookup the Spring BeanFactory to auto-wire and configure/initialize GemFire components created in a non-Spring managed, GemFire context.
    boolean
    useClusterConfiguration
    Configures whether this GemFire cache member node would pull it's configuration meta-data from the cluster-based Cluster Configuration service.

  • Element Details

    • copyOnRead

      boolean copyOnRead
      Indicates whether the "copy on read" is enabled for this cache. Defaults to false. Use spring.data.gemfire.cache.copy-on-read property in application.properties.
      Default:
      false

    • criticalHeapPercentage

      float criticalHeapPercentage
      Configures the percentage of heap at or above which the cache is considered in danger of becoming inoperable. Defaults to ResourceManager.DEFAULT_CRITICAL_PERCENTAGE. Use spring.data.gemfire.cache.critical-heap-percentage property in application.properties.
      Default:
      0.0f

    • criticalOffHeapPercentage

      float criticalOffHeapPercentage
      Configures the percentage of off-heap at or above which the cache is considered in danger of becoming inoperable. Defaults to 0.0. Use spring.data.gemfire.cache.critical-off-heap-percentage property in application.properties.
      Default:
      0.0f

    • enableAutoReconnect

      boolean enableAutoReconnect
      By default, a GemFire member (both locators and servers) will attempt to reconnect and reinitialize the cache after it has been forced out of the distributed system by a network partition event or has otherwise been shunned by other members. Use this property to enable the auto-reconnect behavior. Defaults to false. Use spring.data.gemfire.cache.peer.enable-auto-reconnect property in application.properties.
      Default:
      false

    • evictionHeapPercentage

      float evictionHeapPercentage
      Configures the percentage of heap at or above which the eviction should begin on Regions configured for HeapLRU eviction. Defaults to ResourceManager.DEFAULT_EVICTION_PERCENTAGE. Use spring.data.gemfire.cache.eviction-heap-percentage property in application.properties.
      Default:
      0.0f

    • evictionOffHeapPercentage

      float evictionOffHeapPercentage
      Configures the percentage of off-heap at or above which the eviction should begin on Regions configured for HeapLRU eviction. Defaults to 0.0. Use spring.data.gemfire.cache.eviction-off-heap-percentage property in application.properties.
      Default:
      0.0f

    • locators

      String locators
      Configures the list of Locators defining the cluster to which this Spring cache application will connect. Use spring.data.gemfire.locators property in application.properties.
      Default:
      ""

    • lockLease

      int lockLease
      Configures the length, in seconds, of distributed lock leases obtained by this cache. Defaults to 120 seconds. Use spring.data.gemfire.cache.peer.lock-lease property in application.properties.
      Default:
      120

    • lockTimeout

      int lockTimeout
      Configures the number of seconds a cache operation will wait to obtain a distributed lock lease. Defaults to 60 seconds. Use spring.data.gemfire.cache.peer.lock-timeout property in application.properties.
      Default:
      60

    • logLevel

      String logLevel
      Configures the log level used to output log messages at GemFire cache runtime. Defaults to config. Use spring.data.gemfire.cache.log-level property in application.properties.
      Default:
      "config"

    • messageSyncInterval

      int messageSyncInterval
      Configures the frequency (in seconds) at which a message will be sent by the primary cache-server to all the secondary cache-server nodes to remove the events which have already been dispatched from the queue. Defaults to 1 second. Use spring.data.gemfire.cache.peer.message-sync-interval property in application.properties.
      Default:
      1

    • name

      String name
      Configures the name of this GemFire member in the cluster (distributed system). Defaults to SpringBasedPeerCacheApplication. Use either the spring.data.gemfire.name or the spring.data.gemfire.cache.name property in application.properties.
      Default:
      "SpringBasedPeerCacheApplication"

    • searchTimeout

      int searchTimeout
      Configures the number of seconds a cache get operation can spend searching for a value before it times out. Defaults to 300 seconds, or 5 minutes. Use spring.data.gemfire.cache.peer.search-timeout property in application.properties.
      Default:
      300

    • useBeanFactoryLocator

      boolean useBeanFactoryLocator
      Determines whether the GemfireBeanFactoryLocator should be enabled to lookup the Spring BeanFactory to auto-wire and configure/initialize GemFire components created in a non-Spring managed, GemFire context. Defaults to false. Use spring.data.gemfire.use-bean-factory-locator property in application.properties.
      Default:
      false

    • useClusterConfiguration

      boolean useClusterConfiguration
      Configures whether this GemFire cache member node would pull it's configuration meta-data from the cluster-based Cluster Configuration service. Defaults to false. Use spring.data.gemfire.cache.peer.use-cluster-configuration property in application.properties.
      Default:
      false