Interface ICompositeCacheAttributes

All Superinterfaces:
Cloneable, Serializable
All Known Implementing Classes:
CompositeCacheAttributes

This defines the minimal behavior for the Cache Configuration settings.
  • Method Details

    • setMaxObjects

      void setMaxObjects(int size)
      SetMaxObjects is used to set the attribute to determine the maximum number of objects allowed in the memory cache. If the max number of objects or the cache size is set, the default for the one not set is ignored. If both are set, both are used to determine the capacity of the cache, i.e., object will be removed from the cache if either limit is reached. TODO: move to MemoryCache config file.

      Parameters:
      size - The new maxObjects value
    • getMaxObjects

      Gets the maxObjects attribute of the ICompositeCacheAttributes object

      Returns:
      The maxObjects value
    • setUseDisk

      void setUseDisk(boolean useDisk)
      Sets the useDisk attribute of the ICompositeCacheAttributes object

      Parameters:
      useDisk - The new useDisk value
    • isUseDisk

      boolean isUseDisk()
      Gets the useDisk attribute of the ICompositeCacheAttributes object

      Returns:
      The useDisk value
    • setUseLateral

      void setUseLateral(boolean d)
      set whether the cache should use a lateral cache

      Parameters:
      d - The new useLateral value
    • isUseLateral

      boolean isUseLateral()
      Gets the useLateral attribute of the ICompositeCacheAttributes object

      Returns:
      The useLateral value
    • setUseRemote

      void setUseRemote(boolean isRemote)
      Sets whether the cache is remote enabled

      Parameters:
      isRemote - The new useRemote value
    • isUseRemote

      boolean isUseRemote()
      returns whether the cache is remote enabled

      Returns:
      The useRemote value
    • setCacheName

      Sets the name of the cache, referenced by the appropriate manager.

      Parameters:
      s - The new cacheName value
    • getCacheName

      Gets the cacheName attribute of the ICompositeCacheAttributes object

      Returns:
      The cacheName value
    • setMemoryCacheName

      Sets the name of the MemoryCache, referenced by the appropriate manager. TODO: create a separate memory cache attribute class.

      Parameters:
      s - The new memoryCacheName value
    • getMemoryCacheName

      Gets the memoryCacheName attribute of the ICompositeCacheAttributes object

      Returns:
      The memoryCacheName value
    • setUseMemoryShrinker

      void setUseMemoryShrinker(boolean useShrinker)
      Whether the memory cache should perform background memory shrinkage.

      Parameters:
      useShrinker - The new UseMemoryShrinker value
    • isUseMemoryShrinker

      Whether the memory cache should perform background memory shrinkage.

      Returns:
      The UseMemoryShrinker value
    • setMaxMemoryIdleTimeSeconds

      void setMaxMemoryIdleTimeSeconds(long seconds)
      If UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space.

      Parameters:
      seconds - The new MaxMemoryIdleTimeSeconds value
    • getMaxMemoryIdleTimeSeconds

      If UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space.

      Returns:
      The MaxMemoryIdleTimeSeconds value
    • setShrinkerIntervalSeconds

      void setShrinkerIntervalSeconds(long seconds)
      If UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space. This sets the shrinker interval.

      Parameters:
      seconds - The new ShrinkerIntervalSeconds value
    • getShrinkerIntervalSeconds

      If UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space. This gets the shrinker interval.

      Returns:
      The ShrinkerIntervalSeconds value
    • setMaxSpoolPerRun

      void setMaxSpoolPerRun(int maxSpoolPerRun)
      If UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space. This sets the maximum number of items to spool per run.

      Parameters:
      maxSpoolPerRun - The new maxSpoolPerRun value
    • getMaxSpoolPerRun

      If UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space. This gets the maximum number of items to spool per run.

      Returns:
      The maxSpoolPerRun value
    • setDiskUsagePattern

      By default this is SWAP_ONLY.

      Parameters:
      diskUsagePattern - The diskUsagePattern to set.
    • setDiskUsagePatternName

      void setDiskUsagePatternName(String diskUsagePatternName)
      Translates the name to the disk usage pattern short value.

      The allowed values are SWAP and UPDATE.

      Parameters:
      diskUsagePatternName - The diskUsagePattern to set.
    • getDiskUsagePattern

      Returns:
      Returns the diskUsagePattern.
    • getSpoolChunkSize

      Number to send to disk at time when memory is full.

      Returns:
      int
    • setSpoolChunkSize

      void setSpoolChunkSize(int spoolChunkSize)
      Number to send to disk at a time.

      Parameters:
      spoolChunkSize -
    • clone

      Clone object