fr.paris.lutece.portal.service.cache

Interface IPathCacheService

All Known Implementing Classes:

PathCacheService

public interface IPathCacheService

Service interface for XPage path caching

Field Summary

Fields

Modifier and Type	Field and Description
static String	BEAN_NAME Bean name

Method Summary

Modifier and Type	Method and Description
String	getFromCache(String strKey) Get the path html from 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
void	putInCache(String strKey, String path) Put a path in cache

Field Detail

BEAN_NAME

static final String BEAN_NAME

Bean name

See Also:

Constant Field Values

Method Detail

getKey

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

Constructs a cache key

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

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

Constructs a cache key

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

String getFromCache(String strKey)

Get the path html from cache

Parameters:

strKey - the cache key

Returns:

the path html, or null if it's not in cache or the cache is not enabled

putInCache

void putInCache(String strKey,
                String path)

Put a path in cache

Parameters:

strKey - the cache key

path - the path html