LoadersConfigurationBuilder (Infinispan Distribution 5.2.23.Final API)

java.lang.Object
- org.infinispan.configuration.cache.LoadersConfigurationBuilder

All Implemented Interfaces:

Builder<LoadersConfiguration>, ConfigurationChildBuilder
```
public class LoadersConfigurationBuilder
extends Object
implements Builder<LoadersConfiguration>
```
Configuration for cache loaders and stores.

Constructor Summary

Constructors
Modifier Constructor and Description

protected LoadersConfigurationBuilder(ConfigurationBuilder builder)

Constructors
Modifier	Constructor and Description
`protected`	`LoadersConfigurationBuilder(ConfigurationBuilder builder)`

Method Summary

Methods
Modifier and Type	Method and Description
`LoaderConfigurationBuilder`	`addCacheLoader()` Deprecated.
`ClusterCacheLoaderConfigurationBuilder`	`addClusterCacheLoader()` Adds a cluster cache loader
`FileCacheStoreConfigurationBuilder`	`addFileCacheStore()` Adds a file cache store
`LegacyLoaderConfigurationBuilder`	`addLoader()` Adds a cache loader to the configuration.
`CacheLoaderConfigurationBuilder<?,?>`	`addLoader(CacheLoaderConfigurationBuilder<?,?> builder)` Adds a cache loader which uses the specified builder instance to build its configuration
`<T extends CacheLoaderConfigurationBuilder<?,?>> T`	`addLoader(Class<T> klass)` Adds a cache loader which uses the specified builder class to build its configuration
`LegacyStoreConfigurationBuilder`	`addStore()` Adds a cache store to the configuration.
`CacheLoaderConfigurationBuilder<?,?>`	`addStore(CacheStoreConfigurationBuilder<?,?> builder)` Adds a cache store which uses the specified builder instance to build its configuration
`<T extends CacheStoreConfigurationBuilder<?,?>> T`	`addStore(Class<T> klass)` Adds a cache store which uses the specified builder class to build its configuration
`Configuration`	`build()`
`LoadersConfigurationBuilder`	`clearCacheLoaders()` Removes any configured cache loaders and stores from this builder
`ClusteringConfigurationBuilder`	`clustering()`
`LoadersConfiguration`	`create()` Create the configuration bean
`CustomInterceptorsConfigurationBuilder`	`customInterceptors()`
`DataContainerConfigurationBuilder`	`dataContainer()`
`DeadlockDetectionConfigurationBuilder`	`deadlockDetection()`
`EvictionConfigurationBuilder`	`eviction()`
`ExpirationConfigurationBuilder`	`expiration()`
`protected ConfigurationBuilder`	`getBuilder()`
`IndexingConfigurationBuilder`	`indexing()`
`InvocationBatchingConfigurationBuilder`	`invocationBatching()`
`JMXStatisticsConfigurationBuilder`	`jmxStatistics()`
`LoadersConfigurationBuilder`	`loaders()`
`LockingConfigurationBuilder`	`locking()`
`LoadersConfigurationBuilder`	`passivation(boolean b)`
`LoadersConfigurationBuilder`	`preload(boolean b)` If true, when the cache starts, data stored in the cache store will be pre-loaded into memory.
`LoadersConfigurationBuilder`	`read(LoadersConfiguration template)` Reads the configuration from an already created configuration bean into this builder.
`LoadersConfigurationBuilder`	`shared(boolean b)` 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.
`SitesConfigurationBuilder`	`sites()`
`StoreAsBinaryConfigurationBuilder`	`storeAsBinary()`
`String`	`toString()`
`TransactionConfigurationBuilder`	`transaction()`
`UnsafeConfigurationBuilder`	`unsafe()`
`void`	`validate()` Validate the data in this builder before building the configuration bean
`VersioningConfigurationBuilder`	`versioning()`

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

- Constructor Detail
  - LoadersConfigurationBuilder
```
protected LoadersConfigurationBuilder(ConfigurationBuilder builder)
```
- Method Detail
  - passivation
```
public LoadersConfigurationBuilder passivation(boolean b)
```
  - preload
```
public LoadersConfigurationBuilder preload(boolean b)
```
    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.
  - shared
```
public LoadersConfigurationBuilder shared(boolean b)
```
    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. Note that this could be useful if each individual node has its own cache store - perhaps local on-disk.
  - addCacheLoader
```
@Deprecated
public LoaderConfigurationBuilder addCacheLoader()
```
    Deprecated.
  - addLoader
```
public LegacyLoaderConfigurationBuilder addLoader()
```
    Adds a cache loader to the configuration. If possible use the alternate addLoader(CacheLoaderConfigurationBuilder) and addLoader(Class) which will return appropriately typed builders
    
    Returns:
  - addLoader
```
public <T extends CacheLoaderConfigurationBuilder<?,?>> T addLoader(Class<T> klass)
```
    Adds a cache loader which uses the specified builder class to build its configuration
    
    Parameters:
    klass -
    
    Returns:
  - addLoader
```
public CacheLoaderConfigurationBuilder<?,?> addLoader(CacheLoaderConfigurationBuilder<?,?> builder)
```
    Adds a cache loader which uses the specified builder instance to build its configuration
    
    Parameters:
    builder - an instance of CacheLoaderConfigurationBuilder
    
    Returns:
  - addStore
```
public LegacyStoreConfigurationBuilder addStore()
```
    Adds a cache store to the configuration. If possible use the alternate addStore(CacheStoreConfigurationBuilder) and addStore(Class) which will return appropriately typed builders
    
    Returns:
  - addStore
```
public <T extends CacheStoreConfigurationBuilder<?,?>> T addStore(Class<T> klass)
```
    Adds a cache store which uses the specified builder class to build its configuration
    
    Parameters:
    klass -
    
    Returns:
  - addStore
```
public CacheLoaderConfigurationBuilder<?,?> addStore(CacheStoreConfigurationBuilder<?,?> builder)
```
    Adds a cache store which uses the specified builder instance to build its configuration
    
    Parameters:
    builder - an instance of CacheStoreConfigurationBuilder
  - addClusterCacheLoader
```
public ClusterCacheLoaderConfigurationBuilder addClusterCacheLoader()
```
    Adds a cluster cache loader
  - addFileCacheStore
```
public FileCacheStoreConfigurationBuilder addFileCacheStore()
```
    Adds a file cache store
  - clearCacheLoaders
```
public LoadersConfigurationBuilder clearCacheLoaders()
```
    Removes any configured cache loaders and stores from this builder
  - validate
```
public void validate()
```
    Description copied from interface: Builder
    
    Validate the data in this builder before building the configuration bean
    
    Specified by:
    
    validate in interface Builder<LoadersConfiguration>
  - create
```
public LoadersConfiguration create()
```
    Description copied from interface: Builder
    
    Create the configuration bean
    
    Specified by:
    
    create in interface Builder<LoadersConfiguration>
    
    Returns:
  - read
```
public LoadersConfigurationBuilder read(LoadersConfiguration template)
```
    Description copied from interface: Builder
    
    Reads the configuration from an already created configuration bean into this builder. Returns an appropriate builder to allow fluent configuration
    
    Specified by:
    
    read in interface Builder<LoadersConfiguration>
    
    Parameters:
    template - the configuration from which to "clone" this config if needed.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - clustering
```
public ClusteringConfigurationBuilder clustering()
```
    Specified by:
    
    clustering in interface ConfigurationChildBuilder
  - customInterceptors
```
public CustomInterceptorsConfigurationBuilder customInterceptors()
```
    Specified by:
    
    customInterceptors in interface ConfigurationChildBuilder
  - dataContainer
```
public DataContainerConfigurationBuilder dataContainer()
```
    Specified by:
    
    dataContainer in interface ConfigurationChildBuilder
  - deadlockDetection
```
public DeadlockDetectionConfigurationBuilder deadlockDetection()
```
    Specified by:
    
    deadlockDetection in interface ConfigurationChildBuilder
  - eviction
```
public EvictionConfigurationBuilder eviction()
```
    Specified by:
    
    eviction in interface ConfigurationChildBuilder
  - expiration
```
public ExpirationConfigurationBuilder expiration()
```
    Specified by:
    
    expiration in interface ConfigurationChildBuilder
  - indexing
```
public IndexingConfigurationBuilder indexing()
```
    Specified by:
    
    indexing in interface ConfigurationChildBuilder
  - invocationBatching
```
public InvocationBatchingConfigurationBuilder invocationBatching()
```
    Specified by:
    
    invocationBatching in interface ConfigurationChildBuilder
  - jmxStatistics
```
public JMXStatisticsConfigurationBuilder jmxStatistics()
```
    Specified by:
    
    jmxStatistics in interface ConfigurationChildBuilder
  - loaders
```
public LoadersConfigurationBuilder loaders()
```
    Specified by:
    
    loaders in interface ConfigurationChildBuilder
  - locking
```
public LockingConfigurationBuilder locking()
```
    Specified by:
    
    locking in interface ConfigurationChildBuilder
  - storeAsBinary
```
public StoreAsBinaryConfigurationBuilder storeAsBinary()
```
    Specified by:
    
    storeAsBinary in interface ConfigurationChildBuilder
  - transaction
```
public TransactionConfigurationBuilder transaction()
```
    Specified by:
    
    transaction in interface ConfigurationChildBuilder
  - versioning
```
public VersioningConfigurationBuilder versioning()
```
    Specified by:
    
    versioning in interface ConfigurationChildBuilder
  - unsafe
```
public UnsafeConfigurationBuilder unsafe()
```
    Specified by:
    
    unsafe in interface ConfigurationChildBuilder
  - sites
```
public SitesConfigurationBuilder sites()
```
    Specified by:
    
    sites in interface ConfigurationChildBuilder
  - getBuilder
```
protected ConfigurationBuilder getBuilder()
```
  - build
```
public Configuration build()
```
    Specified by:
    
    build in interface ConfigurationChildBuilder

Class LoadersConfigurationBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LoadersConfigurationBuilder

Method Detail

passivation

preload

shared

addCacheLoader

addLoader

addLoader

addLoader

addStore

addStore

addStore

addClusterCacheLoader

addFileCacheStore

clearCacheLoaders

validate

create

read

toString

clustering

customInterceptors

dataContainer

deadlockDetection

eviction

expiration

indexing

invocationBatching

jmxStatistics

loaders

locking

storeAsBinary

transaction

versioning

unsafe

sites

getBuilder

build