Package org.infinispan.persistence.sifs.configuration

Class SoftIndexFileStoreConfigurationBuilder

java.lang.Object

org.infinispan.configuration.cache.AbstractPersistenceConfigurationChildBuilder

org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder<SoftIndexFileStoreConfiguration,SoftIndexFileStoreConfigurationBuilder>

org.infinispan.persistence.sifs.configuration.SoftIndexFileStoreConfigurationBuilder

All Implemented Interfaces:

BaseConfigurationInfo, Builder<SoftIndexFileStoreConfiguration>, ConfigurationBuilderInfo, Self<SoftIndexFileStoreConfigurationBuilder>, ConfigurationChildBuilder, PersistenceConfigurationChildBuilder, StoreConfigurationBuilder<SoftIndexFileStoreConfiguration,SoftIndexFileStoreConfigurationBuilder>, StoreConfigurationChildBuilder<SoftIndexFileStoreConfigurationBuilder>

public class SoftIndexFileStoreConfigurationBuilder
extends AbstractStoreConfigurationBuilder<SoftIndexFileStoreConfiguration,SoftIndexFileStoreConfigurationBuilder>
implements ConfigurationBuilderInfo

Author:

Radim Vansa <rvansa@redhat.com>

Field Summary

Fields

Modifier and Type	Field	Description
protected ConfigurationBuilder	builder

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

async, attributes

Constructor Summary

Constructors

Constructor	Description
SoftIndexFileStoreConfigurationBuilder(PersistenceConfigurationBuilder builder)

Method Summary

Modifier and Type	Method	Description
org.infinispan.commons.configuration.attributes.AttributeSet	attributes()
Configuration	build()
ClusteringConfigurationBuilder	clustering()
SoftIndexFileStoreConfigurationBuilder	compactionThreshold(double compactionThreshold)	If the amount of unused space in some data file gets above this threshold, the file is compacted - entries from that file are copied to a new file and the old file is deleted.
SoftIndexFileStoreConfiguration	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
SoftIndexFileStoreConfigurationBuilder	dataLocation(String dataLocation)	The path where the Soft-Index store will keep its data files.
EncodingConfigurationBuilder	encoding()
ExpirationConfigurationBuilder	expiration()
protected ConfigurationBuilder	getBuilder()
Collection<ConfigurationBuilderInfo>	getChildrenInfo()
org.infinispan.commons.configuration.elements.ElementDefinition	getElementDefinition()
IndexingConfigurationBuilder	indexing()
SoftIndexFileStoreConfigurationBuilder	indexLocation(String indexLocation)	The path where the Soft-Index store will keep its index files.
SoftIndexFileStoreConfigurationBuilder	indexQueueLength(int indexQueueLength)	Sets the maximum number of entry writes that are waiting to be written to the index, per index segment.
SoftIndexFileStoreConfigurationBuilder	indexSegments(int indexSegments)	Number of index segment files.
InvocationBatchingConfigurationBuilder	invocationBatching()
LockingConfigurationBuilder	locking()
SoftIndexFileStoreConfigurationBuilder	maxFileSize(int maxFileSize)	Sets the maximum size of single data file with entries, in bytes.
SoftIndexFileStoreConfigurationBuilder	maxNodeSize(int maxNodeSize)	Max size of node (continuous block on filesystem used in index implementation), in bytes.
MemoryConfigurationBuilder	memory()
SoftIndexFileStoreConfigurationBuilder	minNodeSize(int minNodeSize)	If the size of the node (continuous block on filesystem used in index implementation) drops below this threshold, the node will try to balance its size with some neighbour node, possibly causing join of multiple nodes.
SoftIndexFileStoreConfigurationBuilder	openFilesLimit(int openFilesLimit)	Sets the maximum number of open files.
PersistenceConfigurationBuilder	persistence()
Builder<?>	read(SoftIndexFileStoreConfiguration template)	Reads the configuration from an already created configuration bean into this builder.
SecurityConfigurationBuilder	security()
SoftIndexFileStoreConfigurationBuilder	self()
boolean	simpleCache()
ConfigurationChildBuilder	simpleCache(boolean simpleCache)
SitesConfigurationBuilder	sites()
StatisticsConfigurationBuilder	statistics()
SoftIndexFileStoreConfigurationBuilder	syncWrites(boolean syncWrites)	Sets whether writes shoud wait to be fsynced to disk.
ConfigurationChildBuilder	template(boolean template)
String	toString()
TransactionConfigurationBuilder	transaction()
UnsafeConfigurationBuilder	unsafe()
protected void	validate(boolean skipClassChecks)
void	validate(GlobalConfiguration globalConfig)

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

addProperty, async, fetchPersistentState, ignoreModifications, maxBatchSize, preload, properties, purgeOnStartup, segmented, shared, transactional, validate, withProperties, writeOnly

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

getBuilderInfo, getNewBuilderInfo

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

build, clustering, customInterceptors, encoding, expiration, indexing, invocationBatching, jmxStatistics, locking, memory, 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

SoftIndexFileStoreConfigurationBuilder

public SoftIndexFileStoreConfigurationBuilder(PersistenceConfigurationBuilder builder)

Method Detail

getElementDefinition

public org.infinispan.commons.configuration.elements.ElementDefinition getElementDefinition()

Specified by:

getElementDefinition in interface BaseConfigurationInfo

Returns:

the ElementDefinition of the configuration.

attributes

public org.infinispan.commons.configuration.attributes.AttributeSet attributes()

Specified by:

attributes in interface BaseConfigurationInfo

Overrides:

attributes in class AbstractStoreConfigurationBuilder<SoftIndexFileStoreConfiguration,SoftIndexFileStoreConfigurationBuilder>

Returns:

the AttributeSet declared by the configuration.

getChildrenInfo

public Collection<ConfigurationBuilderInfo> getChildrenInfo()

Specified by:

getChildrenInfo in interface ConfigurationBuilderInfo

Overrides:

getChildrenInfo in class AbstractStoreConfigurationBuilder<SoftIndexFileStoreConfiguration,SoftIndexFileStoreConfigurationBuilder>

Returns:

a collection of ConfigurationBuilderInfo for the sub-elements of the builder.

dataLocation

public SoftIndexFileStoreConfigurationBuilder dataLocation(String dataLocation)

The path where the Soft-Index store will keep its data files. Under this location the store will create a directory named after the cache name, under which a data directory will be created. The default behaviour is to use the GlobalStateConfiguration.persistentLocation().

indexLocation

public SoftIndexFileStoreConfigurationBuilder indexLocation(String indexLocation)

The path where the Soft-Index store will keep its index files. Under this location the store will create a directory named after the cache name, under which a index directory will be created. The default behaviour is to use the GlobalStateConfiguration.persistentLocation().

indexSegments

public SoftIndexFileStoreConfigurationBuilder indexSegments(int indexSegments)

Number of index segment files. Increasing this value improves throughput but requires more threads to be spawned. Defaults to 3.

maxFileSize

public SoftIndexFileStoreConfigurationBuilder maxFileSize(int maxFileSize)

Sets the maximum size of single data file with entries, in bytes. Defaults to 16777216 (16MB).

minNodeSize

public SoftIndexFileStoreConfigurationBuilder minNodeSize(int minNodeSize)

If the size of the node (continuous block on filesystem used in index implementation) drops below this threshold, the node will try to balance its size with some neighbour node, possibly causing join of multiple nodes. Defaults to 0.

maxNodeSize

public SoftIndexFileStoreConfigurationBuilder maxNodeSize(int maxNodeSize)

Max size of node (continuous block on filesystem used in index implementation), in bytes. Defaults to 4096.

indexQueueLength

public SoftIndexFileStoreConfigurationBuilder indexQueueLength(int indexQueueLength)

Sets the maximum number of entry writes that are waiting to be written to the index, per index segment. Defaults to 1000.

syncWrites

public SoftIndexFileStoreConfigurationBuilder syncWrites(boolean syncWrites)

Sets whether writes shoud wait to be fsynced to disk. Defaults to false.

openFilesLimit

public SoftIndexFileStoreConfigurationBuilder openFilesLimit(int openFilesLimit)

Sets the maximum number of open files. Defaults to 1000.

compactionThreshold

public SoftIndexFileStoreConfigurationBuilder compactionThreshold(double compactionThreshold)

If the amount of unused space in some data file gets above this threshold, the file is compacted - entries from that file are copied to a new file and the old file is deleted. Defaults to 0.5 (50%).

create

public SoftIndexFileStoreConfiguration create()

Description copied from interface: Builder

Create the configuration bean

Specified by:

create in interface Builder<SoftIndexFileStoreConfiguration>

Returns:

read

public Builder<?> read(SoftIndexFileStoreConfiguration 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<SoftIndexFileStoreConfiguration>

Overrides:

read in class AbstractStoreConfigurationBuilder<SoftIndexFileStoreConfiguration,SoftIndexFileStoreConfigurationBuilder>

Parameters:

template - the configuration from which to "clone" this config if needed.

self

public SoftIndexFileStoreConfigurationBuilder self()

Specified by:

self in interface Self<SoftIndexFileStoreConfigurationBuilder>

validate

protected void validate(boolean skipClassChecks)

Overrides:

validate in class AbstractStoreConfigurationBuilder<SoftIndexFileStoreConfiguration,SoftIndexFileStoreConfigurationBuilder>

validate

public void validate(GlobalConfiguration globalConfig)

Specified by:

validate in interface ConfigurationChildBuilder

Overrides:

validate in class AbstractStoreConfigurationBuilder<SoftIndexFileStoreConfiguration,SoftIndexFileStoreConfigurationBuilder>

toString

public String toString()

Overrides:

toString in class AbstractStoreConfigurationBuilder<SoftIndexFileStoreConfiguration,SoftIndexFileStoreConfigurationBuilder>

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