Package com.broadleafcommerce.common.extension.autoconfigure

Class IgniteCacheNodeProperties

java.lang.Object
com.broadleafcommerce.common.extension.autoconfigure.IgniteCacheNodeProperties
@ConfigurationProperties("broadleaf.common.cache.ignite.node") @Deprecated(since="2.0.7") public class IgniteCacheNodeProperties extends Object
Deprecated.

When Ignite is used for caching, IgniteConfiguration is used by SpringCacheManager to establish the embedded Ignite node.

These properties are used to influence the IgniteConfiguration.

  • Constructor Summary

    Constructors
    Constructor
    Description
    IgniteCacheNodeProperties()
    Deprecated.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getDefaultDataRegionEmptyPagesPoolSize()
    Deprecated.
    Configures the default data region's DataRegionConfiguration.getEmptyPagesPoolSize() (see the Javadocs there).
    org.springframework.util.unit.DataSize
    getDefaultDataRegionInitialSize()
    Deprecated.
    The initial allocation size of the default data storage region (this is off-heap memory).
    org.springframework.util.unit.DataSize
    getDefaultDataRegionMaxSize()
    Deprecated.
    The maximum allowed size of the default data storage region (this is off-heap memory).
    org.apache.ignite.configuration.DataPageEvictionMode
    getDefaultDataRegionPageEvictionMode()
    Deprecated.
    Configures the default data region's DataRegionConfiguration.getPageEvictionMode() (see the Javadocs there).
    List<Integer>
    getIncludedEventTypes()
    Deprecated.
    Configures the IgniteConfiguration.getIncludeEventTypes() value.
    org.springframework.util.unit.DataSize
    getMemoryPageSize()
    Deprecated.
    The memory page size to use for Ignite.
    org.springframework.util.unit.DataSize
    getSystemDataRegionInitialSize()
    Deprecated.
    The initial allocation size of the system data storage region for Ignite system cache (this is off-heap memory).
    org.springframework.util.unit.DataSize
    getSystemDataRegionMaxSize()
    Deprecated.
    The maximum allowed size of the system data storage region for Ignite system cache (this is off-heap memory).
    boolean
    isCacheStatisticsEnabled()
    Deprecated.
    Toggles the tracking of high-level throughput metrics such as cache hits, misses, gets, and puts.
    boolean
    isDefaultDataRegionMetricsEnabled()
    Deprecated.
    Controls whether the Ignite engine itself tracks low-level storage metrics (e.g., page allocations, evictions) for the default DataRegion.
    boolean
    isDumpThreadsOnFailure()
    Deprecated.
    Whether to dump all threads to the log when a failure occurs.
    boolean
    isMetricsCollectionEnabled()
    Deprecated.
    A global "kill switch" for the Micrometer integration.
    void
    setCacheStatisticsEnabled(boolean cacheStatisticsEnabled)
    Deprecated.
    Toggles the tracking of high-level throughput metrics such as cache hits, misses, gets, and puts.
    void
    setDefaultDataRegionEmptyPagesPoolSize(int defaultDataRegionEmptyPagesPoolSize)
    Deprecated.
    Configures the default data region's DataRegionConfiguration.getEmptyPagesPoolSize() (see the Javadocs there).
    void
    setDefaultDataRegionInitialSize(org.springframework.util.unit.DataSize defaultDataRegionInitialSize)
    Deprecated.
    The initial allocation size of the default data storage region (this is off-heap memory).
    void
    setDefaultDataRegionMaxSize(org.springframework.util.unit.DataSize defaultDataRegionMaxSize)
    Deprecated.
    The maximum allowed size of the default data storage region (this is off-heap memory).
    void
    setDefaultDataRegionMetricsEnabled(boolean defaultDataRegionMetricsEnabled)
    Deprecated.
    Controls whether the Ignite engine itself tracks low-level storage metrics (e.g., page allocations, evictions) for the default DataRegion.
    void
    setDefaultDataRegionPageEvictionMode(org.apache.ignite.configuration.DataPageEvictionMode defaultDataRegionPageEvictionMode)
    Deprecated.
    Configures the default data region's DataRegionConfiguration.getPageEvictionMode() (see the Javadocs there).
    void
    setDumpThreadsOnFailure(boolean dumpThreadsOnFailure)
    Deprecated.
    Whether to dump all threads to the log when a failure occurs.
    void
    setIncludedEventTypes(List<Integer> includedEventTypes)
    Deprecated.
    Configures the IgniteConfiguration.getIncludeEventTypes() value.
    void
    setMemoryPageSize(org.springframework.util.unit.DataSize memoryPageSize)
    Deprecated.
    The memory page size to use for Ignite.
    void
    setMetricsCollectionEnabled(boolean metricsCollectionEnabled)
    Deprecated.
    A global "kill switch" for the Micrometer integration.
    void
    setSystemDataRegionInitialSize(org.springframework.util.unit.DataSize systemDataRegionInitialSize)
    Deprecated.
    The initial allocation size of the system data storage region for Ignite system cache (this is off-heap memory).
    void
    setSystemDataRegionMaxSize(org.springframework.util.unit.DataSize systemDataRegionMaxSize)
    Deprecated.
    The maximum allowed size of the system data storage region for Ignite system cache (this is off-heap memory).

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • IgniteCacheNodeProperties

      public IgniteCacheNodeProperties()
      Deprecated.

  • Method Details

    • getMemoryPageSize

      public org.springframework.util.unit.DataSize getMemoryPageSize()
      Deprecated.
      The memory page size to use for Ignite. Ignite recommends this to be "no less than the lower of: the page size of your storage media (SSD, Flash, HDD, etc.) and the cache page size of your operating system". The default value here matches DataStorageConfiguration.DFLT_PAGE_SIZE.

    • getSystemDataRegionInitialSize

      public org.springframework.util.unit.DataSize getSystemDataRegionInitialSize()
      Deprecated.
      The initial allocation size of the system data storage region for Ignite system cache (this is off-heap memory). The default matches SystemDataRegionConfiguration.DFLT_SYS_REG_INIT_SIZE.

    • getSystemDataRegionMaxSize

      public org.springframework.util.unit.DataSize getSystemDataRegionMaxSize()
      Deprecated.
      The maximum allowed size of the system data storage region for Ignite system cache (this is off-heap memory). The default matches SystemDataRegionConfiguration.DFLT_SYS_REG_MAX_SIZE.

    • getDefaultDataRegionEmptyPagesPoolSize

      public int getDefaultDataRegionEmptyPagesPoolSize()
      Deprecated.
      Configures the default data region's DataRegionConfiguration.getEmptyPagesPoolSize() (see the Javadocs there). This default is the same as what is configured in DataRegionConfiguration.

    • getDefaultDataRegionPageEvictionMode

      public org.apache.ignite.configuration.DataPageEvictionMode getDefaultDataRegionPageEvictionMode()
      Deprecated.
      Configures the default data region's DataRegionConfiguration.getPageEvictionMode() (see the Javadocs there). NOTE: Setting the default to `DISABLED` as there is a known issue https://issues.apache.org/jira/browse/IGNITE-24992 with `RANDOM_2_LRU` and `RANDOM_LRU` policies for certain versions of Ignite

    • isDefaultDataRegionMetricsEnabled

      public boolean isDefaultDataRegionMetricsEnabled()
      Deprecated.
      Controls whether the Ignite engine itself tracks low-level storage metrics (e.g., page allocations, evictions) for the default DataRegion. While required for storage monitoring, enabling this adds a small amount of overhead to the Ignite memory manager. False by default.

    • isMetricsCollectionEnabled

      public boolean isMetricsCollectionEnabled()
      Deprecated.
      A global "kill switch" for the Micrometer integration. When enabled, Ignite metrics (both storage health and logical cache sizes) will be exported to the Micrometer registry. This is required for any visibility into the cache's footprint in monitoring tools like Grafana. False by default.
      Since:
      2.0.7

    • isCacheStatisticsEnabled

      public boolean isCacheStatisticsEnabled()
      Deprecated.
      Toggles the tracking of high-level throughput metrics such as cache hits, misses, gets, and puts. Tracking these requires Ignite to maintain additional counters for every cache operation, which can introduce non-trivial CPU overhead in high-concurrency environments. This setting only takes effect if isMetricsCollectionEnabled() is true. False by default.
      Since:
      2.0.7

    • getIncludedEventTypes

      public List<Integer> getIncludedEventTypes()
      Deprecated.
      Configures the IgniteConfiguration.getIncludeEventTypes() value. By default, we register EventType.EVT_CACHE_STARTED, which is relevant for Broadleaf's default cache metrics collection. This ensures lazily initialized caches (ex: from Cacheable) can be monitored.
      Since:
      2.0.7

    • getDefaultDataRegionInitialSize

      public org.springframework.util.unit.DataSize getDefaultDataRegionInitialSize()
      Deprecated.
      The initial allocation size of the default data storage region (this is off-heap memory). The default matches DataStorageConfiguration.DFLT_DATA_REGION_INITIAL_SIZE

    • getDefaultDataRegionMaxSize

      public org.springframework.util.unit.DataSize getDefaultDataRegionMaxSize()
      Deprecated.
      The maximum allowed size of the default data storage region (this is off-heap memory).

    • isDumpThreadsOnFailure

      public boolean isDumpThreadsOnFailure()
      Deprecated.
      Whether to dump all threads to the log when a failure occurs. This property influences the IGNITE_DUMP_THREADS_ON_FAILURE system property during Ignite initialization.
      Since:
      2.0.7

    • setMemoryPageSize

      public void setMemoryPageSize(org.springframework.util.unit.DataSize memoryPageSize)
      Deprecated.
      The memory page size to use for Ignite. Ignite recommends this to be "no less than the lower of: the page size of your storage media (SSD, Flash, HDD, etc.) and the cache page size of your operating system". The default value here matches DataStorageConfiguration.DFLT_PAGE_SIZE.

    • setSystemDataRegionInitialSize

      public void setSystemDataRegionInitialSize(org.springframework.util.unit.DataSize systemDataRegionInitialSize)
      Deprecated.
      The initial allocation size of the system data storage region for Ignite system cache (this is off-heap memory). The default matches SystemDataRegionConfiguration.DFLT_SYS_REG_INIT_SIZE.

    • setSystemDataRegionMaxSize

      public void setSystemDataRegionMaxSize(org.springframework.util.unit.DataSize systemDataRegionMaxSize)
      Deprecated.
      The maximum allowed size of the system data storage region for Ignite system cache (this is off-heap memory). The default matches SystemDataRegionConfiguration.DFLT_SYS_REG_MAX_SIZE.

    • setDefaultDataRegionEmptyPagesPoolSize

      public void setDefaultDataRegionEmptyPagesPoolSize(int defaultDataRegionEmptyPagesPoolSize)
      Deprecated.
      Configures the default data region's DataRegionConfiguration.getEmptyPagesPoolSize() (see the Javadocs there). This default is the same as what is configured in DataRegionConfiguration.

    • setDefaultDataRegionPageEvictionMode

      public void setDefaultDataRegionPageEvictionMode(org.apache.ignite.configuration.DataPageEvictionMode defaultDataRegionPageEvictionMode)
      Deprecated.
      Configures the default data region's DataRegionConfiguration.getPageEvictionMode() (see the Javadocs there). NOTE: Setting the default to `DISABLED` as there is a known issue https://issues.apache.org/jira/browse/IGNITE-24992 with `RANDOM_2_LRU` and `RANDOM_LRU` policies for certain versions of Ignite

    • setDefaultDataRegionMetricsEnabled

      public void setDefaultDataRegionMetricsEnabled(boolean defaultDataRegionMetricsEnabled)
      Deprecated.
      Controls whether the Ignite engine itself tracks low-level storage metrics (e.g., page allocations, evictions) for the default DataRegion. While required for storage monitoring, enabling this adds a small amount of overhead to the Ignite memory manager. False by default.

    • setMetricsCollectionEnabled

      public void setMetricsCollectionEnabled(boolean metricsCollectionEnabled)
      Deprecated.
      A global "kill switch" for the Micrometer integration. When enabled, Ignite metrics (both storage health and logical cache sizes) will be exported to the Micrometer registry. This is required for any visibility into the cache's footprint in monitoring tools like Grafana. False by default.
      Since:
      2.0.7

    • setCacheStatisticsEnabled

      public void setCacheStatisticsEnabled(boolean cacheStatisticsEnabled)
      Deprecated.
      Toggles the tracking of high-level throughput metrics such as cache hits, misses, gets, and puts. Tracking these requires Ignite to maintain additional counters for every cache operation, which can introduce non-trivial CPU overhead in high-concurrency environments. This setting only takes effect if isMetricsCollectionEnabled() is true. False by default.
      Since:
      2.0.7

    • setIncludedEventTypes

      public void setIncludedEventTypes(List<Integer> includedEventTypes)
      Deprecated.
      Configures the IgniteConfiguration.getIncludeEventTypes() value. By default, we register EventType.EVT_CACHE_STARTED, which is relevant for Broadleaf's default cache metrics collection. This ensures lazily initialized caches (ex: from Cacheable) can be monitored.
      Since:
      2.0.7

    • setDefaultDataRegionInitialSize

      public void setDefaultDataRegionInitialSize(org.springframework.util.unit.DataSize defaultDataRegionInitialSize)
      Deprecated.
      The initial allocation size of the default data storage region (this is off-heap memory). The default matches DataStorageConfiguration.DFLT_DATA_REGION_INITIAL_SIZE

    • setDefaultDataRegionMaxSize

      public void setDefaultDataRegionMaxSize(org.springframework.util.unit.DataSize defaultDataRegionMaxSize)
      Deprecated.
      The maximum allowed size of the default data storage region (this is off-heap memory).

    • setDumpThreadsOnFailure

      public void setDumpThreadsOnFailure(boolean dumpThreadsOnFailure)
      Deprecated.
      Whether to dump all threads to the log when a failure occurs. This property influences the IGNITE_DUMP_THREADS_ON_FAILURE system property during Ignite initialization.
      Since:
      2.0.7