io.micronaut.configuration.lettuce.cache

Class RedisCacheConfiguration

java.lang.Object

io.micronaut.configuration.lettuce.cache.RedisCacheConfiguration

@EachProperty(value="redis.caches")
public class RedisCacheConfiguration
extends Object

Allows configuration of caches stored in Redis.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields

Modifier and Type	Field and Description
protected String	cacheName
protected Charset	charset
protected Duration	expireAfterAccess
protected Duration	expireAfterWrite
protected Class<io.micronaut.core.serialize.ObjectSerializer>	keySerializer
protected String	server
protected Class<io.micronaut.core.serialize.ObjectSerializer>	valueSerializer

Constructor Summary

Constructors

Constructor and Description
RedisCacheConfiguration(String cacheName, io.micronaut.runtime.ApplicationConfiguration applicationConfiguration) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getCacheName()
Charset	getCharset()
Optional<Duration>	getExpireAfterAccess() Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation, the most recent replacement of its value, or its last read.
Optional<Duration>	getExpireAfterWrite()
Optional<Class<io.micronaut.core.serialize.ObjectSerializer>>	getKeySerializer() The ObjectSerializer to use for serializing keys.
Optional<String>	getServer()
Optional<Class<io.micronaut.core.serialize.ObjectSerializer>>	getValueSerializer()
void	setCharset(Charset charset)
void	setExpireAfterAccess(Duration expireAfterAccess)
void	setExpireAfterWrite(Duration expireAfterWrite)

Methods inherited from class java.lang.Object

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

Field Detail

server

protected String server

keySerializer

protected Class<io.micronaut.core.serialize.ObjectSerializer> keySerializer

valueSerializer

protected Class<io.micronaut.core.serialize.ObjectSerializer> valueSerializer

charset

protected Charset charset

expireAfterWrite

protected Duration expireAfterWrite

expireAfterAccess

protected Duration expireAfterAccess

cacheName

protected final String cacheName

Constructor Detail

RedisCacheConfiguration

public RedisCacheConfiguration(@Parameter
                               String cacheName,
                               io.micronaut.runtime.ApplicationConfiguration applicationConfiguration)

Constructor.

Parameters:

cacheName - cacheName

applicationConfiguration - applicationConfiguration

Method Detail

getServer

public Optional<String> getServer()

Returns:

The name of the server to use.

See Also:

NamedRedisServersConfiguration

getValueSerializer

public Optional<Class<io.micronaut.core.serialize.ObjectSerializer>> getValueSerializer()

Returns:

The ObjectSerializer type to use for serializing values.

getKeySerializer

public Optional<Class<io.micronaut.core.serialize.ObjectSerializer>> getKeySerializer()

The ObjectSerializer to use for serializing keys. Defaults to DefaultStringKeySerializer.

Returns:

The optional ObjectSerializer class

getCacheName

public String getCacheName()

Returns:

The name of the cache

getExpireAfterWrite

public Optional<Duration> getExpireAfterWrite()

Returns:

The expiry to use after the value is written

getExpireAfterAccess

public Optional<Duration> getExpireAfterAccess()

Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation, the most recent replacement of its value, or its last read.

Returns:

The Duration

getCharset

public Charset getCharset()

Returns:

The charset used to serialize and deserialize values

setExpireAfterWrite

public void setExpireAfterWrite(Duration expireAfterWrite)

Parameters:

expireAfterWrite - The cache expiration duration after writing into it.

setExpireAfterAccess

public void setExpireAfterAccess(Duration expireAfterAccess)

Parameters:

expireAfterAccess - The cache expiration duration after accessing it

setCharset

public void setCharset(Charset charset)

Parameters:

charset - The charset used to serialize and deserialize values