Interface RemoteCacheConfiguration

All Superinterfaces:
BasicCacheConfiguration, BasicCacheContainerConfiguration, CacheConfiguration, RemoteCacheContainerConfiguration
public interface RemoteCacheConfiguration extends RemoteCacheContainerConfiguration, BasicCacheConfiguration
Configuration associated with a remote cache.
Author:
Paul Ferraro

  • Method Summary

    Modifier and Type
    Method
    Description
    <K,V> org.infinispan.client.hotrod.RemoteCache<K,V>
    getCache()
    Returns the cache associated with this configuration.
    default org.infinispan.client.hotrod.RemoteCacheContainer
    getCacheContainer()
    Returns the associated cache container.
    default <K,V> CacheEntryMutatorFactory<K,V>
    getCacheEntryMutatorFactory()
    Returns the cache entry mutator associated with this configuration.
    default <K,V,O> CacheEntryMutatorFactory<K,O>
    getCacheEntryMutatorFactory(Function<O, BiFunction<Object,V,V>> functionFactory)
    Returns the compute-based cache entry mutator associated with this configuration.
    default CacheProperties
    getCacheProperties()
    Returns the properties of the associated cache.
    default Executor
    getExecutor()
    Returns the executor associated with this cache container.
    default <K,V> org.infinispan.client.hotrod.RemoteCache<K,V>
    getForceReturnCache()
    Returns a remote cache that whose writes will include return values.
    default <K,V> org.infinispan.client.hotrod.RemoteCache<K,V>
    getIgnoreReturnCache()
    Returns a remote cache that whose writes will ignore return values.
    default String
    getName()
    Returns the name of the associated cache container.
    default org.infinispan.client.hotrod.configuration.NearCacheMode
    getNearCacheMode()
    Returns the near cache mode of the associated cache.
    default <K,V> org.infinispan.client.hotrod.RemoteCache<K,V>
    getReadForUpdateCache()
    Returns a cache with select-for-update semantics.
    default <K,V> org.infinispan.client.hotrod.RemoteCache<K,V>
    getReadWriteCache()
    Returns a cache configured for write operations that return/require previous values.
    default Duration
    getStopTimeout()
    Returns the duration of time a service should wait for ongoing operations to complete prior to stopping.
    default Optional<jakarta.transaction.TransactionManager>
    getTransactionManager()
    If present, returns the transaction manager associated with this cache configuration.
    default <K,V> org.infinispan.client.hotrod.RemoteCache<K,V>
    getWriteOnlyCache()
    Returns a cache configured for write-only operations, i.e. that do not return/require previous values.
    default boolean
    isActive()
    Indicates whether the associated cache is active.
    static RemoteCacheConfiguration
    of(org.infinispan.client.hotrod.RemoteCache<?,?> cache)
    Creates a cache configuration for the specified cache.
    static RemoteCacheConfiguration
    of(org.infinispan.client.hotrod.RemoteCacheContainer container, String cacheName)
    Creates a cache configuration using the specified cache of the specified manager.

    Methods inherited from interface BasicCacheConfiguration

    getBatchFactory

  • Method Details

    • of

      static RemoteCacheConfiguration of(org.infinispan.client.hotrod.RemoteCacheContainer container, String cacheName)
      Creates a cache configuration using the specified cache of the specified manager.
      Parameters:
      container - a cache container
      cacheName - a cache name
      Returns:
      a cache configuration

    • of

      static RemoteCacheConfiguration of(org.infinispan.client.hotrod.RemoteCache<?,?> cache)
      Creates a cache configuration for the specified cache.
      Parameters:
      cache - a cache
      Returns:
      a cache configuration

    • getCache

      <K,V> org.infinispan.client.hotrod.RemoteCache<K,V> getCache()
      Description copied from interface: BasicCacheConfiguration
      Returns the cache associated with this configuration.
      Specified by:
      getCache in interface BasicCacheConfiguration
      Type Parameters:
      K - the cache key type
      V - the cache value type
      Returns:
      the cache associated with this configuration.

    • getName

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

    • isActive

      default boolean isActive()
      Description copied from interface: CacheConfiguration
      Indicates whether the associated cache is active.
      Specified by:
      isActive in interface CacheConfiguration
      Returns:
      true, if the associated cache is active, false otherwise.

    • getCacheEntryMutatorFactory

      default <K,V> CacheEntryMutatorFactory<K,V> getCacheEntryMutatorFactory()
      Description copied from interface: BasicCacheConfiguration
      Returns the cache entry mutator associated with this configuration.
      Specified by:
      getCacheEntryMutatorFactory in interface BasicCacheConfiguration
      Type Parameters:
      K - the cache key type
      V - the cache value type
      Returns:
      the cache entry mutator associated with this configuration.

    • getCacheEntryMutatorFactory

      default <K,V,O> CacheEntryMutatorFactory<K,O> getCacheEntryMutatorFactory(Function<O, BiFunction<Object,V,V>> functionFactory)
      Description copied from interface: BasicCacheConfiguration
      Returns the compute-based cache entry mutator associated with this configuration.
      Specified by:
      getCacheEntryMutatorFactory in interface BasicCacheConfiguration
      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.

    • getCacheContainer

      default org.infinispan.client.hotrod.RemoteCacheContainer getCacheContainer()
      Description copied from interface: BasicCacheContainerConfiguration
      Returns the associated cache container.
      Specified by:
      getCacheContainer in interface BasicCacheContainerConfiguration
      Specified by:
      getCacheContainer in interface RemoteCacheContainerConfiguration
      Returns:
      the associated cache container.

    • getExecutor

      default Executor getExecutor()
      Description copied from interface: BasicCacheContainerConfiguration
      Returns the executor associated with this cache container.
      Specified by:
      getExecutor in interface BasicCacheContainerConfiguration
      Returns:
      the executor associated with this cache container.

    • getTransactionManager

      default Optional<jakarta.transaction.TransactionManager> getTransactionManager()
      Description copied from interface: BasicCacheConfiguration
      If present, returns the transaction manager associated with this cache configuration.
      Specified by:
      getTransactionManager in interface BasicCacheConfiguration
      Returns:
      and optional transaction manager

    • getReadWriteCache

      default <K,V> org.infinispan.client.hotrod.RemoteCache<K,V> getReadWriteCache()
      Description copied from interface: BasicCacheConfiguration
      Returns a cache configured for write operations that return/require previous values.
      Specified by:
      getReadWriteCache in interface BasicCacheConfiguration
      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.client.hotrod.RemoteCache<K,V> getWriteOnlyCache()
      Description copied from interface: BasicCacheConfiguration
      Returns a cache configured for write-only operations, i.e. that do not return/require previous values.
      Specified by:
      getWriteOnlyCache in interface BasicCacheConfiguration
      Type Parameters:
      K - the cache key type
      V - the cache value type
      Returns:
      a cache configured for write-only operations.

    • getReadForUpdateCache

      default <K,V> org.infinispan.client.hotrod.RemoteCache<K,V> getReadForUpdateCache()
      Returns a cache with select-for-update semantics.
      Type Parameters:
      K - the cache key type
      V - the cache value type
      Returns:
      a cache with select-for-update semantics.

    • getIgnoreReturnCache

      default <K,V> org.infinispan.client.hotrod.RemoteCache<K,V> getIgnoreReturnCache()
      Returns a remote cache that whose writes will ignore return values.
      Type Parameters:
      K - the cache key type
      V - the cache value type
      Returns:
      a remote cache that whose writes will ignore return values.

    • getForceReturnCache

      default <K,V> org.infinispan.client.hotrod.RemoteCache<K,V> getForceReturnCache()
      Returns a remote cache that whose writes will include return values.
      Type Parameters:
      K - the cache key type
      V - the cache value type
      Returns:
      a remote cache that whose writes will indlude return values.

    • getNearCacheMode

      default org.infinispan.client.hotrod.configuration.NearCacheMode getNearCacheMode()
      Returns the near cache mode of the associated cache.
      Returns:
      the near cache mode of the associated cache.

    • getCacheProperties

      default CacheProperties getCacheProperties()
      Description copied from interface: CacheConfiguration
      Returns the properties of the associated cache.
      Specified by:
      getCacheProperties in interface CacheConfiguration
      Returns:
      the properties of the associated cache.

    • getStopTimeout

      default Duration getStopTimeout()
      Description copied from interface: BasicCacheConfiguration
      Returns the duration of time a service should wait for ongoing operations to complete prior to stopping.
      Specified by:
      getStopTimeout in interface BasicCacheConfiguration
      Returns:
      the duration of time a service should wait for ongoing operations to complete prior to stopping.