Micronaut Cache Configuration Reference

Every documented configuration property of Micronaut Cache, with types, descriptions, and defaults.

132 properties across 5 sections

Micronaut Cache Caffeine Config Properties

Configuration properties for DefaultCacheConfiguration

Property	Type	Description
`micronaut.caches.*.initial-capacity`	java.lang.Integer
`micronaut.caches.*.maximum-size`	java.lang.Long
`micronaut.caches.*.maximum-weight`	java.lang.Long
`micronaut.caches.*.expire-after-write`	java.time.Duration
`micronaut.caches.*.expire-after-access`	java.time.Duration
`micronaut.caches.*.record-stats`	boolean
`micronaut.caches.*.charset`	java.nio.charset.Charset
`micronaut.caches.*.test-mode`	boolean
`micronaut.caches.*.listen-to-removals`	boolean	True if listen to removals is enabled
`micronaut.caches.*.listen-to-evictions`	boolean	True if listen to evictions is enabled

Micronaut Cache Core Config Properties

Configuration properties for DiscoveryClientCacheConfiguration

Property	Type	Description
`micronaut.caches.discovery-client.initial-capacity`	java.lang.Integer	The initial capacity of the cache
`micronaut.caches.discovery-client.maximum-size`	java.lang.Long	The maximum size of the cache
`micronaut.caches.discovery-client.maximum-weight`	java.lang.Long	The maximum weight of cache entries
`micronaut.caches.discovery-client.expire-after-write`	java.time.Duration	The expiry to use after the value is written
`micronaut.caches.discovery-client.expire-after-access`	java.time.Duration	The {@link Duration}
`micronaut.caches.discovery-client.record-stats`	boolean	Set whether record stats is enabled. Default value (false).
`micronaut.caches.discovery-client.charset`	java.nio.charset.Charset	The charset used to serialize and deserialize values
`micronaut.caches.discovery-client.test-mode`	boolean	Set whether test mode is enabled. Default value (false).
`micronaut.caches.discovery-client.enabled`	boolean	Whether the discovery client is enabled

Micronaut Cache Ehcache Config Properties

Configuration properties for EhcacheCacheManagerConfiguration

Property	Type	Description
`ehcache.default-size-of-max-object-size`	java.lang.Long	the default maximum size of the largest object in the cache
`ehcache.storage-path`	java.lang.String	the storage path in the file system
`ehcache.resource-pool-configurations`	java.util.List

Configuration properties for CacheManagerBuilder

Property	Type	Description
`ehcache.default-write-behind-thread-pool`	java.lang.String
`ehcache.default-disk-store-thread-pool`	java.lang.String
`ehcache.default-event-listeners-thread-pool`	java.lang.String
`ehcache.class-loader`	java.lang.ClassLoader

Configuration properties for EhcacheConfiguration

Property	Type	Description
`ehcache.caches.*.key-type`	java.lang.Class	The type of the keys in the cache
`ehcache.caches.*.value-type`	java.lang.Class	The type of the values in the cache

Configuration properties for CacheConfigurationBuilder

Property	Type	Description
`ehcache.caches.*.service`	org.ehcache.config.Builder
`ehcache.caches.*.eviction-advisor`	org.ehcache.config.EvictionAdvisor
`ehcache.caches.*.class-loader`	java.lang.ClassLoader
`ehcache.caches.*.resource-pools`	org.ehcache.config.Builder
`ehcache.caches.*.loader-writer`	org.ehcache.spi.loaderwriter.CacheLoaderWriter
`ehcache.caches.*.resilience-strategy`	org.ehcache.spi.resilience.ResilienceStrategy
`ehcache.caches.*.key-copier`	org.ehcache.spi.copy.Copier
`ehcache.caches.*.value-copier`	org.ehcache.spi.copy.Copier
`ehcache.caches.*.key-serializer`	org.ehcache.spi.serialization.Serializer
`ehcache.caches.*.value-serializer`	org.ehcache.spi.serialization.Serializer
`ehcache.caches.*.dispatcher-concurrency`	int
`ehcache.caches.*.event-listeners-thread-pool`	java.lang.String

Configuration properties for CacheConfigurationBuilder

Property	Type	Description
`ehcache.caches.*.service`	org.ehcache.config.Builder
`ehcache.caches.*.eviction-advisor`	org.ehcache.config.EvictionAdvisor
`ehcache.caches.*.class-loader`	java.lang.ClassLoader
`ehcache.caches.*.resource-pools`	org.ehcache.config.Builder
`ehcache.caches.*.loader-writer`	org.ehcache.spi.loaderwriter.CacheLoaderWriter
`ehcache.caches.*.resilience-strategy`	org.ehcache.spi.resilience.ResilienceStrategy
`ehcache.caches.*.key-copier`	org.ehcache.spi.copy.Copier
`ehcache.caches.*.value-copier`	org.ehcache.spi.copy.Copier
`ehcache.caches.*.key-serializer`	org.ehcache.spi.serialization.Serializer
`ehcache.caches.*.value-serializer`	org.ehcache.spi.serialization.Serializer
`ehcache.caches.*.dispatcher-concurrency`	int
`ehcache.caches.*.event-listeners-thread-pool`	java.lang.String

Configuration properties for EhcacheConfiguration$ClusteredDedicatedResourcePoolConfiguration

Property	Type	Description
`ehcache.caches.*.clustered-dedicated.max-size`	java.lang.Long	The maximum size of the cache, in bytes
`ehcache.caches.*.clustered-dedicated.server-resource`	java.lang.String	the server resource

Configuration properties for EhcacheConfiguration$ClusteredSharedResourcePoolConfiguration

Property	Type	Description
`ehcache.caches.*.clustered-shared.server-resource`	java.lang.String	the server resource

Configuration properties for EhcacheConfiguration$DiskTieredCacheConfiguration

Property	Type	Description
`ehcache.caches.*.disk.max-size`	java.lang.Long	The maximum size of the cache, in bytes
`ehcache.caches.*.disk.segments`	java.lang.Integer	The disk segments used

Configuration properties for EhcacheConfiguration$HeapTieredCacheConfiguration

Property	Type	Description
`ehcache.caches.*.heap.max-size`	java.lang.Long	The maximum size of the cache, in bytes
`ehcache.caches.*.heap.max-entries`	java.lang.Long	The maximum number of entries
`ehcache.caches.*.heap.size-of-max-object-size`	java.lang.Long	The maximum size of a single object

Configuration properties for EhcacheConfiguration$OffheapTieredCacheConfiguration

Property	Type	Description
`ehcache.caches.*.offheap.max-size`	java.lang.Long	The maximum size of the cache, in bytes

Configuration properties for EhcacheCacheManagerConfiguration$EhcacheClusterConfiguration

Property	Type	Description
`ehcache.cluster.uri`	java.lang.String	cluster URI
`ehcache.cluster.default-server-resource`	java.lang.String	the default server resource

Configuration properties for EhcacheClusterResourcePoolConfiguration

Property	Type	Description
`ehcache.cluster.resource-pools.*.max-size`	java.lang.Long	The maximum size of the cache, in bytes
`ehcache.cluster.resource-pools.*.server-resource`	java.lang.String	the server resource

Micronaut Cache Hazelcast Config Properties

Configuration properties for HazelcastMemberConfiguration

Property	Type	Description
`hazelcast.properties`	java.util.Properties
`hazelcast.instance-name`	java.lang.String
`hazelcast.cluster-name`	java.lang.String
`hazelcast.license-key`	java.lang.String
`hazelcast.config`	java.lang.String	Sets the path to a Hazelcast XML or YAML configuration file. <p>If non-null, the contents of the file will override this configuration. This path will be used to set system property {@code hazelcast.config}.</p>

Configuration properties for HazelcastClientConfiguration

Property	Type	Description
`hazelcast.client.properties`	java.util.Properties
`hazelcast.client.instance-name`	java.lang.String
`hazelcast.client.cluster-name`	java.lang.String
`hazelcast.client.labels`	java.util.Set
`hazelcast.client.user-context`	java.util.concurrent.ConcurrentMap
`hazelcast.client.config`	java.lang.String	Sets the path to a Hazelcast XML or YAML configuration file. <p>If non-null, the contents of the file will override this configuration. This path will be used to set system property {@code hazelcast.client.config}.</p>

Configuration properties for ConnectionRetryConfig

Property	Type	Description
`hazelcast.client.connection-retry.initial-backoff-millis`	int
`hazelcast.client.connection-retry.max-backoff-millis`	int

Configuration properties for ClientNetworkConfig

Property	Type	Description
`hazelcast.client.network.connection-timeout`	int
`hazelcast.client.network.addresses`	java.util.List
`hazelcast.client.network.redo-operation`	boolean
`hazelcast.client.network.outbound-port-definitions`	java.util.Collection
`hazelcast.client.network.outbound-ports`	java.util.Collection

Configuration properties for ClientNetworkConfig

Property	Type	Description
`hazelcast.client.network.connection-timeout`	int
`hazelcast.client.network.addresses`	java.util.List
`hazelcast.client.network.redo-operation`	boolean
`hazelcast.client.network.outbound-port-definitions`	java.util.Collection
`hazelcast.client.network.outbound-ports`	java.util.Collection

Configuration properties for SocketOptions

Property	Type	Description
`hazelcast.client.network.socket.tcp-no-delay`	boolean
`hazelcast.client.network.socket.keep-alive`	boolean
`hazelcast.client.network.socket.reuse-address`	boolean
`hazelcast.client.network.socket.linger-seconds`	int
`hazelcast.client.network.socket.buffer-size`	int

Micronaut Cache Infinispan Config Properties

Configuration properties for InfinispanHotRodClientConfiguration

Property	Type	Description
`infinispan.client.hotrod.config-file`	java.lang.String	the configuration file location
`infinispan.client.hotrod.resource-resolver`	ResourceResolver
`infinispan.client.hotrod.executor-factory`	org.infinispan.commons.executors.ExecutorFactory
`infinispan.client.hotrod.environment`	Environment

Configuration properties for ConfigurationBuilder

Property	Type	Description
`infinispan.client.hotrod.add-cluster`	java.lang.String
`infinispan.client.hotrod.add-servers`	java.lang.String
`infinispan.client.hotrod.balancing-strategy`	java.lang.String
`infinispan.client.hotrod.connection-timeout`	int
`infinispan.client.hotrod.force-return-values`	boolean
`infinispan.client.hotrod.marshaller`	java.lang.String
`infinispan.client.hotrod.add-context-initializer`	java.lang.String
`infinispan.client.hotrod.socket-timeout`	int
`infinispan.client.hotrod.tcp-no-delay`	boolean
`infinispan.client.hotrod.tcp-keep-alive`	boolean
`infinispan.client.hotrod.max-retries`	int
`infinispan.client.hotrod.batch-size`	int

Configuration properties for ExecutorFactoryConfigurationBuilder

Property	Type	Description
`infinispan.client.hotrod.async-executor-factory.factory-class`	java.lang.Class

Configuration properties for AuthenticationConfigurationBuilder

Property	Type	Description
`infinispan.client.hotrod.security.authentication.enabled`	boolean
`infinispan.client.hotrod.security.authentication.sasl-mechanism`	java.lang.String
`infinispan.client.hotrod.security.authentication.server-name`	java.lang.String
`infinispan.client.hotrod.security.authentication.username`	java.lang.String
`infinispan.client.hotrod.security.authentication.password`	java.lang.String
`infinispan.client.hotrod.security.authentication.realm`	java.lang.String

Configuration properties for SslConfigurationBuilder

Property	Type	Description
`infinispan.client.hotrod.security.ssl.enabled`	boolean
`infinispan.client.hotrod.security.ssl.key-store-file-name`	java.lang.String
`infinispan.client.hotrod.security.ssl.key-store-type`	java.lang.String
`infinispan.client.hotrod.security.ssl.key-store-password`	char
`infinispan.client.hotrod.security.ssl.key-alias`	java.lang.String
`infinispan.client.hotrod.security.ssl.trust-store-file-name`	java.lang.String
`infinispan.client.hotrod.security.ssl.trust-store-type`	java.lang.String
`infinispan.client.hotrod.security.ssl.trust-store-password`	char
`infinispan.client.hotrod.security.ssl.sni-host-name`	java.lang.String
`infinispan.client.hotrod.security.ssl.protocol`	java.lang.String

Configuration properties for ServerConfigurationBuilder

Property	Type	Description
`infinispan.client.hotrod.server.host`	java.lang.String
`infinispan.client.hotrod.server.port`	int

Configuration properties for StatisticsConfigurationBuilder

Property	Type	Description
`infinispan.client.hotrod.statistics.enabled`	boolean
`infinispan.client.hotrod.statistics.jmx-enabled`	boolean
`infinispan.client.hotrod.statistics.jmx-domain`	java.lang.String
`infinispan.client.hotrod.statistics.jmx-name`	java.lang.String