javax.portlet
public interface ActionRequest extends PortletRequest
ActionRequest
represents the request sent to the portlet
to handle an action.
It extends the PortletRequest interface to provide action request
information to portlets.ActionRequest
object and
passes it as argument to the portlet's processAction
method.
See Also: PortletRequest RenderRequest
Method Summary | |
---|---|
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.
|
String | getContentType()
Returns the MIME type of the body of the request,
or null if the type is not known.
|
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. |
null
if the request
does not specify a character encoding.
Returns: a String
containing the name of
the chararacter encoding, or null
if the request does not specify a character encoding.
Returns: an integer containing the length of the request body or -1 if the length is not known
Returns: a String
containing the name
of the MIME type of the request, or null
if the type is not known.
InputStream
. Either this method or
ActionRequest 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.
Returns: an input stream containing the body of the request
Throws: java.lang.IllegalStateException if getReader was already called, or it is a HTTP POST data of type application/x-www-form-urlencoded java.io.IOException if an input or output exception occurred
BufferedReader
. The reader translates the character
data according to the character encoding used on the body.
Either this method or ActionRequest 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.
Returns: a BufferedReader
containing the body of the request
Throws: java.io.UnsupportedEncodingException if the character set encoding used is not supported and the text cannot be decoded java.lang.IllegalStateException if ActionRequest method has been called on this request, it is a HTTP POST data of type application/x-www-form-urlencoded. java.io.IOException if an input or output exception occurred
See Also: ActionRequest
This method only sets the character set for the Reader that the ActionRequest method returns.
Parameters: enc a String
containing the name of
the chararacter encoding.
Throws: java.io.UnsupportedEncodingException if this is not a valid encoding java.lang.IllegalStateException if this method is called after
reading request parameters or reading input using
getReader()