public class DistributedCache<T extends DistributedCache<T>> extends Object
Modifier and Type | Class and Description |
---|---|
static class |
DistributedCache.ConsistentHashStrategy |
static class |
DistributedCache.DistributedCacheResources
Child mutators for DistributedCache
|
Constructor and Description |
---|
DistributedCache(String key) |
Modifier and Type | Method and Description |
---|---|
Long |
activations()
The number of cache node activations (bringing a node into memory from a
cache store) .
|
T |
activations(Long value)
The number of cache node activations (bringing a node into memory from a
cache store) .
|
void |
addPropertyChangeListener(PropertyChangeListener listener)
Adds a property change listener
|
Boolean |
asyncMarshalling()
If enabled, this will cause marshalling of entries to be performed
asynchronously.
|
T |
asyncMarshalling(Boolean value)
If enabled, this will cause marshalling of entries to be performed
asynchronously.
|
Long |
averageReadTime()
Average time (in ms) for cache reads.
|
T |
averageReadTime(Long value)
Average time (in ms) for cache reads.
|
Long |
averageReplicationTime()
The average time taken to replicate data around the cluster.
|
T |
averageReplicationTime(Long value)
The average time taken to replicate data around the cluster.
|
Long |
averageWriteTime()
Average time (in ms) for cache writes.
|
T |
averageWriteTime(Long value)
Average time (in ms) for cache writes.
|
T |
backupForComponent()
A cache for which this cache acts as a backup (for use with cross site
replication).
|
T |
backupForComponent(BackupForComponent value)
A cache for which this cache acts as a backup (for use with cross site
replication).
|
T |
backupForComponent(BackupForComponentConsumer consumer)
A cache for which this cache acts as a backup (for use with cross site
replication).
|
T |
backupForComponent(BackupForComponentSupplier supplier)
A cache for which this cache acts as a backup (for use with cross site
replication).
|
T |
backupsComponent()
The remote backups for this cache.
|
T |
backupsComponent(BackupsComponent value)
The remote backups for this cache.
|
T |
backupsComponent(BackupsComponentConsumer consumer)
The remote backups for this cache.
|
T |
backupsComponent(BackupsComponentSupplier supplier)
The remote backups for this cache.
|
T |
binaryJdbcStore()
The cache JDBC store configuration.
|
T |
binaryJdbcStore(BinaryJDBCStore value)
The cache JDBC store configuration.
|
T |
binaryJdbcStore(BinaryJDBCStoreConsumer consumer)
The cache JDBC store configuration.
|
T |
binaryJdbcStore(BinaryJDBCStoreSupplier supplier)
The cache JDBC store configuration.
|
String |
cacheStatus()
The status of the cache component.
|
T |
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.
|
T |
capacityFactor(Double value)
Controls the proportion of entries that will reside on the local node,
compared to the other nodes in the cluster.
|
DistributedCache.ConsistentHashStrategy |
consistentHashStrategy()
Defines the consistent hash strategy for the cache.
|
T |
consistentHashStrategy(DistributedCache.ConsistentHashStrategy value)
Defines the consistent hash strategy for the cache.
|
T |
customStore()
The cache store configuration.
|
T |
customStore(CustomStore value)
The cache store configuration.
|
T |
customStore(CustomStoreConsumer consumer)
The cache store configuration.
|
T |
customStore(CustomStoreSupplier supplier)
The cache store configuration.
|
Long |
elapsedTime()
Time (in secs) since cache started.
|
T |
elapsedTime(Long value)
Time (in secs) since cache started.
|
T |
evictionComponent()
The cache eviction configuration.
|
T |
evictionComponent(EvictionComponent value)
The cache eviction configuration.
|
T |
evictionComponent(EvictionComponentConsumer consumer)
The cache eviction configuration.
|
T |
evictionComponent(EvictionComponentSupplier supplier)
The cache eviction configuration.
|
T |
expirationComponent()
The cache expiration configuration.
|
T |
expirationComponent(ExpirationComponent value)
The cache expiration configuration.
|
T |
expirationComponent(ExpirationComponentConsumer consumer)
The cache expiration configuration.
|
T |
expirationComponent(ExpirationComponentSupplier supplier)
The cache expiration configuration.
|
T |
fileStore()
The cache file store configuration.
|
T |
fileStore(FileStore value)
The cache file store configuration.
|
T |
fileStore(FileStoreConsumer consumer)
The cache file store configuration.
|
T |
fileStore(FileStoreSupplier supplier)
The cache file store configuration.
|
String |
getKey() |
Double |
hitRatio()
The hit/miss ratio for the cache (hits/hits+misses).
|
T |
hitRatio(Double value)
The hit/miss ratio for the cache (hits/hits+misses).
|
Long |
hits()
The number of cache attribute hits.
|
T |
hits(Long value)
The number of cache attribute hits.
|
String |
indexing()
If enabled, entries will be indexed when they are added to the cache.
|
T |
indexing(String value)
If enabled, entries will be indexed when they are added to the cache.
|
Map |
indexingProperties()
Properties to control indexing behaviour
|
T |
indexingProperties(Map value)
Properties to control indexing behaviour
|
T |
indexingProperty(String key,
Object value)
Properties to control indexing behaviour
|
Long |
invalidations()
The number of cache invalidations.
|
T |
invalidations(Long value)
The number of cache invalidations.
|
T |
jdbcStore()
The cache JDBC store configuration.
|
T |
jdbcStore(JDBCStore value)
The cache JDBC store configuration.
|
T |
jdbcStore(JDBCStoreConsumer consumer)
The cache JDBC store configuration.
|
T |
jdbcStore(JDBCStoreSupplier supplier)
The cache JDBC store configuration.
|
String |
jndiName()
The jndi-name to which to bind this cache instance.
|
T |
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.
|
T |
l1Lifespan(Long value)
Maximum lifespan of an entry placed in the L1 cache.
|
T |
lockingComponent()
The locking configuration of the cache.
|
T |
lockingComponent(LockingComponent value)
The locking configuration of the cache.
|
T |
lockingComponent(LockingComponentConsumer consumer)
The locking configuration of the cache.
|
T |
lockingComponent(LockingComponentSupplier supplier)
The locking configuration of the cache.
|
Long |
misses()
The number of cache attribute misses.
|
T |
misses(Long value)
The number of cache attribute misses.
|
T |
mixedJdbcStore()
The cache JDBC store configuration.
|
T |
mixedJdbcStore(MixedJDBCStore value)
The cache JDBC store configuration.
|
T |
mixedJdbcStore(MixedJDBCStoreConsumer consumer)
The cache JDBC store configuration.
|
T |
mixedJdbcStore(MixedJDBCStoreSupplier supplier)
The cache JDBC store configuration.
|
Mode |
mode()
Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC
for synchronous operation.
|
T |
mode(Mode 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.
|
T |
module(String value)
The module whose class loader should be used when building this cache's
configuration.
|
T |
noneStore()
A store-less configuration.
|
T |
noneStore(NoneStore value)
A store-less configuration.
|
T |
noneStore(NoneStoreConsumer consumer)
A store-less configuration.
|
T |
noneStore(NoneStoreSupplier supplier)
A store-less configuration.
|
Integer |
numberOfEntries()
The current number of entries in the cache.
|
T |
numberOfEntries(Integer value)
The current number of entries in the cache.
|
Integer |
owners()
Number of cluster-wide replicas for each cache entry.
|
T |
owners(Integer value)
Number of cluster-wide replicas for each cache entry.
|
T |
partitionHandlingComponent()
The partition handling configuration for distributed and replicated
caches.
|
T |
partitionHandlingComponent(PartitionHandlingComponent value)
The partition handling configuration for distributed and replicated
caches.
|
T |
partitionHandlingComponent(PartitionHandlingComponentConsumer consumer)
The partition handling configuration for distributed and replicated
caches.
|
T |
partitionHandlingComponent(PartitionHandlingComponentSupplier supplier)
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).
|
T |
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.
|
T |
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.
|
T |
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).
|
T |
readWriteRatio(Double value)
The read/write ratio of the cache ((hits+misses)/stores).
|
T |
remoteStore()
The cache remote store configuration.
|
T |
remoteStore(RemoteStore value)
The cache remote store configuration.
|
T |
remoteStore(RemoteStoreConsumer consumer)
The cache remote store configuration.
|
T |
remoteStore(RemoteStoreSupplier supplier)
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.
|
T |
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.
|
T |
removeHits(Long value)
The number of cache attribute remove hits.
|
Long |
removeMisses()
The number of cache attribute remove misses.
|
T |
removeMisses(Long value)
The number of cache attribute remove misses.
|
void |
removePropertyChangeListener(PropertyChangeListener listener)
Removes a property change listener
|
Long |
replicationCount()
The number of times data was replicated around the cluster.
|
T |
replicationCount(Long value)
The number of times data was replicated around the cluster.
|
Long |
replicationFailures()
The number of data replication failures.
|
T |
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.
|
T |
segments(Integer value)
Controls the number of hash space segments which is the granularity for
key distribution in the cluster.
|
T |
stateTransferComponent()
The state transfer configuration for distributed and replicated caches.
|
T |
stateTransferComponent(StateTransferComponent value)
The state transfer configuration for distributed and replicated caches.
|
T |
stateTransferComponent(StateTransferComponentConsumer consumer)
The state transfer configuration for distributed and replicated caches.
|
T |
stateTransferComponent(StateTransferComponentSupplier supplier)
The state transfer configuration for distributed and replicated caches.
|
Boolean |
statisticsEnabled()
If enabled, statistics will be collected for this cache
|
T |
statisticsEnabled(Boolean value)
If enabled, statistics will be collected for this cache
|
Long |
stores()
The number of cache attribute put operations.
|
T |
stores(Long value)
The number of cache attribute put operations.
|
DistributedCache.DistributedCacheResources |
subresources() |
Double |
successRatio()
The data replication success ratio (successes/successes+failures).
|
T |
successRatio(Double value)
The data replication success ratio (successes/successes+failures).
|
Long |
timeSinceReset()
Time (in secs) since cache statistics were reset.
|
T |
timeSinceReset(Long value)
Time (in secs) since cache statistics were reset.
|
T |
transactionComponent()
The cache transaction configuration.
|
T |
transactionComponent(TransactionComponent value)
The cache transaction configuration.
|
T |
transactionComponent(TransactionComponentConsumer consumer)
The cache transaction configuration.
|
T |
transactionComponent(TransactionComponentSupplier supplier)
The cache transaction configuration.
|
public DistributedCache(String key)
public String getKey()
public void addPropertyChangeListener(PropertyChangeListener listener)
public void removePropertyChangeListener(PropertyChangeListener listener)
public DistributedCache.DistributedCacheResources subresources()
public T evictionComponent(EvictionComponent value)
public T evictionComponent(EvictionComponentConsumer consumer)
public T evictionComponent()
public T evictionComponent(EvictionComponentSupplier supplier)
public T expirationComponent(ExpirationComponent value)
public T expirationComponent(ExpirationComponentConsumer consumer)
public T expirationComponent()
public T expirationComponent(ExpirationComponentSupplier supplier)
public T customStore(CustomStore value)
public T customStore(CustomStoreConsumer consumer)
public T customStore()
public T customStore(CustomStoreSupplier supplier)
public T noneStore(NoneStoreConsumer consumer)
public T noneStore()
public T noneStore(NoneStoreSupplier supplier)
public T backupForComponent(BackupForComponent value)
public T backupForComponent(BackupForComponentConsumer consumer)
public T backupForComponent()
public T backupForComponent(BackupForComponentSupplier supplier)
public T transactionComponent(TransactionComponent value)
public T transactionComponent(TransactionComponentConsumer consumer)
public T transactionComponent()
public T transactionComponent(TransactionComponentSupplier supplier)
public T binaryJdbcStore(BinaryJDBCStore value)
public T binaryJdbcStore(BinaryJDBCStoreConsumer consumer)
public T binaryJdbcStore()
public T binaryJdbcStore(BinaryJDBCStoreSupplier supplier)
public T fileStore(FileStoreConsumer consumer)
public T fileStore()
public T fileStore(FileStoreSupplier supplier)
public T stateTransferComponent(StateTransferComponent value)
public T stateTransferComponent(StateTransferComponentConsumer consumer)
public T stateTransferComponent()
public T stateTransferComponent(StateTransferComponentSupplier supplier)
public T jdbcStore(JDBCStoreConsumer consumer)
public T jdbcStore()
public T jdbcStore(JDBCStoreSupplier supplier)
public T partitionHandlingComponent(PartitionHandlingComponent value)
public T partitionHandlingComponent(PartitionHandlingComponentConsumer consumer)
public T partitionHandlingComponent()
public T partitionHandlingComponent(PartitionHandlingComponentSupplier supplier)
public T lockingComponent(LockingComponent value)
public T lockingComponent(LockingComponentConsumer consumer)
public T lockingComponent()
public T lockingComponent(LockingComponentSupplier supplier)
public T backupsComponent(BackupsComponent value)
public T backupsComponent(BackupsComponentConsumer consumer)
public T backupsComponent()
public T backupsComponent(BackupsComponentSupplier supplier)
public T mixedJdbcStore(MixedJDBCStore value)
public T mixedJdbcStore(MixedJDBCStoreConsumer consumer)
public T mixedJdbcStore()
public T mixedJdbcStore(MixedJDBCStoreSupplier supplier)
public T remoteStore(RemoteStore value)
public T remoteStore(RemoteStoreConsumer consumer)
public T remoteStore()
public T remoteStore(RemoteStoreSupplier supplier)
public Long activations()
public T activations(Long value)
public Boolean asyncMarshalling()
public T asyncMarshalling(Boolean value)
public Long averageReadTime()
public T averageReadTime(Long value)
public Long averageReplicationTime()
public T averageReplicationTime(Long value)
public Long averageWriteTime()
public T averageWriteTime(Long value)
public String cacheStatus()
public T cacheStatus(String value)
public Double capacityFactor()
public T capacityFactor(Double value)
public DistributedCache.ConsistentHashStrategy consistentHashStrategy()
public T consistentHashStrategy(DistributedCache.ConsistentHashStrategy value)
public Long elapsedTime()
public T elapsedTime(Long value)
public Double hitRatio()
public T hitRatio(Double value)
public Long hits()
public T hits(Long value)
public String indexing()
public T indexing(String value)
public Map indexingProperties()
public T indexingProperty(String key, Object value)
public Long invalidations()
public T invalidations(Long value)
public String jndiName()
public Long l1Lifespan()
public T l1Lifespan(Long value)
public Long misses()
public T misses(Long value)
public Mode mode()
public T mode(Mode value)
public String module()
public T module(String value)
public Integer numberOfEntries()
public T numberOfEntries(Integer value)
public Integer owners()
public Long passivations()
public T passivations(Long value)
public Long queueFlushInterval()
public T queueFlushInterval(Long value)
public Integer queueSize()
public T queueSize(Integer value)
public Double readWriteRatio()
public T readWriteRatio(Double value)
public Long remoteTimeout()
public T remoteTimeout(Long value)
public Long removeHits()
public T removeHits(Long value)
public Long removeMisses()
public T removeMisses(Long value)
public Long replicationCount()
public T replicationCount(Long value)
public Long replicationFailures()
public T replicationFailures(Long value)
public Integer segments()
public T segments(Integer value)
public Boolean statisticsEnabled()
public T statisticsEnabled(Boolean value)
public Long stores()
public T stores(Long value)
public Double successRatio()
public T successRatio(Double value)
public Long timeSinceReset()
Copyright © 2018 JBoss by Red Hat. All rights reserved.