java.lang.Object

java.lang.Enum<ConfigurationCoreProperties>

one.microstream.integrations.cdi.types.ConfigurationCoreProperties

All Implemented Interfaces:: Serializable, Comparable<ConfigurationCoreProperties>, java.lang.constant.Constable

public enum ConfigurationCoreProperties
extends Enum<ConfigurationCoreProperties>

The relation with the properties from MicroStream docs: Configuration properties

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class ConfigurationCoreProperties.Constants

Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants
Enum Constant	Description
`BACKUP_DIRECTORY`	The backup directory.
`BACKUP_FILESYSTEM`	The backup file system configuration.
`CHANNEL_COUNT`	The number of threads and number of directories used by the storage engine.
`CHANNEL_DIRECTORY_PREFIX`	Name prefix of the subdirectories used by the channel threads.
`DATA_FILE_CLEANUP_HEAD_FILE`	A flag defining whether the current head file (the only file actively written to) shall be subjected to file cleanups as well.
`DATA_FILE_MAXIMUM_SIZE`	Maximum file size for a data file to avoid cleaning it up.
`DATA_FILE_MINIMUM_SIZE`	Minimum file size for a data file to avoid cleaning it up.
`DATA_FILE_MINIMUM_USE_RATIO`	The ratio (value in ]0.0;1.0]) of non-gap data contained in a storage file to prevent the file from being dissolved.
`DATA_FILE_PREFIX`	Name prefix of the storage files.
`DATA_FILE_SUFFIX`	Name suffix of the storage files.
`DELETION_DIRECTORY`	If configured, the storage will not delete files.
`ENTITY_CACHE_THRESHOLD`	Abstract threshold value for the lifetime of entities in the cache.
`ENTITY_CACHE_TIMEOUT`	Timeout in milliseconds for the entity cache evaluator.
`HOUSEKEEPING_INTERVAL`	Interval for the housekeeping.
`HOUSEKEEPING_TIME_BUDGET`	Number of nanoseconds used for each housekeeping cycle.
`LOCK_FILE_NAME`	Name of the lock file.
`RESCUED_FILE_SUFFIX`	Name suffix of the storage rescue files.
`STORAGE_DIRECTORY`	The base directory of the storage in the file system.
`STORAGE_FILESYSTEM`	The live file system configuration.
`TRANSACTION_FILE_PREFIX`	Name prefix of the storage transaction file.
`TRANSACTION_FILE_SUFFIX`	Name suffix of the storage transaction file.
`TRUNCATION_DIRECTORY`	If configured, files that will get truncated are copied into this directory.
`TYPE_DICTIONARY_FILE_NAME`	The name of the dictionary file.

Method Summary

Modifier and Type	Method	Description
`static Optional<ConfigurationCoreProperties>`	`get(String value)`	Returns the `ConfigurationCoreProperties` enum entry that corresponds with the MicroProfile config key value.
`String`	`getMicroProfile()`
`String`	`getMicroStream(String key)`	Returns the corresponding MicroStream version of the config key.
`static Map<String,String>`	`getProperties(org.eclipse.microprofile.config.Config config)`
`static ConfigurationCoreProperties`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static ConfigurationCoreProperties[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details
- STORAGE_DIRECTORY
  
  public static final ConfigurationCoreProperties STORAGE_DIRECTORY
  
  The base directory of the storage in the file system. Default is "storage" in the working directory.
- STORAGE_FILESYSTEM
  
  public static final ConfigurationCoreProperties STORAGE_FILESYSTEM
  
  The live file system configuration. See storage targets configuration.
- DELETION_DIRECTORY
  
  public static final ConfigurationCoreProperties DELETION_DIRECTORY
  
  If configured, the storage will not delete files. Instead of deleting a file it will be moved to this directory.
- TRUNCATION_DIRECTORY
  
  public static final ConfigurationCoreProperties TRUNCATION_DIRECTORY
  
  If configured, files that will get truncated are copied into this directory.
- BACKUP_DIRECTORY
  
  public static final ConfigurationCoreProperties BACKUP_DIRECTORY
  
  The backup directory.
- BACKUP_FILESYSTEM
  
  public static final ConfigurationCoreProperties BACKUP_FILESYSTEM
  
  The backup file system configuration. See storage targets configuration.
- CHANNEL_COUNT
  
  public static final ConfigurationCoreProperties CHANNEL_COUNT
  
  The number of threads and number of directories used by the storage engine. Every thread has exclusive access to its directory. Default is 1.
- CHANNEL_DIRECTORY_PREFIX
  
  public static final ConfigurationCoreProperties CHANNEL_DIRECTORY_PREFIX
  
  Name prefix of the subdirectories used by the channel threads. Default is "channel_".
- DATA_FILE_PREFIX
  
  public static final ConfigurationCoreProperties DATA_FILE_PREFIX
  
  Name prefix of the storage files. Default is "channel_".
- DATA_FILE_SUFFIX
  
  public static final ConfigurationCoreProperties DATA_FILE_SUFFIX
  
  Name suffix of the storage files. Default is ".dat".
- TRANSACTION_FILE_PREFIX
  
  public static final ConfigurationCoreProperties TRANSACTION_FILE_PREFIX
  
  Name prefix of the storage transaction file. Default is "transactions_".
- TRANSACTION_FILE_SUFFIX
  
  public static final ConfigurationCoreProperties TRANSACTION_FILE_SUFFIX
  
  Name suffix of the storage transaction file. Default is ".sft".
- TYPE_DICTIONARY_FILE_NAME
  
  public static final ConfigurationCoreProperties TYPE_DICTIONARY_FILE_NAME
  
  The name of the dictionary file. Default is "PersistenceTypeDictionary.ptd".
- RESCUED_FILE_SUFFIX
  
  public static final ConfigurationCoreProperties RESCUED_FILE_SUFFIX
  
  Name suffix of the storage rescue files. Default is ".bak".
- LOCK_FILE_NAME
  
  public static final ConfigurationCoreProperties LOCK_FILE_NAME
  
  Name of the lock file. Default is "used.lock".
- HOUSEKEEPING_INTERVAL
  
  public static final ConfigurationCoreProperties HOUSEKEEPING_INTERVAL
  
  Interval for the housekeeping. This is work like garbage collection or cache checking. In combination with houseKeepingNanoTimeBudget the maximum processor time for housekeeping work can be set. Default is 1 second.
- HOUSEKEEPING_TIME_BUDGET
  
  public static final ConfigurationCoreProperties HOUSEKEEPING_TIME_BUDGET
  
  Number of nanoseconds used for each housekeeping cycle. Default is 10 milliseconds = 0.01 seconds.
- ENTITY_CACHE_THRESHOLD
  
  public static final ConfigurationCoreProperties ENTITY_CACHE_THRESHOLD
  
  Abstract threshold value for the lifetime of entities in the cache. Default is 1000000000.
- ENTITY_CACHE_TIMEOUT
  
  public static final ConfigurationCoreProperties ENTITY_CACHE_TIMEOUT
  
  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 1 day.
- DATA_FILE_MINIMUM_SIZE
  
  public static final ConfigurationCoreProperties DATA_FILE_MINIMUM_SIZE
  
  Minimum file size for a data file to avoid cleaning it up. Default is 1024^2 = 1 MiB.
- DATA_FILE_MAXIMUM_SIZE
  
  public static final ConfigurationCoreProperties DATA_FILE_MAXIMUM_SIZE
  
  Maximum file size for a data file to avoid cleaning it up. Default is 1024^2*8 = 8 MiB.
- DATA_FILE_MINIMUM_USE_RATIO
  
  public static final ConfigurationCoreProperties DATA_FILE_MINIMUM_USE_RATIO
  
  The ratio (value in ]0.0;1.0]) of non-gap data contained in a storage file to prevent the file from being dissolved. Default is 0.75 (75%).
- DATA_FILE_CLEANUP_HEAD_FILE
  
  public static final ConfigurationCoreProperties DATA_FILE_CLEANUP_HEAD_FILE
  
  A flag defining whether the current head file (the only file actively written to) shall be subjected to file cleanups as well.
Method Details
- values
  
  public static ConfigurationCoreProperties[] values()
  
  Returns an array containing the constants of this enum type, in the order they are declared.
  
  Returns:
  
  an array containing the constants of this enum type, in the order they are declared
- valueOf
  
  public static ConfigurationCoreProperties valueOf(String name)
  
  Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
  
  Parameters:
  
  name - the name of the enum constant to be returned.
  
  Returns:
  
  the enum constant with the specified name
  
  Throws:
  
  IllegalArgumentException - if this enum type has no constant with the specified name
  
  NullPointerException - if the argument is null
- getMicroProfile
  
  public String getMicroProfile()
- getMicroStream
  
  public String getMicroStream(String key)
  
  Returns the corresponding MicroStream version of the config key. It replaces the MicroProfile part with the MicroStream part. So the keys can be 'longer' as the value defined in the enum. A typical example is the 'storage filesystem' element.
  
  Parameters:
  
  key - The Key as defined in MicroProfile config
  
  Returns:
  
  The corresponding MicroStream version of this key.
- get
  
  public static Optional<ConfigurationCoreProperties> get(String value)
  
  Returns the ConfigurationCoreProperties enum entry that corresponds with the MicroProfile config key value. Optional.empty() when no matching entry is found.
  
  Parameters:
  
  value - The MicroProfile config key value to look for.
  
  Returns:
  
  The enum entry if there is a matching entry or Optional.empty()
- getProperties
  
  public static Map<String,String> getProperties(org.eclipse.microprofile.config.Config config)

Enum ConfigurationCoreProperties

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Details

Method Details