JBoss EAP 6.0 Model Reference

  1. JBoss EAP 6.0
  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 (13)

  • 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 false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • 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 false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • 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 false
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Allowed Values NONE
    LOCAL
    ALL
  • jndi-name The jndi-name to which to bind this cache instance.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed false
    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 false
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • 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 false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • owners Number of cluster-wide replicas for each cache entry.
    • Attribute Value
    Default Value 2
    Type INT
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • 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 false
    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 false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • 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 false
    Unit MILLISECONDS
    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 false
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Allowed Values EAGER
    LAZY
  • virtual-nodes Controls the number of virtual nodes per "real" node. If numVirtualNodes is 1, then virtual nodes are disabled. The topology aware consistent hash must be used if you wish to take advantage of virtual nodes. A default of 1 is used.
    • 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
    start STRING false false The cache start mode, which can be EAGER (immediate start) or LAZY (on-demand start).
    batching BOOLEAN false false If enabled, the invocation batching API will be made available for this cache.
    indexing STRING false false If enabled, entries will be indexed when they are added to the cache. Indexes will be updated as entries change or are removed.
    jndi-name STRING false false The jndi-name to which to bind this cache instance.
    module STRING false false The module whose class loader should be used when building this cache's configuration.
    async-marshalling BOOLEAN false false If enabled, this will cause marshalling of entries to be performed asynchronously.
    mode STRING true true Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation.
    queue-size INT false false In ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold.
    queue-flush-interval LONG false false 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.
    remote-timeout LONG false false 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.
    owners INT false false Number of cluster-wide replicas for each cache entry.
    virtual-nodes INT false false Controls the number of virtual nodes per "real" node. If numVirtualNodes is 1, then virtual nodes are disabled. The topology aware consistent hash must be used if you wish to take advantage of virtual nodes. A default of 1 is used.
    l1-lifespan LONG false false 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.
    state-transfer OBJECT false false The state transfer configuration for distribution and replicated caches.
  • remove Remove a cache from this container.