public class CouchbaseCacheConfiguration extends Object
Modifier and Type | Method and Description |
---|---|
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.
|
public static CouchbaseCacheConfiguration defaultCacheConfig()
public static void registerDefaultConverters(ConverterRegistry registry)
registry
- must not be null.public CouchbaseCacheConfiguration entryExpiry(Duration expiry)
Duration.ZERO
to declare an eternal cache.expiry
- must not be null.CouchbaseCacheConfiguration
.public CouchbaseCacheConfiguration valueTranscoder(com.couchbase.client.java.codec.Transcoder valueTranscoder)
valueTranscoder
- the transcoder that should be used.CouchbaseCacheConfiguration
.public CouchbaseCacheConfiguration disableCachingNullValues()
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.CouchbaseCacheConfiguration
.public CouchbaseCacheConfiguration prefixCacheNameWith(String prefix)
cache name
with the given value. prefix + cache name + "::" + cache entry key
.prefix
- the prefix to prepend to the cache name.computePrefixWith(CacheKeyPrefix)
,
CacheKeyPrefix.prefixed(String)
public CouchbaseCacheConfiguration computePrefixWith(CacheKeyPrefix cacheKeyPrefix)
CacheKeyPrefix
to compute the prefix for the actual Couchbase key given the
cache name as function input.cacheKeyPrefix
- must not be null.CouchbaseCacheConfiguration
.CacheKeyPrefix
public Duration getExpiry()
public boolean getAllowCacheNullValues()
public ConversionService getConversionService()
ConversionService
used for cache key to String
conversion. Never null.public boolean usePrefix()
getKeyPrefixFor(String)
if present or
the default which resolves to Cache.getName()
.public String getKeyPrefixFor(String cacheName)
public com.couchbase.client.java.codec.Transcoder getValueTranscoder()
public String getCollectionName()
Copyright © 2011–2021 Pivotal Software, Inc.. All rights reserved.