one.microstream.storage.configuration.Configuration.Default

All Implemented Interfaces:: Configuration

Enclosing interface:: Configuration

public static class Configuration.Default
extends Object
implements Configuration

Nested Class Summary

Nested classes/interfaces inherited from interface one.microstream.storage.configuration.Configuration
Configuration.Default

Method Summary

Modifier and Type	Method	Description
`String`	`getBackupDirectory()`	The backup directory.
`String`	`getBaseDirectory()`	The base directory of the storage in the file system.
`int`	`getChannelCount()`	The number of threads and number of directories used by the storage engine.
`String`	`getChannelDirectoryPrefix()`	Name prefix of the subdirectories used by the channel threads.
`boolean`	`getDataFileCleanupHeadFile()`	A flag defining wether the current head file (the only file actively written to) shall be subjected to file cleanups as well.
`int`	`getDataFileMaximumSize()`	Maximum file size for a data file to avoid cleaning it up.
`int`	`getDataFileMinimumSize()`	Minimum file size for a data file to avoid cleaning it up.
`double`	`getDataFileMinimumUseRatio()`	The ratio (value in ]0.0;1.0]) of non-gap data contained in a storage file to prevent the file from being dissolved.
`String`	`getDataFilePrefix()`	Name prefix of the storage files.
`String`	`getDataFileSuffix()`	Name suffix of the storage files.
`String`	`getDeletionDirectory()`	The deletion directory.
`long`	`getEntityCacheThreshold()`	Abstract threshold value for the lifetime of entities in the cache.
`long`	`getEntityCacheTimeoutMs()`	Timeout in milliseconds for the entity cache evaluator.
`long`	`getHousekeepingIntervalMs()`	Interval in milliseconds for the houskeeping.
`long`	`getHousekeepingTimeBudgetNs()`	Number of nanoseconds used for each housekeeping cycle.
`String`	`getLockFileName()`
`String`	`getRescuedFileSuffix()`
`String`	`getTransactionFilePrefix()`	Name prefix of the storage transaction file.
`String`	`getTransactionFileSuffix()`	Name suffix of the storage transaction file.
`String`	`getTruncationDirectory()`	The truncation directory.
`String`	`getTypeDictionaryFilename()`	The name of the dictionary file.
`Configuration`	`setBackupDirectory(String backupDirectory)`	The backup directory.
`Configuration`	`setBaseDirectory(String baseDirectory)`	The base directory of the storage in the file system.
`Configuration`	`setChannelCount(int channelCount)`	The number of threads and number of directories used by the storage engine.
`Configuration`	`setChannelDirectoryPrefix(String channelDirectoryPrefix)`	Name prefix of the subdirectories used by the channel threads.
`Configuration`	`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.
`Configuration`	`setDataFileMaximumSize(int dataFileMaximumSize)`	Maximum file size for a data file to avoid cleaning it up.
`Configuration`	`setDataFileMinimumSize(int dataFileMinimumSize)`	Minimum file size for a data file to avoid cleaning it up.
`Configuration`	`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.
`Configuration`	`setDataFilePrefix(String dataFilePrefix)`	Name prefix of the storage files.
`Configuration`	`setDataFileSuffix(String dataFileSuffix)`	Name suffix of the storage files.
`Configuration`	`setDeletionDirectory(String deletionDirectory)`	The deletion directory.
`Configuration`	`setEntityCacheThreshold(long entityCacheThreshold)`	Abstract threshold value for the lifetime of entities in the cache.
`Configuration`	`setEntityCacheTimeoutMs(long entityCacheTimeoutMs)`	Timeout in milliseconds for the entity cache evaluator.
`Configuration`	`setHousekeepingIntervalMs(long housekeepingIntervalMs)`	Interval in milliseconds for the houskeeping.
`Configuration`	`setHousekeepingTimeBudgetNs(long housekeepingNanoTimeBudgetNs)`	Number of nanoseconds used for each housekeeping cycle.
`Configuration`	`setLockFileName(String lockFileName)`
`Configuration`	`setRescuedFileSuffix(String rescuedFileSuffix)`
`Configuration`	`setTransactionFilePrefix(String transactionFilePrefix)`	Name prefix of the storage transaction file.
`Configuration`	`setTransactionFileSuffix(String transactionFileSuffix)`	Name suffix of the storage transaction file.
`Configuration`	`setTruncationDirectory(String truncationDirectory)`	The truncation directory.
`Configuration`	`setTypeDictionaryFilename(String typeDictionaryFilename)`	The name of the dictionary file.

Methods inherited from class java.lang.Object

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

Methods inherited from interface one.microstream.storage.configuration.Configuration

createEmbeddedStorageFoundation, exportIni, exportIni, exportIni, exportIni, exportIni, exportIni, exportIni, exportIni, exportXml, exportXml, exportXml, exportXml, exportXml, exportXml, exportXml, exportXml, getDataFileDissolveRatio, getDataFileMaxSize, getDataFileMinSize, getEntityCacheTimeout, getHouseKeepingInterval, getHouseKeepingNanoTimeBudget, setBackupDirectoryInUserHome, setBaseDirectoryInUserHome, setDataFileDissolveRatio, setDataFileMaxSize, setDataFileMinSize, setEntityCacheTimeout, setHouseKeepingInterval, setHouseKeepingNanoTimeBudget

Method Details
- setBaseDirectory
  
  public Configuration setBaseDirectory(String baseDirectory)
  
  Description copied from interface: Configuration
  
  The base directory of the storage in the file system.
  
  Specified by:
  
  setBaseDirectory in interface Configuration
- getBaseDirectory
  
  public String getBaseDirectory()
  
  Description copied from interface: Configuration
  
  The base directory of the storage in the file system.
  
  Specified by:
  
  getBaseDirectory in interface Configuration
- setDeletionDirectory
  
  public Configuration setDeletionDirectory(String deletionDirectory)
  
  Description copied from interface: Configuration
  
  The deletion directory.
  
  Specified by:
  
  setDeletionDirectory in interface Configuration
- getDeletionDirectory
  
  public String getDeletionDirectory()
  
  Description copied from interface: Configuration
  
  The deletion directory.
  
  Specified by:
  
  getDeletionDirectory in interface Configuration
- setTruncationDirectory
  
  public Configuration setTruncationDirectory(String truncationDirectory)
  
  Description copied from interface: Configuration
  
  The truncation directory.
  
  Specified by:
  
  setTruncationDirectory in interface Configuration
- getTruncationDirectory
  
  public String getTruncationDirectory()
  
  Description copied from interface: Configuration
  
  The truncation directory.
  
  Specified by:
  
  getTruncationDirectory in interface Configuration
- setBackupDirectory
  
  public Configuration setBackupDirectory(String backupDirectory)
  
  Description copied from interface: Configuration
  
  The backup directory.
  
  Specified by:
  
  setBackupDirectory in interface Configuration
- getBackupDirectory
  
  public String getBackupDirectory()
  
  Description copied from interface: Configuration
  
  The backup directory.
  
  Specified by:
  
  getBackupDirectory in interface Configuration
- setChannelCount
  
  public Configuration setChannelCount(int channelCount)
  
  Description copied from interface: Configuration
  
  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 Configuration
  
  Parameters:
  
  channelCount - the new channel count, must be a power of 2
- getChannelCount
  
  public int getChannelCount()
  
  Description copied from interface: Configuration
  
  The number of threads and number of directories used by the storage engine. Every thread has exclusive access to its directory.
  
  Specified by:
  
  getChannelCount in interface Configuration
- setChannelDirectoryPrefix
  
  public Configuration setChannelDirectoryPrefix(String channelDirectoryPrefix)
  
  Description copied from interface: Configuration
  
  Name prefix of the subdirectories used by the channel threads. Default is "channel_".
  
  Specified by:
  
  setChannelDirectoryPrefix in interface Configuration
  
  Parameters:
  
  channelDirectoryPrefix - new prefix
- getChannelDirectoryPrefix
  
  public String getChannelDirectoryPrefix()
  
  Description copied from interface: Configuration
  
  Name prefix of the subdirectories used by the channel threads.
  
  Specified by:
  
  getChannelDirectoryPrefix in interface Configuration
- setDataFilePrefix
  
  public Configuration setDataFilePrefix(String dataFilePrefix)
  
  Description copied from interface: Configuration
  
  Name prefix of the storage files. Default is "channel_".
  
  Specified by:
  
  setDataFilePrefix in interface Configuration
  
  Parameters:
  
  dataFilePrefix - new prefix
- getDataFilePrefix
  
  public String getDataFilePrefix()
  
  Description copied from interface: Configuration
  
  Name prefix of the storage files.
  
  Specified by:
  
  getDataFilePrefix in interface Configuration
- setDataFileSuffix
  
  public Configuration setDataFileSuffix(String dataFileSuffix)
  
  Description copied from interface: Configuration
  
  Name suffix of the storage files. Default is ".dat".
  
  Specified by:
  
  setDataFileSuffix in interface Configuration
  
  Parameters:
  
  dataFileSuffix - new suffix
- getDataFileSuffix
  
  public String getDataFileSuffix()
  
  Description copied from interface: Configuration
  
  Name suffix of the storage files.
  
  Specified by:
  
  getDataFileSuffix in interface Configuration
- setTransactionFilePrefix
  
  public Configuration setTransactionFilePrefix(String transactionFilePrefix)
  
  Description copied from interface: Configuration
  
  Name prefix of the storage transaction file. Default is "transactions_".
  
  Specified by:
  
  setTransactionFilePrefix in interface Configuration
  
  Parameters:
  
  transactionFilePrefix - new prefix
- getTransactionFilePrefix
  
  public String getTransactionFilePrefix()
  
  Description copied from interface: Configuration
  
  Name prefix of the storage transaction file.
  
  Specified by:
  
  getTransactionFilePrefix in interface Configuration
- setTransactionFileSuffix
  
  public Configuration setTransactionFileSuffix(String transactionFileSuffix)
  
  Description copied from interface: Configuration
  
  Name suffix of the storage transaction file. Default is ".sft".
  
  Specified by:
  
  setTransactionFileSuffix in interface Configuration
  
  Parameters:
  
  transactionFileSuffix - new suffix
- getTransactionFileSuffix
  
  public String getTransactionFileSuffix()
  
  Description copied from interface: Configuration
  
  Name suffix of the storage transaction file.
  
  Specified by:
  
  getTransactionFileSuffix in interface Configuration
- setTypeDictionaryFilename
  
  public Configuration setTypeDictionaryFilename(String typeDictionaryFilename)
  
  Description copied from interface: Configuration
  
  The name of the dictionary file. Default is "PersistenceTypeDictionary.ptd".
  
  Specified by:
  
  setTypeDictionaryFilename in interface Configuration
  
  Parameters:
  
  typeDictionaryFilename - new name
- getTypeDictionaryFilename
  
  public String getTypeDictionaryFilename()
  
  Description copied from interface: Configuration
  
  The name of the dictionary file.
  
  Specified by:
  
  getTypeDictionaryFilename in interface Configuration
- setRescuedFileSuffix
  
  public Configuration setRescuedFileSuffix(String rescuedFileSuffix)
  
  Specified by:
  
  setRescuedFileSuffix in interface Configuration
- getRescuedFileSuffix
  
  public String getRescuedFileSuffix()
  
  Specified by:
  
  getRescuedFileSuffix in interface Configuration
- setLockFileName
  
  public Configuration setLockFileName(String lockFileName)
  
  Specified by:
  
  setLockFileName in interface Configuration
- getLockFileName
  
  public String getLockFileName()
  
  Specified by:
  
  getLockFileName in interface Configuration
- setHousekeepingIntervalMs
  
  public Configuration setHousekeepingIntervalMs(long housekeepingIntervalMs)
  
  Description copied from interface: Configuration
  
  Interval in milliseconds for the houskeeping. This is work like garbage collection or cache checking. In combination with Configuration.setHousekeepingTimeBudgetNs(long) the maximum processor time for housekeeping work can be set. Default is 1000 (every second).
  
  Specified by:
  
  setHousekeepingIntervalMs in interface Configuration
  
  Parameters:
  
  housekeepingIntervalMs - the new interval
  
  See Also:
  
  Configuration.setHousekeepingTimeBudgetNs(long)
- getHousekeepingIntervalMs
  
  public long getHousekeepingIntervalMs()
  
  Description copied from interface: Configuration
  
  Interval in milliseconds for the houskeeping. This is work like garbage collection or cache checking.
  
  Specified by:
  
  getHousekeepingIntervalMs in interface Configuration
  
  See Also:
  
  Configuration.getHousekeepingTimeBudgetNs()
- setHousekeepingTimeBudgetNs
  
  public Configuration setHousekeepingTimeBudgetNs(long housekeepingNanoTimeBudgetNs)
  
  Description copied from interface: Configuration
  
  Number of nanoseconds 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 10000000 (10 million nanoseconds = 10 milliseconds = 0.01 seconds).
  
  Specified by:
  
  setHousekeepingTimeBudgetNs in interface Configuration
  
  Parameters:
  
  housekeepingNanoTimeBudgetNs - the new time budget
  
  See Also:
  
  Configuration.setHousekeepingIntervalMs(long)
- getHousekeepingTimeBudgetNs
  
  public long getHousekeepingTimeBudgetNs()
  
  Description copied from interface: Configuration
  
  Number of nanoseconds 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.
  
  Specified by:
  
  getHousekeepingTimeBudgetNs in interface Configuration
  
  See Also:
  
  Configuration.getHousekeepingIntervalMs()
- setEntityCacheThreshold
  
  public Configuration setEntityCacheThreshold(long entityCacheThreshold)
  
  Description copied from interface: Configuration
  
  Abstract threshold value for the lifetime of entities in the cache. See StorageEntityCacheEvaluator. Default is 1000000000.
  
  Specified by:
  
  setEntityCacheThreshold in interface Configuration
  
  Parameters:
  
  entityCacheThreshold - the new threshold
- getEntityCacheThreshold
  
  public long getEntityCacheThreshold()
  
  Description copied from interface: Configuration
  
  Abstract threshold value for the lifetime of entities in the cache. See StorageEntityCacheEvaluator.
  
  Specified by:
  
  getEntityCacheThreshold in interface Configuration
- setEntityCacheTimeoutMs
  
  public Configuration setEntityCacheTimeoutMs(long entityCacheTimeoutMs)
  
  Description copied from interface: Configuration
  
  Timeout in milliseconds for the entity cache evaluator. If an entity wasn't accessed in this timespan it will be removed from the cache. Default is 86400000 (1 day).
  
  Specified by:
  
  setEntityCacheTimeoutMs in interface Configuration
  
  See Also:
  
  Duration
- getEntityCacheTimeoutMs
  
  public long getEntityCacheTimeoutMs()
  
  Description copied from interface: Configuration
  
  Timeout in milliseconds for the entity cache evaluator. If an entity wasn't accessed in this timespan it will be removed from the cache.
  
  Specified by:
  
  getEntityCacheTimeoutMs in interface Configuration
- setDataFileMinimumSize
  
  public Configuration setDataFileMinimumSize(int dataFileMinimumSize)
  
  Description copied from interface: Configuration
  
  Minimum file size for a data file to avoid cleaning it up. Default is 1024^2 = 1 MiB.
  
  Specified by:
  
  setDataFileMinimumSize in interface Configuration
  
  Parameters:
  
  dataFileMinimumSize - the new minimum file size
  
  See Also:
  
  Configuration.setDataFileMinimumUseRatio(double)
- getDataFileMinimumSize
  
  public int getDataFileMinimumSize()
  
  Description copied from interface: Configuration
  
  Minimum file size for a data file to avoid cleaning it up.
  
  Specified by:
  
  getDataFileMinimumSize in interface Configuration
  
  See Also:
  
  Configuration.getDataFileMinimumUseRatio()
- setDataFileMaximumSize
  
  public Configuration setDataFileMaximumSize(int dataFileMaximumSize)
  
  Description copied from interface: Configuration
  
  Maximum file size for a data file to avoid cleaning it up. Default is 1024^2*8 = 8 MiB.
  
  Specified by:
  
  setDataFileMaximumSize in interface Configuration
  
  Parameters:
  
  dataFileMaximumSize - the new maximum file size
  
  See Also:
  
  Configuration.setDataFileMinimumUseRatio(double)
- getDataFileMaximumSize
  
  public int getDataFileMaximumSize()
  
  Description copied from interface: Configuration
  
  Maximum file size for a data file to avoid cleaning it up.
  
  Specified by:
  
  getDataFileMaximumSize in interface Configuration
  
  See Also:
  
  Configuration.getDataFileMinimumUseRatio()
- setDataFileMinimumUseRatio
  
  public Configuration setDataFileMinimumUseRatio(double dataFileMinimumUseRatio)
  
  Description copied from interface: Configuration
  
  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 Configuration
  
  Parameters:
  
  dataFileMinimumUseRatio - the new minimum use ratio
- getDataFileMinimumUseRatio
  
  public double getDataFileMinimumUseRatio()
  
  Description copied from interface: Configuration
  
  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:
  
  getDataFileMinimumUseRatio in interface Configuration
- setDataFileCleanupHeadFile
  
  public Configuration setDataFileCleanupHeadFile(boolean dataFileCleanupHeadFile)
  
  Description copied from interface: Configuration
  
  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 Configuration
- getDataFileCleanupHeadFile
  
  public boolean getDataFileCleanupHeadFile()
  
  Description copied from interface: Configuration
  
  A flag defining wether the current head file (the only file actively written to) shall be subjected to file cleanups as well.
  
  Specified by:
  
  getDataFileCleanupHeadFile in interface Configuration

Class Configuration.Default

Nested Class Summary

Nested classes/interfaces inherited from interface one.microstream.storage.configuration.Configuration

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface one.microstream.storage.configuration.Configuration

Method Details