org.apache.jetspeed.services.rundata
Interface JetspeedRunData

All Superinterfaces:

org.apache.turbine.util.pool.Recyclable, org.apache.turbine.util.RunData, org.apache.turbine.services.rundata.TurbineRunData

All Known Implementing Classes:

DefaultJetspeedRunData

public interface JetspeedRunData

extends org.apache.turbine.services.rundata.TurbineRunData

This interface extends the RunData interface with methods specific to the needs of a Jetspeed like portal implementation. Several of these properties may be put in the base RunData interface in future releases of Turbine

Version:

$Id: JetspeedRunData.java,v 1.11 2005/03/21 18:21:44 sgala Exp $

Author:

Raphaël Luta

Field Summary

static int	CUSTOMIZE
static int	MAXIMIZE
static int	NORMAL

Method Summary

void	cleanupFromCustomization() Clean up from customization
CapabilityMap	getCapability() Returns the capability map for the user agent issuing this request
Portlet	getCustomized() Returns the portlet id which should be customized for this request
Profile	getCustomizedProfile() Get the psml profile being customized.
JetspeedUser	getJetspeedUser() Returns the Jetspeed User (same as getUser without cast)
java.lang.String	getJs_peid() Returns the portlet id (PEID) referenced in this request
int	getMode() Returns the portlet id which should be maximized for this request
java.lang.String	getPageSessionId() Access an identifier for the current request's PageSession.
SessionState	getPageSessionState() Access the current request's PageSession state object.
java.lang.String	getPortlet() Returns the portlet id referenced in this request
SessionState	getPortletSessionState(java.lang.String id) Access the current request's PortletSession state object.
Profile	getProfile() Gets the user portal profile for the current request
java.lang.String	getRequestedTemplate() Returns the template path as requested from the parameters
java.lang.String	getUserId() Get the user id for the current user.
SessionState	getUserSessionState() Access the current request's UserSession state object.
void	setCustomized(Portlet p) Sets the portlet id to customize
void	setCustomizedProfile(Profile profile) Set the psml profile being customized.
void	setJs_peid(java.lang.String peid) Sets the portlet id (PEID) referenced for this request
void	setMode(int mode) Sets the portlet id to maximize
void	setMode(java.lang.String mode) Sets the portlet id to maximize
void	setPortlet(java.lang.String id) Sets the portlet id referenced for this request
void	setProfile(Profile profile) Sets the user portal profile for the current request
void	setRequestedTemplate(java.lang.String id) Sets the template path as requested from the parameters

Methods inherited from interface org.apache.turbine.services.rundata.TurbineRunData

getCookieParser, getParameterParser, setCookieParser, setParameterParser, setRequest, setResponse, setServerData, setServletConfig, setSession

Methods inherited from interface org.apache.turbine.util.RunData

addMessage, addMessage, declareDirectResponse, getACL, getAction, getCharSet, getContentType, getContextPath, getCookies, getJNDIContexts, getLayout, getLayoutTemplate, getLocale, getMessage, getMessageAsHTML, getMessages, getOut, getPage, getParameters, getRedirectURI, getRemoteAddr, getRemoteHost, getRequest, getResponse, getScreen, getScreenTemplate, getScriptName, getServerData, getServerName, getServerPort, getServerScheme, getServletConfig, getServletContext, getSession, getStackTrace, getStackTraceException, getStatusCode, getSystemErrors, getTemplateEncoding, getTemplateInfo, getTitle, getUser, getUserAgent, getUserFromSession, getVarDebug, hasAction, hasMessage, hasScreen, isOutSet, isPageSet, populate, removeUserFromSession, save, setACL, setAction, setCharSet, setContentType, setJNDIContexts, setLayout, setLayoutTemplate, setLocale, setMessage, setMessage, setMessages, setRedirectURI, setScreen, setScreenTemplate, setStackTrace, setStatusCode, setSystemError, setTemplateEncoding, setTitle, setUser, unsetMessage, userExists

Methods inherited from interface org.apache.turbine.util.pool.Recyclable

dispose, isDisposed, recycle

Field Detail

NORMAL

public static final int NORMAL

See Also:

Constant Field Values

CUSTOMIZE

public static final int CUSTOMIZE

See Also:

Constant Field Values

MAXIMIZE

public static final int MAXIMIZE

See Also:

Constant Field Values

Method Detail

getJetspeedUser

public JetspeedUser getJetspeedUser()

Returns the Jetspeed User (same as getUser without cast)

Returns:

the current user.

getPortlet

public java.lang.String getPortlet()

Returns the portlet id referenced in this request

Returns:

the portlet id referenced or null

getJs_peid

public java.lang.String getJs_peid()

Returns the portlet id (PEID) referenced in this request

Returns:

the portlet id (PEID) referenced or null

setPortlet

public void setPortlet(java.lang.String id)

Sets the portlet id referenced for this request

Parameters:

id - the portlet id referenced in this request

setJs_peid

public void setJs_peid(java.lang.String peid)

Sets the portlet id (PEID) referenced for this request

getCustomized

public Portlet getCustomized()

Returns the portlet id which should be customized for this request

Returns:

the portlet id being customized or null

setCustomized

public void setCustomized(Portlet p)

Sets the portlet id to customize

getCustomizedProfile

public Profile getCustomizedProfile()

Get the psml profile being customized.

Returns:

the Profile being customized.

setCustomizedProfile

public void setCustomizedProfile(Profile profile)

Set the psml profile being customized.

Parameters:

profile - The Profile being customized.

cleanupFromCustomization

public void cleanupFromCustomization()

Clean up from customization

getMode

public int getMode()

Returns the portlet id which should be maximized for this request

Returns:

the portlet id being maximized or null

setMode

public void setMode(int mode)

Sets the portlet id to maximize

setMode

public void setMode(java.lang.String mode)

Sets the portlet id to maximize

getRequestedTemplate

public java.lang.String getRequestedTemplate()

Returns the template path as requested from the parameters

setRequestedTemplate

public void setRequestedTemplate(java.lang.String id)

Sets the template path as requested from the parameters

getCapability

public CapabilityMap getCapability()

Returns the capability map for the user agent issuing this request

Returns:

a capability map objet

getProfile

public Profile getProfile()

Gets the user portal profile for the current request

Returns:

a profile implementation for the current request

setProfile

public void setProfile(Profile profile)

Sets the user portal profile for the current request

Parameters:

profile - a profile implementation for the current request

getUserId

public java.lang.String getUserId()

Get the user id for the current user. This method is provided as an abstraction to the very implementation specific method of retrieving user ids in Turbine.

Returns:

String The current user's id.

getPageSessionId

public java.lang.String getPageSessionId()

Access an identifier for the current request's PageSession. A PageSession is a specific portal page being viewed in a specific user session (and perhaps, but not yet [@todo] in a specific browser window).

Returns:

the identifier for the current request's PageSession.

getUserSessionState

public SessionState getUserSessionState()

Access the current request's UserSession state object.

Returns:

the current request's UserSession state object (may be null).

getPageSessionState

public SessionState getPageSessionState()

Access the current request's PageSession state object.

Returns:

the current request's PageSession state object (may be null).

getPortletSessionState

public SessionState getPortletSessionState(java.lang.String id)

Access the current request's PortletSession state object.

Parameters:

id - The Portlet's unique id.

Returns:

the current request's PortletSession state object. (may be null).