fr.paris.lutece.portal.service.cache

Class PathCacheService

java.lang.Object

fr.paris.lutece.portal.service.cache.AbstractCacheableService

fr.paris.lutece.portal.service.cache.PathCacheService

All Implemented Interfaces:

CacheableService, IPathCacheService, PageEventListener, LuteceService, Cloneable, EventListener, net.sf.ehcache.event.CacheEventListener

public class PathCacheService
extends AbstractCacheableService
implements IPathCacheService, PageEventListener

XPage path cache service

Field Summary

Fields inherited from interface fr.paris.lutece.portal.service.cache.IPathCacheService

BEAN_NAME

Method Summary

Modifier and Type	Method and Description
String	getFromCache(String strKey) Gets an object from the cache
String	getKey(String strXPageName, int nMode, javax.servlet.http.HttpServletRequest request) Constructs a cache key
String	getKey(String strXPageName, int nMode, String strTitlesUrls, javax.servlet.http.HttpServletRequest request) Constructs a cache key
String	getName() Returns the Service name
void	processPageEvent(PageEvent event) Process a page event
void	putInCache(String strKey, String path) Put a path in cache

Methods inherited from class fr.paris.lutece.portal.service.cache.AbstractCacheableService

clone, dispose, enableCache, getCache, getCacheSize, getInfos, getKeys, getMaxElements, getMemorySize, getTimeToLive, initCache, initCache, isCacheEnable, notifyElementEvicted, notifyElementExpired, notifyElementPut, notifyElementRemoved, notifyElementUpdated, notifyRemoveAll, putInCache, removeKey, resetCache

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Description copied from interface: LuteceService

Returns the Service name

Specified by:

getName in interface LuteceService

Returns:

The name as a String

getKey

public String getKey(String strXPageName,
                     int nMode,
                     javax.servlet.http.HttpServletRequest request)

Description copied from interface: IPathCacheService

Constructs a cache key

Specified by:

getKey in interface IPathCacheService

Parameters:

strXPageName - the XPage name

nMode - the mode

request - the request

Returns:

the cache key, or null if for instance the cache is not enabled

getKey

public String getKey(String strXPageName,
                     int nMode,
                     String strTitlesUrls,
                     javax.servlet.http.HttpServletRequest request)

Description copied from interface: IPathCacheService

Constructs a cache key

Specified by:

getKey in interface IPathCacheService

Parameters:

strXPageName - the XPage name

nMode - the mode

strTitlesUrls - list of links (url and titles)

request - the request the request

Returns:

the cache key, or null if for instance the cache is not enabled

getFromCache

public String getFromCache(String strKey)

Description copied from class: AbstractCacheableService

Gets an object from the cache

Specified by:

getFromCache in interface IPathCacheService

Overrides:

getFromCache in class AbstractCacheableService

Parameters:

strKey - The key of the object to retrieve from the cache

Returns:

The object from the cache

putInCache

public void putInCache(String strKey,
                       String path)

Description copied from interface: IPathCacheService

Put a path in cache

Specified by:

putInCache in interface IPathCacheService

Parameters:

strKey - the cache key

path - the path html

processPageEvent

public void processPageEvent(PageEvent event)

Description copied from interface: PageEventListener

Process a page event

Specified by:

processPageEvent in interface PageEventListener

Parameters:

event - The event to process