Portal Request Context is associated with each request
author: David Sean Taylor version: $Id: RequestContext.java,v 1.14 2005/04/29 14:00:48 weaver Exp $
getParameterMap() Use this method to get a map of request parameters on the generalized request,
decoupling request parameter manipulation from servlet API.
getRequestParameter(String key) Use this method to get a request parameter on the generalized request,
decoupling request parameter manipulation from servlet API.
getUserInfoMap(ObjectID oid) Returns the user info map of user attributes for a given portlet application.
Parameters: oid - The portlet application object id.
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.
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.
Gets the Portal URL for the current request.
The Portal URL object for the current request. This method will neverreturn a null value. throws: IllegalStateException - if portalUrlif has not been set.
getPreferedLanguage
Language getPreferedLanguage(PortletDefinition portlet)(Code)
getPreferedLanguage
Returns the Language object for the portlet which most
closely matches the prefences of the currently requesting client.
Parameters: portlet - Language that matches, as closely as possible, that ofthe requesting client.
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.
HttpServletRequest
Takes a PortletWindow and generates a HttpServletRequest that
accurately represents that PortletWindow's request parameters
Parameters: window - PortletWindow that we are build a request for HttpServletRequest that wraps the existing servletcontainer's request that can interpret encoded portlet informationfor this PortletWindow
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.
Parameters: key - The parameter unique key The object associated with the uniqu
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.
HttpServletResponse
Takes a PortletWindow and generates a HttpServletResponse that
accurately represents that PortletWindow's request parameters.
Parameters: window - PortletWindow that we are build a response for HttpServletRequest that wraps the existing servletcontainer's request that can interpret encoded portlet informationfor this PortletWindow
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.
Parameters: key - The key of the attribute The value of the attribute
Gets the subject associated with the authorized entity.
This subject can be used to provide credentials and principals.
The JAAS subject on this request.
Returns the user info map of user attributes for a given portlet application.
Parameters: oid - The portlet application object id. The PortletRequest.USER_INFO map.
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
Parameters: profiler - The profiler component to use in the search A Content Page located by the profiler, or null if not found
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.
Parameters: key - The key of the request attribute Parameters: value - The value of the request attribute
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.
HttpServletRequest
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.
HttpServletResponse
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.
Parameters: key - The key of the session attribute Parameters: value - The value of the session attribute
Sets the subject associated with the authorized entity.
This subject can be used to provide credentials and principals.
Parameters: subject - The JAAS subject on this request.