com.communote.server.core.config

Class ClientConfigurationElementProvider

java.lang.Object

com.communote.server.core.config.ClientConfigurationElementProvider

All Implemented Interfaces:

CacheElementProvider<ClientSingleElementCacheKey,ClientConfigurationProperties>

public class ClientConfigurationElementProvider
extends Object
implements CacheElementProvider<ClientSingleElementCacheKey,ClientConfigurationProperties>

Cache element provider for the client configuration properties

Author:

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

Field Summary

Fields inherited from interface com.communote.server.core.common.caching.CacheElementProvider

ETERNAL_TIME_TO_LIVE

Constructor Summary

Constructors

Constructor and Description
ClientConfigurationElementProvider()

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).
ClientConfigurationProperties	load(ClientSingleElementCacheKey key) Provides an element identified by the key for caching.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientConfigurationElementProvider

public ClientConfigurationElementProvider()

Method Detail

getContentType

public String getContentType()

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

Specified by:

getContentType in interface CacheElementProvider<ClientSingleElementCacheKey,ClientConfigurationProperties>

Returns:

the string name

getTimeToLive

public 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 CacheElementProvider.ETERNAL_TIME_TO_LIVE when the element should never expire.

Specified by:

getTimeToLive in interface CacheElementProvider<ClientSingleElementCacheKey,ClientConfigurationProperties>

Returns:

the time to live in the cache in seconds.

load

public ClientConfigurationProperties load(ClientSingleElementCacheKey key)

Provides an element identified by the key for caching.

Specified by:

load in interface CacheElementProvider<ClientSingleElementCacheKey,ClientConfigurationProperties>

Parameters:

key - the key to identify the requested element

Returns:

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