com.ibm.wsspi.cache

Interface CacheConfig



  • public interface CacheConfig
    This interface is used to provide the cache instance configuration to a cache provider. This configuration is provided to the CacheProvider via the CacheProvider.createCache(CacheConfig) method.
    Since:
    WAS 6.1.0.27
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface and Description
      static class  CacheConfig.EvictorAlgorithmType
      Eviction algorithm type EvictorAlgorithmType.LRUEvictor is defined as an evictor type that uses a least recently used algorithm to decide which entries to evict when the cache entries map exceeds a maximum number of entries.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.String getCacheName()
      Returns the name of cache instance.
      CacheConfig.EvictorAlgorithmType getEvictorAlgorithmType()
      Returns the type of evictor algorithm.
      int getHighThresholdCacheSizeInMB()
      Returns the high threshold in percentage of JVM heap space that can be occupied by the cache entries.
      int getLowThresholdCacheSizeInMB()
      Returns the low threshold in percentage of JVM heap space that can be occupied by the cache entries.
      long getMaxCacheSize()
      Returns the maximum number of cache entries allowed in the memory.
      long getMaxCacheSizeInMB()
      Returns the maximum space on the JVM heap that can be occupied by the cache entries.
      java.util.Map<java.lang.String,java.lang.String> getProperties()
      Returns additional properties configured for the cacheinstance via the WebSphere admin console, wsadmin, the cacheinstances.properties file or the DistributedObjectCacheFactory.getMap(String name, Properties properties) API.
      boolean isDistributed()
      Indicates if this cache is meant to be distributed across the server instances of the cache provider.
    • Method Detail

      • getCacheName

        java.lang.String getCacheName()
        Returns the name of cache instance.
        Returns:
        Name of cache instance.
      • getMaxCacheSize

        long getMaxCacheSize()
        Returns the maximum number of cache entries allowed in the memory.
        Returns:
        The maximum number of cache entries allowed.
      • getMaxCacheSizeInMB

        long getMaxCacheSizeInMB()
        Returns the maximum space on the JVM heap that can be occupied by the cache entries.
        Returns:
        The maximum size of cache allowed in terms of JVM heap.
      • getHighThresholdCacheSizeInMB

        int getHighThresholdCacheSizeInMB()
        Returns the high threshold in percentage of JVM heap space that can be occupied by the cache entries.
        Returns:
        The high threshold of JVM heap space that can be occupied by the cache entries
      • getLowThresholdCacheSizeInMB

        int getLowThresholdCacheSizeInMB()
        Returns the low threshold in percentage of JVM heap space that can be occupied by the cache entries.
        Returns:
        The low threshold of JVM heap space that can be occupied by the cache entries
      • isDistributed

        boolean isDistributed()
        Indicates if this cache is meant to be distributed across the server instances of the cache provider.
        Returns:
        true - Replication is enabled for this cache instance configuration
      • getProperties

        java.util.Map<java.lang.String,java.lang.String> getProperties()
        Returns additional properties configured for the cacheinstance via the WebSphere admin console, wsadmin, the cacheinstances.properties file or the DistributedObjectCacheFactory.getMap(String name, Properties properties) API.
        Returns:
        additional properties used for configuring the cache provider's cache instance
IBM WebSphere Application ServerTM
Release 8.5