RemoteStore (BOM: * : All 2.3.0.Final API)

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

public class RemoteStore<T extends RemoteStore<T>>
extends Object

The cache remote store configuration.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RemoteStore.RemoteStoreResources
Child mutators for RemoteStore

Nested Classes
Modifier and Type	Class and Description
`static class`	`RemoteStore.RemoteStoreResources` Child mutators for RemoteStore

Constructor Summary

Constructors
Constructor and Description

RemoteStore()

Constructors
Constructor and Description
`RemoteStore()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(PropertyChangeListener listener)` Adds a property change listener
`T`	`behindWrite()` Configures a cache store as write-behind instead of write-through.
`T`	`behindWrite(BehindWrite value)` Configures a cache store as write-behind instead of write-through.
`T`	`behindWrite(BehindWriteConsumer consumer)` Configures a cache store as write-behind instead of write-through.
`T`	`behindWrite(BehindWriteSupplier supplier)` Configures a cache store as write-behind instead of write-through.
`String`	`cache()` The name of the remote cache to use for this remote store.
`T`	`cache(String value)` The name of the remote cache to use for this remote store.
`Long`	`cacheLoaderLoads()` The number of cache loader node loads.
`T`	`cacheLoaderLoads(Long value)` The number of cache loader node loads.
`Long`	`cacheLoaderMisses()` The number of cache loader node misses.
`T`	`cacheLoaderMisses(Long value)` The number of cache loader node misses.
`Boolean`	`fetchState()` If true, fetch persistent state when joining a cluster.
`T`	`fetchState(Boolean value)` If true, fetch persistent state when joining a cluster.
`String`	`getKey()`
`Integer`	`maxBatchSize()` The maximum size of a batch to be inserted/deleted from the store.
`T`	`maxBatchSize(Integer value)` The maximum size of a batch to be inserted/deleted from the store.
`Boolean`	`passivation()` If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'.
`T`	`passivation(Boolean value)` If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'.
`Boolean`	`preload()` If true, when the cache starts, data stored in the cache store will be pre-loaded into memory.
`T`	`preload(Boolean value)` If true, when the cache starts, data stored in the cache store will be pre-loaded into memory.
`Map`	`properties()` A list of cache store properties.
`T`	`properties(List<Property> value)` Add all Property objects to this subresource
`T`	`properties(Map value)` A list of cache store properties.
`T`	`property(Property value)` Add the Property object to the list of subresources
`T`	`property(PropertySupplier supplier)` Install a supplied Property object to the list of subresources
`T`	`property(String childKey)` Create and configure a Property object to the list of subresources
`T`	`property(String key, Object value)` A list of cache store properties.
`T`	`property(String childKey, PropertyConsumer consumer)` Create and configure a Property object to the list of subresources
`Boolean`	`purge()` If true, purges this cache store when it starts up.
`T`	`purge(Boolean value)` If true, purges this cache store when it starts up.
`T`	`remoteServer(String value)` A list of remote servers for this cache store.
`List<String>`	`remoteServers()` A list of remote servers for this cache store.
`T`	`remoteServers(List<String> value)` A list of remote servers for this cache store.
`T`	`remoteServers(String... args)` A list of remote servers for this cache store.
`void`	`removePropertyChangeListener(PropertyChangeListener listener)` Removes a property change listener
`Boolean`	`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.
`T`	`shared(Boolean value)` 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.
`Boolean`	`singleton()` If true, the singleton store cache store is enabled.
`T`	`singleton(Boolean value)` If true, the singleton store cache store is enabled.
`Long`	`socketTimeout()` A socket timeout for remote cache communication.
`T`	`socketTimeout(Long value)` A socket timeout for remote cache communication.
`RemoteStore.RemoteStoreResources`	`subresources()`
`Boolean`	`tcpNoDelay()` A TCP_NODELAY value for remote cache communication.
`T`	`tcpNoDelay(Boolean value)` A TCP_NODELAY value for remote cache communication.
`T`	`throughWrite()` Configures a cache store as write-through.
`T`	`throughWrite(ThroughWrite value)` Configures a cache store as write-through.
`T`	`throughWrite(ThroughWriteConsumer consumer)` Configures a cache store as write-through.
`T`	`throughWrite(ThroughWriteSupplier supplier)` Configures a cache store as write-through.

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

- Constructor Detail
  - RemoteStore
```
public RemoteStore()
```
- Method Detail
  - getKey
```
public String getKey()
```
  - addPropertyChangeListener
```
public void addPropertyChangeListener(PropertyChangeListener listener)
```
    Adds a property change listener
  - removePropertyChangeListener
```
public void removePropertyChangeListener(PropertyChangeListener listener)
```
    Removes a property change listener
  - subresources
```
public RemoteStore.RemoteStoreResources subresources()
```
  - properties
```
public T properties(List<Property> value)
```
    Add all Property objects to this subresource
    
    Parameters:
    
    value - List of Property objects.
    
    Returns:
    
    this
  - property
```
public T property(Property value)
```
    Add the Property object to the list of subresources
    
    Parameters:
    
    value - The Property to add
    
    Returns:
    
    this
  - property
```
public T property(String childKey,
                  PropertyConsumer consumer)
```
    Create and configure a Property object to the list of subresources
    
    Parameters:
    
    key - The key for the Property resource
    
    config - The PropertyConsumer to use
    
    Returns:
    
    this
  - property
```
public T property(String childKey)
```
    Create and configure a Property object to the list of subresources
    
    Parameters:
    
    key - The key for the Property resource
    
    Returns:
    
    this
  - property
```
public T property(PropertySupplier supplier)
```
    Install a supplied Property object to the list of subresources
  - throughWrite
```
public T throughWrite(ThroughWrite value)
```
    Configures a cache store as write-through.
  - throughWrite
```
public T throughWrite(ThroughWriteConsumer consumer)
```
    Configures a cache store as write-through.
  - throughWrite
```
public T throughWrite()
```
    Configures a cache store as write-through.
  - throughWrite
```
public T throughWrite(ThroughWriteSupplier supplier)
```
    Configures a cache store as write-through.
  - behindWrite
```
public T behindWrite(BehindWrite value)
```
    Configures a cache store as write-behind instead of write-through.
  - behindWrite
```
public T behindWrite(BehindWriteConsumer consumer)
```
    Configures a cache store as write-behind instead of write-through.
  - behindWrite
```
public T behindWrite()
```
    Configures a cache store as write-behind instead of write-through.
  - behindWrite
```
public T behindWrite(BehindWriteSupplier supplier)
```
    Configures a cache store as write-behind instead of write-through.
  - cache
```
public String cache()
```
    The name of the remote cache to use for this remote store.
  - cache
```
public T cache(String value)
```
    The name of the remote cache to use for this remote store.
  - cacheLoaderLoads
```
public Long cacheLoaderLoads()
```
    The number of cache loader node loads. May return null if the cache is not started.
  - cacheLoaderLoads
```
public T cacheLoaderLoads(Long value)
```
    The number of cache loader node loads. May return null if the cache is not started.
  - cacheLoaderMisses
```
public Long cacheLoaderMisses()
```
    The number of cache loader node misses. May return null if the cache is not started.
  - cacheLoaderMisses
```
public T cacheLoaderMisses(Long value)
```
    The number of cache loader node misses. May return null if the cache is not started.
  - fetchState
```
public Boolean fetchState()
```
    If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.
  - fetchState
```
public T fetchState(Boolean value)
```
    If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.
  - maxBatchSize
```
public Integer maxBatchSize()
```
    The maximum size of a batch to be inserted/deleted from the store. If the value is less than one, then no upper limit is placed on the number of operations in a batch.
  - maxBatchSize
```
public T maxBatchSize(Integer value)
```
    The maximum size of a batch to be inserted/deleted from the store. If the value is less than one, then no upper limit is placed on the number of operations in a batch.
  - passivation
```
public Boolean 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. If 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.
  - passivation
```
public T passivation(Boolean value)
```
    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. If 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
```
public Boolean 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.
  - preload
```
public T preload(Boolean value)
```
    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.
  - properties
```
public Map properties()
```
    A list of cache store properties.
  - properties
```
public T properties(Map value)
```
    A list of cache store properties.
  - property
```
public T property(String key,
                  Object value)
```
    A list of cache store properties.
  - purge
```
public Boolean purge()
```
    If true, purges this cache store when it starts up.
  - purge
```
public T purge(Boolean value)
```
    If true, purges this cache store when it starts up.
  - remoteServers
```
public List<String> remoteServers()
```
    A list of remote servers for this cache store.
  - remoteServers
```
public T remoteServers(List<String> value)
```
    A list of remote servers for this cache store.
  - remoteServer
```
public T remoteServer(String value)
```
    A list of remote servers for this cache store.
  - remoteServers
```
public T remoteServers(String... args)
```
    A list of remote servers for this cache store.
  - shared
```
public Boolean 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.
  - shared
```
public T shared(Boolean value)
```
    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
```
public Boolean 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.
  - singleton
```
public T singleton(Boolean value)
```
    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.
  - socketTimeout
```
public Long socketTimeout()
```
    A socket timeout for remote cache communication.
  - socketTimeout
```
public T socketTimeout(Long value)
```
    A socket timeout for remote cache communication.
  - tcpNoDelay
```
public Boolean tcpNoDelay()
```
    A TCP_NODELAY value for remote cache communication.
  - tcpNoDelay
```
public T tcpNoDelay(Boolean value)
```
    A TCP_NODELAY value for remote cache communication.

Class RemoteStore<T extends RemoteStore<T>>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RemoteStore

Method Detail

getKey

addPropertyChangeListener

removePropertyChangeListener

subresources

properties

property

property

property

property

throughWrite

throughWrite

throughWrite

throughWrite

behindWrite

behindWrite

behindWrite

behindWrite

cache

cache

cacheLoaderLoads

cacheLoaderLoads

cacheLoaderMisses

cacheLoaderMisses

fetchState

fetchState

maxBatchSize

maxBatchSize

passivation

passivation

preload

preload

properties

properties

property

purge

purge

remoteServers

remoteServers

remoteServer

remoteServers

shared

shared

singleton

singleton

socketTimeout

socketTimeout

tcpNoDelay

tcpNoDelay