WildFly Full 26.1 Model Reference

  1. home
  2. subsystem=infinispan
  3. cache-container
  4. local-cache

A local cache configuration

Children (3)

  • component A configuration component of a cache.
    • expiration The cache expiration configuration.
    • locking The locking configuration of the cache.
    • transaction The cache transaction configuration.
  • memory Alias to the eviction configuration component
    • heap On-heap object-based memory configuration.
    • off-heap Off-heap memory configuration.
  • store A persistent store for a cache.
    • binary-jdbc The cache JDBC store configuration.
    • custom The cache store configuration.
    • file The cache file store configuration.
    • hotrod HotRod-based store using Infinispan Server instance to store data.
    • jdbc The cache JDBC store configuration.
    • mixed-jdbc The cache JDBC store configuration.
    • none A store-less configuration.
    • remote The cache remote store configuration.

Provided capabilities(9)

Name Dynamic Other provider points
org.wildfly.clustering.cache.service-provider-registry true /subsystem=infinispan/cache-container=*/distributed-cache=*
/subsystem=infinispan/cache-container=*/replicated-cache=*
/subsystem=infinispan/cache-container=*/scattered-cache=*
/subsystem=infinispan/cache-container=*/invalidation-cache=*
org.wildfly.clustering.cache.registry true /subsystem=infinispan/cache-container=*/distributed-cache=*
/subsystem=infinispan/cache-container=*/replicated-cache=*
/subsystem=infinispan/cache-container=*/scattered-cache=*
/subsystem=infinispan/cache-container=*/invalidation-cache=*
org.wildfly.clustering.cache.singleton-service-builder-factory true /subsystem=infinispan/cache-container=*/distributed-cache=*
/subsystem=infinispan/cache-container=*/replicated-cache=*
/subsystem=infinispan/cache-container=*/scattered-cache=*
/subsystem=infinispan/cache-container=*/invalidation-cache=*
org.wildfly.clustering.infinispan.cache-configuration true /subsystem=infinispan/cache-container=*/distributed-cache=*
/subsystem=infinispan/cache-container=*/replicated-cache=*
/subsystem=infinispan/cache-container=*/scattered-cache=*
/subsystem=infinispan/cache-container=*/invalidation-cache=*
org.wildfly.clustering.cache.singleton-service-configurator-factory true /subsystem=infinispan/cache-container=*/distributed-cache=*
/subsystem=infinispan/cache-container=*/replicated-cache=*
/subsystem=infinispan/cache-container=*/scattered-cache=*
/subsystem=infinispan/cache-container=*/invalidation-cache=*
org.wildfly.clustering.infinispan.cache true /subsystem=infinispan/cache-container=*/distributed-cache=*
/subsystem=infinispan/cache-container=*/replicated-cache=*
/subsystem=infinispan/cache-container=*/scattered-cache=*
/subsystem=infinispan/cache-container=*/invalidation-cache=*
org.wildfly.clustering.cache.group true /subsystem=infinispan/cache-container=*/distributed-cache=*
/subsystem=infinispan/cache-container=*/replicated-cache=*
/subsystem=infinispan/cache-container=*/scattered-cache=*
/subsystem=infinispan/cache-container=*/invalidation-cache=*
org.wildfly.clustering.cache.registry-entry true /subsystem=infinispan/cache-container=*/distributed-cache=*
/subsystem=infinispan/cache-container=*/replicated-cache=*
/subsystem=infinispan/cache-container=*/scattered-cache=*
/subsystem=infinispan/cache-container=*/invalidation-cache=*
org.wildfly.clustering.cache.registry-factory true /subsystem=infinispan/cache-container=*/distributed-cache=*
/subsystem=infinispan/cache-container=*/replicated-cache=*
/subsystem=infinispan/cache-container=*/scattered-cache=*
/subsystem=infinispan/cache-container=*/invalidation-cache=*

Attributes (24)

  • activations The number of cache node activations (bringing a node into memory from a cache store).
    • Deprecated Since 11.0.0
    Deprecated. Use metric from corresponding runtime cache resource.
    Attribute Value
    Type LONG
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type read-only
  • average-read-time Average time (in ms) for cache reads. Includes hits and misses.
    • Deprecated Since 11.0.0
    Deprecated. Use metric from corresponding runtime cache resource.
    Attribute Value
    Type LONG
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type read-only
  • average-write-time Average time (in ms) for cache writes.
    • Deprecated Since 11.0.0
    Deprecated. Use metric from corresponding runtime cache resource.
    Attribute Value
    Type LONG
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type read-only
  • batching If enabled, the invocation batching API will be made available for this cache.
    • Deprecated Since 3.0.0
    Deprecated. Replaced by BATCH transaction mode.
    Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • cache-status The status of the cache component.
    • Deprecated Since 11.0.0
    Deprecated. Always returns RUNNING.
    Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type read-only
  • elapsed-time Time (in secs) since cache started.
    • Deprecated Since 11.0.0
    Deprecated. Use time-since-start instead.
    Attribute Value
    Type LONG
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type read-only
  • hit-ratio The hit/miss ratio for the cache (hits/hits+misses).
    • Deprecated Since 11.0.0
    Deprecated. Use metric from corresponding runtime cache resource.
    Attribute Value
    Type DOUBLE
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type read-only
  • hits The number of cache attribute hits.
    • Deprecated Since 11.0.0
    Deprecated. Use metric from corresponding runtime cache resource.
    Attribute Value
    Type LONG
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type read-only
  • indexing If enabled, entries will be indexed when they are added to the cache. Indexes will be updated as entries change or are removed.
    • Deprecated Since 4.0.0
    Deprecated. Has no effect.
    Attribute Value
    Default Value NONE
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Allowed Values NONE
    ALL
    PRIMARY_OWNER
  • indexing-properties Properties to control indexing behaviour
    • Deprecated Since 4.0.0
    Deprecated. Has no effect.
    Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • invalidations The number of cache invalidations.
    • Deprecated Since 11.0.0
    Deprecated. Use metric from corresponding runtime cache resource.
    Attribute Value
    Type LONG
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type read-only
  • jndi-name The jndi-name to which to bind this cache instance.
    • Deprecated Since 6.0.0
    Deprecated. Will be ignored.
    Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • misses The number of cache attribute misses.
    • Deprecated Since 11.0.0
    Deprecated. Use metric from corresponding runtime cache resource.
    Attribute Value
    Type LONG
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type read-only
  • module The module associated with this cache's configuration.
    • Deprecated Since 14.0.0
    Deprecated. Superseded by the modules attribute.
    Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • modules The set of modules associated with this cache's configuration.
    • Attribute Value
    Type LIST
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required resource-services
  • number-of-entries The number of entries in the cache including passivated entries.
    • Deprecated Since 11.0.0
    Deprecated. Use metric from corresponding runtime cache resource.
    Attribute Value
    Type INT
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type read-only
  • passivations The number of cache node passivations (passivating a node from memory to a cache store).
    • Deprecated Since 11.0.0
    Deprecated. Use metric from corresponding runtime cache resource.
    Attribute Value
    Type LONG
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type read-only
  • read-write-ratio The read/write ratio of the cache ((hits+misses)/stores).
    • Deprecated Since 11.0.0
    Deprecated. Use metric from corresponding runtime cache resource.
    Attribute Value
    Type DOUBLE
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type read-only
  • remove-hits The number of cache attribute remove hits.
    • Deprecated Since 11.0.0
    Deprecated. Use metric from corresponding runtime cache resource.
    Attribute Value
    Type LONG
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type read-only
  • remove-misses The number of cache attribute remove misses.
    • Deprecated Since 11.0.0
    Deprecated. Use metric from corresponding runtime cache resource.
    Attribute Value
    Type LONG
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type read-only
  • start The cache start mode, which can be EAGER (immediate start) or LAZY (on-demand start).
    • Deprecated Since 3.0.0
    Deprecated. Only LAZY mode is supported.
    Attribute Value
    Default Value LAZY
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Allowed Values LAZY
  • statistics-enabled If enabled, statistics will be collected for this cache
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required resource-services
  • stores The number of cache attribute put operations.
    • Deprecated Since 11.0.0
    Deprecated. Use metric from corresponding runtime cache resource.
    Attribute Value
    Type LONG
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type read-only
  • time-since-reset Time (in secs) since cache statistics were reset.
    • Deprecated Since 11.0.0
    Deprecated. Use metric from corresponding runtime cache resource.
    Attribute Value
    Type LONG
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type read-only

Operations (2)

  • add Add a local cache to this cache container
    Request Parameter Type Required Expressions Allowed Default value Description
    statistics-enabled BOOLEAN false true false If enabled, statistics will be collected for this cache
    modules LIST false true The set of modules associated with this cache's configuration.
    batching BOOLEAN false true false If enabled, the invocation batching API will be made available for this cache.
    indexing STRING false true NONE If enabled, entries will be indexed when they are added to the cache. Indexes will be updated as entries change or are removed.
    indexing-properties OBJECT false false Properties to control indexing behaviour
    jndi-name STRING false true The jndi-name to which to bind this cache instance.
    start STRING false true LAZY The cache start mode, which can be EAGER (immediate start) or LAZY (on-demand start).
    module STRING false true The module associated with this cache's configuration.
  • remove Remove a local cache from this cache container