public interface ClientDataRequest extends PortletRequest
ClientDataRequest
represents the request information
of the HTTP request issued from the client to the portal.PortletRequest
PortletRequest.P3PUserInfos
ACTION_PHASE, ACTION_SCOPE_ID, BASIC_AUTH, CCPP_PROFILE, CLIENT_CERT_AUTH, DIGEST_AUTH, EVENT_PHASE, FORM_AUTH, HEADER_PHASE, LIFECYCLE_PHASE, RENDER_HEADERS, RENDER_MARKUP, RENDER_PART, RENDER_PHASE, RESOURCE_PHASE, USER_INFO
Modifier and Type | Method and Description |
---|---|
String |
getCharacterEncoding()
Returns the name of the character encoding used in the body of this request.
|
int |
getContentLength()
Returns the length, in bytes, of the request body
which is made available by the input stream, or -1 if the
length is not known.
|
long |
getContentLengthLong()
Returns the length, in bytes, of the request body
which is made available by the input stream, or -1 if the
length is not known.
|
String |
getContentType()
Returns the MIME type of the body of the request,
or null if the type is not known.
|
String |
getMethod()
Returns the name of the HTTP method with which this request was made,
for example, GET, POST, or PUT.
|
javax.servlet.http.Part |
getPart(String name)
Gets the Part with the given name.
|
Collection<javax.servlet.http.Part> |
getParts()
Gets all the Part components of this request, provided that it is of type multipart/form-data.
|
InputStream |
getPortletInputStream()
Retrieves the body of the HTTP request from client to
portal as binary data using
an
InputStream . |
BufferedReader |
getReader()
Retrieves the body of the HTTP request from the client to the portal
as character data using
a
BufferedReader . |
void |
setCharacterEncoding(String enc)
Overrides the name of the character encoding used in the body of this
request.
|
getAttribute, getAttributeNames, getAuthType, getContextPath, getCookies, getLocale, getLocales, getParameter, getParameterMap, getParameterNames, getParameterValues, getPortalContext, getPortletContext, getPortletSession, getPortletSession, getPreferences, getPrivateParameterMap, getProperties, getProperty, getPropertyNames, getPublicParameterMap, getRemoteUser, getRequestedSessionId, getResponseContentType, getResponseContentTypes, getScheme, getServerName, getServerPort, getUserAgent, getUserPrincipal, getWindowID, isPortletModeAllowed, isRequestedSessionIdValid, isSecure, isUserInRole, isWindowStateAllowed, removeAttribute, setAttribute
getPortletMode, getRenderParameters, getWindowState
InputStream getPortletInputStream() throws IOException
InputStream
. Either this method or
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.
IllegalStateException
- if getReader was already called, or it is a
HTTP POST data of type application/x-www-form-urlencodedIOException
- if an input or output exception occurredvoid setCharacterEncoding(String enc) throws UnsupportedEncodingException
getReader()
or getPortletInputStream()
.
This method only sets the character set for the Reader that the
getReader()
method returns.
enc
- a String
containing the name of
the character encoding.UnsupportedEncodingException
- if this is not a valid encodingIllegalStateException
- if this method is called after
reading request parameters or reading input using
getReader()
BufferedReader getReader() throws UnsupportedEncodingException, IOException
BufferedReader
. The reader translates the character
data according to the character encoding used on the body.
Either this method or getPortletInputStream()
may be called to read the
body, 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.
BufferedReader
containing the body of the requestUnsupportedEncodingException
- if the character set encoding used is
not supported and the text cannot be decodedIllegalStateException
- if getPortletInputStream()
method
has been called on this request, it is a
HTTP POST data of type application/x-www-form-urlencoded.IOException
- if an input or output exception occurredgetPortletInputStream()
String getCharacterEncoding()
null
if the request
does not specify a character encoding.String
containing the name of
the character encoding, or null
if the request does not specify a character encoding.String getContentType()
String
containing the name
of the MIME type of the request, or null
if the type is not known.int getContentLength()
long getContentLengthLong()
long
containing the length of the
request body or -1 if the length is not knownString getMethod()
javax.servlet.http.Part getPart(String name) throws IOException, PortletException
name
- - the name of the requested PartIOException
- if an I/O error occurred during the retrieval of the Part components of
this requestPortletException
- if this request is not of type multipart/form-dataIllegalStateException
- if the request body is larger than maxRequestSize, or any Part in
the request is larger than maxFileSize, or there is no multipart configuration
presentCollection<javax.servlet.http.Part> getParts() throws IOException, PortletException
If this request is of type multipart/form-data, but does not contain any Part components, the returned Collection will be empty.
Any changes to the returned Collection must not affect this request object.
IOException
- if an I/O error occurred during the retrieval of the Part components of
this requestPortletException
- if this request is not of type multipart/form-dataIllegalStateException
- if the request body is larger than maxRequestSize, or any Part in
the request is larger than maxFileSize, or there is no multipart configuration
presentJava Portlet 3.0 API Specification. See the Copyright and License provided with this distribution. Use is subject to license terms.