org.apache.jetspeed.request
Class JetspeedRequestContext

java.lang.Object
  org.apache.jetspeed.request.JetspeedRequestContext

All Implemented Interfaces:

RequestContext

public class JetspeedRequestContext
extends java.lang.Object
implements RequestContext

Jetspeed Request Context is associated with each portal request. The request holds the contextual information shared amongst components in the portal, accessed through a common valve pipeline.

Version:

$Id: JetspeedRequestContext.java,v 1.19 2004/05/25 01:37:12 taylor Exp $

Author:

David Sean Taylor

Field Summary

Fields inherited from interface org.apache.jetspeed.request.RequestContext

REQUEST_PORTALENV

Constructor Summary

JetspeedRequestContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.ServletConfig config, UserInfoManager userInfoMgr)
Create a new Request Context

JetspeedRequestContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.ServletConfig config, UserInfoManager userInfoMgr, java.util.Map objects)

Method Summary

org.apache.pluto.om.window.PortletWindow	getActionWindow() Get the target Portlet Action Window
java.lang.Object	getAttribute(java.lang.String key) Get a request attribute associated with this single request.
CapabilityMap	getCapabilityMap() get the Capability Map
java.lang.String	getCharacterEncoding() get the character encoding
javax.servlet.ServletConfig	getConfig() Gets the HTTP Servlet Config
ContentDispatcher	getContentDispatcher() Gets the content dispatcher for this request
java.util.Locale	getLocale() Gets the locale associated with this request.
java.lang.String	getMediaType() get the Media Type
java.lang.String	getMimeType() get the mimeType for the request
java.util.Map	getObjects() Return a map of Jetspeed Request Context objects configured via Spring Map
ContentPage	getPage() Gets the target page for this request
java.util.Map	getParameterMap() Use this method to get a map of request parameters on the generalized request, decoupling request parameter manipulation from servlet API.
java.lang.String	getPath() Returns any extra path information associated with the URL the client sent when it made this request.
Pipeline	getPipeline() Get the current executing pipeline
PortalURL	getPortalURL() Gets the Portal URL for the current request.
org.apache.pluto.om.portlet.PortletDefinition	getPortletDefinition()
org.apache.pluto.om.common.Language	getPreferedLanguage(org.apache.pluto.om.portlet.PortletDefinition portlet) getPreferedLanguage
java.util.Map	getProfileLocators() Gets the profile locators for this request
javax.servlet.http.HttpServletRequest	getRequest() Gets the HTTP Servlet Request.
java.lang.Object	getRequestAttribute(java.lang.String key)
javax.servlet.http.HttpServletRequest	getRequestForWindow(org.apache.pluto.om.window.PortletWindow window) getRequestForWindow
java.lang.String	getRequestParameter(java.lang.String key) Use this method to get a request parameter on the generalized request, decoupling request parameter manipulation from servlet API.
javax.servlet.http.HttpServletResponse	getResponse() Gets the HTTP Servlet Response.
javax.servlet.http.HttpServletResponse	getResponseForWindow(org.apache.pluto.om.window.PortletWindow window) getResponseForWindow
java.lang.Object	getSessionAttribute(java.lang.String key) Gets an attribute from the session.
javax.security.auth.Subject	getSubject() Gets the subject associated with the authorized entity.
java.util.Map	getUserInfoMap(org.apache.pluto.om.common.ObjectID oid) Returns the user info map of user attributes for a given portlet application.
java.security.Principal	getUserPrincipal() Gets the Jetspeed primary user principal associated with the authorized entity.
ContentPage	locatePage(Profiler profiler, java.lang.String nonProfiledPath) Locates a specific page using the profiler and site manager location algorithms from a generalized non-profiled path to the first page matching the path
java.lang.Throwable	popActionFailure(org.apache.pluto.om.window.PortletWindow window)
void	setActionFailure(org.apache.pluto.om.window.PortletWindow window, java.lang.Throwable actionFailure)
void	setActionWindow(org.apache.pluto.om.window.PortletWindow portletWindow) Sets the target Portlet Action Window
void	setAttribute(java.lang.String key, java.lang.Object value) Sets an attribute into the request.
void	setCapabilityMap(CapabilityMap map) Set the capabilityMap.
void	setCharacterEncoding(java.lang.String enc) set character encoding
void	setContentDispatcher(ContentDispatcher dispatcher) Sets the content dispatcher for this request
void	setLocale(java.util.Locale locale) Sets the locale associated with this request.
void	setMediaType(java.lang.String mediaType) Set the mediaType.
void	setMimeType(java.lang.String mimeType) Set the Mimetype.
void	setPage(ContentPage page) Sets the target page for this request
void	setPath(java.lang.String path) setPath
void	setPipeline(Pipeline pipeline) Set the current pipeline
void	setPortalURL(PortalURL url) Sets the Portal URL for the current request.
void	setPortletDefinition(org.apache.pluto.om.portlet.PortletDefinition portletDefinition)
void	setProfileLocators(java.util.Map locators) Sets the target page profile locators for this request
void	setRequest(javax.servlet.http.HttpServletRequest request) Sets the HTTP Servlet Request.
void	setRequestParameter(java.lang.String key, java.lang.String value)
void	setResponse(javax.servlet.http.HttpServletResponse response) Sets the HTTP Servlet Response.
void	setSessionAttribute(java.lang.String key, java.lang.Object value) Sets an attribute into the session.
void	setSubject(javax.security.auth.Subject subject) Sets the subject associated with the authorized entity.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JetspeedRequestContext

public JetspeedRequestContext(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response,
                              javax.servlet.ServletConfig config,
                              UserInfoManager userInfoMgr)

Create a new Request Context

Parameters:

pc -

request -

response -

config -

JetspeedRequestContext

public JetspeedRequestContext(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response,
                              javax.servlet.ServletConfig config,
                              UserInfoManager userInfoMgr,
                              java.util.Map objects)

Method Detail

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

Description copied from interface: RequestContext

Gets the HTTP Servlet Request. This is the Servlet containers raw request object. This request should be wrapped using getPortletRequestForWindow() before being processed by the portlet container.

Specified by:

getRequest in interface RequestContext

Returns:

HttpServletRequest

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

Description copied from interface: RequestContext

Gets the HTTP Servlet Response. This is the Servlet containers raw response object. This response should be wrapped using getPortletResponseForWindow() before being processed by the portlet container.

Specified by:

getResponse in interface RequestContext

Returns:

HttpServletResponse

getConfig

public javax.servlet.ServletConfig getConfig()

Description copied from interface: RequestContext

Gets the HTTP Servlet Config

Specified by:

getConfig in interface RequestContext

Returns:

ServletConfig

getProfileLocators

public java.util.Map getProfileLocators()

Description copied from interface: RequestContext

Gets the profile locators for this request

Specified by:

getProfileLocators in interface RequestContext

Returns:

Profile locators by locator name

setProfileLocators

public void setProfileLocators(java.util.Map locators)

Description copied from interface: RequestContext

Sets the target page profile locators for this request

Specified by:

setProfileLocators in interface RequestContext

Parameters:

locators - The target profile locators by locator name

getPage

public ContentPage getPage()

Description copied from interface: RequestContext

Gets the target page for this request

Specified by:

getPage in interface RequestContext

Returns:

Page

setPage

public void setPage(ContentPage page)

Description copied from interface: RequestContext

Sets the target page for this request

Specified by:

setPage in interface RequestContext

Parameters:

page - The target page

getPortletDefinition

public org.apache.pluto.om.portlet.PortletDefinition getPortletDefinition()

setPortletDefinition

public void setPortletDefinition(org.apache.pluto.om.portlet.PortletDefinition portletDefinition)

getContentDispatcher

public ContentDispatcher getContentDispatcher()

Description copied from interface: RequestContext

Gets the content dispatcher for this request

Specified by:

getContentDispatcher in interface RequestContext

Returns:

ContentDispatcher

setContentDispatcher

public void setContentDispatcher(ContentDispatcher dispatcher)

Description copied from interface: RequestContext

Sets the content dispatcher for this request

Specified by:

setContentDispatcher in interface RequestContext

Parameters:

dispatcher - The ContentDispatcher to use for this request

getCapabilityMap

public CapabilityMap getCapabilityMap()

get the Capability Map

Specified by:

getCapabilityMap in interface RequestContext

setMimeType

public void setMimeType(java.lang.String mimeType)

Set the Mimetype. Used by the CapabilityValve

Specified by:

setMimeType in interface RequestContext

Parameters:

mimeType -

getMimeType

public java.lang.String getMimeType()

get the mimeType for the request

Specified by:

getMimeType in interface RequestContext

setMediaType

public void setMediaType(java.lang.String mediaType)

Set the mediaType. Used by the CapabilityValve

Specified by:

setMediaType in interface RequestContext

Parameters:

mediaType -

getMediaType

public java.lang.String getMediaType()

get the Media Type

Specified by:

getMediaType in interface RequestContext

getActionWindow

public org.apache.pluto.om.window.PortletWindow getActionWindow()

Get the target Portlet Action Window

Specified by:

getActionWindow in interface RequestContext

Returns:

PortletWindow The target portlet window

setActionWindow

public void setActionWindow(org.apache.pluto.om.window.PortletWindow portletWindow)

Sets the target Portlet Action Window

Specified by:

setActionWindow in interface RequestContext

Parameters:

window -

setCapabilityMap

public void setCapabilityMap(CapabilityMap map)

Set the capabilityMap. Used by the CapabilityValve

Specified by:

setCapabilityMap in interface RequestContext

Parameters:

capabilityMap -

getCharacterEncoding

public java.lang.String getCharacterEncoding()

get the character encoding

Specified by:

getCharacterEncoding in interface RequestContext

setCharacterEncoding

public void setCharacterEncoding(java.lang.String enc)

set character encoding

Specified by:

setCharacterEncoding in interface RequestContext

Parameters:

enc -

getRequestForWindow

public javax.servlet.http.HttpServletRequest getRequestForWindow(org.apache.pluto.om.window.PortletWindow window)

getRequestForWindow

Specified by:

getRequestForWindow in interface RequestContext

Parameters:

window -

Returns:

See Also:

RequestContext.getRequestForWindow(org.apache.pluto.om.window.PortletWindow)

getResponseForWindow

public javax.servlet.http.HttpServletResponse getResponseForWindow(org.apache.pluto.om.window.PortletWindow window)

getResponseForWindow

Specified by:

getResponseForWindow in interface RequestContext

Parameters:

window -

Returns:

See Also:

RequestContext.getResponseForWindow(org.apache.pluto.om.window.PortletWindow)

getSubject

public javax.security.auth.Subject getSubject()

Description copied from interface: RequestContext

Gets the subject associated with the authorized entity. This subject can be used to provide credentials and principals.

Specified by:

getSubject in interface RequestContext

Returns:

The JAAS subject on this request.

See Also:

RequestContext.getSubject()

getUserPrincipal

public java.security.Principal getUserPrincipal()

Description copied from interface: RequestContext

Gets the Jetspeed primary user principal associated with the authorized entity.

Specified by:

getUserPrincipal in interface RequestContext

Returns:

The primary principal on this request.

setSubject

public void setSubject(javax.security.auth.Subject subject)

Description copied from interface: RequestContext

Sets the subject associated with the authorized entity. This subject can be used to provide credentials and principals.

Specified by:

setSubject in interface RequestContext

Parameters:

subject - The JAAS subject on this request.

See Also:

RequestContext.setSubject(javax.security.auth.Subject)

getLocale

public java.util.Locale getLocale()

Description copied from interface: RequestContext

Gets the locale associated with this request.

Specified by:

getLocale in interface RequestContext

Returns:

The locale associated with this request.

See Also:

RequestContext.getLocale()

setLocale

public void setLocale(java.util.Locale locale)

Description copied from interface: RequestContext

Sets the locale associated with this request.

Specified by:

setLocale in interface RequestContext

See Also:

RequestContext.setLocale(java.util.Locale)

getRequestParameter

public java.lang.String getRequestParameter(java.lang.String key)

Description copied from interface: RequestContext

Use this method to get a request parameter on the generalized request, decoupling request parameter manipulation from servlet API. This parameter could be on the Http Servlet request, in that case it simply passes through to the servlet request.

Specified by:

getRequestParameter in interface RequestContext

Parameters:

key - The parameter unique key

Returns:

The object associated with the uniqu

See Also:

RequestContext.getRequestParameter(java.lang.String)

setRequestParameter

public void setRequestParameter(java.lang.String key,
                                java.lang.String value)

getParameterMap

public java.util.Map getParameterMap()

Description copied from interface: RequestContext

Use this method to get a map of request parameters on the generalized request, decoupling request parameter manipulation from servlet API. The parameters returned could be on the Http Servlet request, in that case it simply passes through to the servlet request.

Specified by:

getParameterMap in interface RequestContext

Returns:

See Also:

RequestContext.getParameterMap()

getRequestAttribute

public java.lang.Object getRequestAttribute(java.lang.String key)

See Also:

org.apache.jetspeed.request.RequestContext#getRequestAttribute(java.lang.String)

getSessionAttribute

public java.lang.Object getSessionAttribute(java.lang.String key)

Description copied from interface: RequestContext

Gets an attribute from the session. This method is decoupled from the servlet api request to facilitate abstractions for testing and other programs not connected to a servlet application.

Specified by:

getSessionAttribute in interface RequestContext

Parameters:

key - The key of the attribute

Returns:

The value of the attribute

See Also:

RequestContext.getSessionAttribute(java.lang.String)

setSessionAttribute

public void setSessionAttribute(java.lang.String key,
                                java.lang.Object value)

Description copied from interface: RequestContext

Sets an attribute into the session. This method is decoupled from the servlet api request to facilitate abstractions for testing and other programs not connected to a servlet application.

Specified by:

setSessionAttribute in interface RequestContext

Parameters:

key - The key of the session attribute

value - The value of the session attribute

See Also:

RequestContext.setSessionAttribute(java.lang.String, java.lang.Object)

setAttribute

public void setAttribute(java.lang.String key,
                         java.lang.Object value)

Description copied from interface: RequestContext

Sets an attribute into the request. This method is decoupled from the servlet api request to facilitate abstractions for testing and other programs not connected to a servlet application.

Specified by:

setAttribute in interface RequestContext

Parameters:

key - The key of the request attribute

value - The value of the request attribute

See Also:

RequestContext.setAttribute(java.lang.String, java.lang.Object)

getAttribute

public java.lang.Object getAttribute(java.lang.String key)

Description copied from interface: RequestContext

Get a request attribute associated with this single request.

Specified by:

getAttribute in interface RequestContext

Parameters:

key - The key of the request attribute

Returns:

The value of the request attribute

See Also:

RequestContext.getAttribute(java.lang.String)

getPath

public java.lang.String getPath()

Description copied from interface: RequestContext

Returns any extra path information associated with the URL the client sent when it made this request. The extra path information follows the servlet path but precedes the query string. This method returns null if there was no extra path information.

This method should function identically to HttpServletRequest.getPathInfo() except for that it removes ALL portal/portlet navigational state information from the path info string.

Specified by:

getPath in interface RequestContext

Returns:

the path

See Also:

RequestContext.getPath()

setPortalURL

public void setPortalURL(PortalURL url)

Description copied from interface: RequestContext

Sets the Portal URL for the current request.

Specified by:

setPortalURL in interface RequestContext

getPortalURL

public PortalURL getPortalURL()

Description copied from interface: RequestContext

Gets the Portal URL for the current request.

Specified by:

getPortalURL in interface RequestContext

Returns:

The Portal URL object for the current request. This method will never return a null value.

getUserInfoMap

public java.util.Map getUserInfoMap(org.apache.pluto.om.common.ObjectID oid)

Description copied from interface: RequestContext

Returns the user info map of user attributes for a given portlet application.

Specified by:

getUserInfoMap in interface RequestContext

Parameters:

oid - The portlet application object id.

Returns:

The PortletRequest.USER_INFO map.

See Also:

RequestContext.getUserInfoMap(org.apache.pluto.om.common.ObjectID)

getPreferedLanguage

public org.apache.pluto.om.common.Language getPreferedLanguage(org.apache.pluto.om.portlet.PortletDefinition portlet)

getPreferedLanguage

Specified by:

getPreferedLanguage in interface RequestContext

Parameters:

portlet -

Returns:

See Also:

RequestContext.getPreferedLanguage(org.apache.pluto.om.portlet.PortletDefinition)

setPath

public void setPath(java.lang.String path)

setPath

Specified by:

setPath in interface RequestContext

Parameters:

path -

See Also:

RequestContext.setPath(java.lang.String)

popActionFailure

public java.lang.Throwable popActionFailure(org.apache.pluto.om.window.PortletWindow window)

Specified by:

popActionFailure in interface RequestContext

Returns:

setActionFailure

public void setActionFailure(org.apache.pluto.om.window.PortletWindow window,
                             java.lang.Throwable actionFailure)

Specified by:

setActionFailure in interface RequestContext

getPipeline

public Pipeline getPipeline()

Get the current executing pipeline

Specified by:

getPipeline in interface RequestContext

Returns:

Pipeline

setPipeline

public void setPipeline(Pipeline pipeline)

Set the current pipeline

Specified by:

setPipeline in interface RequestContext

Parameters:

pipeline -

setRequest

public void setRequest(javax.servlet.http.HttpServletRequest request)

Description copied from interface: RequestContext

Sets the HTTP Servlet Request. This is the Servlet containers raw request object. This request should be wrapped using getPortletRequestForWindow() before being processed by the portlet container.

Specified by:

setRequest in interface RequestContext

Parameters:

request - The request to set.

setResponse

public void setResponse(javax.servlet.http.HttpServletResponse response)

Description copied from interface: RequestContext

Sets the HTTP Servlet Response. This is the Servlet containers raw response object. This response should be wrapped using getPortletResponseForWindow() before being processed by the portlet container.

Specified by:

setResponse in interface RequestContext

Parameters:

response - The request to set.

locatePage

public ContentPage locatePage(Profiler profiler,
                              java.lang.String nonProfiledPath)

Description copied from interface: RequestContext

Locates a specific page using the profiler and site manager location algorithms from a generalized non-profiled path to the first page matching the path

Specified by:

locatePage in interface RequestContext

Parameters:

profiler - The profiler component to use in the search

Returns:

A Content Page located by the profiler, or null if not found

getObjects

public java.util.Map getObjects()

Description copied from interface: RequestContext

Return a map of Jetspeed Request Context objects configured via Spring Map

Specified by:

getObjects in interface RequestContext

Returns:

a Map of request context objects