com.sdl.web.client.cache

Interface CacheProvider

All Known Implementing Classes:

AbstractCacheProvider, GeneralCacheProvider, RedisCacheProvider

public interface CacheProvider

Cache provider common interface. Use this interface for implementation of your own cache providers.

Method Summary

Modifier and Type	Method and Description
void	configure(Properties properties) Configures the CacheProvider.
Integer	getCacheExpirationPeriod() Cache expiration duration (in seconds).
ServiceAvailabilityChecker	getServiceChecker() Returns service checker.
boolean	isCacheEnabled() Returns whether cache is enabled.
boolean	needCheckHostAvailability() Returns whether there is a need to check host availability.
default <K extends Serializable,V extends Serializable> javax.cache.Cache<K,V>	provideCacheForClass(Class<K> cacheKeyClass, Class<V> cacheValueClass) Returns a cache for passed as a parameter class, could be existing one or just created.
<K extends Serializable,V extends Serializable> javax.cache.Cache<K,V>	provideCacheForClass(Class<K> cacheKeyClass, Class<V> cacheValueClass, String cacheName) Returns a cache for passed as a parameter class, could be existing one or just created.

Method Detail

configure

void configure(Properties properties)

Configures the CacheProvider.

Parameters:

properties - properties to configure

provideCacheForClass

<K extends Serializable,V extends Serializable> javax.cache.Cache<K,V> provideCacheForClass(Class<K> cacheKeyClass,
                                                                                            Class<V> cacheValueClass,
                                                                                            String cacheName)

Returns a cache for passed as a parameter class, could be existing one or just created.

Parameters:

cacheKeyClass - the cache key type

cacheValueClass - the cache value type

cacheName - cache name

Returns:

the cache

provideCacheForClass

default <K extends Serializable,V extends Serializable> javax.cache.Cache<K,V> provideCacheForClass(Class<K> cacheKeyClass,
                                                                                                    Class<V> cacheValueClass)

Returns a cache for passed as a parameter class, could be existing one or just created.

Parameters:

cacheKeyClass - the cache key type

cacheValueClass - the cache value type

Returns:

the cache

isCacheEnabled

boolean isCacheEnabled()

Returns whether cache is enabled.

Returns:

true if cache is enabled, otherwise - false

needCheckHostAvailability

boolean needCheckHostAvailability()

Returns whether there is a need to check host availability.

Returns:

true if host availability should be checked, otherwise - false.

getServiceChecker

ServiceAvailabilityChecker getServiceChecker()

Returns service checker. Used to check service availability.

Returns:

service checker

getCacheExpirationPeriod

Integer getCacheExpirationPeriod()

Cache expiration duration (in seconds). This is common config that could be shared between different cache providers.

Returns:

cache expiration duration (in seconds)