|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.servlet.ServletRequestWrapper
javax.servlet.http.HttpServletRequestWrapper
org.apache.pluto.internal.impl.PortletRequestImpl
org.apache.pluto.internal.impl.ResourceRequestImpl
public class ResourceRequestImpl
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface javax.portlet.PortletRequest |
---|
PortletRequest.P3PUserInfos |
Field Summary |
---|
Fields inherited from class org.apache.pluto.internal.impl.PortletRequestImpl |
---|
container, internalPortletWindow |
Fields inherited from interface javax.portlet.ResourceRequest |
---|
ETAG |
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 |
Fields inherited from interface javax.servlet.http.HttpServletRequest |
---|
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH |
Constructor Summary | |
---|---|
ResourceRequestImpl(PortletContainer container,
InternalPortletWindow internalPortletWindow,
javax.servlet.http.HttpServletRequest servletRequest)
|
Method Summary | |
---|---|
javax.servlet.http.Cookie[] |
getCookieProperties()
|
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. |
javax.servlet.ServletInputStream |
getInputStream()
|
String |
getLifecyclePhase()
|
String |
getParameter(String name)
Returns the value of a request parameter as a String ,
or null if the parameter does not exist. |
String[] |
getParameterValues(String name)
Returns an array of String objects containing
all of the values the given request parameter has, or
null if the parameter does not exist. |
InputStream |
getPortletInputStream()
Retrieves the body of the HTTP request from client to portal as binary data using an InputStream . |
PortletPreferences |
getPreferences()
FIXME: |
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. |
Methods inherited from class javax.servlet.http.HttpServletRequestWrapper |
---|
getMethod, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL |
Methods inherited from class javax.servlet.ServletRequestWrapper |
---|
getCharacterEncoding, getContentLength, getContentType, getRequest, setRequest |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.pluto.internal.InternalPortletRequest |
---|
getHttpServletRequest, getInternalPortletWindow, getPortletContainer, init, isForwarded, isIncluded, release, setAttribute, setForwarded, setForwardedQueryString, setIncluded, setIncludedQueryString |
Methods inherited from interface javax.portlet.ClientDataRequest |
---|
getCharacterEncoding, getContentLength, getContentType, getMethod, getReader, setCharacterEncoding |
Methods inherited from interface javax.servlet.ServletRequest |
---|
getCharacterEncoding, getContentLength, getContentType |
Constructor Detail |
---|
public ResourceRequestImpl(PortletContainer container, InternalPortletWindow internalPortletWindow, javax.servlet.http.HttpServletRequest servletRequest)
Method Detail |
---|
public InputStream getPortletInputStream() throws IOException
ClientDataRequest
InputStream
. Either this method or
ClientDataRequest.getReader()
may be called to read the body, but not both.
For HTTP POST data of type application/x-www-form-urlencoded
this method throws an IllegalStateException
as this data has been already processed by the
portal/portlet-container and is available as request parameters.
getPortletInputStream
in interface ClientDataRequest
IOException
- if an input or output exception occurredpublic String[] getParameterValues(String name)
PortletRequest
String
objects containing
all of the values the given request parameter has, or
null
if the parameter does not exist.
The returned parameters are "x-www-form-urlencoded" decoded.
If the parameter has a single value, the array has a length of 1.
getParameterValues
in interface PortletRequest
getParameterValues
in interface javax.servlet.ServletRequest
getParameterValues
in class PortletRequestImpl
name
- a String
containing the name of
the parameter the value of which is requested
String
objects
containing the parameter values.PortletRequest.getParameter(java.lang.String)
public String getParameter(String name)
PortletRequest
String
,
or null
if the parameter does not exist. Request parameters
are extra information sent with the request. The returned parameter
are "x-www-form-urlencoded" decoded.
Only parameters targeted to the current portlet are accessible.
This method should only be used if the
parameter has only one value. If the parameter might have
more than one value, use PortletRequest.getParameterValues(java.lang.String)
.
If this method is used with a multivalued
parameter, the value returned is equal to the first value
in the array returned by getParameterValues
.
getParameter
in interface PortletRequest
getParameter
in interface javax.servlet.ServletRequest
getParameter
in class PortletRequestImpl
name
- a String
specifying the
name of the parameter
String
representing the
single value of the parameterPortletRequest.getParameterValues(java.lang.String)
public PortletPreferences getPreferences()
getPreferences
in interface PortletRequest
getPreferences
in class PortletRequestImpl
public String getETag()
ResourceRequest
null
if no cached response exists.
This call returns the same value as
ResourceRequest.getProperty(ResourceRequest.ETAG)
.
getETag
in interface ResourceRequest
null
if no cached response exists.public String getLifecyclePhase()
getLifecyclePhase
in interface InternalPortletRequest
getLifecyclePhase
in class PortletRequestImpl
public String getResourceID()
ResourceRequest
null
if no resource ID was set on the URL.
getResourceID
in interface ResourceRequest
null
if no resource ID was set on the URL.public javax.servlet.http.Cookie[] getCookieProperties()
public javax.servlet.ServletInputStream getInputStream() throws IOException
getInputStream
in interface javax.servlet.ServletRequest
getInputStream
in class PortletRequestImpl
IOException
public Map<String,String[]> getPrivateRenderParameterMap()
ResourceRequest
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
.
getPrivateRenderParameterMap
in interface ResourceRequest
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[]
).
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |