fr.paris.lutece.portal.service.cache

Interface CacheableService

All Superinterfaces:

LuteceService

All Known Implementing Classes:

AbstractCacheableService, BaseUserPreferencesCacheService, ContentService, DatastoreCacheService, FullPageCachingService, HeadersPageCachingFilter, LinksIncludeCacheService, LuteceUserCacheService, MailAttachmentCacheService, PageCacheService, PageContentService, PathCacheService, PortalMenuService, PortletCacheService, ResourceService, SiteMapCacheService, StandaloneAppService, XmlTransformerCacheService, XPageAppService

public interface CacheableService
extends LuteceService

Base interface of Lutece services that provide a cache

Method Summary

Modifier and Type	Method and Description
void	enableCache(boolean bEnable) Enable the cache
int	getCacheSize() Gets the number of item currently in the cache.
String	getInfos() Returns cache infos
List<String>	getKeys() Gets all keys in the cache
int	getMaxElements() Returns maximum elements accepted into the cache
long	getMemorySize() Return the memory size
long	getTimeToLive() Returns the time to live for objects in the cache
boolean	isCacheEnable() Gets the current cache status.
void	resetCache() Reset the cache.

Methods inherited from interface fr.paris.lutece.portal.service.util.LuteceService

getName

Method Detail

isCacheEnable

boolean isCacheEnable()

Gets the current cache status.

Returns:

true if enable, otherwise false

getCacheSize

int getCacheSize()

Gets the number of item currently in the cache.

Returns:

the number of item currently in the cache.

resetCache

void resetCache()

Reset the cache.

enableCache

void enableCache(boolean bEnable)

Enable the cache

Parameters:

bEnable - true to enable, false to disable

getKeys

List<String> getKeys()

Gets all keys in the cache

Returns:

The List

getMaxElements

int getMaxElements()

Returns maximum elements accepted into the cache

Returns:

The max elements

getTimeToLive

long getTimeToLive()

Returns the time to live for objects in the cache

Returns:

The time to live in seconds

getMemorySize

long getMemorySize()

Return the memory size

Returns:

the memory size

getInfos

String getInfos()

Returns cache infos

Returns:

cache infos