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	defaultExpirationTimeSecs
protected boolean	defaultHardInvalidation
protected long	defaultInvalidationWindowSecs
protected long	defaultOperationTimeoutMillis
protected long	defaultStoredObjectRemovalTimeSecs
protected String	invalidationKeyPrefix
protected String	keyDelimiter
protected String	keyNamespace
protected Random	randomGenerator
protected long	timeMeasurementErrorSecs

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 invalidationWindowSecs)
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 invalidationWindowSecs)
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	getDefaultExpirationTime()
boolean	getDefaultHardInvalidation()
long	getDefaultInvalidationWindow()
long	getDefaultOperationTimeout()
long	getDefaultStoredObjectRemovalTime()
String	getKeyDelimiter()
String	getKeyNamespace()
long	getTimeMeasurementError()
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 invalidationWindowSecs)
void	invalidateKey(String key, long invalidationWindowSecs) 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)
void	setDefaultExpirationTime(long expirationTimeSecs) Sets the default value to be used to consider a cached object expired
void	setDefaultHardInvalidation(boolean hardInvalidation)
void	setDefaultInvalidationWindow(long windowSecs) set the default invalidation window, this is the ammount of time to do probabilistic invalidation.
void	setDefaultOperationTimeout(long timeoutMillis)
void	setDefaultStoredObjectRemovalTime(long removeTimeSecs) Sets the default value to be used to set the lifetime of the object at backend level.
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	setTimeMeasurementError(long errorSecs) Error total en la medicion de tiempos expresado en segundos debe ser 1 + 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

timeMeasurementErrorSecs

protected long timeMeasurementErrorSecs

defaultInvalidationWindowSecs

protected long defaultInvalidationWindowSecs

defaultHardInvalidation

protected boolean defaultHardInvalidation

keyNamespace

protected String keyNamespace

keyDelimiter

protected String keyDelimiter

invalidationKeyPrefix

protected String invalidationKeyPrefix

defaultExpirationTimeSecs

protected long defaultExpirationTimeSecs

defaultStoredObjectRemovalTimeSecs

protected long defaultStoredObjectRemovalTimeSecs

backendClient

protected ArcacheBackendClient backendClient

randomGenerator

protected Random randomGenerator

Constructor Detail

ArcacheClient

public ArcacheClient()

ArcacheClient

protected ArcacheClient(ArcacheBackendClient backendClient)

Method Detail

setBackendClient

public void setBackendClient(ArcacheBackendClient backendClient)

Specified by:

setBackendClient in interface ArcacheConfigurationSetInterface

getBackendClient

public ArcacheBackendClient getBackendClient()

Specified by:

getBackendClient in interface ArcacheConfigurationGetInterface

setDefaultOperationTimeout

public void setDefaultOperationTimeout(long timeoutMillis)

Specified by:

setDefaultOperationTimeout in interface ArcacheConfigurationSetInterface

Parameters:

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

getDefaultOperationTimeout

public long getDefaultOperationTimeout()

Specified by:

getDefaultOperationTimeout in interface ArcacheConfigurationGetInterface

setTimeMeasurementError

public void setTimeMeasurementError(long errorSecs)

Description copied from interface: ArcacheConfigurationSetInterface

Error total en la medicion de tiempos expresado en segundos debe ser 1 + 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:

setTimeMeasurementError in interface ArcacheConfigurationSetInterface

Parameters:

errorSecs - the time measurament error in seconds

getTimeMeasurementError

public long getTimeMeasurementError()

Specified by:

getTimeMeasurementError in interface ArcacheConfigurationGetInterface

setDefaultInvalidationWindow

public void setDefaultInvalidationWindow(long windowSecs)

Description copied from interface: ArcacheConfigurationSetInterface

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

Specified by:

setDefaultInvalidationWindow in interface ArcacheConfigurationSetInterface

Parameters:

windowSecs - invalidation window in seconds

getDefaultInvalidationWindow

public long getDefaultInvalidationWindow()

Specified by:

getDefaultInvalidationWindow 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

setDefaultExpirationTime

public void setDefaultExpirationTime(long expirationTimeSecs)

Description copied from interface: ArcacheConfigurationSetInterface

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

Specified by:

setDefaultExpirationTime in interface ArcacheConfigurationSetInterface

Parameters:

expirationTimeSecs - ...

getDefaultExpirationTime

public long getDefaultExpirationTime()

Specified by:

getDefaultExpirationTime in interface ArcacheConfigurationGetInterface

setDefaultStoredObjectRemovalTime

public void setDefaultStoredObjectRemovalTime(long removeTimeSecs)

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:

setDefaultStoredObjectRemovalTime in interface ArcacheConfigurationSetInterface

Parameters:

removeTimeSecs - ...

getDefaultStoredObjectRemovalTime

public long getDefaultStoredObjectRemovalTime()

Specified by:

getDefaultStoredObjectRemovalTime 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 invalidationWindowSecs)
                   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 invalidationWindowSecs)
                   throws TimeoutException,
                          Exception

Specified by:

invalidateKey in interface ArcacheInvalidationInterface

Throws:

TimeoutException

Exception

asyncInvalidateKey

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

Specified by:

asyncInvalidateKey in interface ArcacheInvalidationInterface

buildInvalidateKeyTask

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

createBackendKey

public String createBackendKey(String userKey)

Create the key to be used in the backend client

createInvalidationBackendKey

public String createInvalidationBackendKey(String invalidationKey)