Package io.micronaut.cache.ehcache.configuration

Class EhcacheConfiguration

java.lang.Object

io.micronaut.cache.ehcache.configuration.EhcacheConfiguration

All Implemented Interfaces:

io.micronaut.core.naming.Named

@EachProperty("ehcache.caches")
public class EhcacheConfiguration
extends Object
implements io.micronaut.core.naming.Named

Configuration class for an Ehacahe-based cache.

Since:

1.0.0

Author:

Álvaro Sánchez-Mariscal

See Also:

• CacheConfigurationBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EhcacheConfiguration.ClusteredDedicatedResourcePoolConfiguration	Clustered dedicated configuration.
static class	EhcacheConfiguration.ClusteredSharedResourcePoolConfiguration	Clustered shared configuration.
static class	EhcacheConfiguration.DiskTieredCacheConfiguration	Disk tier configuration options.
static class	EhcacheConfiguration.HeapTieredCacheConfiguration	Heap tier configuration properties.
static class	EhcacheConfiguration.OffheapTieredCacheConfiguration	Off-heap configuration options.

Field Summary

Fields

Modifier and Type	Field	Description
static final Class<?>	DEFAULT_KEY_TYPE
static final Long	DEFAULT_MAX_ENTRIES
static final Class<?>	DEFAULT_VALUE_TYPE
static final String	PREFIX

Constructor Summary

Constructors

Constructor	Description
EhcacheConfiguration(String name)

Method Summary

Modifier and Type	Method	Description
org.ehcache.config.builders.CacheConfigurationBuilder<?,?>	getBuilder()
EhcacheConfiguration.ClusteredDedicatedResourcePoolConfiguration	getClusteredDedicated()
EhcacheConfiguration.ClusteredSharedResourcePoolConfiguration	getClusteredShared()
EhcacheConfiguration.DiskTieredCacheConfiguration	getDisk()
EhcacheConfiguration.HeapTieredCacheConfiguration	getHeap()
Class<?>	getKeyType()
@NonNull String	getName()
EhcacheConfiguration.OffheapTieredCacheConfiguration	getOffheap()
Class<?>	getValueType()
void	setBuilder(org.ehcache.config.builders.CacheConfigurationBuilder builder)
void	setClusteredDedicated(EhcacheConfiguration.ClusteredDedicatedResourcePoolConfiguration clusteredDedicated)
void	setClusteredShared(EhcacheConfiguration.ClusteredSharedResourcePoolConfiguration clusteredShared)
void	setDisk(EhcacheConfiguration.DiskTieredCacheConfiguration disk)
void	setHeap(EhcacheConfiguration.HeapTieredCacheConfiguration heap)
void	setKeyType(Class<?> keyType)
void	setOffheap(EhcacheConfiguration.OffheapTieredCacheConfiguration offheap)
void	setValueType(Class<?> valueType)

Methods inherited from class java.lang.Object

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

Field Details

PREFIX

public static final String PREFIX

See Also:

• Constant Field Values

DEFAULT_KEY_TYPE

public static final Class<?> DEFAULT_KEY_TYPE

DEFAULT_VALUE_TYPE

public static final Class<?> DEFAULT_VALUE_TYPE

DEFAULT_MAX_ENTRIES

public static final Long DEFAULT_MAX_ENTRIES

Constructor Details

EhcacheConfiguration

public EhcacheConfiguration(@Parameter
 String name)

Parameters:

name - the cache name

Method Details

getBuilder

public org.ehcache.config.builders.CacheConfigurationBuilder<?,?> getBuilder()

Returns:

the configuration builder

setBuilder

public void setBuilder(org.ehcache.config.builders.CacheConfigurationBuilder builder)

Parameters:

builder - The cache configuration builder

getName

@NonNull
public @NonNull String getName()

Specified by:

getName in interface io.micronaut.core.naming.Named

getKeyType

public Class<?> getKeyType()

Returns:

The type of the keys in the cache

setKeyType

public void setKeyType(Class<?> keyType)

Parameters:

keyType - The type of the keys in the cache

getValueType

public Class<?> getValueType()

Returns:

The type of the values in the cache

setValueType

public void setValueType(Class<?> valueType)

Parameters:

valueType - The type of the values in the cache

getHeap

public EhcacheConfiguration.HeapTieredCacheConfiguration getHeap()

Returns:

the heap tier configuration

setHeap

public void setHeap(EhcacheConfiguration.HeapTieredCacheConfiguration heap)

Parameters:

heap - the heap tier configuration

getOffheap

public EhcacheConfiguration.OffheapTieredCacheConfiguration getOffheap()

Returns:

the off-heap configuration

setOffheap

public void setOffheap(EhcacheConfiguration.OffheapTieredCacheConfiguration offheap)

Parameters:

offheap - the off-heap configuration

getDisk

public EhcacheConfiguration.DiskTieredCacheConfiguration getDisk()

Returns:

the disk tier configuration

setDisk

public void setDisk(EhcacheConfiguration.DiskTieredCacheConfiguration disk)

Parameters:

disk - the disk tier configuration

getClusteredDedicated

public EhcacheConfiguration.ClusteredDedicatedResourcePoolConfiguration getClusteredDedicated()

Returns:

the clustered dedicated configuration

setClusteredDedicated

public void setClusteredDedicated(EhcacheConfiguration.ClusteredDedicatedResourcePoolConfiguration clusteredDedicated)

Parameters:

clusteredDedicated - the clustered dedicated configuration

getClusteredShared

public EhcacheConfiguration.ClusteredSharedResourcePoolConfiguration getClusteredShared()

Returns:

the clustered shared configuration

setClusteredShared

public void setClusteredShared(EhcacheConfiguration.ClusteredSharedResourcePoolConfiguration clusteredShared)

Parameters:

clusteredShared - the clustered shared configuration