com.communote.server.service

Class StandaloneClientCacheElementProvider

java.lang.Object

com.communote.server.service.StandaloneClientCacheElementProvider

All Implemented Interfaces:

CacheElementProvider<StringIdBasedCacheKey,ClientTO>

public class StandaloneClientCacheElementProvider
extends Object
implements CacheElementProvider<StringIdBasedCacheKey,ClientTO>

Cache provider for caching clients in a standalone environment.

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
StandaloneClientCacheElementProvider()

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).
ClientTO	load(StringIdBasedCacheKey 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

StandaloneClientCacheElementProvider

public StandaloneClientCacheElementProvider()

Method Detail

getContentType

public String getContentType()

Description copied from interface: CacheElementProvider

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<StringIdBasedCacheKey,ClientTO>

Returns:

"communote/client"

getTimeToLive

public int getTimeToLive()

Description copied from interface: CacheElementProvider

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<StringIdBasedCacheKey,ClientTO>

Returns:

the time to live in the cache in seconds.

load

public ClientTO load(StringIdBasedCacheKey key)
              throws CacheElementProviderException

Description copied from interface: CacheElementProvider

Provides an element identified by the key for caching.

Specified by:

load in interface CacheElementProvider<StringIdBasedCacheKey,ClientTO>

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