DistributedCache (api 0.3.4 API)

java.lang.Object
- org.wildfly.swarm.config.infinispan.cache_container.DistributedCache

public class DistributedCache
extends Object

A distributed cache configuration.

Constructor Summary

Constructors
Constructor and Description

DistributedCache(String key)

Constructors
Constructor and Description
`DistributedCache(String key)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Long`	`activations()` The number of cache node activations (bringing a node into memory from a cache store) .
`DistributedCache`	`activations(Long value)` The number of cache node activations (bringing a node into memory from a cache store) .
`Long`	`averageReadTime()` Average time (in ms) for cache reads.
`DistributedCache`	`averageReadTime(Long value)` Average time (in ms) for cache reads.
`Long`	`averageReplicationTime()` The average time taken to replicate data around the cluster.
`DistributedCache`	`averageReplicationTime(Long value)` The average time taken to replicate data around the cluster.
`Long`	`averageWriteTime()` Average time (in ms) for cache writes.
`DistributedCache`	`averageWriteTime(Long value)` Average time (in ms) for cache writes.
`BackupForComponent`	`backupForComponent()` A cache for which this cache acts as a backup (for use with cross site replication).
`DistributedCache`	`backupForComponent(BackupForComponent value)` A cache for which this cache acts as a backup (for use with cross site replication).
`BackupsComponent`	`backupsComponent()` The remote backups for this cache.
`DistributedCache`	`backupsComponent(BackupsComponent value)` The remote backups for this cache.
`BinaryJdbcStore`	`binaryJdbcStore()` The cache JDBC store configuration.
`DistributedCache`	`binaryJdbcStore(BinaryJdbcStore value)` The cache JDBC store configuration.
`String`	`cacheStatus()` The status of the cache component.
`DistributedCache`	`cacheStatus(String value)` The status of the cache component.
`Double`	`capacityFactor()` Controls the proportion of entries that will reside on the local node, compared to the other nodes in the cluster.
`DistributedCache`	`capacityFactor(Double value)` Controls the proportion of entries that will reside on the local node, compared to the other nodes in the cluster.
`String`	`consistentHashStrategy()` Defines the consistent hash strategy for the cache.
`DistributedCache`	`consistentHashStrategy(String value)` Defines the consistent hash strategy for the cache.
`CustomStore`	`customStore()` The cache store configuration.
`DistributedCache`	`customStore(CustomStore value)` The cache store configuration.
`Long`	`elapsedTime()` Time (in secs) since cache started.
`DistributedCache`	`elapsedTime(Long value)` Time (in secs) since cache started.
`EvictionComponent`	`evictionComponent()` The cache eviction configuration.
`DistributedCache`	`evictionComponent(EvictionComponent value)` The cache eviction configuration.
`ExpirationComponent`	`expirationComponent()` The cache expiration configuration.
`DistributedCache`	`expirationComponent(ExpirationComponent value)` The cache expiration configuration.
`FileStore`	`fileStore()` The cache file store configuration.
`DistributedCache`	`fileStore(FileStore value)` The cache file store configuration.
`String`	`getKey()`
`Double`	`hitRatio()` The hit/miss ratio for the cache (hits/hits+misses).
`DistributedCache`	`hitRatio(Double value)` The hit/miss ratio for the cache (hits/hits+misses).
`Long`	`hits()` The number of cache attribute hits.
`DistributedCache`	`hits(Long value)` The number of cache attribute hits.
`Long`	`invalidations()` The number of cache invalidations.
`DistributedCache`	`invalidations(Long value)` The number of cache invalidations.
`String`	`jndiName()` The jndi-name to which to bind this cache instance.
`DistributedCache`	`jndiName(String value)` The jndi-name to which to bind this cache instance.
`Long`	`l1Lifespan()` Maximum lifespan of an entry placed in the L1 cache.
`DistributedCache`	`l1Lifespan(Long value)` Maximum lifespan of an entry placed in the L1 cache.
`LockingComponent`	`lockingComponent()` The locking configuration of the cache.
`DistributedCache`	`lockingComponent(LockingComponent value)` The locking configuration of the cache.
`Long`	`misses()` The number of cache attribute misses.
`DistributedCache`	`misses(Long value)` The number of cache attribute misses.
`MixedJdbcStore`	`mixedJdbcStore()` The cache JDBC store configuration.
`DistributedCache`	`mixedJdbcStore(MixedJdbcStore value)` The cache JDBC store configuration.
`String`	`mode()` Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation.
`DistributedCache`	`mode(String value)` Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation.
`String`	`module()` The module whose class loader should be used when building this cache's configuration.
`DistributedCache`	`module(String value)` The module whose class loader should be used when building this cache's configuration.
`NoneStore`	`noneStore()` A store-less configuration.
`DistributedCache`	`noneStore(NoneStore value)` A store-less configuration.
`Integer`	`numberOfEntries()` The current number of entries in the cache.
`DistributedCache`	`numberOfEntries(Integer value)` The current number of entries in the cache.
`Integer`	`owners()` Number of cluster-wide replicas for each cache entry.
`DistributedCache`	`owners(Integer value)` Number of cluster-wide replicas for each cache entry.
`PartitionHandlingComponent`	`partitionHandlingComponent()` The partition handling configuration for distributed and replicated caches.
`DistributedCache`	`partitionHandlingComponent(PartitionHandlingComponent value)` The partition handling configuration for distributed and replicated caches.
`Long`	`passivations()` The number of cache node passivations (passivating a node from memory to a cache store).
`DistributedCache`	`passivations(Long value)` The number of cache node passivations (passivating a node from memory to a cache store).
`Long`	`queueFlushInterval()` In ASYNC mode, this attribute controls how often the asynchronous thread used to flush the replication queue runs.
`DistributedCache`	`queueFlushInterval(Long value)` In ASYNC mode, this attribute controls how often the asynchronous thread used to flush the replication queue runs.
`Integer`	`queueSize()` In ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold.
`DistributedCache`	`queueSize(Integer value)` In ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold.
`Double`	`readWriteRatio()` The read/write ratio of the cache ((hits+misses)/stores).
`DistributedCache`	`readWriteRatio(Double value)` The read/write ratio of the cache ((hits+misses)/stores).
`RemoteStore`	`remoteStore()` The cache remote store configuration.
`DistributedCache`	`remoteStore(RemoteStore value)` The cache remote store configuration.
`Long`	`remoteTimeout()` 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.
`DistributedCache`	`remoteTimeout(Long value)` 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.
`Long`	`removeHits()` The number of cache attribute remove hits.
`DistributedCache`	`removeHits(Long value)` The number of cache attribute remove hits.
`Long`	`removeMisses()` The number of cache attribute remove misses.
`DistributedCache`	`removeMisses(Long value)` The number of cache attribute remove misses.
`Long`	`replicationCount()` The number of times data was replicated around the cluster.
`DistributedCache`	`replicationCount(Long value)` The number of times data was replicated around the cluster.
`Long`	`replicationFailures()` The number of data replication failures.
`DistributedCache`	`replicationFailures(Long value)` The number of data replication failures.
`Integer`	`segments()` Controls the number of hash space segments which is the granularity for key distribution in the cluster.
`DistributedCache`	`segments(Integer value)` Controls the number of hash space segments which is the granularity for key distribution in the cluster.
`StateTransferComponent`	`stateTransferComponent()` The state transfer configuration for distributed and replicated caches.
`DistributedCache`	`stateTransferComponent(StateTransferComponent value)` The state transfer configuration for distributed and replicated caches.
`Boolean`	`statisticsEnabled()` If enabled, statistics will be collected for this cache
`DistributedCache`	`statisticsEnabled(Boolean value)` If enabled, statistics will be collected for this cache
`Long`	`stores()` The number of cache attribute put operations.
`DistributedCache`	`stores(Long value)` The number of cache attribute put operations.
`StringJdbcStore`	`stringJdbcStore()` The cache JDBC store configuration.
`DistributedCache`	`stringJdbcStore(StringJdbcStore value)` The cache JDBC store configuration.
`Double`	`successRatio()` The data replication success ratio (successes/successes+failures).
`DistributedCache`	`successRatio(Double value)` The data replication success ratio (successes/successes+failures).
`Long`	`timeSinceReset()` Time (in secs) since cache statistics were reset.
`DistributedCache`	`timeSinceReset(Long value)` Time (in secs) since cache statistics were reset.
`TransactionComponent`	`transactionComponent()` The cache transaction configuration.
`DistributedCache`	`transactionComponent(TransactionComponent value)` The cache transaction configuration.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DistributedCache
```
public DistributedCache(String key)
```
- Method Detail
  - getKey
```
public String getKey()
```
  - activations
```
public Long activations()
```
    The number of cache node activations (bringing a node into memory from a cache store) . May return null if the cache is not started.
  - activations
```
public DistributedCache activations(Long value)
```
    The number of cache node activations (bringing a node into memory from a cache store) . May return null if the cache is not started.
  - averageReadTime
```
public Long averageReadTime()
```
    Average time (in ms) for cache reads. Includes hits and misses. May return null if the cache is not started.
  - averageReadTime
```
public DistributedCache averageReadTime(Long value)
```
    Average time (in ms) for cache reads. Includes hits and misses. May return null if the cache is not started.
  - averageReplicationTime
```
public Long averageReplicationTime()
```
    The average time taken to replicate data around the cluster. May return null if the cache is not started.
  - averageReplicationTime
```
public DistributedCache averageReplicationTime(Long value)
```
    The average time taken to replicate data around the cluster. May return null if the cache is not started.
  - averageWriteTime
```
public Long averageWriteTime()
```
    Average time (in ms) for cache writes. May return null if the cache is not started.
  - averageWriteTime
```
public DistributedCache averageWriteTime(Long value)
```
    Average time (in ms) for cache writes. May return null if the cache is not started.
  - cacheStatus
```
public String cacheStatus()
```
    The status of the cache component. May return null if the cache is not started.
  - cacheStatus
```
public DistributedCache cacheStatus(String value)
```
    The status of the cache component. May return null if the cache is not started.
  - capacityFactor
```
public Double capacityFactor()
```
    Controls the proportion of entries that will reside on the local node, compared to the other nodes in the cluster.
  - capacityFactor
```
public DistributedCache capacityFactor(Double value)
```
    Controls the proportion of entries that will reside on the local node, compared to the other nodes in the cluster.
  - consistentHashStrategy
```
public String consistentHashStrategy()
```
    Defines the consistent hash strategy for the cache.
  - consistentHashStrategy
```
public DistributedCache consistentHashStrategy(String value)
```
    Defines the consistent hash strategy for the cache.
  - elapsedTime
```
public Long elapsedTime()
```
    Time (in secs) since cache started. May return null if the cache is not started.
  - elapsedTime
```
public DistributedCache elapsedTime(Long value)
```
    Time (in secs) since cache started. May return null if the cache is not started.
  - hitRatio
```
public Double hitRatio()
```
    The hit/miss ratio for the cache (hits/hits+misses). May return null if the cache is not started.
  - hitRatio
```
public DistributedCache hitRatio(Double value)
```
    The hit/miss ratio for the cache (hits/hits+misses). May return null if the cache is not started.
  - hits
```
public Long hits()
```
    The number of cache attribute hits. May return null if the cache is not started.
  - hits
```
public DistributedCache hits(Long value)
```
    The number of cache attribute hits. May return null if the cache is not started.
  - invalidations
```
public Long invalidations()
```
    The number of cache invalidations. May return null if the cache is not started.
  - invalidations
```
public DistributedCache invalidations(Long value)
```
    The number of cache invalidations. May return null if the cache is not started.
  - jndiName
```
public String jndiName()
```
    The jndi-name to which to bind this cache instance.
  - jndiName
```
public DistributedCache jndiName(String value)
```
    The jndi-name to which to bind this cache instance.
  - l1Lifespan
```
public Long l1Lifespan()
```
    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.
  - l1Lifespan
```
public DistributedCache l1Lifespan(Long value)
```
    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.
  - misses
```
public Long misses()
```
    The number of cache attribute misses. May return null if the cache is not started.
  - misses
```
public DistributedCache misses(Long value)
```
    The number of cache attribute misses. May return null if the cache is not started.
  - mode
```
public String mode()
```
    Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation.
  - mode
```
public DistributedCache mode(String value)
```
    Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation.
  - module
```
public String module()
```
    The module whose class loader should be used when building this cache's configuration.
  - module
```
public DistributedCache module(String value)
```
    The module whose class loader should be used when building this cache's configuration.
  - numberOfEntries
```
public Integer numberOfEntries()
```
    The current number of entries in the cache. May return null if the cache is not started.
  - numberOfEntries
```
public DistributedCache numberOfEntries(Integer value)
```
    The current number of entries in the cache. May return null if the cache is not started.
  - owners
```
public Integer owners()
```
    Number of cluster-wide replicas for each cache entry.
  - owners
```
public DistributedCache owners(Integer value)
```
    Number of cluster-wide replicas for each cache entry.
  - passivations
```
public Long 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.
  - passivations
```
public DistributedCache passivations(Long value)
```
    The number of cache node passivations (passivating a node from memory to a cache store). May return null if the cache is not started.
  - queueFlushInterval
```
public Long queueFlushInterval()
```
    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.
  - queueFlushInterval
```
public DistributedCache queueFlushInterval(Long value)
```
    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.
  - queueSize
```
public Integer queueSize()
```
    In ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold.
  - queueSize
```
public DistributedCache queueSize(Integer value)
```
    In ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold.
  - readWriteRatio
```
public Double readWriteRatio()
```
    The read/write ratio of the cache ((hits+misses)/stores). May return null if the cache is not started.
  - readWriteRatio
```
public DistributedCache readWriteRatio(Double value)
```
    The read/write ratio of the cache ((hits+misses)/stores). May return null if the cache is not started.
  - remoteTimeout
```
public Long remoteTimeout()
```
    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.
  - remoteTimeout
```
public DistributedCache remoteTimeout(Long value)
```
    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.
  - removeHits
```
public Long removeHits()
```
    The number of cache attribute remove hits. May return null if the cache is not started.
  - removeHits
```
public DistributedCache removeHits(Long value)
```
    The number of cache attribute remove hits. May return null if the cache is not started.
  - removeMisses
```
public Long removeMisses()
```
    The number of cache attribute remove misses. May return null if the cache is not started.
  - removeMisses
```
public DistributedCache removeMisses(Long value)
```
    The number of cache attribute remove misses. May return null if the cache is not started.
  - replicationCount
```
public Long replicationCount()
```
    The number of times data was replicated around the cluster. May return null if the cache is not started.
  - replicationCount
```
public DistributedCache replicationCount(Long value)
```
    The number of times data was replicated around the cluster. May return null if the cache is not started.
  - replicationFailures
```
public Long replicationFailures()
```
    The number of data replication failures. May return null if the cache is not started.
  - replicationFailures
```
public DistributedCache replicationFailures(Long value)
```
    The number of data replication failures. May return null if the cache is not started.
  - segments
```
public Integer segments()
```
    Controls the number of hash space segments which is the granularity for key distribution in the cluster. Value must be strictly positive.
  - segments
```
public DistributedCache segments(Integer value)
```
    Controls the number of hash space segments which is the granularity for key distribution in the cluster. Value must be strictly positive.
  - statisticsEnabled
```
public Boolean statisticsEnabled()
```
    If enabled, statistics will be collected for this cache
  - statisticsEnabled
```
public DistributedCache statisticsEnabled(Boolean value)
```
    If enabled, statistics will be collected for this cache
  - stores
```
public Long stores()
```
    The number of cache attribute put operations. May return null if the cache is not started.
  - stores
```
public DistributedCache stores(Long value)
```
    The number of cache attribute put operations. May return null if the cache is not started.
  - successRatio
```
public Double successRatio()
```
    The data replication success ratio (successes/successes+failures). May return null if the cache is not started.
  - successRatio
```
public DistributedCache successRatio(Double value)
```
    The data replication success ratio (successes/successes+failures). May return null if the cache is not started.
  - timeSinceReset
```
public Long timeSinceReset()
```
    Time (in secs) since cache statistics were reset. May return null if the cache is not started.
  - timeSinceReset
```
public DistributedCache timeSinceReset(Long value)
```
    Time (in secs) since cache statistics were reset. May return null if the cache is not started.
  - evictionComponent
```
public EvictionComponent evictionComponent()
```
    The cache eviction configuration.
  - evictionComponent
```
public DistributedCache evictionComponent(EvictionComponent value)
```
    The cache eviction configuration.
  - expirationComponent
```
public ExpirationComponent expirationComponent()
```
    The cache expiration configuration.
  - expirationComponent
```
public DistributedCache expirationComponent(ExpirationComponent value)
```
    The cache expiration configuration.
  - customStore
```
public CustomStore customStore()
```
    The cache store configuration.
  - customStore
```
public DistributedCache customStore(CustomStore value)
```
    The cache store configuration.
  - noneStore
```
public NoneStore noneStore()
```
    A store-less configuration.
  - noneStore
```
public DistributedCache noneStore(NoneStore value)
```
    A store-less configuration.
  - backupForComponent
```
public BackupForComponent backupForComponent()
```
    A cache for which this cache acts as a backup (for use with cross site replication).
  - backupForComponent
```
public DistributedCache backupForComponent(BackupForComponent value)
```
    A cache for which this cache acts as a backup (for use with cross site replication).
  - transactionComponent
```
public TransactionComponent transactionComponent()
```
    The cache transaction configuration.
  - transactionComponent
```
public DistributedCache transactionComponent(TransactionComponent value)
```
    The cache transaction configuration.
  - binaryJdbcStore
```
public BinaryJdbcStore binaryJdbcStore()
```
    The cache JDBC store configuration.
  - binaryJdbcStore
```
public DistributedCache binaryJdbcStore(BinaryJdbcStore value)
```
    The cache JDBC store configuration.
  - stringJdbcStore
```
public StringJdbcStore stringJdbcStore()
```
    The cache JDBC store configuration.
  - stringJdbcStore
```
public DistributedCache stringJdbcStore(StringJdbcStore value)
```
    The cache JDBC store configuration.
  - fileStore
```
public FileStore fileStore()
```
    The cache file store configuration.
  - fileStore
```
public DistributedCache fileStore(FileStore value)
```
    The cache file store configuration.
  - stateTransferComponent
```
public StateTransferComponent stateTransferComponent()
```
    The state transfer configuration for distributed and replicated caches.
  - stateTransferComponent
```
public DistributedCache stateTransferComponent(StateTransferComponent value)
```
    The state transfer configuration for distributed and replicated caches.
  - partitionHandlingComponent
```
public PartitionHandlingComponent partitionHandlingComponent()
```
    The partition handling configuration for distributed and replicated caches.
  - partitionHandlingComponent
```
public DistributedCache partitionHandlingComponent(PartitionHandlingComponent value)
```
    The partition handling configuration for distributed and replicated caches.
  - lockingComponent
```
public LockingComponent lockingComponent()
```
    The locking configuration of the cache.
  - lockingComponent
```
public DistributedCache lockingComponent(LockingComponent value)
```
    The locking configuration of the cache.
  - backupsComponent
```
public BackupsComponent backupsComponent()
```
    The remote backups for this cache.
  - backupsComponent
```
public DistributedCache backupsComponent(BackupsComponent value)
```
    The remote backups for this cache.
  - mixedJdbcStore
```
public MixedJdbcStore mixedJdbcStore()
```
    The cache JDBC store configuration.
  - mixedJdbcStore
```
public DistributedCache mixedJdbcStore(MixedJdbcStore value)
```
    The cache JDBC store configuration.
  - remoteStore
```
public RemoteStore remoteStore()
```
    The cache remote store configuration.
  - remoteStore
```
public DistributedCache remoteStore(RemoteStore value)
```
    The cache remote store configuration.

Class DistributedCache

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DistributedCache

Method Detail

getKey

activations

activations

averageReadTime

averageReadTime

averageReplicationTime

averageReplicationTime

averageWriteTime

averageWriteTime

cacheStatus

cacheStatus

capacityFactor

capacityFactor

consistentHashStrategy

consistentHashStrategy

elapsedTime

elapsedTime

hitRatio

hitRatio

hits

hits

invalidations

invalidations

jndiName

jndiName

l1Lifespan

l1Lifespan

misses

misses

mode

mode

module

module

numberOfEntries

numberOfEntries

owners

owners

passivations

passivations

queueFlushInterval

queueFlushInterval

queueSize

queueSize

readWriteRatio

readWriteRatio

remoteTimeout

remoteTimeout

removeHits

removeHits

removeMisses

removeMisses

replicationCount

replicationCount

replicationFailures

replicationFailures

segments

segments

statisticsEnabled

statisticsEnabled

stores

stores

successRatio

successRatio

timeSinceReset

timeSinceReset

evictionComponent

evictionComponent

expirationComponent

expirationComponent

customStore

customStore

noneStore

noneStore