|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ResourceRequest
The ResourceRequest
interface represents the request send to the portlet for rendering resources. It extends the ClientDataRequest interface and provides resource request information to portlets.
The portlet container creates an ResourceRequest
object and passes it as argument to the portlet's serveResource
method.
The ResourceRequest
is provided with the current portlet mode, window state, and render parameters that the portlet can access via the PortletResourceRequest
with getPortletMode
and, getWindowState
, or one of the getParameter
methods. ResourceURLs cannot change the current portlet mode, window state or render parameters. Parameters set on a resource URL are not render parameters but parameters for serving this resource and will last only for only this the current serveResource request.
If a parameter is set that has the same name as a render parameter that this resource URL contains, the render parameter must be the last entry in the parameter value array.
ClientDataRequest
, ResourceServingPortlet
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface javax.portlet.PortletRequest |
---|
PortletRequest.P3PUserInfos |
Field Summary | |
---|---|
static String |
ETAG This property is set by the container if the container has a cached response for the given validation tag. |
Fields inherited from interface javax.portlet.PortletRequest |
---|
ACTION_PHASE, ACTION_SCOPE_ID, BASIC_AUTH, CCPP_PROFILE, CLIENT_CERT_AUTH, DIGEST_AUTH, EVENT_PHASE, FORM_AUTH, LIFECYCLE_PHASE, RENDER_HEADERS, RENDER_MARKUP, RENDER_PART, RENDER_PHASE, RESOURCE_PHASE, USER_INFO |
Method Summary | |
---|---|
String |
getCacheability() Returns the cache level of this resource request. |
String |
getETag() Returns the validation tag if the portlet container has a cached response for this validation tag, or null if no cached response exists. |
Map<String,String[]> |
getPrivateRenderParameterMap() Returns a Map of the private render parameters of this request. |
String |
getResourceID() Returns the resource ID set on the ResourceURL or null if no resource ID was set on the URL. |
String |
getResponseContentType() Returns the portal preferred content type for the response. |
Enumeration<String> |
getResponseContentTypes() Gets a list of content types which the portal accepts for the response. |
Methods inherited from interface javax.portlet.ClientDataRequest |
---|
getCharacterEncoding, getContentLength, getContentType, getMethod, getPortletInputStream, getReader, setCharacterEncoding |
Field Detail |
---|
static final String ETAG
getProperty
method.
The value is "portlet.ETag "
.
Method Detail |
---|
String getETag()
null
if no cached response exists.
This call returns the same value as ResourceRequest.getProperty(ResourceRequest.ETAG)
.
null
if no cached response exists.String getResourceID()
null
if no resource ID was set on the URL.null
if no resource ID was set on the URL.Map<String,String[]> getPrivateRenderParameterMap()
Map
of the private render parameters of this request. Private parameters are not shared with other portlets or components. The returned parameters are "x-www-form-urlencoded" decoded.
The parameters returned do not include the resource parameters that the portlet may have set on the resource URL triggering this serveResource
call.
The values in the returned Map
are from type String array (String[]
).
If no private parameters exist this method returns an empty Map
.
Map
containing private parameter names as keys and private parameter values as map values, or an empty Map
if no private parameters exist. The keys in the parameter map are of type String. The values in the parameter map are of type String array (String[]
).String getResponseContentType()
The returned content type should be based on the HTTP Accept header provided by the client.
getResponseContentType
in interface PortletRequest
Enumeration<String> getResponseContentTypes()
The returned content types should be based on the HTTP Accept header provided by the client.
getResponseContentTypes
in interface PortletRequest
String getCacheability()
Possible return values are: ResourceURL.FULL, ResourceURL.PORTLET
or ResourceURL.PAGE
.
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2010, Oracle. All rights reserved.