ContentCacheKey (Jetspeed-2 Core API 2.2.2 API)

This project has retired. For details please refer to its Attic page.

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.jetspeed.cache
Interface ContentCacheKey

All Superinterfaces:: java.io.Serializable

public interface ContentCacheKey
extends java.io.Serializable
extends java.io.Serializable

Provides interface to all Content Caches (Portlet API cache)

Version:: $Id: $
Author:: David Sean Taylor

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

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

Method Detail

getUsername

java.lang.String getUsername()

Get the username or null if not used

Returns:

getPipeline

java.lang.String getPipeline()

Get the pipeline name or null if not used

Returns:

getWindowId

java.lang.String getWindowId()

Get the window (portlet fragment) id

Returns:

getSessionId

java.lang.String getSessionId()

Get the session id or null if not used

Returns:

getRequestParameter

java.lang.String getRequestParameter()

Returns:

getSessionAttribute

java.lang.String getSessionAttribute()

Returns:

getKey

java.lang.String getKey()

Return the full key as a string

Returns:

createFromUser

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

createFromSession

void createFromSession(java.lang.String sessionid,
                       java.lang.String pipeline,
                       java.lang.String windowId)