|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Portal Request Context is associated with each request
Field Summary | |
static String |
REQUEST_PORTALENV
|
Method Summary | |
org.apache.pluto.om.window.PortletWindow |
getActionWindow()
Get the target Action Window |
Object |
getAttribute(String key)
Get a request attribute associated with this single request. |
CapabilityMap |
getCapabilityMap()
Get the Capability Map |
String |
getCharacterEncoding()
get the character encoding |
javax.servlet.ServletConfig |
getConfig()
Gets the HTTP Servlet Config |
ContentDispatcher |
getContentDispatcher()
Gets the content dispatcher for this request |
Locale |
getLocale()
Gets the locale associated with this request. |
String |
getMediaType()
get the Media Type |
String |
getMimeType()
Get the mimeType for the request |
ContentPage |
getPage()
Gets the target page for this request |
Map |
getParameterMap()
Use this method to get a map of request parameters on the generalized request, decoupling request parameter manipulation from servlet API. |
String |
getPath()
Returns any extra path information associated with the URL the client sent when it made this request. |
PortalURL |
getPortalURL()
Gets the Portal URL for the current request. |
org.apache.pluto.om.common.Language |
getPreferedLanguage(org.apache.pluto.om.portlet.PortletDefinition portlet)
getPreferedLanguage |
Map |
getProfileLocators()
Gets the profile locators for this request |
javax.servlet.http.HttpServletRequest |
getRequest()
Gets the HTTP Servlet Request. |
javax.servlet.http.HttpServletRequest |
getRequestForWindow(org.apache.pluto.om.window.PortletWindow window)
getRequestForWindow |
String |
getRequestParameter(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 |
Object |
getSessionAttribute(String key)
Gets an attribute from the session. |
Subject |
getSubject()
Gets the subject associated with the authorized entity. |
Map |
getUserInfoMap(org.apache.pluto.om.common.ObjectID oid)
Returns the user info map of user attributes for a given portlet application. |
Throwable |
popActionFailure(org.apache.pluto.om.window.PortletWindow window)
|
void |
setActionFailure(org.apache.pluto.om.window.PortletWindow window,
Throwable actionFailure)
|
void |
setActionWindow(org.apache.pluto.om.window.PortletWindow window)
Sets the target Portlet Window |
void |
setAttribute(String key,
Object value)
Sets an attribute into the request. |
void |
setCapabilityMap(CapabilityMap map)
Set the capabilityMap. |
void |
setCharacterEncoding(String enc)
set character encoding |
void |
setContentDispatcher(ContentDispatcher dispatcher)
Sets the content dispatcher for this request |
void |
setLocale(Locale locale)
Sets the locale associated with this request. |
void |
setMediaType(String mediaType)
Set the mediaType. |
void |
setMimeType(String mimeType)
Set the Mimetype. |
void |
setPage(ContentPage page)
Sets the target page for this request |
void |
setPath(String path)
setPath |
void |
setPortalURL(PortalURL portalUrl)
Sets the Portal URL for the current request. |
void |
setProfileLocators(Map locators)
Sets the target page profile locators for this request |
void |
setSessionAttribute(String key,
Object value)
Sets an attribute into the session. |
void |
setSubject(Subject subject)
Sets the subject associated with the authorized entity. |
Field Detail |
public static final String REQUEST_PORTALENV
Method Detail |
public javax.servlet.http.HttpServletRequest getRequest()
getPortletRequestForWindow()
before
being processed by the portlet container.
public javax.servlet.http.HttpServletResponse getResponse()
getPortletResponseForWindow()
before
being processed by the portlet container.
public javax.servlet.ServletConfig getConfig()
public Map getProfileLocators()
public void setProfileLocators(Map locators)
locators
- The target profile locators by locator namepublic ContentPage getPage()
public void setPage(ContentPage page)
page
- The target pagepublic ContentDispatcher getContentDispatcher()
public void setContentDispatcher(ContentDispatcher dispatcher)
dispatcher
- The ContentDispatcher to use for this requestpublic void setCapabilityMap(CapabilityMap map)
public CapabilityMap getCapabilityMap()
public void setMimeType(String mimeType)
mimeType
- public String getMimeType()
public void setMediaType(String mediaType)
mediaType
- public String getMediaType()
public PortalURL getPortalURL()
null
value.
IllegalStateException
- if portalUrl
if has not been set.public void setPortalURL(PortalURL portalUrl)
IllegalStateException
- if portalUrl
has been set already.
IllegalArgumentException
- if a null value is passed in.public org.apache.pluto.om.window.PortletWindow getActionWindow()
public void setActionWindow(org.apache.pluto.om.window.PortletWindow window)
window
- public String getCharacterEncoding()
public void setCharacterEncoding(String enc)
enc
- public javax.servlet.http.HttpServletRequest getRequestForWindow(org.apache.pluto.om.window.PortletWindow window)
getRequestForWindow
Takes a PortletWindow and generates a HttpServletRequest that accurately represents that PortletWindow's request parameters
window
- PortletWindow that we are build a request for
public javax.servlet.http.HttpServletResponse getResponseForWindow(org.apache.pluto.om.window.PortletWindow window)
getResponseForWindow
Takes a PortletWindow and generates a HttpServletResponse that accurately represents that PortletWindow's request parameters.
window
- PortletWindow that we are build a response for
public Subject getSubject()
public void setSubject(Subject subject)
subject
- The JAAS subject on this request.public Locale getLocale()
public void setLocale(Locale locale)
public String getRequestParameter(String key)
key
- The parameter unique key
public Map getParameterMap()
public Object getSessionAttribute(String key)
key
- The key of the attribute
public void setSessionAttribute(String key, Object value)
key
- The key of the session attributevalue
- The value of the session attributepublic Object getAttribute(String key)
key
- The key of the request attribute
public void setAttribute(String key, Object value)
key
- The key of the request attributevalue
- The value of the request attributepublic String getPath()
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.
public void setPath(String path)
setPath
Allows the manual overriding of path Jetspeed 2 will look to resolves pages and folders.
path
- public Map getUserInfoMap(org.apache.pluto.om.common.ObjectID oid)
oid
- The portlet application object id.
public org.apache.pluto.om.common.Language getPreferedLanguage(org.apache.pluto.om.portlet.PortletDefinition portlet)
getPreferedLanguage
Returns the Language object for theportlet
which most
closely matches the prefences of the currently requesting client.
portlet
-
Language
that matches, as closely as possible, that of
the requesting client.public Throwable popActionFailure(org.apache.pluto.om.window.PortletWindow window)
public void setActionFailure(org.apache.pluto.om.window.PortletWindow window, Throwable actionFailure)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |