org.apache.jetspeed.cache
Interface ContentCacheKeyGenerator

public interface ContentCacheKeyGenerator

Provides interface to Jetspeed for content cache key generation

Version:

$Id: $

Author:

David Sean Taylor

Method Summary

ContentCacheKey	createCacheKey(RequestContext context, java.lang.String windowId) Normalized and pluggable cache key generator
ContentCacheKey	createSessionCacheKey(java.lang.String sessionid, java.lang.String pipeline, java.lang.String windowId) Create a cache key without request context information, but by providing required parameters sessinid and windowid
ContentCacheKey	createUserCacheKey(java.lang.String username, java.lang.String pipeline, java.lang.String windowId) Create a cache key without request context information, but by providing required parameters username and windowid
boolean	isCacheBySessionId() return true if caching is by session id, not username
boolean	isCacheByUsername() return true if caching is by username, not sessionid

Method Detail

createCacheKey

ContentCacheKey createCacheKey(RequestContext context,
                               java.lang.String windowId)

Normalized and pluggable cache key generator

Parameters:

context -

windowId - The window id of the portlet to be cached.

Returns:

Since:

2.1.2

createUserCacheKey

ContentCacheKey createUserCacheKey(java.lang.String username,
                                   java.lang.String pipeline,
                                   java.lang.String windowId)

Create a cache key without request context information, but by providing required parameters username and windowid

Parameters:

username -

pipeline - "desktop" or "portal"

windowId -

Returns:

createSessionCacheKey

ContentCacheKey createSessionCacheKey(java.lang.String sessionid,
                                      java.lang.String pipeline,
                                      java.lang.String windowId)

Create a cache key without request context information, but by providing required parameters sessinid and windowid

Parameters:

sessionid -

pipeline - "desktop" or "portal"

windowId -

Returns:

isCacheBySessionId

boolean isCacheBySessionId()

return true if caching is by session id, not username

Returns:

isCacheByUsername

boolean isCacheByUsername()

return true if caching is by username, not sessionid

Returns: