org.apache.jetspeed.services.rundata
Class DefaultJetspeedRunData

java.lang.Object
  extended byorg.apache.turbine.util.pool.RecyclableSupport
      extended byorg.apache.turbine.services.rundata.DefaultTurbineRunData
          extended byorg.apache.jetspeed.services.rundata.DefaultJetspeedRunData
All Implemented Interfaces:
JetspeedRunData, org.apache.turbine.util.pool.Recyclable, org.apache.turbine.util.RunData, org.apache.turbine.services.rundata.TurbineRunData

public class DefaultJetspeedRunData
extends org.apache.turbine.services.rundata.DefaultTurbineRunData
implements JetspeedRunData

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: DefaultJetspeedRunData.java,v 1.21 2005/03/21 18:21:44 sgala Exp $
Author:
RaphaŽl Luta, Santiago Gala, Paul Spencer

Field Summary
 
Fields inherited from class org.apache.turbine.services.rundata.DefaultTurbineRunData
cookies
 
Fields inherited from interface org.apache.jetspeed.services.rundata.JetspeedRunData
CUSTOMIZE, MAXIMIZE, NORMAL
 
Constructor Summary
DefaultJetspeedRunData()
           
 
Method Summary
 void cleanupFromCustomization()
          Clean up from customization
 void dispose()
          Clears the state of this object for recycling...
 org.apache.turbine.util.security.AccessControlList getACL()
          Deprecated.  
 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 class org.apache.turbine.services.rundata.DefaultTurbineRunData
addMessage, addMessage, declareDirectResponse, getAction, getCharSet, getContentType, getContextPath, getCookieParser, getCookies, getDefaultCharSet, getDefaultLocale, getJNDIContexts, getLayout, getLayoutTemplate, getLocale, getMessage, getMessageAsHTML, getMessages, getOut, getPage, getParameterParser, 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, getUserFromSession, getVarDebug, hasAction, hasMessage, hasScreen, isOutSet, isPageSet, populate, recycle, removeUserFromSession, removeUserFromSession, save, setACL, setAction, setCharSet, setContentType, setContextPath, setCookieParser, setJNDIContexts, setLayout, setLayoutTemplate, setLocale, setMessage, setMessage, setMessages, setOut, setParameterParser, setRedirectURI, setRequest, setResponse, setScreen, setScreenTemplate, setScriptName, setServerData, setServerName, setServerPort, setServerScheme, setServletConfig, setSession, setStackTrace, setStatusCode, setSystemError, setTemplateEncoding, setTitle, setUser, unsetMessage, userExists
 
Methods inherited from class org.apache.turbine.util.pool.RecyclableSupport
doDispose, isDisposed, Recyclable
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
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, 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
isDisposed, recycle
 

Constructor Detail

DefaultJetspeedRunData

public DefaultJetspeedRunData()
Method Detail

getPortlet

public java.lang.String getPortlet()
Returns the portlet id referenced in this request

Specified by:
getPortlet in interface JetspeedRunData
Returns:
the portlet id referenced or null

setPortlet

public void setPortlet(java.lang.String id)
Sets the portlet id referenced for this request

Specified by:
setPortlet in interface JetspeedRunData
Parameters:
id - the portlet id referenced in this request

getCustomized

public Portlet getCustomized()
Returns the portlet id which should be customized for this request

Specified by:
getCustomized in interface JetspeedRunData
Returns:
the portlet id being customized or null

setCustomized

public void setCustomized(Portlet p)
Sets the portlet id to customize

Specified by:
setCustomized in interface JetspeedRunData

getCustomizedProfile

public Profile getCustomizedProfile()
Get the psml profile being customized.

Specified by:
getCustomizedProfile in interface JetspeedRunData
Returns:
the Profile being customized.

setCustomizedProfile

public void setCustomizedProfile(Profile profile)
Set the psml profile being customized.

Specified by:
setCustomizedProfile in interface JetspeedRunData
Parameters:
profile - The Profile being customized.

cleanupFromCustomization

public void cleanupFromCustomization()
Clean up from customization

Specified by:
cleanupFromCustomization in interface JetspeedRunData

getMode

public int getMode()
Returns the portlet id which should be maximized for this request

Specified by:
getMode in interface JetspeedRunData
Returns:
the portlet id being maximized or null

setMode

public void setMode(int mode)
Sets the portlet id to maximize

Specified by:
setMode in interface JetspeedRunData

setMode

public void setMode(java.lang.String mode)
Sets the portlet id to maximize

Specified by:
setMode in interface JetspeedRunData

getRequestedTemplate

public java.lang.String getRequestedTemplate()
Returns the template path as requested from the parameters

Specified by:
getRequestedTemplate in interface JetspeedRunData

setRequestedTemplate

public void setRequestedTemplate(java.lang.String id)
Sets the template path as requested from the parameters

Specified by:
setRequestedTemplate in interface JetspeedRunData

getCapability

public CapabilityMap getCapability()
Returns the capability map for the user agent issuing this request

Specified by:
getCapability in interface JetspeedRunData
Returns:
a capability map objet

setProfile

public void setProfile(Profile profile)
Sets the user portal profile for the current request

Specified by:
setProfile in interface JetspeedRunData
Parameters:
profile - a profile implementation for the current request

getProfile

public Profile getProfile()
Gets the user portal profile for the current request

Specified by:
getProfile in interface JetspeedRunData
Returns:
a profile implementation for the current request

dispose

public void dispose()
Clears the state of this object for recycling...

Specified by:
dispose in interface org.apache.turbine.util.pool.Recyclable

getJs_peid

public java.lang.String getJs_peid()
Returns the portlet id (PEID) referenced in this request

Specified by:
getJs_peid in interface JetspeedRunData
Returns:
the portlet id (PEID) referenced or null

setJs_peid

public void setJs_peid(java.lang.String peid)
Sets the portlet id (PEID) referenced for this request

Specified by:
setJs_peid in interface JetspeedRunData

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.

Specified by:
getUserId in interface JetspeedRunData
Returns:
int 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).

Specified by:
getPageSessionId in interface JetspeedRunData
Returns:
the identifier for the current request's PageSession.

getUserSessionState

public SessionState getUserSessionState()
Access the current request's UserSession state object.

Specified by:
getUserSessionState in interface JetspeedRunData
Returns:
the current request's UserSession state object (may be null).

getPageSessionState

public SessionState getPageSessionState()
Access the current request's PageSession state object.

Specified by:
getPageSessionState in interface JetspeedRunData
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.

Specified by:
getPortletSessionState in interface JetspeedRunData
Parameters:
id - The Portlet's unique id.
Returns:
the current request's PortletSession state object. (may be null).

getJetspeedUser

public JetspeedUser getJetspeedUser()
Returns the Jetspeed User (same as getUser without cast)

Specified by:
getJetspeedUser in interface JetspeedRunData
Returns:
the current user.

getACL

public org.apache.turbine.util.security.AccessControlList getACL()
Deprecated.  

Function is deprecated by required to compile with Turbine

Specified by:
getACL in interface org.apache.turbine.util.RunData


Copyright © 2000-2005 Apache Software Foundation. All Rights Reserved.