SingleFileStoreConfigurationBuilder (JBoss Data Grid 7.1.0 API)

java.lang.Object
- org.infinispan.configuration.cache.AbstractPersistenceConfigurationChildBuilder
- - org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder<SingleFileStoreConfiguration,SingleFileStoreConfigurationBuilder>
  - - org.infinispan.configuration.cache.SingleFileStoreConfigurationBuilder

All Implemented Interfaces:

Builder<SingleFileStoreConfiguration>, Self<SingleFileStoreConfigurationBuilder>, ConfigurationChildBuilder, PersistenceConfigurationChildBuilder, StoreConfigurationBuilder<SingleFileStoreConfiguration,SingleFileStoreConfigurationBuilder>, StoreConfigurationChildBuilder<SingleFileStoreConfigurationBuilder>
```
public class SingleFileStoreConfigurationBuilder
extends AbstractStoreConfigurationBuilder<SingleFileStoreConfiguration,SingleFileStoreConfigurationBuilder>
```
Single file cache store configuration builder.

Since:

6.0

Author:

Galder Zamarreño

Field Summary

Fields
Modifier and Type Field and Description

protected ConfigurationBuilder builder
- Fields inherited from class org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder
  async, attributes, fetchPersistentState, ignoreModifications, preload, properties, purgeOnStartup, shared, singletonStore

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

Constructor Summary

Constructors
Constructor and Description

SingleFileStoreConfigurationBuilder(PersistenceConfigurationBuilder builder)

Constructors
Constructor and Description
`SingleFileStoreConfigurationBuilder(PersistenceConfigurationBuilder builder)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Configuration`	`build()`
`ClusteringConfigurationBuilder`	`clustering()`
`CompatibilityModeConfigurationBuilder`	`compatibility()`
`SingleFileStoreConfiguration`	`create()` Create the configuration bean
`CustomInterceptorsConfigurationBuilder`	`customInterceptors()`
`DataContainerConfigurationBuilder`	`dataContainer()`
`DeadlockDetectionConfigurationBuilder`	`deadlockDetection()`
`EvictionConfigurationBuilder`	`eviction()`
`ExpirationConfigurationBuilder`	`expiration()`
`SingleFileStoreConfigurationBuilder`	`fragmentationFactor(float fragmentationFactor)` The store tries to fit in a new entry into an existing entry from a free entry pool (if one is available) However, this existing free entry may be quite bigger than what is required to contain the new entry It may then make sense to split the free entry into two parts: 1.
`protected ConfigurationBuilder`	`getBuilder()`
`IndexingConfigurationBuilder`	`indexing()`
`InvocationBatchingConfigurationBuilder`	`invocationBatching()`
`JMXStatisticsConfigurationBuilder`	`jmxStatistics()`
`SingleFileStoreConfigurationBuilder`	`location(String location)` Sets a location on disk where the store can write.
`LockingConfigurationBuilder`	`locking()`
`SingleFileStoreConfigurationBuilder`	`maxEntries(int maxEntries)` In order to speed up lookups, the single file cache store keeps an index of keys and their corresponding position in the file.
`PersistenceConfigurationBuilder`	`persistence()`
`Builder<?>`	`read(SingleFileStoreConfiguration template)` Reads the configuration from an already created configuration bean into this builder.
`SecurityConfigurationBuilder`	`security()`
`SingleFileStoreConfigurationBuilder`	`self()`
`boolean`	`simpleCache()`
`ConfigurationChildBuilder`	`simpleCache(boolean simpleCache)`
`SitesConfigurationBuilder`	`sites()`
`StoreAsBinaryConfigurationBuilder`	`storeAsBinary()`
`ConfigurationChildBuilder`	`template(boolean template)`
`TransactionConfigurationBuilder`	`transaction()`
`UnsafeConfigurationBuilder`	`unsafe()`
`VersioningConfigurationBuilder`	`versioning()`

Methods inherited from class org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder
addProperty, async, fetchPersistentState, ignoreModifications, preload, properties, purgeOnStartup, shared, singleton, toString, validate, validate, withProperties

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

Methods inherited from interface org.infinispan.configuration.cache.ConfigurationChildBuilder
build, clustering, compatibility, customInterceptors, dataContainer, deadlockDetection, eviction, expiration, indexing, invocationBatching, jmxStatistics, locking, persistence, security, simpleCache, simpleCache, sites, storeAsBinary, template, transaction, unsafe, versioning

Methods inherited from interface org.infinispan.configuration.cache.PersistenceConfigurationChildBuilder
persistence

- Field Detail
  - builder
```
protected final ConfigurationBuilder builder
```
- Constructor Detail
  - SingleFileStoreConfigurationBuilder
```
public SingleFileStoreConfigurationBuilder(PersistenceConfigurationBuilder builder)
```
- Method Detail
  - self
```
public SingleFileStoreConfigurationBuilder self()
```
  - location
```
public SingleFileStoreConfigurationBuilder location(String location)
```
    Sets a location on disk where the store can write.
  - maxEntries
```
public SingleFileStoreConfigurationBuilder maxEntries(int maxEntries)
```
    In order to speed up lookups, the single file cache store keeps an index of keys and their corresponding position in the file. To avoid this index resulting in memory consumption problems, this cache store can bounded by a maximum number of entries that it stores. If this limit is exceeded, entries are removed permanently using the LRU algorithm both from the in-memory index and the underlying file based cache store. So, setting a maximum limit only makes sense when Infinispan is used as a cache, whose contents can be recomputed or they can be retrieved from the authoritative data store. If this maximum limit is set when the Infinispan is used as an authoritative data store, it could lead to data loss, and hence it's not recommended for this use case.
  - fragmentationFactor
```
public SingleFileStoreConfigurationBuilder fragmentationFactor(float fragmentationFactor)
```
    The store tries to fit in a new entry into an existing entry from a free entry pool (if one is available) However, this existing free entry may be quite bigger than what is required to contain the new entry It may then make sense to split the free entry into two parts: 1. That is required to contain the new entry requested 2. the remaining part to be returned to the pool of free entries. The fragmentationFactor decides when to split the free entry. So, if this value is set as 0.75, then the free entry will be split if the new entry is equal to or less than 0.75 times the size of free entry
  - create
```
public SingleFileStoreConfiguration create()
```
    Description copied from interface: Builder
    
    Create the configuration bean
    
    Returns:
  - read
```
public Builder<?> read(SingleFileStoreConfiguration 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<SingleFileStoreConfiguration>
    
    Overrides:
    
    read in class AbstractStoreConfigurationBuilder<SingleFileStoreConfiguration,SingleFileStoreConfigurationBuilder>
    
    Parameters:
    
    template - the configuration from which to "clone" this config if needed.
  - 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
```
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
  - 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
  - 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
  - compatibility
```
public CompatibilityModeConfigurationBuilder compatibility()
```
    Specified by:
    
    compatibility in interface ConfigurationChildBuilder
  - getBuilder
```
protected ConfigurationBuilder getBuilder()
```
  - build
```
public Configuration build()
```
    Specified by:
    
    build in interface ConfigurationChildBuilder

Class SingleFileStoreConfigurationBuilder

Field Summary

Fields inherited from class org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder

Constructor Summary

Method Summary

Methods inherited from class org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder

Methods inherited from class java.lang.Object

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

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

Field Detail

builder

Constructor Detail

SingleFileStoreConfigurationBuilder

Method Detail

self

location

maxEntries

fragmentationFactor

create

read

template

simpleCache

simpleCache

clustering

customInterceptors

dataContainer

deadlockDetection

eviction

expiration

indexing

invocationBatching

jmxStatistics

persistence

locking

security

storeAsBinary

transaction

versioning

unsafe

sites

compatibility

getBuilder

build