PersistenceConfigurationBuilder (Red Hat JBoss Enterprise Application Platform 7.4.0.GA public API)

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

All Implemented Interfaces:

BaseConfigurationInfo, Builder<PersistenceConfiguration>, ConfigurationBuilderInfo, ConfigurationChildBuilder
```
public class PersistenceConfigurationBuilder
extends Object
implements Builder<PersistenceConfiguration>, ConfigurationBuilderInfo
```
Configuration for cache stores.

Field Summary

Fields
Modifier and Type Field and Description

protected ConfigurationBuilder builder

Fields
Modifier and Type	Field and Description
`protected ConfigurationBuilder`	`builder`

Constructor Summary

Constructors
Modifier Constructor and Description

protected PersistenceConfigurationBuilder(ConfigurationBuilder builder)

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

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ClusterLoaderConfigurationBuilder`	`addClusterLoader()` Deprecated. since 11.0. To be removed in 14.0 ISPN-11864 with no direct replacement.
`SingleFileStoreConfigurationBuilder`	`addSingleFileStore()` Adds a single file cache store.
`<T extends StoreConfigurationBuilder<?,?>> T`	`addStore(Class<T> klass)` Adds a cache loader that uses the specified builder class to build its configuration.
`StoreConfigurationBuilder<?,?>`	`addStore(StoreConfigurationBuilder<?,?> builder)` Adds a cache loader that uses the specified builder instance to build its configuration.
`AttributeSet`	`attributes()`
`PersistenceConfigurationBuilder`	`availabilityInterval(int interval)`
`Configuration`	`build()`
`PersistenceConfigurationBuilder`	`clearStores()` Removes any configured stores from this builder.
`ClusteringConfigurationBuilder`	`clustering()`
`PersistenceConfigurationBuilder`	`connectionAttempts(int attempts)`
`PersistenceConfigurationBuilder`	`connectionInterval(int interval)`
`PersistenceConfiguration`	`create()` Create the configuration bean
`CustomInterceptorsConfigurationBuilder`	`customInterceptors()` Deprecated. Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors
`EncodingConfigurationBuilder`	`encoding()`
`ExpirationConfigurationBuilder`	`expiration()`
`protected ConfigurationBuilder`	`getBuilder()`
`StoreConfigurationBuilder`	`getBuilderFromName(String name)`
`ConfigurationBuilderInfo`	`getBuilderInfo(String name, String qualifier)`
`ElementDefinition`	`getElementDefinition()`
`ConfigurationBuilderInfo`	`getNewBuilderInfo(String name)`
`IndexingConfigurationBuilder`	`indexing()`
`InvocationBatchingConfigurationBuilder`	`invocationBatching()`
`LockingConfigurationBuilder`	`locking()`
`MemoryConfigurationBuilder`	`memory()`
`PersistenceConfigurationBuilder`	`passivation(boolean b)`
`PersistenceConfigurationBuilder`	`persistence()`
`PersistenceConfigurationBuilder`	`read(PersistenceConfiguration template)` Reads the configuration from an already created configuration bean into this builder.
`SecurityConfigurationBuilder`	`security()`
`boolean`	`simpleCache()`
`ConfigurationChildBuilder`	`simpleCache(boolean simpleCache)`
`SitesConfigurationBuilder`	`sites()`
`StatisticsConfigurationBuilder`	`statistics()`
`List<StoreConfigurationBuilder<?,?>>`	`stores()`
`ConfigurationChildBuilder`	`template(boolean template)`
`String`	`toString()`
`TransactionConfigurationBuilder`	`transaction()`
`UnsafeConfigurationBuilder`	`unsafe()`
`void`	`validate()` Validate the data in this builder before building the configuration bean
`void`	`validate(GlobalConfiguration globalConfig)`

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

Methods inherited from interface org.infinispan.commons.configuration.ConfigurationBuilderInfo
getChildrenInfo

Methods inherited from interface org.infinispan.configuration.cache.ConfigurationChildBuilder
jmxStatistics

- Field Detail
  - builder
```
protected final ConfigurationBuilder builder
```
- Constructor Detail
  - PersistenceConfigurationBuilder
```
protected PersistenceConfigurationBuilder(ConfigurationBuilder builder)
```
- Method Detail
  - getBuilderFromName
```
public StoreConfigurationBuilder getBuilderFromName(String name)
```
  - passivation
```
public PersistenceConfigurationBuilder passivation(boolean b)
```
  - getElementDefinition
```
public ElementDefinition getElementDefinition()
```
    Specified by:
    
    getElementDefinition in interface BaseConfigurationInfo
    
    Returns:
    
    the ElementDefinition of the configuration.
  - attributes
```
public AttributeSet attributes()
```
    Specified by:
    
    attributes in interface BaseConfigurationInfo
    
    Returns:
    
    the AttributeSet declared by the configuration.
  - getNewBuilderInfo
```
public ConfigurationBuilderInfo getNewBuilderInfo(String name)
```
    Specified by:
    
    getNewBuilderInfo in interface ConfigurationBuilderInfo
    
    Returns:
    
    same as ConfigurationBuilderInfo.getBuilderInfo(String, String) but will return a new instance of the builder on every call. This is to create unbounded sub-elements in a builder.
  - getBuilderInfo
```
public ConfigurationBuilderInfo getBuilderInfo(String name,
                                               String qualifier)
```
    Specified by:
    
    getBuilderInfo in interface ConfigurationBuilderInfo
    
    Returns:
    
    the ConfigurationBuilderInfo associated with a certain serialized element name.
  - availabilityInterval
```
public PersistenceConfigurationBuilder availabilityInterval(int interval)
```
    Parameters:
    
    interval - The time, in milliseconds, between availability checks to determine if the PersistenceManager is available. In other words, this interval sets how often stores/loaders are polled via their `org.infinispan.persistence.spi.CacheWriter#isAvailable` or `org.infinispan.persistence.spi.CacheLoader#isAvailable` implementation. If a single store/loader is not available, an exception is thrown during cache operations.
  - connectionAttempts
```
public PersistenceConfigurationBuilder connectionAttempts(int attempts)
```
    Parameters:
    
    attempts - The maximum number of unsuccessful attempts to start each of the configured CacheWriter/CacheLoader before an exception is thrown and the cache fails to start.
  - connectionInterval
```
public PersistenceConfigurationBuilder connectionInterval(int interval)
```
    Parameters:
    
    interval - The time, in milliseconds, to wait between subsequent connection attempts on startup. A negative or zero value means no wait between connection attempts.
  - addStore
```
public <T extends StoreConfigurationBuilder<?,?>> T addStore(Class<T> klass)
```
    Adds a cache loader that uses the specified builder class to build its configuration.
  - addStore
```
public StoreConfigurationBuilder<?,?> addStore(StoreConfigurationBuilder<?,?> builder)
```
    Adds a cache loader that uses the specified builder instance to build its configuration.
    
    Parameters:
    
    builder - is an instance of StoreConfigurationBuilder.
  - addClusterLoader
```
@Deprecated
public ClusterLoaderConfigurationBuilder addClusterLoader()
```
    Deprecated. since 11.0. To be removed in 14.0 ISPN-11864 with no direct replacement.
    
    Adds a cluster cache loader.
  - addSingleFileStore
```
public SingleFileStoreConfigurationBuilder addSingleFileStore()
```
    Adds a single file cache store.
  - clearStores
```
public PersistenceConfigurationBuilder clearStores()
```
    Removes any configured 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<PersistenceConfiguration>
  - validate
```
public void validate(GlobalConfiguration globalConfig)
```
    Specified by:
    
    validate in interface ConfigurationChildBuilder
  - create
```
public PersistenceConfiguration create()
```
    Description copied from interface: Builder
    
    Create the configuration bean
    
    Specified by:
    
    create in interface Builder<PersistenceConfiguration>
    
    Returns:
  - read
```
public PersistenceConfigurationBuilder read(PersistenceConfiguration 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<PersistenceConfiguration>
    
    Parameters:
    
    template - the configuration from which to "clone" this config if needed.
  - stores
```
public List<StoreConfigurationBuilder<?,?>> stores()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - template
```
public ConfigurationChildBuilder template(boolean template)
```
    Specified by:
    
    template in interface ConfigurationChildBuilder
  - simpleCache
```
public ConfigurationChildBuilder simpleCache(boolean simpleCache)
```
    Specified by:
    
    simpleCache in interface ConfigurationChildBuilder
  - simpleCache
```
public boolean simpleCache()
```
    Specified by:
    
    simpleCache in interface ConfigurationChildBuilder
  - clustering
```
public ClusteringConfigurationBuilder clustering()
```
    Specified by:
    
    clustering in interface ConfigurationChildBuilder
  - customInterceptors
```
@Deprecated
public CustomInterceptorsConfigurationBuilder customInterceptors()
```
    Deprecated. Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors
    
    Specified by:
    
    customInterceptors in interface ConfigurationChildBuilder
  - encoding
```
public EncodingConfigurationBuilder encoding()
```
    Specified by:
    
    encoding 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
  - statistics
```
public StatisticsConfigurationBuilder statistics()
```
    Specified by:
    
    statistics in interface ConfigurationChildBuilder
  - persistence
```
public PersistenceConfigurationBuilder persistence()
```
    Specified by:
    
    persistence in interface ConfigurationChildBuilder
  - locking
```
public LockingConfigurationBuilder locking()
```
    Specified by:
    
    locking in interface ConfigurationChildBuilder
  - security
```
public SecurityConfigurationBuilder security()
```
    Specified by:
    
    security in interface ConfigurationChildBuilder
  - transaction
```
public TransactionConfigurationBuilder transaction()
```
    Specified by:
    
    transaction in interface ConfigurationChildBuilder
  - unsafe
```
public UnsafeConfigurationBuilder unsafe()
```
    Specified by:
    
    unsafe in interface ConfigurationChildBuilder
  - sites
```
public SitesConfigurationBuilder sites()
```
    Specified by:
    
    sites in interface ConfigurationChildBuilder
  - memory
```
public MemoryConfigurationBuilder memory()
```
    Specified by:
    
    memory in interface ConfigurationChildBuilder
  - getBuilder
```
protected ConfigurationBuilder getBuilder()
```
  - build
```
public Configuration build()
```
    Specified by:
    
    build in interface ConfigurationChildBuilder

Class PersistenceConfigurationBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.infinispan.commons.configuration.ConfigurationBuilderInfo

Methods inherited from interface org.infinispan.configuration.cache.ConfigurationChildBuilder

Field Detail

builder

Constructor Detail

PersistenceConfigurationBuilder

Method Detail

getBuilderFromName

passivation

getElementDefinition

attributes

getNewBuilderInfo

getBuilderInfo

availabilityInterval

connectionAttempts

connectionInterval

addStore

addStore

addClusterLoader

addSingleFileStore

clearStores

validate

validate

create

read

stores

toString

template

simpleCache

simpleCache

clustering

customInterceptors

encoding

expiration

indexing

invocationBatching

statistics

persistence

locking

security

transaction

unsafe

sites

memory

getBuilder

build