JBoss EAP 6.3 Model Reference

  1. JBoss EAP 6.3
  2. subsystem=infinispan
  3. cache-container
  4. distributed-cache

A distributed cache

Children (11)

  • binary-keyed-jdbc-store The binary keyed cache JDBC store configuration.
  • eviction The cache eviction configuration.
    • EVICTION The cache eviction configuration.
  • expiration The cache expiration configuration.
  • file-store The cache file store configuration.
  • locking The locking configuration of the cache.
    • LOCKING The locking configuration of the cache.
  • mixed-keyed-jdbc-store The mixed keyed cache JDBC store configuration.
  • remote-store The cache remote store configuration.
  • state-transfer The state transfer configuration for distribution and replicated caches.
    • STATE_TRANSFER The state transfer configuration for distribution and replicated caches.
  • store The cache store configuration.
    • STORE The cache store configuration.
  • string-keyed-jdbc-store The string keyed cache JDBC store configuration.
  • transaction The cache transaction configuration.

Attributes (35)

  • async-marshalling If enabled, this will cause marshalling of entries to be performed asynchronously.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • average-read-time Average time (in ms) for cache reads. Includes hits and misses. May return null if the cache is not started.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric
  • average-replication-time The average time taken to replicate data around the cluster. May return null if the cache is not started.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric
  • average-write-time Average time (in ms) for cache writes. May return null if the cache is not started.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric
  • batching If enabled, the invocation batching API will be made available for this cache.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • cache-status The status of the cache component. May return null if the cache is not started.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric
  • elapsed-time Time (in secs) since cache started. May return null if the cache is not started.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric
  • hit-ratio The hit/miss ratio for the cache (hits/hits+misses). May return null if the cache is not started.
    • Attribute Value
    Type DOUBLE
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric
  • hits The number of cache attribute hits. May return null if the cache is not started.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric
  • indexing If enabled, entries will be indexed when they are added to the cache. Indexes will be updated as entries change or are removed.
    • Attribute Value
    Default Value NONE
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Allowed Values NONE
    LOCAL
    ALL
  • indexing-properties Properties to control indexing behaviour
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • invalidations The number of cache invalidations. May return null if the cache is not started.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric
  • jndi-name The jndi-name to which to bind this cache instance.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • l1-lifespan Maximum lifespan of an entry placed in the L1 cache. This element configures the L1 cache behavior in 'distributed' caches instances. In any other cache modes, this element is ignored.
    • Attribute Value
    Default Value 600000
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • misses The number of cache attribute misses. May return null if the cache is not started.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric
  • mode Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Allowed Values SYNC
    ASYNC
  • module The module whose class loader should be used when building this cache's configuration.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • number-of-entries The current number of entries in the cache. May return null if the cache is not started.
    • Attribute Value
    Type INT
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric
  • owners Number of cluster-wide replicas for each cache entry.
    • Attribute Value
    Default Value 2
    Type INT
    Nillable true
    Expressions Allowed true
    Min 1
    Max 2,147,483,647
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • passivations The number of cache node passivations (passivating a node from memory to a cache store). May return null if the cache is not started.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric
  • queue-flush-interval In ASYNC mode, this attribute controls how often the asynchronous thread used to flush the replication queue runs. This should be a positive integer which represents thread wakeup time in milliseconds.
    • Attribute Value
    Default Value 10
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • queue-size In ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold.
    • Attribute Value
    Default Value 0
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • read-write-ratio The read/write ratio of the cache ((hits+misses)/stores). May return null if the cache is not started.
    • Attribute Value
    Type DOUBLE
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric
  • remote-timeout In SYNC mode, the timeout (in ms) used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown.
    • Attribute Value
    Default Value 17500
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • remove-hits The number of cache attribute remove hits. May return null if the cache is not started.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric
  • remove-misses The number of cache attribute remove misses. May return null if the cache is not started.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric
  • replication-count The number of times data was replicated around the cluster. May return null if the cache is not started.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric
  • replication-failures The number of data replication failures. May return null if the cache is not started.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric
  • segments Controls the number of hash space segments which is the granularity for key distribution in the cluster. Value must be strictly positive.
    • Attribute Value
    Default Value 80
    Type INT
    Nillable true
    Expressions Allowed true
    Min 1
    Max 2,147,483,647
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • start The cache start mode, which can be EAGER (immediate start) or LAZY (on-demand start).
    • Attribute Value
    Default Value LAZY
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Allowed Values EAGER
    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. May return null if the cache is not started.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric
  • success-ratio The data replication success ratio (successes/successes+failures). May return null if the cache is not started.
    • Attribute Value
    Type DOUBLE
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric
  • time-since-reset Time (in secs) since cache statistics were reset. May return null if the cache is not started.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric
  • virtual-nodes Deprecated. Has no effect.
    • Deprecated Since 1.4.0
    Deprecated. Has no effect.
    Attribute Value
    Default Value 1
    Type INT
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services

Operations (2)

  • add Add a distributed cache to this cache container
    Request Parameter Type Required Expressions Allowed Default value Description
    virtual-nodes INT false false 1 Deprecated. Has no effect.
    segments INT false true 80 Controls the number of hash space segments which is the granularity for key distribution in the cluster. Value must be strictly positive.
    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.
    mode STRING true true Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation.
    remote-timeout LONG false true 17500 In SYNC mode, the timeout (in ms) used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown.
    jndi-name STRING false true The jndi-name to which to bind this cache instance.
    queue-size INT false true 0 In ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold.
    async-marshalling BOOLEAN false true false If enabled, this will cause marshalling of entries to be performed asynchronously.
    queue-flush-interval LONG false true 10 In ASYNC mode, this attribute controls how often the asynchronous thread used to flush the replication queue runs. This should be a positive integer which represents thread wakeup time in milliseconds.
    module STRING false true The module whose class loader should be used when building this cache's configuration.
    statistics-enabled BOOLEAN false true false If enabled, statistics will be collected for this cache
    batching BOOLEAN false true false If enabled, the invocation batching API will be made available for this cache.
    start STRING false true LAZY The cache start mode, which can be EAGER (immediate start) or LAZY (on-demand start).
    l1-lifespan LONG false true 600000 Maximum lifespan of an entry placed in the L1 cache. This element configures the L1 cache behavior in 'distributed' caches instances. In any other cache modes, this element is ignored.
    indexing-properties OBJECT false true Properties to control indexing behaviour
    owners INT false true 2 Number of cluster-wide replicas for each cache entry.
  • remove Remove a distributed cache from this cache container