CustomStore (api 0.3.4 API)

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

```
public class CustomStore
extends Object
```
The cache store configuration.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class CustomStore.CustomStoreResources
Child mutators for CustomStore

Nested Classes
Modifier and Type	Class and Description
`class`	`CustomStore.CustomStoreResources` Child mutators for CustomStore

Constructor Summary

Constructors
Constructor and Description

CustomStore()

Constructors
Constructor and Description
`CustomStore()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`attributeClass()` The custom store implementation class to use for this cache store.
`CustomStore`	`attributeClass(String value)` The custom store implementation class to use for this cache store.
`BehindWrite`	`behindWrite()` Configures a cache store as write-behind instead of write-through.
`CustomStore`	`behindWrite(BehindWrite value)` Configures a cache store as write-behind instead of write-through.
`Long`	`cacheLoaderLoads()` The number of cache loader node loads.
`CustomStore`	`cacheLoaderLoads(Long value)` The number of cache loader node loads.
`Long`	`cacheLoaderMisses()` The number of cache loader node misses.
`CustomStore`	`cacheLoaderMisses(Long value)` The number of cache loader node misses.
`Boolean`	`fetchState()` If true, fetch persistent state when joining a cluster.
`CustomStore`	`fetchState(Boolean value)` If true, fetch persistent state when joining a cluster.
`String`	`getKey()`
`Boolean`	`passivation()` If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'.
`CustomStore`	`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.
`CustomStore`	`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.
`CustomStore`	`properties(Map value)` A list of cache store properties.
`CustomStore`	`property(Property value)` Add the org.wildfly.swarm.config.infinispan.cache_container.Property object to the list of subresources
`CustomStore`	`propertys(List<Property> value)` Add all org.wildfly.swarm.config.infinispan.cache_container.Property objects to this subresource
`Boolean`	`purge()` If true, purges this cache store when it starts up.
`CustomStore`	`purge(Boolean value)` If true, purges this cache store when it starts up.
`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.
`CustomStore`	`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.
`CustomStore`	`singleton(Boolean value)` If true, the singleton store cache store is enabled.
`CustomStore.CustomStoreResources`	`subresources()`
`ThroughWrite`	`throughWrite()` Configures a cache store as write-through.
`CustomStore`	`throughWrite(ThroughWrite value)` 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
  - CustomStore
```
public CustomStore()
```
- Method Detail
  - getKey
```
public String getKey()
```
  - cacheLoaderLoads
```
public Long cacheLoaderLoads()
```
    The number of cache loader node loads. May return null if the cache is not started.
  - cacheLoaderLoads
```
public CustomStore 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 CustomStore cacheLoaderMisses(Long value)
```
    The number of cache loader node misses. May return null if the cache is not started.
  - attributeClass
```
public String attributeClass()
```
    The custom store implementation class to use for this cache store.
  - attributeClass
```
public CustomStore attributeClass(String value)
```
    The custom store implementation class to use for this cache store.
  - 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 CustomStore 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.
  - 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. 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.
  - passivation
```
public CustomStore 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. 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
```
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 CustomStore 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 CustomStore properties(Map value)
```
    A list of cache store properties.
  - purge
```
public Boolean purge()
```
    If true, purges this cache store when it starts up.
  - purge
```
public CustomStore purge(Boolean value)
```
    If true, purges this cache store when it starts up.
  - 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 CustomStore 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 CustomStore 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.
  - subresources
```
public CustomStore.CustomStoreResources subresources()
```
  - propertys
```
public CustomStore propertys(List<Property> value)
```
    Add all org.wildfly.swarm.config.infinispan.cache_container.Property objects to this subresource
    
    Parameters:
    
    value - List of org.wildfly.swarm.config.infinispan.cache_container.Property objects.
    
    Returns:
    
    this
  - property
```
public CustomStore property(Property value)
```
    Add the org.wildfly.swarm.config.infinispan.cache_container.Property object to the list of subresources
    
    Parameters:
    
    value - The org.wildfly.swarm.config.infinispan.cache_container.Property to add
    
    Returns:
    
    this
  - throughWrite
```
public ThroughWrite throughWrite()
```
    Configures a cache store as write-through.
  - throughWrite
```
public CustomStore throughWrite(ThroughWrite value)
```
    Configures a cache store as write-through.
  - behindWrite
```
public BehindWrite behindWrite()
```
    Configures a cache store as write-behind instead of write-through.
  - behindWrite
```
public CustomStore behindWrite(BehindWrite value)
```
    Configures a cache store as write-behind instead of write-through.

Class CustomStore

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CustomStore

Method Detail

getKey

cacheLoaderLoads

cacheLoaderLoads

cacheLoaderMisses

cacheLoaderMisses

attributeClass

attributeClass

fetchState

fetchState

passivation

passivation

preload

preload

properties

properties

purge

purge

shared

shared

singleton

singleton

subresources

propertys

property

throughWrite

throughWrite

behindWrite

behindWrite