This is the manual for older MicroStream versions (Version < 5.0).
The new documentation (Version >= 5.0) is located at:
The default way to configure a JCache provider is to use the classjavax.cache.configuration.MutableConfiguration
. This is mostly used to avoid provider specific code.
If you want to use all of MicroStream's Cache features, you can use our configuration implementation: one.microstream.cache.CacheConfiguration
To read an external configuration use CacheConfigurationLoader
and CacheConfigurationParser
or the Load*()
methods of CacheConfiguration
.
If you just use CacheConfiguration.Load()
the default configuration file is used, which is either a file in the classpath root named microstream-cache.properties
, or the path configured via the system property microstream.cache.configuration.path
.
This is the manual for older MicroStream versions (Version < 5.0).
The new documentation (Version >= 5.0) is located at:
MicroStream's storage can be used as a backing store for the cache. It functions as a CacheWriter as well as a CacheReader, depending on the writeThrough and readThrough configuration. Per default it is used for both.
If you prefer an external configuration, you can link the storage configuration:
Or you can embed the storage configuration using the storage.
prefix:
Spring example:
This is the manual for older MicroStream versions (Version < 5.0).
The new documentation (Version >= 5.0) is located at:
These are the available properties of the CacheConfiguration
type. The names are used accordingly in the external configuration files. They can be found as constants in CacheConfigurationPropertyNames
.
Property
Description
keyType
Determines the required type of keys for the Cache.
valueType
Determines the required type of values for the Cache.
storageConfigurationResourceName
Path for the storage configuration for the backing store.
cacheLoaderFactory
A CacheLoader should be configured for "Read Through" caches to load values when a cache miss occurs.
cacheWriterFactory
A CacheWriter is used for write-through to an external resource.
expiryPolicyFactory
Determines when cache entries will expire based oncreation, access and modification operations.
evictionManagerFactory
Clears cache entries using a policy. Works interval-based or on entry creation.
readThrough
When in "read-through" mode, cache misses that occur due to cache entries not existing as a result of performing a "get" will appropriately cause the configured CacheLoader to be invoked.
writeThrough
When in "write-through" mode, cache updates that occur as a result of performing "put" operations will appropriately cause the configured CacheWriter to be invoked.
storeByValue
When a cache is storeByValue, any mutation to the key or value does not affect the key of value stored in the cache.
statisticsEnabled
Checks whether statistics collection is enabled in this cache.
managementEnabled
Checks whether management is enabled on this cache.