ar.com.siripo.arcache

Class ArcacheClient

java.lang.Object

ar.com.siripo.arcache.ArcacheClient

All Implemented Interfaces:

ArcacheClientInterface, ArcacheConfigurationGetInterface, ArcacheConfigurationInterface, ArcacheConfigurationSetInterface, ArcacheInvalidationInterface, ArcacheReadWriteInterface

public class ArcacheClient
extends Object
implements ArcacheClientInterface

Field Summary

Fields

Modifier and Type	Field and Description
protected ArcacheBackendClient	backendClient
protected long	defaultExpirationTimeMillis
protected boolean	defaultHardInvalidation
protected long	defaultInvalidationWindowMillis
protected long	defaultOperationTimeoutMillis
protected long	defaultStoredObjectRemovalTimeMillis
protected ArcacheBackendClient	effectiveInvalidationBackendClient
protected ProbabilityFunction	expirationProbabilityFunction
protected String	invalidationKeyPrefix
protected ProbabilityFunction	invalidationProbabilityFunction
protected String	keyDelimiter
protected String	keyNamespace
protected Random	randomGenerator
protected long	timeMeasurementErrorMillis
protected ArcacheBackendClient	userConfiguredInvalidationBackendClient The userConfiguredInvalidationBackendClient is what the user sets, the effective backend client used is at effectiveInvalidationBackendClient

Constructor Summary

Constructors

Modifier	Constructor and Description
	ArcacheClient()
protected	ArcacheClient(ArcacheBackendClient backendClient)

Method Summary

Modifier and Type	Method and Description
Future<CacheGetResult>	asyncGetCacheObject(String key) Allow async get
Future<Boolean>	asyncInvalidateKey(String key, boolean hardInvalidation, long invalidationWindowMillis)
Future<Boolean>	asyncSet(String key, Object value)
Future<Boolean>	asyncSet(String key, Object value, String[] invalidationKeys)
protected Future<CacheGetResult>	buildCacheGetterTask(String key)
protected Future<Boolean>	buildInvalidateKeyTask(String key, boolean hardInvalidation, long invalidationWindowMillis)
String	createBackendKey(String userKey) Create the key to be used in the backend client
String	createInvalidationBackendKey(String invalidationKey)
Object	get(String key) This is the most basic get method.
Object	get(String key, long timeoutMillis)
ArcacheBackendClient	getBackendClient()
CacheGetResult	getCacheObject(String key)
CacheGetResult	getCacheObject(String key, long timeoutMillis) This method never throws an exception, in case of an exception it is returned inside the returned object
long	getDefaultExpirationTimeMillis()
boolean	getDefaultHardInvalidation()
long	getDefaultInvalidationWindowMillis()
long	getDefaultOperationTimeoutMillis()
long	getDefaultStoredObjectRemovalTimeMillis()
ProbabilityFunction	getExpirationProbabilityFunction()
ArcacheBackendClient	getInvalidationBackendClient()
ProbabilityFunction	getInvalidationProbabilityFunction()
String	getKeyDelimiter()
String	getKeyNamespace()
long	getTimeMeasurementErrorMillis()
void	invalidateKey(String key) Invalida una key, utilizando una invalidacion soft o hard segun se haya configurado, utilizando el invalidationWindow default
void	invalidateKey(String key, boolean hardInvalidation) Invalidates a key using the default invalidationWindow
void	invalidateKey(String key, boolean hardInvalidation, long invalidationWindowMillis)
void	invalidateKey(String key, long invalidationWindowMillis) Invalida una key, utilizando una invalidacion soft o hard segun se haya configurado
void	set(String key, Object value) Almacena un valor, como timeout utiliza el default, en caso de falla retornará una exepcion
void	set(String key, Object value, String[] invalidationKeys) Almacena un valor y define las claves de invalidacion
void	setBackendClient(ArcacheBackendClient backendClient) Sets the default backend client to store objects and invalidationkeys
void	setDefaultExpirationTimeMillis(long expirationTimeMillis) Sets the default value to be used to consider a cached object expired
void	setDefaultHardInvalidation(boolean hardInvalidation)
void	setDefaultInvalidationWindowMillis(long windowMillis) set the default invalidation window, this is the ammount of time to do probabilistic invalidation.
void	setDefaultOperationTimeoutMillis(long timeoutMillis)
void	setDefaultStoredObjectRemovalTimeMillis(long removeTimeMillis) Sets the default value to be used to set the lifetime of the object at backend level.
void	setExpirationProbabilityFunction(ProbabilityFunction expirationProbabilityFunction) Sets the function to be used to compute the probability of a key has expired
void	setInvalidationBackendClient(ArcacheBackendClient invalidationBackendClient) Set the invalidation backend client to store invalidationkeys If you null this, then the defaultBackendClient is used.
void	setInvalidationProbabilityFunction(ProbabilityFunction invalidationProbabilityFunction) Sets the function to be used to compute the probability of a key has invalidated
void	setKeyDelimiter(String keyDelimiter) Permite configurar un delimitador default para las keys el mismo sera utilizado par separar las keys de invalidacion y el namespace
void	setKeyNamespace(String namespace) Permite configurar un namsepace default para todas las keys De esta forma se puede evitar la colision de keys con otro servicio
void	setTimeMeasurementErrorMillis(long errorMillis) Error total en la medicion de tiempos expresado en mili segundos debe ser 1000 + maxClockOffset + maxKeyCreationTime maxClockOffset (diferencia maxima entre 2 relojes de la infraestructura involucrada) maxKeyCreationTime (Tiempo (95pt) que demanda generar un valor a ser almacenado)

Methods inherited from class java.lang.Object

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

Field Detail

defaultOperationTimeoutMillis

protected long defaultOperationTimeoutMillis

timeMeasurementErrorMillis

protected long timeMeasurementErrorMillis

defaultInvalidationWindowMillis

protected long defaultInvalidationWindowMillis

defaultHardInvalidation

protected boolean defaultHardInvalidation

keyNamespace

protected String keyNamespace

keyDelimiter

protected String keyDelimiter

invalidationKeyPrefix

protected String invalidationKeyPrefix

defaultExpirationTimeMillis

protected long defaultExpirationTimeMillis

defaultStoredObjectRemovalTimeMillis

protected long defaultStoredObjectRemovalTimeMillis

expirationProbabilityFunction

protected ProbabilityFunction expirationProbabilityFunction

invalidationProbabilityFunction

protected ProbabilityFunction invalidationProbabilityFunction

backendClient

protected ArcacheBackendClient backendClient

userConfiguredInvalidationBackendClient

protected ArcacheBackendClient userConfiguredInvalidationBackendClient

The userConfiguredInvalidationBackendClient is what the user sets, the effective backend client used is at effectiveInvalidationBackendClient

effectiveInvalidationBackendClient

protected ArcacheBackendClient effectiveInvalidationBackendClient

randomGenerator

protected Random randomGenerator

Constructor Detail

ArcacheClient

public ArcacheClient()

ArcacheClient

protected ArcacheClient(ArcacheBackendClient backendClient)

Method Detail

setBackendClient

public void setBackendClient(ArcacheBackendClient backendClient)

Description copied from interface: ArcacheConfigurationSetInterface

Sets the default backend client to store objects and invalidationkeys

Specified by:

setBackendClient in interface ArcacheConfigurationSetInterface

getBackendClient

public ArcacheBackendClient getBackendClient()

Specified by:

getBackendClient in interface ArcacheConfigurationGetInterface

setInvalidationBackendClient

public void setInvalidationBackendClient(ArcacheBackendClient invalidationBackendClient)

Description copied from interface: ArcacheConfigurationSetInterface

Set the invalidation backend client to store invalidationkeys If you null this, then the defaultBackendClient is used.

Specified by:

setInvalidationBackendClient in interface ArcacheConfigurationSetInterface

getInvalidationBackendClient

public ArcacheBackendClient getInvalidationBackendClient()

Specified by:

getInvalidationBackendClient in interface ArcacheConfigurationGetInterface

setDefaultOperationTimeoutMillis

public void setDefaultOperationTimeoutMillis(long timeoutMillis)

Specified by:

setDefaultOperationTimeoutMillis in interface ArcacheConfigurationSetInterface

Parameters:

timeoutMillis - timeoutMillis the default timeout to be used in backend operations

getDefaultOperationTimeoutMillis

public long getDefaultOperationTimeoutMillis()

Specified by:

getDefaultOperationTimeoutMillis in interface ArcacheConfigurationGetInterface

setTimeMeasurementErrorMillis

public void setTimeMeasurementErrorMillis(long errorMillis)

Description copied from interface: ArcacheConfigurationSetInterface

Error total en la medicion de tiempos expresado en mili segundos debe ser 1000 + maxClockOffset + maxKeyCreationTime maxClockOffset (diferencia maxima entre 2 relojes de la infraestructura involucrada) maxKeyCreationTime (Tiempo (95pt) que demanda generar un valor a ser almacenado)

Specified by:

setTimeMeasurementErrorMillis in interface ArcacheConfigurationSetInterface

Parameters:

errorMillis - the time measurament error in milliseconds

getTimeMeasurementErrorMillis

public long getTimeMeasurementErrorMillis()

Specified by:

getTimeMeasurementErrorMillis in interface ArcacheConfigurationGetInterface

setDefaultInvalidationWindowMillis

public void setDefaultInvalidationWindowMillis(long windowMillis)

Description copied from interface: ArcacheConfigurationSetInterface

set the default invalidation window, this is the ammount of time to do probabilistic invalidation.

Specified by:

setDefaultInvalidationWindowMillis in interface ArcacheConfigurationSetInterface

Parameters:

windowMillis - invalidation window in milliseconds

getDefaultInvalidationWindowMillis

public long getDefaultInvalidationWindowMillis()

Specified by:

getDefaultInvalidationWindowMillis in interface ArcacheConfigurationGetInterface

setDefaultHardInvalidation

public void setDefaultHardInvalidation(boolean hardInvalidation)

Specified by:

setDefaultHardInvalidation in interface ArcacheConfigurationSetInterface

Parameters:

hardInvalidation - default type of invalidation to be used

getDefaultHardInvalidation

public boolean getDefaultHardInvalidation()

Specified by:

getDefaultHardInvalidation in interface ArcacheConfigurationGetInterface

setKeyNamespace

public void setKeyNamespace(String namespace)

Description copied from interface: ArcacheConfigurationSetInterface

Permite configurar un namsepace default para todas las keys De esta forma se puede evitar la colision de keys con otro servicio

Specified by:

setKeyNamespace in interface ArcacheConfigurationSetInterface

Parameters:

namespace - ...

getKeyNamespace

public String getKeyNamespace()

Specified by:

getKeyNamespace in interface ArcacheConfigurationGetInterface

setKeyDelimiter

public void setKeyDelimiter(String keyDelimiter)

Description copied from interface: ArcacheConfigurationSetInterface

Permite configurar un delimitador default para las keys el mismo sera utilizado par separar las keys de invalidacion y el namespace

Specified by:

setKeyDelimiter in interface ArcacheConfigurationSetInterface

Parameters:

keyDelimiter - ...

getKeyDelimiter

public String getKeyDelimiter()

Specified by:

getKeyDelimiter in interface ArcacheConfigurationGetInterface

setDefaultExpirationTimeMillis

public void setDefaultExpirationTimeMillis(long expirationTimeMillis)

Description copied from interface: ArcacheConfigurationSetInterface

Sets the default value to be used to consider a cached object expired

Specified by:

setDefaultExpirationTimeMillis in interface ArcacheConfigurationSetInterface

Parameters:

expirationTimeMillis - ...

getDefaultExpirationTimeMillis

public long getDefaultExpirationTimeMillis()

Specified by:

getDefaultExpirationTimeMillis in interface ArcacheConfigurationGetInterface

setDefaultStoredObjectRemovalTimeMillis

public void setDefaultStoredObjectRemovalTimeMillis(long removeTimeMillis)

Description copied from interface: ArcacheConfigurationSetInterface

Sets the default value to be used to set the lifetime of the object at backend level. When this time is reached the object is expected to be removed

Specified by:

setDefaultStoredObjectRemovalTimeMillis in interface ArcacheConfigurationSetInterface

Parameters:

removeTimeMillis - ...

getDefaultStoredObjectRemovalTimeMillis

public long getDefaultStoredObjectRemovalTimeMillis()

Specified by:

getDefaultStoredObjectRemovalTimeMillis in interface ArcacheConfigurationGetInterface

setExpirationProbabilityFunction

public void setExpirationProbabilityFunction(ProbabilityFunction expirationProbabilityFunction)

Description copied from interface: ArcacheConfigurationSetInterface

Sets the function to be used to compute the probability of a key has expired

Specified by:

setExpirationProbabilityFunction in interface ArcacheConfigurationSetInterface

getExpirationProbabilityFunction

public ProbabilityFunction getExpirationProbabilityFunction()

Specified by:

getExpirationProbabilityFunction in interface ArcacheConfigurationGetInterface

setInvalidationProbabilityFunction

public void setInvalidationProbabilityFunction(ProbabilityFunction invalidationProbabilityFunction)

Description copied from interface: ArcacheConfigurationSetInterface

Sets the function to be used to compute the probability of a key has invalidated

Specified by:

setInvalidationProbabilityFunction in interface ArcacheConfigurationSetInterface

getInvalidationProbabilityFunction

public ProbabilityFunction getInvalidationProbabilityFunction()

Specified by:

getInvalidationProbabilityFunction in interface ArcacheConfigurationGetInterface

get

public Object get(String key)
           throws TimeoutException,
                  Exception

Description copied from interface: ArcacheReadWriteInterface

This is the most basic get method. It uses the defaultOperationTimeoutMillis. In case of MISS, EXPIRED, INVALIDATED returns null. In case of TIMEOUT throws TimeoutException. In case of ERROR throws the Exception.

Specified by:

get in interface ArcacheReadWriteInterface

Returns:

Throws:

TimeoutException

Exception

get

public Object get(String key,
                  long timeoutMillis)
           throws TimeoutException,
                  Exception

Specified by:

get in interface ArcacheReadWriteInterface

Throws:

TimeoutException

Exception

getCacheObject

public CacheGetResult getCacheObject(String key)

Specified by:

getCacheObject in interface ArcacheReadWriteInterface

Returns:

getCacheObject(key, defaultOperationTimeoutMillis);

getCacheObject

public CacheGetResult getCacheObject(String key,
                                     long timeoutMillis)

Description copied from interface: ArcacheReadWriteInterface

This method never throws an exception, in case of an exception it is returned inside the returned object

Specified by:

getCacheObject in interface ArcacheReadWriteInterface

Returns:

asyncGetCacheObject

public Future<CacheGetResult> asyncGetCacheObject(String key)

Description copied from interface: ArcacheReadWriteInterface

Allow async get

Specified by:

asyncGetCacheObject in interface ArcacheReadWriteInterface

Returns:

buildCacheGetterTask

protected Future<CacheGetResult> buildCacheGetterTask(String key)

set

public void set(String key,
                Object value)
         throws TimeoutException,
                Exception

Description copied from interface: ArcacheReadWriteInterface

Almacena un valor, como timeout utiliza el default, en caso de falla retornará una exepcion

Specified by:

set in interface ArcacheReadWriteInterface

Throws:

TimeoutException

Exception

set

public void set(String key,
                Object value,
                String[] invalidationKeys)
         throws TimeoutException,
                Exception

Description copied from interface: ArcacheReadWriteInterface

Almacena un valor y define las claves de invalidacion

Specified by:

set in interface ArcacheReadWriteInterface

Throws:

TimeoutException

Exception

asyncSet

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

Specified by:

asyncSet in interface ArcacheReadWriteInterface

asyncSet

public Future<Boolean> asyncSet(String key,
                                Object value,
                                String[] invalidationKeys)

Specified by:

asyncSet in interface ArcacheReadWriteInterface

invalidateKey

public void invalidateKey(String key)
                   throws TimeoutException,
                          Exception

Description copied from interface: ArcacheInvalidationInterface

Invalida una key, utilizando una invalidacion soft o hard segun se haya configurado, utilizando el invalidationWindow default

Specified by:

invalidateKey in interface ArcacheInvalidationInterface

Throws:

TimeoutException

Exception

invalidateKey

public void invalidateKey(String key,
                          long invalidationWindowMillis)
                   throws TimeoutException,
                          Exception

Description copied from interface: ArcacheInvalidationInterface

Invalida una key, utilizando una invalidacion soft o hard segun se haya configurado

Specified by:

invalidateKey in interface ArcacheInvalidationInterface

Throws:

TimeoutException

Exception

invalidateKey

public void invalidateKey(String key,
                          boolean hardInvalidation)
                   throws TimeoutException,
                          Exception

Description copied from interface: ArcacheInvalidationInterface

Invalidates a key using the default invalidationWindow

Specified by:

invalidateKey in interface ArcacheInvalidationInterface

Throws:

TimeoutException - when the operation exceeds the DefaultOperationTimeout

Exception - when there is a problem with the backend operation

invalidateKey

public void invalidateKey(String key,
                          boolean hardInvalidation,
                          long invalidationWindowMillis)
                   throws TimeoutException,
                          Exception

Specified by:

invalidateKey in interface ArcacheInvalidationInterface

Throws:

TimeoutException

Exception

asyncInvalidateKey

public Future<Boolean> asyncInvalidateKey(String key,
                                          boolean hardInvalidation,
                                          long invalidationWindowMillis)

Specified by:

asyncInvalidateKey in interface ArcacheInvalidationInterface

buildInvalidateKeyTask

protected Future<Boolean> buildInvalidateKeyTask(String key,
                                                 boolean hardInvalidation,
                                                 long invalidationWindowMillis)

createBackendKey

public String createBackendKey(String userKey)

Create the key to be used in the backend client

createInvalidationBackendKey

public String createInvalidationBackendKey(String invalidationKey)