Class CacheBuilder<K,V>

Method Details

• getName

  public 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 Class<K> getKeyClass()

  Retrieve the key class.

  Returns:

  the key class.

• getRemoteStoreNames

  public List<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 Duration getReadThroughRetryInterval()

  Retrieve the read through retry interval.

  Returns:

  the read through retry interval.

• getRegisterRemoteStoreRetryInterval

  public 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(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(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(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(List<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(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(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(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.