Interface BasicCacheConfiguration

All Superinterfaces:
BasicCacheContainerConfiguration, org.wildfly.clustering.cache.CacheConfiguration
public interface BasicCacheConfiguration extends org.wildfly.clustering.cache.CacheConfiguration, BasicCacheContainerConfiguration
Infinispan cache configuration specialization for a BasicCache.
Author:
Paul Ferraro

  • Method Summary

    Modifier and Type
    Method
    Description
    default org.wildfly.clustering.function.Supplier<org.wildfly.clustering.cache.batch.Batch>
    getBatchFactory()
     
    <K,V> org.infinispan.commons.api.BasicCache<K,V>
    getCache()
    Returns the cache associated with this configuration.
    <K,V> org.wildfly.clustering.cache.CacheEntryMutatorFactory<K,V>
    getCacheEntryMutatorFactory()
    Returns the cache entry mutator associated with this configuration.
    <K,V,O> org.wildfly.clustering.cache.CacheEntryMutatorFactory<K,O>
    getCacheEntryMutatorFactory(Function<O, BiFunction<Object,V,V>> functionFactory)
    Returns the compute-based cache entry mutator associated with this configuration.
    default String
    getName()
    Returns the name of the associated cache container.
    default <K,V> org.infinispan.commons.api.BasicCache<K,V>
    getReadWriteCache()
    Returns a cache configured for write operations that return/require previous values.
    Duration
    getStopTimeout()
    Returns the duration of time a service should wait for ongoing operations to complete prior to stopping.
    Optional<jakarta.transaction.TransactionManager>
    getTransactionManager()
    If present, returns the transaction manager associated with this cache configuration.
    default <K,V> org.infinispan.commons.api.BasicCache<K,V>
    getWriteOnlyCache()
    Returns a cache configured for write-only operations, i.e. that do not return/require previous values.

    Methods inherited from interface BasicCacheContainerConfiguration

    getCacheContainer, getExecutor

    Methods inherited from interface org.wildfly.clustering.cache.CacheConfiguration

    getCacheProperties, isActive

  • Method Details

    • getName

      default String getName()
      Description copied from interface: BasicCacheContainerConfiguration
      Returns the name of the associated cache container.
      Specified by:
      getName in interface BasicCacheContainerConfiguration
      Returns:
      the name of the associated cache container.

    • getCache

      <K,V> org.infinispan.commons.api.BasicCache<K,V> getCache()
      Returns the cache associated with this configuration.
      Type Parameters:
      K - the cache key type
      V - the cache value type
      Returns:
      the cache associated with this configuration.

    • getReadWriteCache

      default <K,V> org.infinispan.commons.api.BasicCache<K,V> getReadWriteCache()
      Returns a cache configured for write operations that return/require previous values.
      Type Parameters:
      K - the cache key type
      V - the cache value type
      Returns:
      a cache configured for read/write operations.

    • getWriteOnlyCache

      default <K,V> org.infinispan.commons.api.BasicCache<K,V> getWriteOnlyCache()
      Returns a cache configured for write-only operations, i.e. that do not return/require previous values.
      Type Parameters:
      K - the cache key type
      V - the cache value type
      Returns:
      a cache configured for write-only operations.

    • getCacheEntryMutatorFactory

      <K,V> org.wildfly.clustering.cache.CacheEntryMutatorFactory<K,V> getCacheEntryMutatorFactory()
      Returns the cache entry mutator associated with this configuration.
      Type Parameters:
      K - the cache key type
      V - the cache value type
      Returns:
      the cache entry mutator associated with this configuration.

    • getCacheEntryMutatorFactory

      <K,V,O> org.wildfly.clustering.cache.CacheEntryMutatorFactory<K,O> getCacheEntryMutatorFactory(Function<O, BiFunction<Object,V,V>> functionFactory)
      Returns the compute-based cache entry mutator associated with this configuration.
      Type Parameters:
      K - the cache key type
      V - the cache value type
      O - the operand type
      Parameters:
      functionFactory - a compute function factory
      Returns:
      the compute-based cache entry mutator associated with this configuration.

    • getTransactionManager

      Optional<jakarta.transaction.TransactionManager> getTransactionManager()
      If present, returns the transaction manager associated with this cache configuration.
      Returns:
      and optional transaction manager

    • getStopTimeout

      Duration getStopTimeout()
      Returns the duration of time a service should wait for ongoing operations to complete prior to stopping.
      Returns:
      the duration of time a service should wait for ongoing operations to complete prior to stopping.

    • getBatchFactory

      default org.wildfly.clustering.function.Supplier<org.wildfly.clustering.cache.batch.Batch> getBatchFactory()
      Specified by:
      getBatchFactory in interface org.wildfly.clustering.cache.CacheConfiguration