Package org.springframework.data.couchbase.cache

Class CouchbaseCacheConfiguration

java.lang.Object

org.springframework.data.couchbase.cache.CouchbaseCacheConfiguration

public class CouchbaseCacheConfiguration
extends Object

Method Summary

Modifier and Type	Method	Description
CouchbaseCacheConfiguration	collection(String collectionName)	Set the collectinName to use.
CouchbaseCacheConfiguration	computePrefixWith(CacheKeyPrefix cacheKeyPrefix)	Use the given CacheKeyPrefix to compute the prefix for the actual Couchbase key given the cache name as function input.
static CouchbaseCacheConfiguration	defaultCacheConfig()
CouchbaseCacheConfiguration	disableCachingNullValues()	Disable caching null values.
CouchbaseCacheConfiguration	entryExpiry(Duration expiry)	Set the expiry to apply for cache entries.
boolean	getAllowCacheNullValues()
String	getCollectionName()	The name of the collection to use for this cache - if empty uses the default collection.
ConversionService	getConversionService()
Duration	getExpiry()
String	getKeyPrefixFor(String cacheName)	Get the computed key prefix for a given cacheName.
com.couchbase.client.java.codec.Transcoder	getValueTranscoder()	Get the transcoder for encoding and decoding cache values.
CouchbaseCacheConfiguration	prefixCacheNameWith(String prefix)	Prefix the cache name with the given value.
static void	registerDefaultConverters(ConverterRegistry registry)	Registers default cache key converters.
boolean	usePrefix()
CouchbaseCacheConfiguration	valueTranscoder(com.couchbase.client.java.codec.Transcoder valueTranscoder)	Sets a custom transcoder to use for reads and writes.

Methods inherited from class java.lang.Object

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

Method Details

defaultCacheConfig

public static CouchbaseCacheConfiguration defaultCacheConfig()

registerDefaultConverters

public static void registerDefaultConverters(ConverterRegistry registry)

Registers default cache key converters. The following converters get registered:

• String to byte[] using UTF-8 encoding.
• SimpleKey to String

Parameters:

registry - must not be null.

entryExpiry

public CouchbaseCacheConfiguration entryExpiry(Duration expiry)

Set the expiry to apply for cache entries. Use Duration.ZERO to declare an eternal cache.

Parameters:

expiry - must not be null.

Returns:

new CouchbaseCacheConfiguration.

collection

public CouchbaseCacheConfiguration collection(String collectionName)

Set the collectinName to use.

Parameters:

collectionName - must not be null.

Returns:

new CouchbaseCacheConfiguration.

valueTranscoder

public CouchbaseCacheConfiguration valueTranscoder(com.couchbase.client.java.codec.Transcoder valueTranscoder)

Sets a custom transcoder to use for reads and writes.

Parameters:

valueTranscoder - the transcoder that should be used.

Returns:

new CouchbaseCacheConfiguration.

disableCachingNullValues

public CouchbaseCacheConfiguration disableCachingNullValues()

Disable caching null values.
NOTE any Cache.put(Object, Object) operation involving null value will error. Nothing will be written to Couchbase, nothing will be removed. An already existing key will still be there afterwards with the very same value as before.

Returns:

new CouchbaseCacheConfiguration.

prefixCacheNameWith

public CouchbaseCacheConfiguration prefixCacheNameWith(String prefix)

Prefix the cache name with the given value.
The generated cache key will be: prefix + cache name + "::" + cache entry key.

Parameters:

prefix - the prefix to prepend to the cache name.

Returns:

this.

See Also:

• computePrefixWith(CacheKeyPrefix)
• CacheKeyPrefix.prefixed(String)

computePrefixWith

public CouchbaseCacheConfiguration computePrefixWith(CacheKeyPrefix cacheKeyPrefix)

Use the given CacheKeyPrefix to compute the prefix for the actual Couchbase key given the cache name as function input.

Parameters:

cacheKeyPrefix - must not be null.

Returns:

new CouchbaseCacheConfiguration.

See Also:

• CacheKeyPrefix

getExpiry

public Duration getExpiry()

Returns:

The expiration time (ttl) for cache entries. Never null.

getAllowCacheNullValues

public boolean getAllowCacheNullValues()

Returns:

true if caching null is allowed.

getConversionService

public ConversionService getConversionService()

Returns:

The ConversionService used for cache key to String conversion. Never null.

usePrefix

public boolean usePrefix()

Returns:

true if cache keys need to be prefixed with the getKeyPrefixFor(String) if present or the default which resolves to Cache.getName().

getKeyPrefixFor

public String getKeyPrefixFor(String cacheName)

Get the computed key prefix for a given cacheName.

Returns:

never null.

getValueTranscoder

public com.couchbase.client.java.codec.Transcoder getValueTranscoder()

Get the transcoder for encoding and decoding cache values.

getCollectionName

public String getCollectionName()

The name of the collection to use for this cache - if empty uses the default collection.