WildFly 35 Model Reference

The cache file store configuration.

Children (1)

  • write The write behavior of the cache store.
    • behind Configures a cache store as write-behind instead of write-through.
    • through Configures a cache store as write-through.

Provided capabilities(1)

Name Dynamic Other provider points
org.wildfly.clustering.infinispan.cache-configuration.store true /subsystem=infinispan/cache-container=*/invalidation-cache=*/store=file
/subsystem=infinispan/cache-container=*/invalidation-cache=*/store=remote
/subsystem=infinispan/cache-container=*/scattered-cache=*/store=custom
/subsystem=infinispan/cache-container=*/local-cache=*/store=custom
/subsystem=infinispan/cache-container=*/invalidation-cache=*/store=none
/subsystem=infinispan/cache-container=*/scattered-cache=*/store=hotrod
/subsystem=infinispan/cache-container=*/invalidation-cache=*/store=jdbc
/subsystem=infinispan/cache-container=*/distributed-cache=*/store=remote
/subsystem=infinispan/cache-container=*/local-cache=*/store=hotrod
/subsystem=infinispan/cache-container=*/invalidation-cache=*/store=hotrod
/subsystem=infinispan/cache-container=*/scattered-cache=*/store=jdbc
/subsystem=infinispan/cache-container=*/distributed-cache=*/store=custom
/subsystem=infinispan/cache-container=*/replicated-cache=*/store=none
/subsystem=infinispan/cache-container=*/replicated-cache=*/store=jdbc
/subsystem=infinispan/cache-container=*/scattered-cache=*/store=none
/subsystem=infinispan/cache-container=*/scattered-cache=*/store=remote
/subsystem=infinispan/cache-container=*/distributed-cache=*/store=hotrod
/subsystem=infinispan/cache-container=*/invalidation-cache=*/store=custom
/subsystem=infinispan/cache-container=*/replicated-cache=*/store=file
/subsystem=infinispan/cache-container=*/distributed-cache=*/store=none
/subsystem=infinispan/cache-container=*/local-cache=*/store=remote
/subsystem=infinispan/cache-container=*/replicated-cache=*/store=custom
/subsystem=infinispan/cache-container=*/replicated-cache=*/store=hotrod
/subsystem=infinispan/cache-container=*/local-cache=*/store=none
/subsystem=infinispan/cache-container=*/distributed-cache=*/store=jdbc
/subsystem=infinispan/cache-container=*/distributed-cache=*/store=file
/subsystem=infinispan/cache-container=*/local-cache=*/store=file
/subsystem=infinispan/cache-container=*/replicated-cache=*/store=remote
/subsystem=infinispan/cache-container=*/local-cache=*/store=jdbc

Attributes (10)

  • fetch-state If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.
    • Deprecated Since 16.0.0
    Deprecated. Persistent state will always be fetched if store is not shared.
    Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required resource-services
    Stability default
  • max-batch-size The maximum size of a batch to be inserted/deleted from the store. If the value is less than one, then no upper limit is placed on the number of operations in a batch.
    • Attribute Value
    Default Value 100
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required resource-services
    Stability default
  • passivation If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required resource-services
    Stability default
  • path The system path under which this cache store will persist its entries.
    • Deprecated Since 16.0.0
    Deprecated. Uses the persistence location of the associated cache container.
    Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required resource-services
    Stability default
  • preload If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required resource-services
    Stability default
  • properties A list of cache store properties.
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required resource-services
    Stability default
  • purge If true, purges this cache store when it starts up.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required resource-services
    Stability default
  • relative-to The system path to which the specified path is relative.
    • Deprecated Since 16.0.0
    Deprecated. Uses the persistence location of the associated cache container.
    Attribute Value
    Capability reference
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required resource-services
    Stability default
  • segmented Indicates whether or not this cache store should be segment aware.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required resource-services
    Stability default
  • shared This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required resource-services
    Stability default

Operations (3)

  • add Adds a file cache store configuration element to the cache.
    Request Parameter Type Required Expressions Allowed Default value Description
    fetch-state BOOLEAN false true true If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.
    max-batch-size INT false true 100 The maximum size of a batch to be inserted/deleted from the store. If the value is less than one, then no upper limit is placed on the number of operations in a batch.
    passivation BOOLEAN false true false If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.
    path STRING false true The system path under which this cache store will persist its entries.
    preload BOOLEAN false true false If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.
    properties OBJECT false true A list of cache store properties.
    purge BOOLEAN false true false If true, purges this cache store when it starts up.
    relative-to STRING false false The system path to which the specified path is relative.
    segmented BOOLEAN false true true Indicates whether or not this cache store should be segment aware.
    shared BOOLEAN false true false This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
  • remove Removes a cache file store configuration element from the cache.
  • resolve-path Resolves a relative path of a previously named paths or one of the standard paths provided by the system.
    Deprecated Since 16.0.0
    Deprecated; will be removed in a future release.
    Request Parameter Type Required Expressions Allowed Default value Description
    relative-to-only BOOLEAN false false Indicates whether only the relative-to attribute should be resolved or the full path should be resolved. The default is false meaning the entire path will be resolved.

    Reply properties

    The resolved path from the relative path attribute.
    type
    STRING