com.sdl.web.client.cache

Class AbstractCacheProvider

java.lang.Object

com.sdl.web.client.cache.AbstractCacheProvider

All Implemented Interfaces:

CacheProvider

Direct Known Subclasses:

GeneralCacheProvider, RedisCacheProvider

public abstract class AbstractCacheProvider
extends Object
implements CacheProvider

Abstract CacheProvider implementation holding configuration values.

Constructor Summary

Constructors

Constructor and Description
AbstractCacheProvider()

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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sdl.web.client.cache.CacheProvider

provideCacheForClass, provideCacheForClass

Constructor Detail

AbstractCacheProvider

public AbstractCacheProvider()

Method Detail

configure

public void configure(Properties properties)

Configures the CacheProvider.

Specified by:

configure in interface CacheProvider

Parameters:

properties - properties to configure

isCacheEnabled

public boolean isCacheEnabled()

Returns whether cache is enabled.

Specified by:

isCacheEnabled in interface CacheProvider

Returns:

true if cache is enabled, otherwise - false

needCheckHostAvailability

public boolean needCheckHostAvailability()

Returns whether there is a need to check host availability.

Specified by:

needCheckHostAvailability in interface CacheProvider

Returns:

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

getServiceChecker

public ServiceAvailabilityChecker getServiceChecker()

Returns service checker. Used to check service availability.

Specified by:

getServiceChecker in interface CacheProvider

Returns:

service checker

getCacheExpirationPeriod

public Integer getCacheExpirationPeriod()

Description copied from interface: CacheProvider

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

Specified by:

getCacheExpirationPeriod in interface CacheProvider

Returns:

cache expiration duration (in seconds)