org.apache.jetspeed.portalsite
Interface PortalSiteSessionContext

All Superinterfaces:

java.io.Serializable

public interface PortalSiteSessionContext
extends java.io.Serializable

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

Version:

$Id: PortalSiteSessionContext.java 929033 2010-03-30 08:14:54Z rwatler $

Author:

Randy Watler

Method Summary

PortalSiteContentTypeMapper	getContentTypeMapper() getContentTypeMapper - return PortalSiteContentTypeMapper component instance
PageManager	getPageManager() getPageManager - return PageManager component instance
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(java.util.Map requestProfileLocators, java.lang.String requestUserPrincipal) newRequestContext - create a new request context instance with fallback and history
PortalSiteRequestContext	newRequestContext(java.util.Map requestProfileLocators, java.lang.String requestUserPrincipal, boolean requestFallback) newRequestContext - create a new request context instance with history
PortalSiteRequestContext	newRequestContext(java.util.Map requestProfileLocators, java.lang.String requestUserPrincipal, boolean requestFallback, boolean useHistory) newRequestContext - create a new request context instance
PortalSiteRequestContext	newRequestContext(java.util.Map requestProfileLocators, java.lang.String requestUserPrincipal, boolean requestFallback, boolean useHistory, boolean forceReservedVisible, boolean forceTemplatesAccessible) newRequestContext - create a new request context instance
PortalSiteRequestContext	newRequestContext(java.lang.String requestPath, java.lang.String requestServerName, java.lang.String requestUserPrincipal) newRequestContext - create a new request context instance without profiling support with fallback and history
PortalSiteRequestContext	newRequestContext(java.lang.String requestPath, java.lang.String requestServerName, java.lang.String requestUserPrincipal, boolean requestFallback) newRequestContext - create a new request context instance without profiling support with history
PortalSiteRequestContext	newRequestContext(java.lang.String requestPath, java.lang.String requestServerName, java.lang.String requestUserPrincipal, boolean requestFallback, boolean useHistory) newRequestContext - create a new request context instance without profiling support
PortalSiteRequestContext	newRequestContext(java.lang.String requestPath, java.lang.String requestServerName, java.lang.String requestUserPrincipal, boolean requestFallback, boolean useHistory, boolean forceTemplatesAccessible) newRequestContext - create a new request context instance without profiling support

Method Detail

newRequestContext

PortalSiteRequestContext newRequestContext(java.util.Map requestProfileLocators,
                                           java.lang.String requestUserPrincipal)

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

Parameters:

requestProfileLocators - request profile locators

requestUserPrincipal - request user principal

Returns:

new request context instance

newRequestContext

PortalSiteRequestContext newRequestContext(java.util.Map requestProfileLocators,
                                           java.lang.String requestUserPrincipal,
                                           boolean requestFallback)

newRequestContext - create a new request context instance with history

Parameters:

requestProfileLocators - request profile locators

requestUserPrincipal - request user principal

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(java.util.Map requestProfileLocators,
                                           java.lang.String requestUserPrincipal,
                                           boolean requestFallback,
                                           boolean useHistory)

newRequestContext - create a new request context instance

Parameters:

requestProfileLocators - request profile locators

requestUserPrincipal - request user principal

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

newRequestContext

PortalSiteRequestContext newRequestContext(java.util.Map requestProfileLocators,
                                           java.lang.String requestUserPrincipal,
                                           boolean requestFallback,
                                           boolean useHistory,
                                           boolean forceReservedVisible,
                                           boolean forceTemplatesAccessible)

newRequestContext - create a new request context instance

Parameters:

requestProfileLocators - request profile locators

requestUserPrincipal - request user principal

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

forceReservedVisible - force reserved/hidden folders visible in site view

forceTemplatesAccessible - force templates accessible to requests in site view

Returns:

new request context instance

newRequestContext

PortalSiteRequestContext newRequestContext(java.lang.String requestPath,
                                           java.lang.String requestServerName,
                                           java.lang.String requestUserPrincipal)

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

Parameters:

requestPath - request path

requestServerName - request server name

requestUserPrincipal - request user principal

Returns:

new request context instance

newRequestContext

PortalSiteRequestContext newRequestContext(java.lang.String requestPath,
                                           java.lang.String requestServerName,
                                           java.lang.String requestUserPrincipal,
                                           boolean requestFallback)

newRequestContext - create a new request context instance without profiling support with history

Parameters:

requestPath - request path

requestServerName - request server name

requestUserPrincipal - request user principal

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(java.lang.String requestPath,
                                           java.lang.String requestServerName,
                                           java.lang.String requestUserPrincipal,
                                           boolean requestFallback,
                                           boolean useHistory)

newRequestContext - create a new request context instance without profiling support

Parameters:

requestPath - request path

requestServerName - request server name

requestUserPrincipal - request user principal

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

newRequestContext

PortalSiteRequestContext newRequestContext(java.lang.String requestPath,
                                           java.lang.String requestServerName,
                                           java.lang.String requestUserPrincipal,
                                           boolean requestFallback,
                                           boolean useHistory,
                                           boolean forceTemplatesAccessible)

newRequestContext - create a new request context instance without profiling support

Parameters:

requestPath - request path

requestServerName - request server name

requestUserPrincipal - request user principal

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

forceTemplatesAccessible - force templates accessible to requests in site view

Returns:

new request context instance

getPageManager

PageManager getPageManager()

getPageManager - return PageManager component instance

Returns:

PageManager instance

getContentTypeMapper

PortalSiteContentTypeMapper getContentTypeMapper()

getContentTypeMapper - return PortalSiteContentTypeMapper component instance

Returns:

PortalSiteContentTypeMapper 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