org.apache.jetspeed.portalsite
Interface PortalSiteSessionContext

All Superinterfaces:

Serializable

public interface PortalSiteSessionContext
extends Serializable

This describes the session context for the portal-site component.

Version:

$Id: PortalSiteSessionContext.java 553375 2007-07-05 05:37:00Z taylor $

Author:

Randy Watler

Method Summary

PageManager	getPageManager() getPageManager - return PageManager component instance
String	getPipeline() get which pipeline this context is stored for
boolean	isValid() isValid - return flag indicating whether this context instance is valid or if it is stale after being persisted and reloaded as session state
PortalSiteRequestContext	newRequestContext(Map requestProfileLocators) newRequestContext - create a new request context instance with fallback and history
PortalSiteRequestContext	newRequestContext(Map requestProfileLocators, boolean requestFallback) newRequestContext - create a new request context instance with history
PortalSiteRequestContext	newRequestContext(Map requestProfileLocators, boolean requestFallback, boolean useHistory) newRequestContext - create a new request context instance
void	setPipeline(String pipeline) set which pipeline this context is stored for

Method Detail

newRequestContext

PortalSiteRequestContext newRequestContext(Map requestProfileLocators)

newRequestContext - create a new request context instance with fallback and history

Parameters:

requestProfileLocators - request profile locators

Returns:

new request context instance

newRequestContext

PortalSiteRequestContext newRequestContext(Map requestProfileLocators,
                                           boolean requestFallback)

newRequestContext - create a new request context instance with history

Parameters:

requestProfileLocators - request profile locators

requestFallback - flag specifying whether to fallback to root folder if locators do not select a page or access is forbidden

Returns:

new request context instance

newRequestContext

PortalSiteRequestContext newRequestContext(Map requestProfileLocators,
                                           boolean requestFallback,
                                           boolean useHistory)

newRequestContext - create a new request context instance

Parameters:

requestProfileLocators - request profile locators

requestFallback - flag specifying whether to fallback to root folder if locators do not select a page or access is forbidden

useHistory - flag indicating whether to use visited page history to select default page per site folder

Returns:

new request context instance

getPageManager

PageManager getPageManager()

getPageManager - return PageManager component instance

Returns:

PageManager instance

isValid

boolean isValid()

isValid - return flag indicating whether this context instance is valid or if it is stale after being persisted and reloaded as session state

Returns:

valid context status

setPipeline

void setPipeline(String pipeline)

set which pipeline this context is stored for

Parameters:

pipeline -

getPipeline

String getPipeline()

get which pipeline this context is stored for