|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.jetspeed.request.JetspeedRequestContext
public class JetspeedRequestContext
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.
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 |
---|
public JetspeedRequestContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.ServletConfig config, UserInfoManager userInfoMgr)
pc
- request
- response
- config
- public JetspeedRequestContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.ServletConfig config, UserInfoManager userInfoMgr, java.util.Map objects)
Method Detail |
---|
public javax.servlet.http.HttpServletRequest getRequest()
RequestContext
getPortletRequestForWindow()
before
being processed by the portlet container.
getRequest
in interface RequestContext
public javax.servlet.http.HttpServletResponse getResponse()
RequestContext
getPortletResponseForWindow()
before
being processed by the portlet container.
getResponse
in interface RequestContext
public javax.servlet.ServletConfig getConfig()
RequestContext
getConfig
in interface RequestContext
public java.util.Map getProfileLocators()
RequestContext
getProfileLocators
in interface RequestContext
public void setProfileLocators(java.util.Map locators)
RequestContext
setProfileLocators
in interface RequestContext
locators
- The target profile locators by locator namepublic ContentPage getPage()
RequestContext
getPage
in interface RequestContext
public void setPage(ContentPage page)
RequestContext
setPage
in interface RequestContext
page
- The target pagepublic org.apache.pluto.om.portlet.PortletDefinition getPortletDefinition()
public void setPortletDefinition(org.apache.pluto.om.portlet.PortletDefinition portletDefinition)
public ContentDispatcher getContentDispatcher()
RequestContext
getContentDispatcher
in interface RequestContext
public void setContentDispatcher(ContentDispatcher dispatcher)
RequestContext
setContentDispatcher
in interface RequestContext
dispatcher
- The ContentDispatcher to use for this requestpublic CapabilityMap getCapabilityMap()
getCapabilityMap
in interface RequestContext
public void setMimeType(java.lang.String mimeType)
setMimeType
in interface RequestContext
mimeType
- public java.lang.String getMimeType()
getMimeType
in interface RequestContext
public void setMediaType(java.lang.String mediaType)
setMediaType
in interface RequestContext
mediaType
- public java.lang.String getMediaType()
getMediaType
in interface RequestContext
public org.apache.pluto.om.window.PortletWindow getActionWindow()
getActionWindow
in interface RequestContext
public void setActionWindow(org.apache.pluto.om.window.PortletWindow portletWindow)
setActionWindow
in interface RequestContext
window
- public void setCapabilityMap(CapabilityMap map)
setCapabilityMap
in interface RequestContext
capabilityMap
- public java.lang.String getCharacterEncoding()
getCharacterEncoding
in interface RequestContext
public void setCharacterEncoding(java.lang.String enc)
setCharacterEncoding
in interface RequestContext
enc
- public javax.servlet.http.HttpServletRequest getRequestForWindow(org.apache.pluto.om.window.PortletWindow window)
getRequestForWindow
getRequestForWindow
in interface RequestContext
window
-
RequestContext.getRequestForWindow(org.apache.pluto.om.window.PortletWindow)
public javax.servlet.http.HttpServletResponse getResponseForWindow(org.apache.pluto.om.window.PortletWindow window)
getResponseForWindow
getResponseForWindow
in interface RequestContext
window
-
RequestContext.getResponseForWindow(org.apache.pluto.om.window.PortletWindow)
public javax.security.auth.Subject getSubject()
RequestContext
getSubject
in interface RequestContext
RequestContext.getSubject()
public java.security.Principal getUserPrincipal()
RequestContext
getUserPrincipal
in interface RequestContext
public void setSubject(javax.security.auth.Subject subject)
RequestContext
setSubject
in interface RequestContext
subject
- The JAAS subject on this request.RequestContext.setSubject(javax.security.auth.Subject)
public java.util.Locale getLocale()
RequestContext
getLocale
in interface RequestContext
RequestContext.getLocale()
public void setLocale(java.util.Locale locale)
RequestContext
setLocale
in interface RequestContext
RequestContext.setLocale(java.util.Locale)
public java.lang.String getRequestParameter(java.lang.String key)
RequestContext
getRequestParameter
in interface RequestContext
key
- The parameter unique key
RequestContext.getRequestParameter(java.lang.String)
public void setRequestParameter(java.lang.String key, java.lang.String value)
public java.util.Map getParameterMap()
RequestContext
getParameterMap
in interface RequestContext
RequestContext.getParameterMap()
public java.lang.Object getRequestAttribute(java.lang.String key)
org.apache.jetspeed.request.RequestContext#getRequestAttribute(java.lang.String)
public java.lang.Object getSessionAttribute(java.lang.String key)
RequestContext
getSessionAttribute
in interface RequestContext
key
- The key of the attribute
RequestContext.getSessionAttribute(java.lang.String)
public void setSessionAttribute(java.lang.String key, java.lang.Object value)
RequestContext
setSessionAttribute
in interface RequestContext
key
- The key of the session attributevalue
- The value of the session attributeRequestContext.setSessionAttribute(java.lang.String,
java.lang.Object)
public void setAttribute(java.lang.String key, java.lang.Object value)
RequestContext
setAttribute
in interface RequestContext
key
- The key of the request attributevalue
- The value of the request attributeRequestContext.setAttribute(java.lang.String,
java.lang.Object)
public java.lang.Object getAttribute(java.lang.String key)
RequestContext
getAttribute
in interface RequestContext
key
- The key of the request attribute
RequestContext.getAttribute(java.lang.String)
public java.lang.String getPath()
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.
getPath
in interface RequestContext
RequestContext.getPath()
public void setPortalURL(PortalURL url)
RequestContext
setPortalURL
in interface RequestContext
public PortalURL getPortalURL()
RequestContext
getPortalURL
in interface RequestContext
null
value.public java.util.Map getUserInfoMap(org.apache.pluto.om.common.ObjectID oid)
RequestContext
getUserInfoMap
in interface RequestContext
oid
- The portlet application object id.
RequestContext.getUserInfoMap(org.apache.pluto.om.common.ObjectID)
public org.apache.pluto.om.common.Language getPreferedLanguage(org.apache.pluto.om.portlet.PortletDefinition portlet)
getPreferedLanguage
getPreferedLanguage
in interface RequestContext
portlet
-
RequestContext.getPreferedLanguage(org.apache.pluto.om.portlet.PortletDefinition)
public void setPath(java.lang.String path)
setPath
setPath
in interface RequestContext
path
- RequestContext.setPath(java.lang.String)
public java.lang.Throwable popActionFailure(org.apache.pluto.om.window.PortletWindow window)
popActionFailure
in interface RequestContext
public void setActionFailure(org.apache.pluto.om.window.PortletWindow window, java.lang.Throwable actionFailure)
setActionFailure
in interface RequestContext
public Pipeline getPipeline()
getPipeline
in interface RequestContext
public void setPipeline(Pipeline pipeline)
setPipeline
in interface RequestContext
pipeline
- public void setRequest(javax.servlet.http.HttpServletRequest request)
RequestContext
getPortletRequestForWindow()
before
being processed by the portlet container.
setRequest
in interface RequestContext
request
- The request to set.public void setResponse(javax.servlet.http.HttpServletResponse response)
RequestContext
getPortletResponseForWindow()
before
being processed by the portlet container.
setResponse
in interface RequestContext
response
- The request to set.public ContentPage locatePage(Profiler profiler, java.lang.String nonProfiledPath)
RequestContext
locatePage
in interface RequestContext
profiler
- The profiler component to use in the search
public java.util.Map getObjects()
RequestContext
getObjects
in interface RequestContext
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |