org.apache.jetspeed.cache.impl
Class JetspeedContentCacheKey

java.lang.Object
  org.apache.jetspeed.cache.impl.JetspeedContentCacheKey

All Implemented Interfaces:

java.io.Serializable, ContentCacheKey

public class JetspeedContentCacheKey
extends java.lang.Object
implements ContentCacheKey, java.io.Serializable

The content cache key holds an immutable cache key definition. Cache key definitions are based on the following required properties:

• username
• windowid
• pipeline

and the following optional properties:

• sessionid
• request.{parameter}
• session.{attribute}

The string representation of this key is calculated once upon construction.

Version:

$Id: $

Author:

David Sean Taylor

See Also:

Serialized Form

Constructor Summary

JetspeedContentCacheKey()

JetspeedContentCacheKey(java.util.List segments, RequestContext context, java.lang.String windowId)

Method Summary

void	createFromSession(java.lang.String sessionId, java.lang.String pipeline, java.lang.String windowId)
void	createFromUser(java.lang.String username, java.lang.String pipeline, java.lang.String windowId)
java.lang.String	getKey() Return the full key as a string
java.lang.String	getPipeline() Get the pipeline name or null if not used
java.lang.String	getRequestParameter()
java.lang.String	getSessionAttribute()
java.lang.String	getSessionId() Get the session id or null if not used
java.lang.String	getUsername() Get the username or null if not used
java.lang.String	getWindowId() Get the window (portlet fragment) id
void	setPipeline(java.lang.String pipeline)
void	setRequestParameter(java.lang.String requestParameter)
void	setSessionAttribute(java.lang.String sessionAttribute)
void	setSessionId(java.lang.String sessionId)
void	setUsername(java.lang.String username)
void	setWindowId(java.lang.String windowId)

Methods inherited from class java.lang.Object

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

Constructor Detail

JetspeedContentCacheKey

public JetspeedContentCacheKey(java.util.List segments,
                               RequestContext context,
                               java.lang.String windowId)

JetspeedContentCacheKey

public JetspeedContentCacheKey()

Method Detail

createFromUser

public void createFromUser(java.lang.String username,
                           java.lang.String pipeline,
                           java.lang.String windowId)

Specified by:

createFromUser in interface ContentCacheKey

createFromSession

public void createFromSession(java.lang.String sessionId,
                              java.lang.String pipeline,
                              java.lang.String windowId)

Specified by:

createFromSession in interface ContentCacheKey

getKey

public java.lang.String getKey()

Description copied from interface: ContentCacheKey

Return the full key as a string

Specified by:

getKey in interface ContentCacheKey

Returns:

getPipeline

public java.lang.String getPipeline()

Description copied from interface: ContentCacheKey

Get the pipeline name or null if not used

Specified by:

getPipeline in interface ContentCacheKey

Returns:

getRequestParameter

public java.lang.String getRequestParameter()

Specified by:

getRequestParameter in interface ContentCacheKey

Returns:

getSessionAttribute

public java.lang.String getSessionAttribute()

Specified by:

getSessionAttribute in interface ContentCacheKey

Returns:

getSessionId

public java.lang.String getSessionId()

Description copied from interface: ContentCacheKey

Get the session id or null if not used

Specified by:

getSessionId in interface ContentCacheKey

Returns:

getUsername

public java.lang.String getUsername()

Description copied from interface: ContentCacheKey

Get the username or null if not used

Specified by:

getUsername in interface ContentCacheKey

Returns:

getWindowId

public java.lang.String getWindowId()

Description copied from interface: ContentCacheKey

Get the window (portlet fragment) id

Specified by:

getWindowId in interface ContentCacheKey

Returns:

setPipeline

public void setPipeline(java.lang.String pipeline)

setRequestParameter

public void setRequestParameter(java.lang.String requestParameter)

setSessionAttribute

public void setSessionAttribute(java.lang.String sessionAttribute)

setSessionId

public void setSessionId(java.lang.String sessionId)

setUsername

public void setUsername(java.lang.String username)

setWindowId

public void setWindowId(java.lang.String windowId)