ar.com.siripo.arcache.backend.speedup

Class ArcacheSpeedupClient

java.lang.Object

ar.com.siripo.arcache.backend.speedup.ArcacheSpeedupClient

All Implemented Interfaces:

ArcacheBackendClient, ArcacheSpeedupConfigurationGetInterface, ArcacheSpeedupConfigurationSetInterface

public class ArcacheSpeedupClient
extends Object
implements ArcacheBackendClient, ArcacheSpeedupConfigurationSetInterface, ArcacheSpeedupConfigurationGetInterface

This is a local memory proxy of another backend. The purpose is speed up the access to a slow backend.

Author:

Mariano Santamarina

Field Summary

Fields

Modifier and Type	Field and Description
protected ArcacheBackendClient	backendClient
protected boolean	cacheIsolation
protected ProbabilityFunction	expirationProbabilityFunction
protected boolean	initialized
protected ArcacheInMemoryClient	invalidationKeysCache
protected int	invalidationKeysCacheSize
protected long	invalidationKeysExpirationMillis
protected ArcacheInMemoryClient	missesCache
protected int	missesCacheSize
protected long	missesExpirationMillis
protected ArcacheInMemoryClient	objectsCache
protected int	objectsCacheSize
protected long	objectsExpirationMillis
protected boolean	protectAgainstBackendFailures
protected Random	random
protected long	speedupCacheTTLMillis
protected ArcacheSpeedupTracker	tracker

Constructor Summary

Constructors

Constructor and Description
ArcacheSpeedupClient()

Method Summary

Modifier and Type	Method and Description
Future<Object>	asyncGet(String key)
Future<Boolean>	asyncSet(String key, long ttlMillis, Object value)
void	clear()
protected ar.com.siripo.arcache.backend.speedup.FutureBackendGetWrapper	createFutureBackendGetWrapper(Future<Object> backendFuture, String key)
protected SpeedupCacheObject	createSpeedupCacheObject(Object value)
ArcacheBackendClient	getBackendClient() Get the inner backend client
boolean	getCacheIsolation()
ProbabilityFunction	getExpirationProbabilityFunction() Get the probability function to be used in expiration evaluation
int	getInvalidationKeysCacheSize() Get the maximum size of invalidationKeys Cache in number of elements
long	getInvalidationKeysExpirationMillis() Get the expiration of the stored values in milliseconds
int	getMissesCacheSize() Get the maximum size of misses Cache in number of elements
long	getMissesExpirationMillis() Get the expiration of the stored values in milliseconds
int	getObjectsCacheSize() Get the maximum size of objects Cache in number of elements
long	getObjectsExpirationMillis() Get the expiration of the stored values in milliseconds
boolean	getProtectAgainstBackendFailures() Allow some protection against backend failures.
long	getSpeedupCacheTTLMillis() Get the speedup cache ttl in milli seconds, this value must be restricted by the cache size, the ttl is allowed to make a hard expiration if its needed.
ArcacheSpeedupTracker	getTracker() Get a tracker to keep control of speedup performance and malfunctions
void	initialize()
protected RestoredSpeedupCacheObject	restoreObjectFromAnySpeedupCache(String key)
protected RestoredSpeedupCacheObject	restoreObjectFromSpeedupCache(String key, ArcacheInMemoryClient speedupCache, long timeoutMillis)
void	setBackendClient(ArcacheBackendClient backendClient) Set the inner backend client
void	setCacheIsolation(boolean cacheIsolation) Enable the cache isolation (disabled by default), when cache isolation is enabled, the stored objects are immutable but with an performance cost.
void	setExpirationProbabilityFunction(ProbabilityFunction probabilityFunction) Set the probability function to be used in expiration evaluation
void	setInvalidationKeysCacheSize(int cacheSize) Set the maximum size of invalidationKeys Cache in number of elements
void	setInvalidationKeysExpirationMillis(long expirationMillis) Set the expiration of the stored values in milliseconds
void	setMissesCacheSize(int cacheSize) Set the maximum size of misses Cache in number of elements
void	setMissesExpirationMillis(long expirationMillis) Set the expiration of the stored values in milliseconds
void	setObjectsCacheSize(int cacheSize) Set the maximum size of objects Cache in number of elements
void	setObjectsExpirationMillis(long expirationMillis) Set the expiration of the stored values in milliseconds
void	setProtectAgainstBackendFailures(boolean protect) Allow some protection against backend failures.
void	setSpeedupCacheTTLMillis(long ttlMillis) Set the speedup cache ttl in milli seconds, this value must be restricted by the cache size, the ttl is allowed to make a hard expiration if its needed.
void	setTracker(ArcacheSpeedupTracker tracker) Set a tracker to keep control of speedup performance and malfunctions
protected ArcacheInMemoryClient	storeSpeedupCache(String key, Object value)
protected void	validateSetCacheSize(int cachesize)
protected void	validateSetExpirationMillis(long expirationMillis)

Methods inherited from class java.lang.Object

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

Field Detail

backendClient

protected ArcacheBackendClient backendClient

invalidationKeysCacheSize

protected int invalidationKeysCacheSize

objectsCacheSize

protected int objectsCacheSize

missesCacheSize

protected int missesCacheSize

invalidationKeysExpirationMillis

protected long invalidationKeysExpirationMillis

objectsExpirationMillis

protected long objectsExpirationMillis

missesExpirationMillis

protected long missesExpirationMillis

protectAgainstBackendFailures

protected boolean protectAgainstBackendFailures

speedupCacheTTLMillis

protected long speedupCacheTTLMillis

expirationProbabilityFunction

protected ProbabilityFunction expirationProbabilityFunction

tracker

protected ArcacheSpeedupTracker tracker

cacheIsolation

protected boolean cacheIsolation

invalidationKeysCache

protected ArcacheInMemoryClient invalidationKeysCache

objectsCache

protected ArcacheInMemoryClient objectsCache

missesCache

protected ArcacheInMemoryClient missesCache

initialized

protected boolean initialized

random

protected Random random

Constructor Detail

ArcacheSpeedupClient

public ArcacheSpeedupClient()

Method Detail

setBackendClient

public void setBackendClient(ArcacheBackendClient backendClient)

Description copied from interface: ArcacheSpeedupConfigurationSetInterface

Set the inner backend client

Specified by:

setBackendClient in interface ArcacheSpeedupConfigurationSetInterface

setInvalidationKeysCacheSize

public void setInvalidationKeysCacheSize(int cacheSize)

Description copied from interface: ArcacheSpeedupConfigurationSetInterface

Set the maximum size of invalidationKeys Cache in number of elements

Specified by:

setInvalidationKeysCacheSize in interface ArcacheSpeedupConfigurationSetInterface

setObjectsCacheSize

public void setObjectsCacheSize(int cacheSize)

Description copied from interface: ArcacheSpeedupConfigurationSetInterface

Set the maximum size of objects Cache in number of elements

Specified by:

setObjectsCacheSize in interface ArcacheSpeedupConfigurationSetInterface

setMissesCacheSize

public void setMissesCacheSize(int cacheSize)

Description copied from interface: ArcacheSpeedupConfigurationSetInterface

Set the maximum size of misses Cache in number of elements

Specified by:

setMissesCacheSize in interface ArcacheSpeedupConfigurationSetInterface

setInvalidationKeysExpirationMillis

public void setInvalidationKeysExpirationMillis(long expirationMillis)

Description copied from interface: ArcacheSpeedupConfigurationSetInterface

Set the expiration of the stored values in milliseconds

Specified by:

setInvalidationKeysExpirationMillis in interface ArcacheSpeedupConfigurationSetInterface

setObjectsExpirationMillis

public void setObjectsExpirationMillis(long expirationMillis)

Description copied from interface: ArcacheSpeedupConfigurationSetInterface

Set the expiration of the stored values in milliseconds

Specified by:

setObjectsExpirationMillis in interface ArcacheSpeedupConfigurationSetInterface

setMissesExpirationMillis

public void setMissesExpirationMillis(long expirationMillis)

Description copied from interface: ArcacheSpeedupConfigurationSetInterface

Set the expiration of the stored values in milliseconds

Specified by:

setMissesExpirationMillis in interface ArcacheSpeedupConfigurationSetInterface

setProtectAgainstBackendFailures

public void setProtectAgainstBackendFailures(boolean protect)

Description copied from interface: ArcacheSpeedupConfigurationSetInterface

Allow some protection against backend failures. For example if a get backend operation fails with an TimeoutException, and the local cache has the value expired, then this is returned

Specified by:

setProtectAgainstBackendFailures in interface ArcacheSpeedupConfigurationSetInterface

setSpeedupCacheTTLMillis

public void setSpeedupCacheTTLMillis(long ttlMillis)

Description copied from interface: ArcacheSpeedupConfigurationSetInterface

Set the speedup cache ttl in milli seconds, this value must be restricted by the cache size, the ttl is allowed to make a hard expiration if its needed. By default this value is a year

Specified by:

setSpeedupCacheTTLMillis in interface ArcacheSpeedupConfigurationSetInterface

setExpirationProbabilityFunction

public void setExpirationProbabilityFunction(ProbabilityFunction probabilityFunction)

Description copied from interface: ArcacheSpeedupConfigurationSetInterface

Set the probability function to be used in expiration evaluation

Specified by:

setExpirationProbabilityFunction in interface ArcacheSpeedupConfigurationSetInterface

setTracker

public void setTracker(ArcacheSpeedupTracker tracker)

Description copied from interface: ArcacheSpeedupConfigurationSetInterface

Set a tracker to keep control of speedup performance and malfunctions

Specified by:

setTracker in interface ArcacheSpeedupConfigurationSetInterface

getBackendClient

public ArcacheBackendClient getBackendClient()

Description copied from interface: ArcacheSpeedupConfigurationGetInterface

Get the inner backend client

Specified by:

getBackendClient in interface ArcacheSpeedupConfigurationGetInterface

getInvalidationKeysCacheSize

public int getInvalidationKeysCacheSize()

Description copied from interface: ArcacheSpeedupConfigurationGetInterface

Get the maximum size of invalidationKeys Cache in number of elements

Specified by:

getInvalidationKeysCacheSize in interface ArcacheSpeedupConfigurationGetInterface

getObjectsCacheSize

public int getObjectsCacheSize()

Description copied from interface: ArcacheSpeedupConfigurationGetInterface

Get the maximum size of objects Cache in number of elements

Specified by:

getObjectsCacheSize in interface ArcacheSpeedupConfigurationGetInterface

getMissesCacheSize

public int getMissesCacheSize()

Description copied from interface: ArcacheSpeedupConfigurationGetInterface

Get the maximum size of misses Cache in number of elements

Specified by:

getMissesCacheSize in interface ArcacheSpeedupConfigurationGetInterface

getInvalidationKeysExpirationMillis

public long getInvalidationKeysExpirationMillis()

Description copied from interface: ArcacheSpeedupConfigurationGetInterface

Get the expiration of the stored values in milliseconds

Specified by:

getInvalidationKeysExpirationMillis in interface ArcacheSpeedupConfigurationGetInterface

getObjectsExpirationMillis

public long getObjectsExpirationMillis()

Description copied from interface: ArcacheSpeedupConfigurationGetInterface

Get the expiration of the stored values in milliseconds

Specified by:

getObjectsExpirationMillis in interface ArcacheSpeedupConfigurationGetInterface

getMissesExpirationMillis

public long getMissesExpirationMillis()

Description copied from interface: ArcacheSpeedupConfigurationGetInterface

Get the expiration of the stored values in milliseconds

Specified by:

getMissesExpirationMillis in interface ArcacheSpeedupConfigurationGetInterface

getProtectAgainstBackendFailures

public boolean getProtectAgainstBackendFailures()

Description copied from interface: ArcacheSpeedupConfigurationGetInterface

Allow some protection against backend failures. For example if a get backend operation fails with an TimeoutException, and the local cache has the value expired, then this is returned

Specified by:

getProtectAgainstBackendFailures in interface ArcacheSpeedupConfigurationGetInterface

getSpeedupCacheTTLMillis

public long getSpeedupCacheTTLMillis()

Description copied from interface: ArcacheSpeedupConfigurationGetInterface

Get the speedup cache ttl in milli seconds, this value must be restricted by the cache size, the ttl is allowed to make a hard expiration if its needed. By default this value is a year

Specified by:

getSpeedupCacheTTLMillis in interface ArcacheSpeedupConfigurationGetInterface

getExpirationProbabilityFunction

public ProbabilityFunction getExpirationProbabilityFunction()

Description copied from interface: ArcacheSpeedupConfigurationGetInterface

Get the probability function to be used in expiration evaluation

Specified by:

getExpirationProbabilityFunction in interface ArcacheSpeedupConfigurationGetInterface

getTracker

public ArcacheSpeedupTracker getTracker()

Description copied from interface: ArcacheSpeedupConfigurationGetInterface

Get a tracker to keep control of speedup performance and malfunctions

Specified by:

getTracker in interface ArcacheSpeedupConfigurationGetInterface

getCacheIsolation

public boolean getCacheIsolation()

Specified by:

getCacheIsolation in interface ArcacheSpeedupConfigurationGetInterface

setCacheIsolation

public void setCacheIsolation(boolean cacheIsolation)

Description copied from interface: ArcacheSpeedupConfigurationSetInterface

Enable the cache isolation (disabled by default), when cache isolation is enabled, the stored objects are immutable but with an performance cost. With no isolation, if you store an object and alter it after storing, the stored object is altered

Specified by:

setCacheIsolation in interface ArcacheSpeedupConfigurationSetInterface

initialize

public void initialize()

clear

public void clear()

validateSetCacheSize

protected void validateSetCacheSize(int cachesize)

validateSetExpirationMillis

protected void validateSetExpirationMillis(long expirationMillis)

asyncSet

public Future<Boolean> asyncSet(String key,
                                long ttlMillis,
                                Object value)

Specified by:

asyncSet in interface ArcacheBackendClient

storeSpeedupCache

protected ArcacheInMemoryClient storeSpeedupCache(String key,
                                                  Object value)

createSpeedupCacheObject

protected SpeedupCacheObject createSpeedupCacheObject(Object value)

asyncGet

public Future<Object> asyncGet(String key)

Specified by:

asyncGet in interface ArcacheBackendClient

createFutureBackendGetWrapper

protected ar.com.siripo.arcache.backend.speedup.FutureBackendGetWrapper createFutureBackendGetWrapper(Future<Object> backendFuture,
                                                                                                      String key)

restoreObjectFromAnySpeedupCache

protected RestoredSpeedupCacheObject restoreObjectFromAnySpeedupCache(String key)

restoreObjectFromSpeedupCache

protected RestoredSpeedupCacheObject restoreObjectFromSpeedupCache(String key,
                                                                   ArcacheInMemoryClient speedupCache,
                                                                   long timeoutMillis)