Package one.microstream.storage.embedded.configuration.types

Class EmbeddedStorageConfigurationBuilder.Default

java.lang.Object

one.microstream.storage.embedded.configuration.types.EmbeddedStorageConfigurationBuilder.Default

All Implemented Interfaces:

Configuration.Builder, EmbeddedStorageConfigurationBuilder, EmbeddedStorageConfigurationPropertyNames

Enclosing interface:

EmbeddedStorageConfigurationBuilder

public static class EmbeddedStorageConfigurationBuilder.Default
extends Object
implements EmbeddedStorageConfigurationBuilder, EmbeddedStorageConfigurationPropertyNames

Nested Class Summary

Nested classes/interfaces inherited from interface one.microstream.storage.embedded.configuration.types.EmbeddedStorageConfigurationBuilder

EmbeddedStorageConfigurationBuilder.Default

Field Summary

Fields inherited from interface one.microstream.storage.embedded.configuration.types.EmbeddedStorageConfigurationPropertyNames

BACKUP_DIRECTORY, BACKUP_FILESYSTEM, CHANNEL_COUNT, CHANNEL_DIRECTORY_PREFIX, DATA_FILE_CLEANUP_HEAD_FILE, DATA_FILE_MAXIMUM_SIZE, DATA_FILE_MINIMUM_SIZE, DATA_FILE_MINIMUM_USE_RATIO, DATA_FILE_PREFIX, DATA_FILE_SUFFIX, DELETION_DIRECTORY, ENTITY_CACHE_THRESHOLD, ENTITY_CACHE_TIMEOUT, HOUSEKEEPING_INTERVAL, HOUSEKEEPING_TIME_BUDGET, LOCK_FILE_NAME, RESCUED_FILE_SUFFIX, STORAGE_DIRECTORY, STORAGE_FILESYSTEM, TRANSACTION_FILE_PREFIX, TRANSACTION_FILE_SUFFIX, TRUNCATION_DIRECTORY, TYPE_DICTIONARY_FILE_NAME

Method Summary

Modifier and Type	Method	Description
Configuration	buildConfiguration()	Finishes the building and returns the resulting Configuration.
EmbeddedStorageConfigurationBuilder	child(String key)	Creates a builder for a child configuration.
EmbeddedStorageConfigurationBuilder	set(String key, String value)	Sets either a simple key-value pair (foo=bar) or an entry in a child-configuration (full.qualified.foo=bar).
EmbeddedStorageConfigurationBuilder	setAll(XGettingCollection<KeyValue<String,String>> properties)	Sets many entries at once.
EmbeddedStorageConfigurationBuilder	setAll(KeyValue<String,String>... properties)	Sets many entries at once.
EmbeddedStorageConfigurationBuilder	setBackupDirectory(String backupDirectory)	The backup directory.
EmbeddedStorageConfigurationBuilder	setChannelCount(int channelCount)	The number of threads and number of directories used by the storage engine.
EmbeddedStorageConfigurationBuilder	setChannelDirectoryPrefix(String channelDirectoryPrefix)	Name prefix of the subdirectories used by the channel threads.
EmbeddedStorageConfigurationBuilder	setDataFileCleanupHeadFile(boolean dataFileCleanupHeadFile)	A flag defining wether the current head file (the only file actively written to) shall be subjected to file cleanups as well.
EmbeddedStorageConfigurationBuilder	setDataFileMaximumSize(ByteSize dataFileMaximumSize)	Maximum file size for a data file to avoid cleaning it up.
EmbeddedStorageConfigurationBuilder	setDataFileMinimumSize(ByteSize dataFileMinimumSize)	Minimum file size for a data file to avoid cleaning it up.
EmbeddedStorageConfigurationBuilder	setDataFileMinimumUseRatio(double dataFileMinimumUseRatio)	The ratio (value in ]0.0;1.0]) of non-gap data contained in a storage file to prevent the file from being dissolved.
EmbeddedStorageConfigurationBuilder	setDataFilePrefix(String dataFilePrefix)	Name prefix of the storage files.
EmbeddedStorageConfigurationBuilder	setDataFileSuffix(String dataFileSuffix)	Name suffix of the storage files.
EmbeddedStorageConfigurationBuilder	setDeletionDirectory(String deletionDirectory)	The deletion directory.
EmbeddedStorageConfigurationBuilder	setEntityCacheThreshold(long entityCacheThreshold)	Abstract threshold value for the lifetime of entities in the cache.
EmbeddedStorageConfigurationBuilder	setEntityCacheTimeout(Duration entityCacheTimeout)	Timeout for the entity cache evaluator.
EmbeddedStorageConfigurationBuilder	setHousekeepingInterval(Duration houseKeepingInterval)	Interval for the houskeeping.
EmbeddedStorageConfigurationBuilder	setHousekeepingTimeBudget(Duration housekeepingTimeBudget)	Duration used for each housekeeping cycle.
EmbeddedStorageConfigurationBuilder	setLockFileName(String lockFileName)
EmbeddedStorageConfigurationBuilder	setRescuedFileSuffix(String rescuedFileSuffix)
EmbeddedStorageConfigurationBuilder	setStorageDirectory(String storageDirectory)	The base directory of the storage in the file system.
EmbeddedStorageConfigurationBuilder	setTransactionFilePrefix(String transactionFilePrefix)	Name prefix of the storage transaction file.
EmbeddedStorageConfigurationBuilder	setTransactionFileSuffix(String transactionFileSuffix)	Name suffix of the storage transaction file.
EmbeddedStorageConfigurationBuilder	setTruncationDirectory(String truncationDirectory)	The truncation directory.
EmbeddedStorageConfigurationBuilder	setTypeDictionaryFileName(String typeDictionaryFileName)	The name of the dictionary file.
EmbeddedStorageConfigurationBuilder	valueMapperProvider(ConfigurationValueMapperProvider valueMapperProvider)	Sets the ConfigurationValueMapperProvider.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface one.microstream.configuration.types.Configuration.Builder

child, load, map

Methods inherited from interface one.microstream.storage.embedded.configuration.types.EmbeddedStorageConfigurationBuilder

createEmbeddedStorageFoundation, setBackupDirectoryInUserHome, setStorageDirectoryInUserHome

Method Details

valueMapperProvider

public EmbeddedStorageConfigurationBuilder valueMapperProvider(ConfigurationValueMapperProvider valueMapperProvider)

Description copied from interface: Configuration.Builder

Sets the ConfigurationValueMapperProvider. Use this method to insert user-defined value mappers.

Specified by:

valueMapperProvider in interface Configuration.Builder

Parameters:

valueMapperProvider - the new mapper provider

Returns:

this builder

set

public EmbeddedStorageConfigurationBuilder set(String key, String value)

Description copied from interface: Configuration.Builder

Sets either a simple key-value pair (foo=bar) or an entry in a child-configuration (full.qualified.foo=bar).

Specified by:

set in interface Configuration.Builder

Parameters:

key - simple or full-qualified key, cannot be empty or null

value - the value to set, cannot be null

Returns:

this builder

setAll

public EmbeddedStorageConfigurationBuilder setAll(XGettingCollection<KeyValue<String,String>> properties)

Description copied from interface: Configuration.Builder

Sets many entries at once.

Specified by:

setAll in interface Configuration.Builder

Parameters:

properties - the key-value pairs

Returns:

this builder

See Also:

Configuration.Builder.set(String, String)

setAll

public EmbeddedStorageConfigurationBuilder setAll(KeyValue<String,String>... properties)

Description copied from interface: Configuration.Builder

Sets many entries at once.

Specified by:

setAll in interface Configuration.Builder

Parameters:

properties - the key-value pairs

Returns:

this builder

See Also:

Configuration.Builder.set(String, String)

child

public EmbeddedStorageConfigurationBuilder child(String key)

Description copied from interface: Configuration.Builder

Creates a builder for a child configuration.

Specified by:

child in interface Configuration.Builder

Parameters:

key - the key for the child configuration

Returns:

a new builder

See Also:

Configuration.Builder.child(String, Consumer)

buildConfiguration

public Configuration buildConfiguration()

Description copied from interface: Configuration.Builder

Finishes the building and returns the resulting Configuration.

Specified by:

buildConfiguration in interface Configuration.Builder

Returns:

the Configuration with all values and child-configurations from this builder

setStorageDirectory

public EmbeddedStorageConfigurationBuilder setStorageDirectory(String storageDirectory)

Description copied from interface: EmbeddedStorageConfigurationBuilder

The base directory of the storage in the file system.

Specified by:

setStorageDirectory in interface EmbeddedStorageConfigurationBuilder

setDeletionDirectory

public EmbeddedStorageConfigurationBuilder setDeletionDirectory(String deletionDirectory)

Description copied from interface: EmbeddedStorageConfigurationBuilder

The deletion directory.

Specified by:

setDeletionDirectory in interface EmbeddedStorageConfigurationBuilder

setTruncationDirectory

public EmbeddedStorageConfigurationBuilder setTruncationDirectory(String truncationDirectory)

Description copied from interface: EmbeddedStorageConfigurationBuilder

The truncation directory.

Specified by:

setTruncationDirectory in interface EmbeddedStorageConfigurationBuilder

setBackupDirectory

public EmbeddedStorageConfigurationBuilder setBackupDirectory(String backupDirectory)

Description copied from interface: EmbeddedStorageConfigurationBuilder

The backup directory.

Specified by:

setBackupDirectory in interface EmbeddedStorageConfigurationBuilder

setChannelCount

public EmbeddedStorageConfigurationBuilder setChannelCount(int channelCount)

Description copied from interface: EmbeddedStorageConfigurationBuilder

The number of threads and number of directories used by the storage engine. Every thread has exclusive access to its directory. Default is 1.

Specified by:

setChannelCount in interface EmbeddedStorageConfigurationBuilder

Parameters:

channelCount - the new channel count, must be a power of 2

setChannelDirectoryPrefix

public EmbeddedStorageConfigurationBuilder setChannelDirectoryPrefix(String channelDirectoryPrefix)

Description copied from interface: EmbeddedStorageConfigurationBuilder

Name prefix of the subdirectories used by the channel threads. Default is "channel_".

Specified by:

setChannelDirectoryPrefix in interface EmbeddedStorageConfigurationBuilder

Parameters:

channelDirectoryPrefix - new prefix

setDataFilePrefix

public EmbeddedStorageConfigurationBuilder setDataFilePrefix(String dataFilePrefix)

Description copied from interface: EmbeddedStorageConfigurationBuilder

Name prefix of the storage files. Default is "channel_".

Specified by:

setDataFilePrefix in interface EmbeddedStorageConfigurationBuilder

Parameters:

dataFilePrefix - new prefix

setDataFileSuffix

public EmbeddedStorageConfigurationBuilder setDataFileSuffix(String dataFileSuffix)

Description copied from interface: EmbeddedStorageConfigurationBuilder

Name suffix of the storage files. Default is ".dat".

Specified by:

setDataFileSuffix in interface EmbeddedStorageConfigurationBuilder

Parameters:

dataFileSuffix - new suffix

setTransactionFilePrefix

public EmbeddedStorageConfigurationBuilder setTransactionFilePrefix(String transactionFilePrefix)

Description copied from interface: EmbeddedStorageConfigurationBuilder

Name prefix of the storage transaction file. Default is "transactions_".

Specified by:

setTransactionFilePrefix in interface EmbeddedStorageConfigurationBuilder

Parameters:

transactionFilePrefix - new prefix

setTransactionFileSuffix

public EmbeddedStorageConfigurationBuilder setTransactionFileSuffix(String transactionFileSuffix)

Description copied from interface: EmbeddedStorageConfigurationBuilder

Name suffix of the storage transaction file. Default is ".sft".

Specified by:

setTransactionFileSuffix in interface EmbeddedStorageConfigurationBuilder

Parameters:

transactionFileSuffix - new suffix

setTypeDictionaryFileName

public EmbeddedStorageConfigurationBuilder setTypeDictionaryFileName(String typeDictionaryFileName)

Description copied from interface: EmbeddedStorageConfigurationBuilder

The name of the dictionary file. Default is "PersistenceTypeDictionary.ptd".

Specified by:

setTypeDictionaryFileName in interface EmbeddedStorageConfigurationBuilder

Parameters:

typeDictionaryFileName - new name

setRescuedFileSuffix

public EmbeddedStorageConfigurationBuilder setRescuedFileSuffix(String rescuedFileSuffix)

Specified by:

setRescuedFileSuffix in interface EmbeddedStorageConfigurationBuilder

setLockFileName

public EmbeddedStorageConfigurationBuilder setLockFileName(String lockFileName)

Specified by:

setLockFileName in interface EmbeddedStorageConfigurationBuilder

setHousekeepingInterval

public EmbeddedStorageConfigurationBuilder setHousekeepingInterval(Duration houseKeepingInterval)

Description copied from interface: EmbeddedStorageConfigurationBuilder

Interval for the houskeeping. This is work like garbage collection or cache checking. In combination with EmbeddedStorageConfigurationBuilder.setHousekeepingTimeBudget(Duration) the maximum processor time for housekeeping work can be set. Default is one second.

Specified by:

setHousekeepingInterval in interface EmbeddedStorageConfigurationBuilder

Parameters:

houseKeepingInterval - the new interval

See Also:

EmbeddedStorageConfigurationBuilder.setHousekeepingTimeBudget(Duration)

setHousekeepingTimeBudget

public EmbeddedStorageConfigurationBuilder setHousekeepingTimeBudget(Duration housekeepingTimeBudget)

Description copied from interface: EmbeddedStorageConfigurationBuilder

Duration used for each housekeeping cycle. However, no matter how low the number is, one item of work will always be completed. But if there is nothing to clean up, no processor time will be wasted. Default is 10 milliseconds = 0.01 seconds.

Specified by:

setHousekeepingTimeBudget in interface EmbeddedStorageConfigurationBuilder

Parameters:

housekeepingTimeBudget - the new time budget

See Also:

EmbeddedStorageConfigurationBuilder.setHousekeepingInterval(Duration)

setEntityCacheThreshold

public EmbeddedStorageConfigurationBuilder setEntityCacheThreshold(long entityCacheThreshold)

Description copied from interface: EmbeddedStorageConfigurationBuilder

Abstract threshold value for the lifetime of entities in the cache. See StorageEntityCacheEvaluator.New(long, long). Default is 1.000.000.000.

Specified by:

setEntityCacheThreshold in interface EmbeddedStorageConfigurationBuilder

Parameters:

entityCacheThreshold - the new threshold

See Also:

EmbeddedStorageConfigurationBuilder.setEntityCacheTimeout(Duration)

setEntityCacheTimeout

public EmbeddedStorageConfigurationBuilder setEntityCacheTimeout(Duration entityCacheTimeout)

Description copied from interface: EmbeddedStorageConfigurationBuilder

Timeout for the entity cache evaluator. If an entity wasn't accessed in this timespan it will be removed from the cache. Default is one day. See StorageEntityCacheEvaluator.New(long, long).

Specified by:

setEntityCacheTimeout in interface EmbeddedStorageConfigurationBuilder

Parameters:

entityCacheTimeout - the new timeout

See Also:

Duration, EmbeddedStorageConfigurationBuilder.setEntityCacheThreshold(long)

setDataFileMinimumSize

public EmbeddedStorageConfigurationBuilder setDataFileMinimumSize(ByteSize dataFileMinimumSize)

Description copied from interface: EmbeddedStorageConfigurationBuilder

Minimum file size for a data file to avoid cleaning it up. Default is 1 MiB.

Specified by:

setDataFileMinimumSize in interface EmbeddedStorageConfigurationBuilder

Parameters:

dataFileMinimumSize - the new minimum file size

See Also:

EmbeddedStorageConfigurationBuilder.setDataFileMinimumUseRatio(double)

setDataFileMaximumSize

public EmbeddedStorageConfigurationBuilder setDataFileMaximumSize(ByteSize dataFileMaximumSize)

Description copied from interface: EmbeddedStorageConfigurationBuilder

Maximum file size for a data file to avoid cleaning it up. Default is 8 MiB.

Specified by:

setDataFileMaximumSize in interface EmbeddedStorageConfigurationBuilder

Parameters:

dataFileMaximumSize - the new maximum file size

See Also:

EmbeddedStorageConfigurationBuilder.setDataFileMinimumUseRatio(double)

setDataFileMinimumUseRatio

public EmbeddedStorageConfigurationBuilder setDataFileMinimumUseRatio(double dataFileMinimumUseRatio)

Description copied from interface: EmbeddedStorageConfigurationBuilder

The ratio (value in ]0.0;1.0]) of non-gap data contained in a storage file to prevent the file from being dissolved. "Gap" data is anything that is not the latest version of an entity's data, inluding older versions of an entity and "comment" bytes (a sequence of bytes beginning with its length as a negative value length header).
The closer this value is to 1.0 (100%), the less disk space is occupied by storage files, but the more file dissolving (data transfers to new files) is required and vice versa.

Specified by:

setDataFileMinimumUseRatio in interface EmbeddedStorageConfigurationBuilder

Parameters:

dataFileMinimumUseRatio - the new minimum use ratio

setDataFileCleanupHeadFile

public EmbeddedStorageConfigurationBuilder setDataFileCleanupHeadFile(boolean dataFileCleanupHeadFile)

Description copied from interface: EmbeddedStorageConfigurationBuilder

A flag defining wether the current head file (the only file actively written to) shall be subjected to file cleanups as well.

Specified by:

setDataFileCleanupHeadFile in interface EmbeddedStorageConfigurationBuilder