com.scaleout.client.caching

Class CacheBuilder<K,V>

java.lang.Object

com.scaleout.client.caching.CacheBuilder<K,V>

Type Parameters:

K - the key type. Must be int, string, byte[], UUID or provide a custom KeyEncoder.

V - the value type.

public class CacheBuilder<K,V>
extends java.lang.Object

The CacheBuilder is used to instantiate a typed cache connected to a ScaleOut in-memory data grid.

Constructor Summary

Constructors

Constructor and Description
CacheBuilder(GridConnection connection, java.lang.String cacheName, java.lang.Class<K> keyClass) Instantiates a new CacheBuilder instance.
CacheBuilder(GridConnection connection, java.lang.String cacheName, java.lang.Class<K> keyClass, java.util.Properties properties) Instantiates a new CacheBuilder instance.
CacheBuilder(GridConnection connection, java.lang.String cacheName, KeyEncoder<K> keyEncoder, java.lang.Class<K> keyClass) Instantiates a new CacheBuilder instance.
CacheBuilder(GridConnection connection, java.lang.String cacheName, KeyEncoder<K> keyEncoder, java.lang.Class<K> keyClass, java.util.Properties properties) Instantiates a new CacheBuilder instance.

Method Summary

Modifier and Type	Method and Description
CacheBuilder<K,V>	addRemoteStoreName(java.lang.String remoteStoreName) Set the remote store name for GeoServerPull.
CacheBuilder<K,V>	addRemoteStoreNames(java.util.List<java.lang.String> remoteStoreNames) Set remote store names to use for GeoServerPull.
CacheBuilder<K,V>	backingStoreEventInterval(java.time.Duration interval) The interval the BackingStoreMode will use.
CacheBuilder<K,V>	backingStoreMode(BackingStoreMode mode) The BackingStoreMode the Cache will use.
Cache<K,V>	build() Instantiates a Cache connected to ScaleOut via the GridConnection.
CacheBuilder<K,V>	clientCache(ClientCache<K,V> clientCache) Assign a custom client cache implementation to this Cache.
CacheBuilder<K,V>	clientCacheCoherencyIntervalMs(long clientCacheCoherencyIntervalMs) The client cache will return the object if the coherency interval has not elapsed.
CacheBuilder<K,V>	clientCacheEntryWeigher(ClientCacheEntryWeigher<K,V> weigher) The ClientCacheEntryWeigher the ClientCache will use.
CacheBuilder<K,V>	clientCacheOptions(ClientCacheOptions clientCacheOptions) The ClientCacheOptions the ClientCache will use.
CacheBuilder<K,V>	clientCacheSize(int size) The size of the ClientCache.
CacheBuilder<K,V>	customSerialization(CacheSerializer<V> valueSerializer, CacheDeserializer<V> valueDeserializer) Set the value CacheSerializer and CacheDeserializer the Cache will use.
CacheBuilder<K,V>	disableLocalStringKeyCaching() Disables the in-memory string key cache.
CacheBuilder<K,V>	geoServerCoherencyInterval(java.time.Duration interval) Note, requires GeoServer Pro enabled license.
CacheBuilder<K,V>	geoServerCoherencyPolicy(GeoServerCoherencyPolicy policy) Note, GeoServerCoherencyPolicy.Poll and GeoServerCoherencyPolicy.Notify requires GeoServer Pro enabled license.
CacheBuilder<K,V>	geoServerPullPolicy(GeoServerPullPolicy policy) Note, requires GeoServer Pro enabled license.
CacheBuilder<K,V>	geoServerPushPolicy(GeoServerPushPolicy policy) The GeoServerPushPolicy the Cache will use.
CacheBuilder<K,V>	geoServerReadMode(GeoServerReadMode mode) The GeoServerReadMode the Cache will use.
ClientCache<K,V>	getClientCache() Retrieve the ClientCache.
long	getClientCacheCoherencyIntervalMs() Retrieve the client cache coherency interval in Ms
ClientCacheOptions	getClientCacheOptions() Retrieve the ClientCacheOptions the ClientCache will use.
int	getClientCacheSize() Retrieve the size of the ClientCache.
ClientCacheEntryWeigher<K,V>	getClientCacheWeigher() Retrieve the ClientCacheEntryWeigher the ClientCache will use.
GridConnection	getConnection() Retrieve the GridConnection the Cache will use.
CreatePolicy	getCreatePolicy() Retrieve the CreatePolicy the Cache will use.
CacheDeserializer<V>	getDeserializer() Retrieve the CacheDeserializer the Cache will use
GeoServerReadMode	getGeoServerReadMode() Retrieve the GeoServerReadMode the Cache will use.
java.lang.Class<K>	getKeyClass() Retrieve the key class.
KeyEncoder<K>	getKeyEncoder() Retrieve the KeyEncoder the Cache will use to encode keys.
int	getMaxReadThroughAttempts() Retrieve the max read through attempts.
int	getMaxRegisterRemoteStoreAttempts() Retrieve the max register remote store attempts.
java.lang.String	getName() Retrieve the name of the Cache this CacheBuilder will create.
ReadPolicy	getReadPolicy() Retrieve the ReadPolicy the Cache will use.
java.time.Duration	getReadThroughRetryInterval() Retrieve the read through retry interval.
java.time.Duration	getRegisterRemoteStoreRetryInterval() Retrieve the register remote store interval.
java.util.List<java.lang.String>	getRemoteStoreNames() Retrieve the remote store names.
CacheSerializer<V>	getSerializer() Retrieve the CacheSerializer the Cache will use
CacheBuilder<K,V>	objectTimeout(java.time.Duration objectTimeout) The timeout for objects stored in the ScaleOut Cache.
CacheBuilder<K,V>	objectTimeoutType(TimeoutType timeoutType) The TimeoutType the Cache will use.
CacheBuilder<K,V>	preemptionPriority(PreemptionPriority priority) The PreemptionPriority the Cache will use.
CacheBuilder<K,V>	raiseServiceEventForReadThrough() Tell the ScaleOut StateServer service to raise events for read through.
CacheBuilder<K,V>	setMaxReadThroughAttempts(int attempts) Specify the number of max read through attempts.
CacheBuilder<K,V>	setMaxRegisterRemoteStoreNameAttempts(int attempts) Specifies the number of attempts to retry setting the remote store.
CacheBuilder<K,V>	setReadThroughRetryInterval(java.time.Duration interval) Specify the amount of time the client will wait during a read through attempt.
CacheBuilder<K,V>	setRegisterRemoteStoreRetryInterval(java.time.Duration interval) Specifies the number of attempts to retry setting the remote store.
boolean	useAsyncReadThrough() Check to see if service events should raise an event for read through

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheBuilder

public CacheBuilder(GridConnection connection,
                    java.lang.String cacheName,
                    java.lang.Class<K> keyClass)

Instantiates a new CacheBuilder instance.

GridConnection is instantiated through the static method, GridConnection.connect(String).

The provided cacheName is used to logically separate Cache instances.

Parameters:

connection - an existing grid connection

cacheName - the cache name to use

keyClass - the key class. Note, must be Integer.class, byte[].class, UUID.class, or String.class

CacheBuilder

public CacheBuilder(GridConnection connection,
                    java.lang.String cacheName,
                    KeyEncoder<K> keyEncoder,
                    java.lang.Class<K> keyClass)

Instantiates a new CacheBuilder instance. GridConnection is instantiated through the static method, GridConnection.connect(String).

Parameters:

connection - an existing GridConnection.

cacheName - the cache name to use.

keyEncoder - the KeyEncoder.

keyClass - the key class.

CacheBuilder

public CacheBuilder(GridConnection connection,
                    java.lang.String cacheName,
                    KeyEncoder<K> keyEncoder,
                    java.lang.Class<K> keyClass,
                    java.util.Properties properties)

Instantiates a new CacheBuilder instance. GridConnection is instantiated through the static method, GridConnection.connect(String).

Parameters:

connection - an existing GridConnection.

cacheName - the cache name to use.

keyEncoder - the KeyEncoder.

keyClass - the key class.

properties - the properties to initialize this CacheBuilder from.

CacheBuilder

public CacheBuilder(GridConnection connection,
                    java.lang.String cacheName,
                    java.lang.Class<K> keyClass,
                    java.util.Properties properties)

Instantiates a new CacheBuilder instance. GridConnection is instantiated through the static method, GridConnection.connect(String).

Parameters:

connection - an existing GridConnection.

cacheName - the cache name to use.

keyClass - the key class.

properties - the properties to initialize this CacheBuilder from.

Method Detail

getName

public java.lang.String getName()

Retrieve the name of the Cache this CacheBuilder will create.

Returns:

the name of the Cache.

getConnection

public GridConnection getConnection()

Retrieve the GridConnection the Cache will use.

Returns:

the GridConnection.

getKeyEncoder

public KeyEncoder<K> getKeyEncoder()

Retrieve the KeyEncoder the Cache will use to encode keys.

Returns:

the KeyEncoder.

getSerializer

public CacheSerializer<V> getSerializer()

Retrieve the CacheSerializer the Cache will use

Returns:

the CacheSerializer.

getDeserializer

public CacheDeserializer<V> getDeserializer()

Retrieve the CacheDeserializer the Cache will use

Returns:

the CacheDeserializer.

getCreatePolicy

public CreatePolicy getCreatePolicy()

Retrieve the CreatePolicy the Cache will use.

Returns:

the CreatePolicy.

getReadPolicy

public ReadPolicy getReadPolicy()

Retrieve the ReadPolicy the Cache will use.

Returns:

the ReadPolicy.

getGeoServerReadMode

public GeoServerReadMode getGeoServerReadMode()

Retrieve the GeoServerReadMode the Cache will use.

Returns:

the GeoServerReadMode.

getClientCache

public ClientCache<K,V> getClientCache()

Retrieve the ClientCache.

Returns:

the client cache.

getClientCacheWeigher

public ClientCacheEntryWeigher<K,V> getClientCacheWeigher()

Retrieve the ClientCacheEntryWeigher the ClientCache will use.

Returns:

the ClientCacheEntryWeigher.

getClientCacheSize

public int getClientCacheSize()

Retrieve the size of the ClientCache.

Returns:

the size of the ClientCache.

getClientCacheOptions

public ClientCacheOptions getClientCacheOptions()

Retrieve the ClientCacheOptions the ClientCache will use.

Returns:

the ClientCacheOptions.

getClientCacheCoherencyIntervalMs

public long getClientCacheCoherencyIntervalMs()

Retrieve the client cache coherency interval in Ms

Returns:

the client cache coherency interval

getKeyClass

public java.lang.Class<K> getKeyClass()

Retrieve the key class.

Returns:

the key class.

getRemoteStoreNames

public java.util.List<java.lang.String> getRemoteStoreNames()

Retrieve the remote store names.

Returns:

the remote store names.

useAsyncReadThrough

public boolean useAsyncReadThrough()

Check to see if service events should raise an event for read through

Returns:

true if service events should raise an event for read through, false otherwise.

getMaxReadThroughAttempts

public int getMaxReadThroughAttempts()

Retrieve the max read through attempts.

Returns:

the max read through attempts.

getMaxRegisterRemoteStoreAttempts

public int getMaxRegisterRemoteStoreAttempts()

Retrieve the max register remote store attempts.

Returns:

the max register remote store attempts.

getReadThroughRetryInterval

public java.time.Duration getReadThroughRetryInterval()

Retrieve the read through retry interval.

Returns:

the read through retry interval.

getRegisterRemoteStoreRetryInterval

public java.time.Duration getRegisterRemoteStoreRetryInterval()

Retrieve the register remote store interval.

Returns:

the register remote store interval.

customSerialization

public CacheBuilder<K,V> customSerialization(CacheSerializer<V> valueSerializer,
                                             CacheDeserializer<V> valueDeserializer)

Set the value CacheSerializer and CacheDeserializer the Cache will use.

Parameters:

valueSerializer - the value serializer.

valueDeserializer - the value deserializer.

Returns:

this CacheBuilder.

geoServerCoherencyPolicy

public CacheBuilder<K,V> geoServerCoherencyPolicy(GeoServerCoherencyPolicy policy)

Note, GeoServerCoherencyPolicy.Poll and GeoServerCoherencyPolicy.Notify requires GeoServer Pro enabled license. Set the GeoServerCoherencyPolicy the Cache will use.

Parameters:

policy - the GeoServerCoherencyPolicy.

Returns:

this CacheBuilder.

geoServerCoherencyInterval

public CacheBuilder<K,V> geoServerCoherencyInterval(java.time.Duration interval)

Note, requires GeoServer Pro enabled license. If GeoServerCoherencyPolicy.Poll is used, set the interval for GeoServer polling operations.

Parameters:

interval - the interval to wait for polling operations.

Returns:

this CacheBuilder.

geoServerPullPolicy

public CacheBuilder<K,V> geoServerPullPolicy(GeoServerPullPolicy policy)

Note, requires GeoServer Pro enabled license. The GeoServerPullPolicy the Cache will use.

Parameters:

policy - the GeoServerPullPolicy.

Returns:

this CacheBuilder.

geoServerPushPolicy

public CacheBuilder<K,V> geoServerPushPolicy(GeoServerPushPolicy policy)

The GeoServerPushPolicy the Cache will use.

Parameters:

policy - the GeoServerPullPolicy.

Returns:

this CacheBuilder.

geoServerReadMode

public CacheBuilder<K,V> geoServerReadMode(GeoServerReadMode mode)

The GeoServerReadMode the Cache will use.

Parameters:

mode - the GeoServerReadMode.

Returns:

this CacheBuilder.

preemptionPriority

public CacheBuilder<K,V> preemptionPriority(PreemptionPriority priority)

The PreemptionPriority the Cache will use.

Parameters:

priority - the PreemptionPriority.

Returns:

this CacheBuilder.

objectTimeout

public CacheBuilder<K,V> objectTimeout(java.time.Duration objectTimeout)

The timeout for objects stored in the ScaleOut Cache.

Parameters:

objectTimeout - the timeout.

Returns:

this CacheBuilder.

objectTimeoutType

public CacheBuilder<K,V> objectTimeoutType(TimeoutType timeoutType)

The TimeoutType the Cache will use.

Parameters:

timeoutType - the TimeoutType.

Returns:

this CacheBuilder.

backingStoreMode

public CacheBuilder<K,V> backingStoreMode(BackingStoreMode mode)

The BackingStoreMode the Cache will use.

Parameters:

mode - the BackingStoreMode.

Returns:

this CacheBuilder.

backingStoreEventInterval

public CacheBuilder<K,V> backingStoreEventInterval(java.time.Duration interval)

The interval the BackingStoreMode will use. TODO replace with BackingStore class when finished

Parameters:

interval - the interval.

Returns:

this CacheBuilder.

clientCacheEntryWeigher

public CacheBuilder<K,V> clientCacheEntryWeigher(ClientCacheEntryWeigher<K,V> weigher)

The ClientCacheEntryWeigher the ClientCache will use.

Parameters:

weigher - the ClientCacheEntryWeigher.

Returns:

this CacheBuilder.

clientCacheSize

public CacheBuilder<K,V> clientCacheSize(int size)

The size of the ClientCache.

Parameters:

size - the size.

Returns:

this CacheBuilder.

clientCache

public CacheBuilder<K,V> clientCache(ClientCache<K,V> clientCache)

Assign a custom client cache implementation to this Cache.

Parameters:

clientCache - the client cache implemenation.

Returns:

this CacheBuilder

clientCacheOptions

public CacheBuilder<K,V> clientCacheOptions(ClientCacheOptions clientCacheOptions)

The ClientCacheOptions the ClientCache will use.

Parameters:

clientCacheOptions - the ClientCacheOptions.

Returns:

this CacheBuilder.

clientCacheCoherencyIntervalMs

public CacheBuilder<K,V> clientCacheCoherencyIntervalMs(long clientCacheCoherencyIntervalMs)

The client cache will return the object if the coherency interval has not elapsed. Default is 0 (disabled).

Parameters:

clientCacheCoherencyIntervalMs - the coherency interval

Returns:

this CacheBuilder.

raiseServiceEventForReadThrough

public CacheBuilder<K,V> raiseServiceEventForReadThrough()

Tell the ScaleOut StateServer service to raise events for read through.

Returns:

this builder.

addRemoteStoreNames

public CacheBuilder<K,V> addRemoteStoreNames(java.util.List<java.lang.String> remoteStoreNames)

Set remote store names to use for GeoServerPull.

Parameters:

remoteStoreNames - a list of the remote store names.

Returns:

this.

addRemoteStoreName

public CacheBuilder<K,V> addRemoteStoreName(java.lang.String remoteStoreName)

Set the remote store name for GeoServerPull.

Parameters:

remoteStoreName - the remote store name.

Returns:

this.

setMaxReadThroughAttempts

public CacheBuilder<K,V> setMaxReadThroughAttempts(int attempts)

Specify the number of max read through attempts. A read through attempt is performed when a value factory is supplied to ServiceEvents.setLoadObjectHandler(Cache, ValueFactory) or when using Cache.readOrAdd(Object, ValueFactory, ReadPolicy) and Cache.readOrAddAsync(Object, ValueFactory, ReadPolicy).

Parameters:

attempts - number of attempts.

Returns:

this.

setReadThroughRetryInterval

public CacheBuilder<K,V> setReadThroughRetryInterval(java.time.Duration interval)

Specify the amount of time the client will wait during a read through attempt. A read through attempt is performed when a value factory is supplied to ServiceEvents.setLoadObjectHandler(Cache, ValueFactory) or when using Cache.readOrAdd(Object, ValueFactory, ReadPolicy) and Cache.readOrAddAsync(Object, ValueFactory, ReadPolicy).

Parameters:

interval - number of attempts.

Returns:

this.

setMaxRegisterRemoteStoreNameAttempts

public CacheBuilder<K,V> setMaxRegisterRemoteStoreNameAttempts(int attempts)

Specifies the number of attempts to retry setting the remote store. If an operation which requires a remote store (Cache.readAndLock(Object)) is attempted, and no remote store has been set, the client will automatically attempt to reset the remote store.

Parameters:

attempts - the attempts.

Returns:

this builder.

setRegisterRemoteStoreRetryInterval

public CacheBuilder<K,V> setRegisterRemoteStoreRetryInterval(java.time.Duration interval)

Specifies the number of attempts to retry setting the remote store. If an operation which requires a remote store (Cache.readAndLock(Object)) is attempted, and no remote store has been set, the client will automatically attempt to reset the remote store.

Parameters:

interval - the interval

Returns:

this builder.

disableLocalStringKeyCaching

public CacheBuilder<K,V> disableLocalStringKeyCaching()

Disables the in-memory string key cache.

Returns:

this builder.

build

public Cache<K,V> build()

Instantiates a Cache connected to ScaleOut via the GridConnection.

Returns:

the Cache.