JBoss EAP 7.0 Model Reference

  1. JBoss EAP 7.0
  2. subsystem=infinispan
  3. cache-container
  4. distributed-cache
  5. store=remote

The cache remote store configuration.

Children (2)

  • property A cache store property with name and value.
  • 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)

Attributes (13)

  • cache The name of the remote cache to use for this remote store.
    • Attribute Value
    Default Value ___defaultcache
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required resource-services
  • cache-loader-loads The number of cache loader node loads. May return null if the cache is not started.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type read-only
  • cache-loader-misses The number of cache loader node misses. May return null if the cache is not started.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type read-only
  • 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.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required resource-services
  • 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. f 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 true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required resource-services
  • 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
  • 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
  • purge If true, purges this cache store when it starts up.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required resource-services
  • remote-servers A list of remote servers for this cache store.
    • Attribute Value
    Capability reference org.wildfly.network.outbound-socket-binding
    Type LIST
    Nillable false
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required resource-services
  • 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
  • singleton If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required resource-services
  • socket-timeout A socket timeout for remote cache communication.
    • Attribute Value
    Default Value 60000
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required resource-services
  • tcp-no-delay A TCP_NODELAY value for remote cache communication.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required resource-services

Operations (2)

  • add Adds a remote cache store configuration element to the cache.
    Request Parameter Type Required Expressions Allowed Default value Description
    cache STRING false true ___defaultcache The name of the remote cache to use for this remote store.
    socket-timeout LONG false true 60000 A socket timeout for remote cache communication.
    tcp-no-delay BOOLEAN false true true A TCP_NODELAY value for remote cache communication.
    remote-servers LIST true false A list of remote servers for this cache store.
    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.
    passivation BOOLEAN false true true 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. f 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.
    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.
    purge BOOLEAN false true true If true, purges this cache store when it starts up.
    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.
    singleton BOOLEAN false true false If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.
    properties OBJECT false true A list of cache store properties.
  • remove Removes a cache remote store configuration element from the cache.