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

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

All Implemented Interfaces:

BaseConfigurationInfo, Builder<SingleFileStoreConfiguration>, ConfigurationBuilderInfo, Self<SingleFileStoreConfigurationBuilder>, ConfigurationChildBuilder, PersistenceConfigurationChildBuilder, StoreConfigurationBuilder<SingleFileStoreConfiguration,SingleFileStoreConfigurationBuilder>, StoreConfigurationChildBuilder<SingleFileStoreConfigurationBuilder>
```
public class SingleFileStoreConfigurationBuilder
extends AbstractStoreConfigurationBuilder<SingleFileStoreConfiguration,SingleFileStoreConfigurationBuilder>
implements ConfigurationBuilderInfo
```
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

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

Constructor Summary

Constructors
Constructor and Description
`SingleFileStoreConfigurationBuilder(PersistenceConfigurationBuilder builder)`
`SingleFileStoreConfigurationBuilder(PersistenceConfigurationBuilder builder, AttributeSet attributeSet)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`AttributeSet`	`attributes()`
`Configuration`	`build()`
`ClusteringConfigurationBuilder`	`clustering()`
`SingleFileStoreConfiguration`	`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()`
`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()`
`ElementDefinition`	`getElementDefinition()`
`IndexingConfigurationBuilder`	`indexing()`
`InvocationBatchingConfigurationBuilder`	`invocationBatching()`
`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.
`MemoryConfigurationBuilder`	`memory()`
`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()`
`StatisticsConfigurationBuilder`	`statistics()`
`ConfigurationChildBuilder`	`template(boolean template)`
`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 org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder
addProperty, async, fetchPersistentState, getChildrenInfo, ignoreModifications, maxBatchSize, preload, properties, purgeOnStartup, segmented, shared, toString, transactional, validate, withProperties, writeOnly

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
getBuilderInfo, getChildrenInfo, getNewBuilderInfo

Methods inherited from interface org.infinispan.configuration.cache.ConfigurationChildBuilder
build, clustering, customInterceptors, encoding, expiration, indexing, invocationBatching, jmxStatistics, locking, memory, persistence, security, simpleCache, simpleCache, sites, statistics, template, transaction, unsafe

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

- Field Detail
  - builder
```
protected final ConfigurationBuilder builder
```
- Constructor Detail
  - SingleFileStoreConfigurationBuilder
```
public SingleFileStoreConfigurationBuilder(PersistenceConfigurationBuilder builder)
```
  - SingleFileStoreConfigurationBuilder
```
public SingleFileStoreConfigurationBuilder(PersistenceConfigurationBuilder builder,
                                           AttributeSet attributeSet)
```
- Method Detail
  - 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
    
    Overrides:
    
    attributes in class AbstractStoreConfigurationBuilder<SingleFileStoreConfiguration,SingleFileStoreConfigurationBuilder>
    
    Returns:
    
    the AttributeSet declared by the configuration.
  - self
```
public SingleFileStoreConfigurationBuilder self()
```
    Specified by:
    
    self in interface Self<SingleFileStoreConfigurationBuilder>
  - 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
  - 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<SingleFileStoreConfiguration>
    
    Overrides:
    
    validate in class AbstractStoreConfigurationBuilder<SingleFileStoreConfiguration,SingleFileStoreConfigurationBuilder>
  - validate
```
public void validate(GlobalConfiguration globalConfig)
```
    Specified by:
    
    validate in interface ConfigurationChildBuilder
    
    Overrides:
    
    validate in class AbstractStoreConfigurationBuilder<SingleFileStoreConfiguration,SingleFileStoreConfigurationBuilder>
  - create
```
public SingleFileStoreConfiguration create()
```
    Description copied from interface: Builder
    
    Create the configuration bean
    
    Specified by:
    
    create in interface Builder<SingleFileStoreConfiguration>
    
    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
```
@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 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.commons.configuration.ConfigurationBuilderInfo

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

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

Field Detail

builder

Constructor Detail

SingleFileStoreConfigurationBuilder

SingleFileStoreConfigurationBuilder

Method Detail

getElementDefinition

attributes

self

location

maxEntries

fragmentationFactor

validate

validate

create

read

template

simpleCache

simpleCache

clustering

customInterceptors

encoding

expiration

indexing

invocationBatching

statistics

persistence

locking

security

transaction

unsafe

sites

memory

getBuilder

build