com.scooterframework.cache
Interface CacheProvider

All Known Implementing Classes:

AbstractCacheProvider

public interface CacheProvider

CacheProvider interface defines common methods of a cache provider.

Field Summary

static java.lang.String	KEY_CACHE_PROVIDER_CONFIGFILE Key to represent cache provider configFile property.
static java.lang.String	KEY_CACHE_PROVIDER_EXPIRESINSECONDS Key to represent cache provider expiresInSeconds property.
static java.lang.String	KEY_CACHE_PROVIDER_NAMESPACE Key to represent cache provider namespace property.
static java.lang.String	KEY_CACHE_PROVIDER_REQUESTTIMEOUTINSECONDS Key to represent cache provider retrieveTimeoutInSeconds property.
static java.lang.String	KEY_CACHE_PROVIDER_URLS Key to represent cache provider urls property.

Method Summary

Cache	getCache(java.lang.String name) Returns the cache for the name.
java.util.Collection<java.lang.String>	getCacheNames() Returns a list of cache names.
int	getExpiresInSecondsProperty() Returns the expiresInSeconds
java.lang.String	getName() Returns the cache provider name.
java.lang.String	getNamespaceProperty() Returns the namespace
java.util.Properties	getProperties() Returns properties defined for the cache provider.
java.lang.String	getProperty(java.lang.String name) Returns value of a property.
java.lang.String	getProviderClassName() Returns the implementation cache provider class name.
int	getRequestTimeoutInSecondsProperty() Returns the requestTimeoutInSeconds
java.util.Map<java.lang.String,java.util.Properties>	getStatistics() Returns statistics of all caches.
java.util.Properties	getStatistics(java.lang.String name) Returns statistics of a cache.
java.lang.String	getUrlsProperty() Returns the urls if defined

Field Detail

KEY_CACHE_PROVIDER_CONFIGFILE

static final java.lang.String KEY_CACHE_PROVIDER_CONFIGFILE

Key to represent cache provider configFile property.

See Also:

Constant Field Values

KEY_CACHE_PROVIDER_NAMESPACE

static final java.lang.String KEY_CACHE_PROVIDER_NAMESPACE

Key to represent cache provider namespace property.

See Also:

Constant Field Values

KEY_CACHE_PROVIDER_URLS

static final java.lang.String KEY_CACHE_PROVIDER_URLS

Key to represent cache provider urls property.

See Also:

Constant Field Values

KEY_CACHE_PROVIDER_EXPIRESINSECONDS

static final java.lang.String KEY_CACHE_PROVIDER_EXPIRESINSECONDS

Key to represent cache provider expiresInSeconds property.

See Also:

Constant Field Values

KEY_CACHE_PROVIDER_REQUESTTIMEOUTINSECONDS

static final java.lang.String KEY_CACHE_PROVIDER_REQUESTTIMEOUTINSECONDS

Key to represent cache provider retrieveTimeoutInSeconds property.

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Returns the cache provider name.

getProviderClassName

java.lang.String getProviderClassName()

Returns the implementation cache provider class name.

getNamespaceProperty

java.lang.String getNamespaceProperty()

Returns the namespace

getUrlsProperty

java.lang.String getUrlsProperty()

Returns the urls if defined

getExpiresInSecondsProperty

int getExpiresInSecondsProperty()

Returns the expiresInSeconds

getRequestTimeoutInSecondsProperty

int getRequestTimeoutInSecondsProperty()

Returns the requestTimeoutInSeconds

getProperties

java.util.Properties getProperties()

Returns properties defined for the cache provider.

getProperty

java.lang.String getProperty(java.lang.String name)

Returns value of a property.

Parameters:

name - property name

Returns:

value of the property.

getCache

Cache getCache(java.lang.String name)

Returns the cache for the name.

Parameters:

name - name of the cache

Returns:

the cache associated with the name

getCacheNames

java.util.Collection<java.lang.String> getCacheNames()

Returns a list of cache names.

getStatistics

java.util.Properties getStatistics(java.lang.String name)

Returns statistics of a cache.

getStatistics

java.util.Map<java.lang.String,java.util.Properties> getStatistics()

Returns statistics of all caches.