com.atlassian.vcache.internal.memcached

Class MemcachedVCacheServiceSettingsBuilder

java.lang.Object

com.atlassian.vcache.internal.memcached.MemcachedVCacheServiceSettingsBuilder

public class MemcachedVCacheServiceSettingsBuilder
extends java.lang.Object

Builder for creating MemcachedVCacheServiceSettings instances.

All settings must be set before build() can be called, except for metricsCollector(MetricsCollector), begunTransactionalActivityHandler(BegunTransactionalActivityHandler) and dontExternaliseCache(Function). See their Javadoc for the defaults used.

Either externalCacheKeyGenerator(ExternalCacheKeyGenerator) or productIdentifier(String) must be called.

Since:

1.3.0

Constructor Summary

Constructors

Constructor and Description
MemcachedVCacheServiceSettingsBuilder()

Method Summary

Modifier and Type	Method and Description
MemcachedVCacheServiceSettingsBuilder	begunTransactionalActivityHandler(com.atlassian.vcache.internal.BegunTransactionalActivityHandler handler) Sets the begun transaction activity handler.
MemcachedVCacheServiceSettings	build() Returns a new MemcachedVCacheServiceSettings instance configured using the supplied settings.
MemcachedVCacheServiceSettingsBuilder	clientSupplier(java.util.function.Supplier<net.spy.memcached.MemcachedClientIF> clientSupplier) Sets the client supplier.
MemcachedVCacheServiceSettingsBuilder	creationHandler(com.atlassian.vcache.internal.VCacheCreationHandler creationHandler) Set the creation handler.
MemcachedVCacheServiceSettingsBuilder	defaultsProvider(com.atlassian.vcache.internal.VCacheSettingsDefaultsProvider defaultsProvider) Sets the defaults provider.
MemcachedVCacheServiceSettingsBuilder	dontExternaliseCache(java.util.function.Function<java.lang.String,java.lang.Boolean> dontExternaliseCache) Sets the function to determine whether an ExternalCache should really be externalised.
MemcachedVCacheServiceSettingsBuilder	enableSerializationHack() Enable the serialization hack, whereby if an ExternalCache's values are Serializable, then the values are not marshalled before they are passed to the delegate Atlassian Cache.
MemcachedVCacheServiceSettingsBuilder	externalCacheExceptionListener(com.atlassian.vcache.internal.ExternalCacheExceptionListener externalCacheExceptionListener) Set the external cache exception listener.
MemcachedVCacheServiceSettingsBuilder	externalCacheKeyGenerator(com.atlassian.vcache.internal.core.ExternalCacheKeyGenerator externalCacheKeyGenerator) Set the external cache key generator.
MemcachedVCacheServiceSettingsBuilder	lockTimeout(java.time.Duration lockTimeout) Change the timeout that is used when acquiring locks.
MemcachedVCacheServiceSettingsBuilder	metricsCollector(com.atlassian.vcache.internal.core.metrics.MetricsCollector metricsCollector) Sets the metrics collector.
MemcachedVCacheServiceSettingsBuilder	productIdentifier(java.lang.String productIdentifier) Equivalent to calling externalCacheKeyGenerator(ExternalCacheKeyGenerator) passing a Sha1ExternalCacheKeyGenerator instance created using the supplied product identifier.
MemcachedVCacheServiceSettingsBuilder	threadLocalContextSupplier(java.util.function.Supplier<com.atlassian.vcache.internal.RequestContext> threadLocalContextSupplier) Sets the context supplier.
MemcachedVCacheServiceSettingsBuilder	workContextContextSupplier(java.util.function.Supplier<com.atlassian.vcache.internal.RequestContext> contextSupplier) Sets the context supplier for caches that can be thread safe.

Methods inherited from class java.lang.Object

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

Constructor Detail

MemcachedVCacheServiceSettingsBuilder

public MemcachedVCacheServiceSettingsBuilder()

Method Detail

clientSupplier

public MemcachedVCacheServiceSettingsBuilder clientSupplier(java.util.function.Supplier<net.spy.memcached.MemcachedClientIF> clientSupplier)

Sets the client supplier.

Parameters:

clientSupplier - the client supplier.

Returns:

the builder

threadLocalContextSupplier

public MemcachedVCacheServiceSettingsBuilder threadLocalContextSupplier(java.util.function.Supplier<com.atlassian.vcache.internal.RequestContext> threadLocalContextSupplier)

Sets the context supplier.

Parameters:

threadLocalContextSupplier - the context supplier.

Returns:

the builder.

workContextContextSupplier

public MemcachedVCacheServiceSettingsBuilder workContextContextSupplier(java.util.function.Supplier<com.atlassian.vcache.internal.RequestContext> contextSupplier)

Sets the context supplier for caches that can be thread safe.

Parameters:

contextSupplier - the context supplier.

Returns:

the builder.

defaultsProvider

public MemcachedVCacheServiceSettingsBuilder defaultsProvider(com.atlassian.vcache.internal.VCacheSettingsDefaultsProvider defaultsProvider)

Sets the defaults provider.

Parameters:

defaultsProvider - the defaults provider.

Returns:

the builder.

creationHandler

public MemcachedVCacheServiceSettingsBuilder creationHandler(com.atlassian.vcache.internal.VCacheCreationHandler creationHandler)

Set the creation handler.

Parameters:

creationHandler - the creation handler.

Returns:

the builder.

metricsCollector

public MemcachedVCacheServiceSettingsBuilder metricsCollector(com.atlassian.vcache.internal.core.metrics.MetricsCollector metricsCollector)

Sets the metrics collector. If not invoked, then the DefaultMetricsCollector implementation will be used.

Parameters:

metricsCollector - the metrics collector.

Returns:

the builder.

productIdentifier

public MemcachedVCacheServiceSettingsBuilder productIdentifier(java.lang.String productIdentifier)

Equivalent to calling externalCacheKeyGenerator(ExternalCacheKeyGenerator) passing a Sha1ExternalCacheKeyGenerator instance created using the supplied product identifier.

Parameters:

productIdentifier - the product identifier to use with the Sha1ExternalCacheKeyGenerator.

Returns:

the builder.

externalCacheKeyGenerator

public MemcachedVCacheServiceSettingsBuilder externalCacheKeyGenerator(com.atlassian.vcache.internal.core.ExternalCacheKeyGenerator externalCacheKeyGenerator)

Set the external cache key generator.

Parameters:

externalCacheKeyGenerator - the external cache key generator.

Returns:

the builder.

begunTransactionalActivityHandler

public MemcachedVCacheServiceSettingsBuilder begunTransactionalActivityHandler(com.atlassian.vcache.internal.BegunTransactionalActivityHandler handler)

Sets the begun transaction activity handler. If not invoked, then a default implementation is provided that does nothing.

Parameters:

handler - the begun transaction activity handler.

Returns:

the builder.

dontExternaliseCache

public MemcachedVCacheServiceSettingsBuilder dontExternaliseCache(java.util.function.Function<java.lang.String,java.lang.Boolean> dontExternaliseCache)

Sets the function to determine whether an ExternalCache should really be externalised. If the supplied function returns true for a cache, then an in-memory implementation will be used.

If not set, then a default implementation is provided that will externalise all ExternalCache's. nothing.

Note: this function is provided to allow for an orderly migration of external caches from being in-memory to be stored in Memcached.

Parameters:

dontExternaliseCache - the function to determine whether an ExternalCache should really be externalised.

Returns:

the builder.

enableSerializationHack

public MemcachedVCacheServiceSettingsBuilder enableSerializationHack()

Enable the serialization hack, whereby if an ExternalCache's values are Serializable, then the values are not marshalled before they are passed to the delegate Atlassian Cache. This is to allow for performance optimisations.

lockTimeout

public MemcachedVCacheServiceSettingsBuilder lockTimeout(java.time.Duration lockTimeout)

Change the timeout that is used when acquiring locks.

Parameters:

lockTimeout - the timeout that is used when acquiring locks.

Returns:

the current builder

externalCacheExceptionListener

public MemcachedVCacheServiceSettingsBuilder externalCacheExceptionListener(com.atlassian.vcache.internal.ExternalCacheExceptionListener externalCacheExceptionListener)

Set the external cache exception listener.

Parameters:

externalCacheExceptionListener - the external cache exception listener.

Returns:

the builder.

build

public MemcachedVCacheServiceSettings build()

Returns a new MemcachedVCacheServiceSettings instance configured using the supplied settings.

Returns:

a new MemcachedVCacheServiceSettings instance configured using the supplied settings.