org.apache.jetspeed.cache.impl
Class JetspeedContentCacheKey

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

All Implemented Interfaces:

Serializable, org.apache.jetspeed.cache.ContentCacheKey

public class JetspeedContentCacheKey
extends Object
implements org.apache.jetspeed.cache.ContentCacheKey, 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

Field Summary

private String	key
private String	pipeline
private String	requestParameter
private String	sessionAttribute
private String	sessionId
private String	username
private String	windowId

Constructor Summary

JetspeedContentCacheKey()

JetspeedContentCacheKey(List segments, org.apache.jetspeed.request.RequestContext context, String windowId)

Method Summary

void	createFromSession(String sessionId, String pipeline, String windowId)
void	createFromUser(String username, String pipeline, String windowId)
String	getKey()
String	getPipeline()
String	getRequestParameter()
String	getSessionAttribute()
String	getSessionId()
String	getUsername()
String	getWindowId()
void	setPipeline(String pipeline)
void	setRequestParameter(String requestParameter)
void	setSessionAttribute(String sessionAttribute)
void	setSessionId(String sessionId)
void	setUsername(String username)
void	setWindowId(String windowId)

Methods inherited from class java.lang.Object

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

Field Detail

username

private String username

pipeline

private String pipeline

windowId

private String windowId

sessionId

private String sessionId

requestParameter

private String requestParameter

sessionAttribute

private String sessionAttribute

key

private String key

Constructor Detail

JetspeedContentCacheKey

public JetspeedContentCacheKey(List segments,
                               org.apache.jetspeed.request.RequestContext context,
                               String windowId)

JetspeedContentCacheKey

public JetspeedContentCacheKey()

Method Detail

createFromUser

public void createFromUser(String username,
                           String pipeline,
                           String windowId)

Specified by:

createFromUser in interface org.apache.jetspeed.cache.ContentCacheKey

createFromSession

public void createFromSession(String sessionId,
                              String pipeline,
                              String windowId)

Specified by:

createFromSession in interface org.apache.jetspeed.cache.ContentCacheKey

getKey

public String getKey()

Specified by:

getKey in interface org.apache.jetspeed.cache.ContentCacheKey

getPipeline

public String getPipeline()

Specified by:

getPipeline in interface org.apache.jetspeed.cache.ContentCacheKey

getRequestParameter

public String getRequestParameter()

Specified by:

getRequestParameter in interface org.apache.jetspeed.cache.ContentCacheKey

getSessionAttribute

public String getSessionAttribute()

Specified by:

getSessionAttribute in interface org.apache.jetspeed.cache.ContentCacheKey

getSessionId

public String getSessionId()

Specified by:

getSessionId in interface org.apache.jetspeed.cache.ContentCacheKey

getUsername

public String getUsername()

Specified by:

getUsername in interface org.apache.jetspeed.cache.ContentCacheKey

getWindowId

public String getWindowId()

Specified by:

getWindowId in interface org.apache.jetspeed.cache.ContentCacheKey

setPipeline

public void setPipeline(String pipeline)

setRequestParameter

public void setRequestParameter(String requestParameter)

setSessionAttribute

public void setSessionAttribute(String sessionAttribute)

setSessionId

public void setSessionId(String sessionId)

setUsername

public void setUsername(String username)

setWindowId

public void setWindowId(String windowId)