com.communote.server.core.common.caching

Interface CacheElementProvider<K extends CacheKey,T extends Serializable>

Type Parameters:

K - the type of the key to be used for caching

T - the type of the objects that this provider provides

All Known Subinterfaces:

AccessRestrictedCacheElementProvider<T,U>

All Known Implementing Classes:

AbstractCacheElementProvider, ApplicationConfigurationElementProvider, ChannelConfigurationCacheElementProvider, ClientConfigurationElementProvider, FollowCacheElementProvider, ImageCacheElementProvider, IpFilterCacheElementProvider, LdapServerCacheElementProvider, PluginPropertyCacheElementProvider, StandaloneClientCacheElementProvider, UserNotePropertyCacheElementProvider, UserNoteTOElementProvider

public interface CacheElementProvider<K extends CacheKey,T extends Serializable>

A CacheElementProvider is required when an element is requested but not yet cached. In that case the load(CacheKey) method is called and the returned element will be cached.

Author:

Communote GmbH - http://www.communote.com/

Field Summary

Fields

Modifier and Type	Field and Description
static int	ETERNAL_TIME_TO_LIVE Constant representing eternal caching.

Method Summary

Modifier and Type	Method and Description
String	getContentType() Returns a unique string naming the content type of the elements provided by this provider (e.g.
int	getTimeToLive() Returns the time in seconds describing how long a provided element will be cached without expiring (when it is not replaced manually).
T	load(K key) Provides an element identified by the key for caching.

Field Detail

ETERNAL_TIME_TO_LIVE

static final int ETERNAL_TIME_TO_LIVE

Constant representing eternal caching.

See Also:

Constant Field Values

Method Detail

getContentType

String getContentType()

Returns a unique string naming the content type of the elements provided by this provider (e.g. 'image' when providing image data).

Returns:

the string name

getTimeToLive

int getTimeToLive()

Returns the time in seconds describing how long a provided element will be cached without expiring (when it is not replaced manually). Return ETERNAL_TIME_TO_LIVE when the element should never expire.

Returns:

the time to live in the cache in seconds.

load

T load(K key)
throws CacheElementProviderException

Provides an element identified by the key for caching.

Parameters:

key - the key to identify the requested element

Returns:

the loaded object or null if there is no element for the key

Throws:

CacheElementProviderException - in case the loading failed and nothing should or can be cached