org.springframework.data.couchbase.cache

Class CouchbaseCacheManager.CouchbaseCacheManagerBuilder

java.lang.Object

org.springframework.data.couchbase.cache.CouchbaseCacheManager.CouchbaseCacheManagerBuilder

Enclosing class:

CouchbaseCacheManager

public static class CouchbaseCacheManager.CouchbaseCacheManagerBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
CouchbaseCacheManager	build() Create new instance of CouchbaseCacheManager with configuration options applied.
CouchbaseCacheManager.CouchbaseCacheManagerBuilder	cacheDefaults(CouchbaseCacheConfiguration defaultCacheConfiguration) Define a default CouchbaseCacheConfiguration applied to dynamically created CouchbaseCaches.
CouchbaseCacheManager.CouchbaseCacheManagerBuilder	disableCreateOnMissingCache() Disable in-flight Cache creation for unconfigured caches.
static CouchbaseCacheManager.CouchbaseCacheManagerBuilder	fromCacheWriter(CouchbaseCacheWriter cacheWriter) Entry point for builder style CouchbaseCacheManager configuration.
static CouchbaseCacheManager.CouchbaseCacheManagerBuilder	fromConnectionFactory(CouchbaseClientFactory clientFactory) Entry point for builder style CouchbaseCacheManager configuration.
Optional<CouchbaseCacheConfiguration>	getCacheConfigurationFor(String cacheName) Get the CouchbaseCacheConfiguration for a given cache by its name.
Set<String>	getConfiguredCaches() Get the Set of cache names for which the builder holds configuration.
CouchbaseCacheManager.CouchbaseCacheManagerBuilder	initialCacheNames(Set<String> cacheNames) Append a Set of cache names to be pre initialized with current CouchbaseCacheConfiguration.
CouchbaseCacheManager.CouchbaseCacheManagerBuilder	transactionAware() Enable CouchbaseCaches to synchronize cache put/evict operations with ongoing Spring-managed transactions.
CouchbaseCacheManager.CouchbaseCacheManagerBuilder	withCacheConfiguration(String cacheName, CouchbaseCacheConfiguration cacheConfiguration)
CouchbaseCacheManager.CouchbaseCacheManagerBuilder	withInitialCacheConfigurations(Map<String,CouchbaseCacheConfiguration> cacheConfigurations) Append a Map of cache name/CouchbaseCacheConfiguration pairs to be pre initialized.

Methods inherited from class java.lang.Object

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

Method Detail

fromConnectionFactory

public static CouchbaseCacheManager.CouchbaseCacheManagerBuilder fromConnectionFactory(CouchbaseClientFactory clientFactory)

Entry point for builder style CouchbaseCacheManager configuration.

Parameters:

clientFactory - must not be null.

Returns:

new CouchbaseCacheManager.CouchbaseCacheManagerBuilder.

fromCacheWriter

public static CouchbaseCacheManager.CouchbaseCacheManagerBuilder fromCacheWriter(CouchbaseCacheWriter cacheWriter)

Entry point for builder style CouchbaseCacheManager configuration.

Parameters:

cacheWriter - must not be null.

Returns:

new CouchbaseCacheManager.CouchbaseCacheManagerBuilder.

cacheDefaults

public CouchbaseCacheManager.CouchbaseCacheManagerBuilder cacheDefaults(CouchbaseCacheConfiguration defaultCacheConfiguration)

Define a default CouchbaseCacheConfiguration applied to dynamically created CouchbaseCaches.

Parameters:

defaultCacheConfiguration - must not be null.

Returns:

this CouchbaseCacheManager.CouchbaseCacheManagerBuilder.

transactionAware

public CouchbaseCacheManager.CouchbaseCacheManagerBuilder transactionAware()

Enable CouchbaseCaches to synchronize cache put/evict operations with ongoing Spring-managed transactions.

Returns:

this CouchbaseCacheManager.CouchbaseCacheManagerBuilder.

initialCacheNames

public CouchbaseCacheManager.CouchbaseCacheManagerBuilder initialCacheNames(Set<String> cacheNames)

Append a Set of cache names to be pre initialized with current CouchbaseCacheConfiguration. NOTE: This calls depends on cacheDefaults(CouchbaseCacheConfiguration) using whatever default CouchbaseCacheConfiguration is present at the time of invoking this method.

Parameters:

cacheNames - must not be null.

Returns:

this CouchbaseCacheManager.CouchbaseCacheManagerBuilder.

withInitialCacheConfigurations

public CouchbaseCacheManager.CouchbaseCacheManagerBuilder withInitialCacheConfigurations(Map<String,CouchbaseCacheConfiguration> cacheConfigurations)

Append a Map of cache name/CouchbaseCacheConfiguration pairs to be pre initialized.

Parameters:

cacheConfigurations - must not be null.

Returns:

this CouchbaseCacheManager.CouchbaseCacheManagerBuilder.

withCacheConfiguration

public CouchbaseCacheManager.CouchbaseCacheManagerBuilder withCacheConfiguration(String cacheName,
                                                                                 CouchbaseCacheConfiguration cacheConfiguration)

Parameters:

cacheName -

cacheConfiguration -

Returns:

this CouchbaseCacheManager.CouchbaseCacheManagerBuilder.

disableCreateOnMissingCache

public CouchbaseCacheManager.CouchbaseCacheManagerBuilder disableCreateOnMissingCache()

Disable in-flight Cache creation for unconfigured caches.

CouchbaseCacheManager.getMissingCache(String) returns null for any unconfigured Cache instead of a new CouchbaseCache instance. This allows eg. CompositeCacheManager to chime in.

Returns:

this CouchbaseCacheManager.CouchbaseCacheManagerBuilder.

getConfiguredCaches

public Set<String> getConfiguredCaches()

Get the Set of cache names for which the builder holds configuration.

Returns:

an unmodifiable Set holding the name of caches for which a configuration has been set.

getCacheConfigurationFor

public Optional<CouchbaseCacheConfiguration> getCacheConfigurationFor(String cacheName)

Get the CouchbaseCacheConfiguration for a given cache by its name.

Parameters:

cacheName - must not be null.

Returns:

Optional.empty() if no CouchbaseCacheConfiguration set for the given cache name.

build

public CouchbaseCacheManager build()

Create new instance of CouchbaseCacheManager with configuration options applied.

Returns:

new instance of CouchbaseCacheManager.