ReplicatedCache (config-api 0.3.11 API)

java.lang.Object
- org.wildfly.swarm.config.infinispan.cache_container.ReplicatedCache<T>

public class ReplicatedCache<T extends ReplicatedCache>
extends Object

A replicated cache configuration

Constructor Summary

Constructors
Constructor and Description

ReplicatedCache(String key)

Constructors
Constructor and Description
`ReplicatedCache(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) .
`ReplicatedCache`	`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.
`ReplicatedCache`	`averageReadTime(Long value)` Average time (in ms) for cache reads.
`Long`	`averageReplicationTime()` The average time taken to replicate data around the cluster.
`ReplicatedCache`	`averageReplicationTime(Long value)` The average time taken to replicate data around the cluster.
`Long`	`averageWriteTime()` Average time (in ms) for cache writes.
`ReplicatedCache`	`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).
`ReplicatedCache`	`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.
`ReplicatedCache`	`backupsComponent(BackupsComponent value)` The remote backups for this cache.
`BinaryJDBCStore`	`binaryJdbcStore()` The cache JDBC store configuration.
`ReplicatedCache`	`binaryJdbcStore(BinaryJDBCStore value)` The cache JDBC store configuration.
`String`	`cacheStatus()` The status of the cache component.
`ReplicatedCache`	`cacheStatus(String value)` The status of the cache component.
`CustomStore`	`customStore()` The cache store configuration.
`ReplicatedCache`	`customStore(CustomStore value)` The cache store configuration.
`Long`	`elapsedTime()` Time (in secs) since cache started.
`ReplicatedCache`	`elapsedTime(Long value)` Time (in secs) since cache started.
`EvictionComponent`	`evictionComponent()` The cache eviction configuration.
`ReplicatedCache`	`evictionComponent(EvictionComponent value)` The cache eviction configuration.
`ExpirationComponent`	`expirationComponent()` The cache expiration configuration.
`ReplicatedCache`	`expirationComponent(ExpirationComponent value)` The cache expiration configuration.
`FileStore`	`fileStore()` The cache file store configuration.
`ReplicatedCache`	`fileStore(FileStore value)` The cache file store configuration.
`String`	`getKey()`
`Double`	`hitRatio()` The hit/miss ratio for the cache (hits/hits+misses).
`ReplicatedCache`	`hitRatio(Double value)` The hit/miss ratio for the cache (hits/hits+misses).
`Long`	`hits()` The number of cache attribute hits.
`ReplicatedCache`	`hits(Long value)` The number of cache attribute hits.
`Long`	`invalidations()` The number of cache invalidations.
`ReplicatedCache`	`invalidations(Long value)` The number of cache invalidations.
`String`	`jndiName()` The jndi-name to which to bind this cache instance.
`ReplicatedCache`	`jndiName(String value)` The jndi-name to which to bind this cache instance.
`LockingComponent`	`lockingComponent()` The locking configuration of the cache.
`ReplicatedCache`	`lockingComponent(LockingComponent value)` The locking configuration of the cache.
`Long`	`misses()` The number of cache attribute misses.
`ReplicatedCache`	`misses(Long value)` The number of cache attribute misses.
`MixedJDBCStore`	`mixedJdbcStore()` The cache JDBC store configuration.
`ReplicatedCache`	`mixedJdbcStore(MixedJDBCStore value)` The cache JDBC store configuration.
`String`	`mode()` Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation.
`ReplicatedCache`	`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.
`ReplicatedCache`	`module(String value)` The module whose class loader should be used when building this cache's configuration.
`NoneStore`	`noneStore()` A store-less configuration.
`ReplicatedCache`	`noneStore(NoneStore value)` A store-less configuration.
`Integer`	`numberOfEntries()` The current number of entries in the cache.
`ReplicatedCache`	`numberOfEntries(Integer value)` The current number of entries in the cache.
`PartitionHandlingComponent`	`partitionHandlingComponent()` The partition handling configuration for distributed and replicated caches.
`ReplicatedCache`	`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).
`ReplicatedCache`	`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.
`ReplicatedCache`	`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.
`ReplicatedCache`	`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).
`ReplicatedCache`	`readWriteRatio(Double value)` The read/write ratio of the cache ((hits+misses)/stores).
`RemoteStore`	`remoteStore()` The cache remote store configuration.
`ReplicatedCache`	`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.
`ReplicatedCache`	`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.
`ReplicatedCache`	`removeHits(Long value)` The number of cache attribute remove hits.
`Long`	`removeMisses()` The number of cache attribute remove misses.
`ReplicatedCache`	`removeMisses(Long value)` The number of cache attribute remove misses.
`Long`	`replicationCount()` The number of times data was replicated around the cluster.
`ReplicatedCache`	`replicationCount(Long value)` The number of times data was replicated around the cluster.
`Long`	`replicationFailures()` The number of data replication failures.
`ReplicatedCache`	`replicationFailures(Long value)` The number of data replication failures.
`StateTransferComponent`	`stateTransferComponent()` The state transfer configuration for distributed and replicated caches.
`ReplicatedCache`	`stateTransferComponent(StateTransferComponent value)` The state transfer configuration for distributed and replicated caches.
`Boolean`	`statisticsEnabled()` If enabled, statistics will be collected for this cache
`ReplicatedCache`	`statisticsEnabled(Boolean value)` If enabled, statistics will be collected for this cache
`Long`	`stores()` The number of cache attribute put operations.
`ReplicatedCache`	`stores(Long value)` The number of cache attribute put operations.
`StringJDBCStore`	`stringJdbcStore()` The cache JDBC store configuration.
`ReplicatedCache`	`stringJdbcStore(StringJDBCStore value)` The cache JDBC store configuration.
`Double`	`successRatio()` The data replication success ratio (successes/successes+failures).
`ReplicatedCache`	`successRatio(Double value)` The data replication success ratio (successes/successes+failures).
`Long`	`timeSinceReset()` Time (in secs) since cache statistics were reset.
`ReplicatedCache`	`timeSinceReset(Long value)` Time (in secs) since cache statistics were reset.
`TransactionComponent`	`transactionComponent()` The cache transaction configuration.
`ReplicatedCache`	`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
  - ReplicatedCache
```
public ReplicatedCache(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 ReplicatedCache 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 ReplicatedCache 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 ReplicatedCache 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 ReplicatedCache 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 ReplicatedCache cacheStatus(String value)
```
    The status of the cache component. May return null if the cache is not started.
  - elapsedTime
```
public Long elapsedTime()
```
    Time (in secs) since cache started. May return null if the cache is not started.
  - elapsedTime
```
public ReplicatedCache 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 ReplicatedCache 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 ReplicatedCache 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 ReplicatedCache 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 ReplicatedCache jndiName(String value)
```
    The jndi-name to which to bind this cache instance.
  - misses
```
public Long misses()
```
    The number of cache attribute misses. May return null if the cache is not started.
  - misses
```
public ReplicatedCache 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 ReplicatedCache 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 ReplicatedCache 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 ReplicatedCache numberOfEntries(Integer value)
```
    The current number of entries in the cache. May return null if the cache is not started.
  - 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 ReplicatedCache 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 ReplicatedCache 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 ReplicatedCache 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 ReplicatedCache 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 ReplicatedCache 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 ReplicatedCache 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 ReplicatedCache 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 ReplicatedCache 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 ReplicatedCache replicationFailures(Long value)
```
    The number of data replication failures. May return null if the cache is not started.
  - statisticsEnabled
```
public Boolean statisticsEnabled()
```
    If enabled, statistics will be collected for this cache
  - statisticsEnabled
```
public ReplicatedCache 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 ReplicatedCache 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 ReplicatedCache 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 ReplicatedCache 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 ReplicatedCache evictionComponent(EvictionComponent value)
```
    The cache eviction configuration.
  - expirationComponent
```
public ExpirationComponent expirationComponent()
```
    The cache expiration configuration.
  - expirationComponent
```
public ReplicatedCache expirationComponent(ExpirationComponent value)
```
    The cache expiration configuration.
  - customStore
```
public CustomStore customStore()
```
    The cache store configuration.
  - customStore
```
public ReplicatedCache customStore(CustomStore value)
```
    The cache store configuration.
  - noneStore
```
public NoneStore noneStore()
```
    A store-less configuration.
  - noneStore
```
public ReplicatedCache 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 ReplicatedCache 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 ReplicatedCache transactionComponent(TransactionComponent value)
```
    The cache transaction configuration.
  - binaryJdbcStore
```
public BinaryJDBCStore binaryJdbcStore()
```
    The cache JDBC store configuration.
  - binaryJdbcStore
```
public ReplicatedCache binaryJdbcStore(BinaryJDBCStore value)
```
    The cache JDBC store configuration.
  - stringJdbcStore
```
public StringJDBCStore stringJdbcStore()
```
    The cache JDBC store configuration.
  - stringJdbcStore
```
public ReplicatedCache stringJdbcStore(StringJDBCStore value)
```
    The cache JDBC store configuration.
  - fileStore
```
public FileStore fileStore()
```
    The cache file store configuration.
  - fileStore
```
public ReplicatedCache fileStore(FileStore value)
```
    The cache file store configuration.
  - stateTransferComponent
```
public StateTransferComponent stateTransferComponent()
```
    The state transfer configuration for distributed and replicated caches.
  - stateTransferComponent
```
public ReplicatedCache 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 ReplicatedCache partitionHandlingComponent(PartitionHandlingComponent value)
```
    The partition handling configuration for distributed and replicated caches.
  - lockingComponent
```
public LockingComponent lockingComponent()
```
    The locking configuration of the cache.
  - lockingComponent
```
public ReplicatedCache lockingComponent(LockingComponent value)
```
    The locking configuration of the cache.
  - backupsComponent
```
public BackupsComponent backupsComponent()
```
    The remote backups for this cache.
  - backupsComponent
```
public ReplicatedCache backupsComponent(BackupsComponent value)
```
    The remote backups for this cache.
  - mixedJdbcStore
```
public MixedJDBCStore mixedJdbcStore()
```
    The cache JDBC store configuration.
  - mixedJdbcStore
```
public ReplicatedCache mixedJdbcStore(MixedJDBCStore value)
```
    The cache JDBC store configuration.
  - remoteStore
```
public RemoteStore remoteStore()
```
    The cache remote store configuration.
  - remoteStore
```
public ReplicatedCache remoteStore(RemoteStore value)
```
    The cache remote store configuration.

Class ReplicatedCache<T extends ReplicatedCache>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReplicatedCache

Method Detail

getKey

activations

activations

averageReadTime

averageReadTime

averageReplicationTime

averageReplicationTime

averageWriteTime

averageWriteTime

cacheStatus

cacheStatus

elapsedTime

elapsedTime

hitRatio

hitRatio

hits

hits

invalidations

invalidations

jndiName

jndiName

misses

misses

mode

mode

module

module

numberOfEntries

numberOfEntries

passivations

passivations

queueFlushInterval

queueFlushInterval

queueSize

queueSize

readWriteRatio

readWriteRatio

remoteTimeout

remoteTimeout

removeHits

removeHits

removeMisses

removeMisses

replicationCount

replicationCount

replicationFailures

replicationFailures

statisticsEnabled

statisticsEnabled

stores

stores

successRatio

successRatio

timeSinceReset

timeSinceReset

evictionComponent

evictionComponent

expirationComponent

expirationComponent

customStore

customStore

noneStore

noneStore

backupForComponent

backupForComponent

transactionComponent

transactionComponent

binaryJdbcStore

binaryJdbcStore

stringJdbcStore

stringJdbcStore

fileStore

fileStore