javax.portlet
Interface ActionRequest
- PortletRequest
public interface ActionRequest
The ActionRequest
represents the request sent to the portlet
to handle an action.
It extends the PortletRequest interface to provide action request
information to portlets.
The portlet container creates an ActionRequest
object and
passes it as argument to the portlet's processAction
method.
java.lang.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.
|
java.lang.String | getContentType() - Returns the MIME type of the body of the request,
or null if the type is not known.
|
java.io.InputStream | getPortletInputStream() - Retrieves the body of the HTTP request from client to
portal as binary data using
an
InputStream .
|
java.io.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 , getLocale , getLocales , getParameter , getParameterMap , getParameterNames , getParameterValues , getPortalContext , getPortletMode , getPortletSession , getPortletSession , getPreferences , getProperties , getProperty , getPropertyNames , getRemoteUser , getRequestedSessionId , getResponseContentType , getResponseContentTypes , getScheme , getServerName , getServerPort , getUserPrincipal , getWindowState , isPortletModeAllowed , isRequestedSessionIdValid , isSecure , isUserInRole , isWindowStateAllowed , removeAttribute , setAttribute |
getCharacterEncoding
public java.lang.String getCharacterEncoding()
Returns the name of the character encoding used in the body of this request.
This method returns null
if the request
does not specify a character encoding.
- a
String
containing the name of
the chararacter encoding, or null
if the request does not specify a character encoding.
getContentLength
public 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.
- an integer containing the length of the
request body or -1 if the length is not known
getContentType
public java.lang.String getContentType()
Returns the MIME type of the body of the request,
or null if the type is not known.
- a
String
containing the name
of the MIME type of the request, or null
if the type is not known.
getPortletInputStream
public java.io.InputStream getPortletInputStream()
throws java.io.IOException
Retrieves the body of the HTTP request from client to
portal as binary data using
an
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.
- an input stream containing the body of the request
getReader
public java.io.BufferedReader getReader()
throws java.io.UnsupportedEncodingException,
java.io.IOException
Retrieves the body of the HTTP request from the client to the portal
as character data using
a
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.
- a
BufferedReader
containing the body of the request
setCharacterEncoding
public void setCharacterEncoding(String enc)
throws java.io.UnsupportedEncodingException
Overrides the name of the character encoding used in the body of this
request. This method must be called prior to reading input
using
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 chararacter encoding.