Home » gridsphere-3.1-src » javax.portlet » [javadoc | source]
javax.portlet
public interface: ActionRequest [javadoc | source]

All Implemented Interfaces:
    PortletRequest

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.
Method from javax.portlet.ActionRequest Summary:
getCharacterEncoding,   getContentLength,   getContentType,   getPortletInputStream,   getReader,   setCharacterEncoding
Method from javax.portlet.ActionRequest Detail:
 public 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.
 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.
 public String getContentType()
    Returns the MIME type of the body of the request, or null if the type is not known.
 public InputStream getPortletInputStream() throws 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.

 public BufferedReader getReader() throws UnsupportedEncodingException, 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.

 public  void setCharacterEncoding(String enc) throws 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.