org.apache.cocoon.environment.portlet
Class ActionRequest

java.lang.Object
  extended byorg.apache.cocoon.environment.impl.AbstractRequest
      extended byorg.apache.cocoon.environment.portlet.PortletRequest
          extended byorg.apache.cocoon.environment.portlet.ActionRequest
All Implemented Interfaces:
Request

public final class ActionRequest
extends PortletRequest

Implements the Request interface for the JSR-168 (Portlet) environment.

Version:
$Id: ActionRequest.java 326051 2005-10-18 08:19:11Z cziegeler $

Field Summary
 
Fields inherited from class org.apache.cocoon.environment.portlet.PortletRequest
portletRequestURI
 
Fields inherited from interface org.apache.cocoon.environment.Request
GLOBAL_SCOPE, REQUEST_SCOPE
 
Constructor Summary
protected ActionRequest(String servletPath, String pathInfo, javax.portlet.ActionRequest request, PortletEnvironment environment)
          Creates a ActionRequest based on a real ActionRequest object
 
Method Summary
 javax.portlet.ActionRequest getActionRequest()
          Type cast portletRequest to ActionRequest
 String getCharacterEncoding()
          Returns the name of the character encoding used in the body of this request.
 int getContentLength()
          Action request provides content length for custom upload handling
 String getContentType()
          Action request provides content type for custom upload handling
 InputStream getInputStream()
          Retrieves the body of the request as binary data using an InputStream.
 String getMethod()
          Action request can be always recognized by POST method
 BufferedReader getReader()
           
 
Methods inherited from class org.apache.cocoon.environment.portlet.PortletRequest
get, getAttribute, getAttribute, getAttributeNames, getAttributeNames, getAuthType, getContextPath, getCookieMap, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getLocale, getLocales, getParameter, getParameterMap, getParameterNames, getParameterValues, getPathInfo, getPathTranslated, getPortalContext, getPortletMode, getPortletRequest, getPortletSession, getPortletSession, getPreferences, getProperties, getProperty, getPropertyNames, getProtocol, getQueryString, getRemoteAddr, getRemoteHost, getRemoteUser, getRequestedSessionId, getRequestURI, getResponseContentType, getResponseContentTypes, getScheme, getServerName, getServerPort, getServletPath, getSession, getSession, getSitemapPath, getSitemapURI, getSitemapURIPrefix, getUserPrincipal, getWindowState, isPortletModeAllowed, isRequestedSessionIdFromCookie, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isSecure, isUserInRole, isWindowStateAllowed, removeAttribute, removeAttribute, searchAttribute, setAttribute, setAttribute, setCharacterEncoding, setContainerEncoding
 
Methods inherited from class org.apache.cocoon.environment.impl.AbstractRequest
getAttributes, getHeaders, getParameters
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ActionRequest

protected ActionRequest(String servletPath,
                        String pathInfo,
                        javax.portlet.ActionRequest request,
                        PortletEnvironment environment)
Creates a ActionRequest based on a real ActionRequest object

Method Detail

getCharacterEncoding

public String getCharacterEncoding()
Description copied from interface: Request
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

Specified by:
getCharacterEncoding in interface Request
Overrides:
getCharacterEncoding in class PortletRequest
See Also:
Request.getCharacterEncoding()

getMethod

public String getMethod()
Action request can be always recognized by POST method

Specified by:
getMethod in interface Request
Specified by:
getMethod in class PortletRequest

getActionRequest

public javax.portlet.ActionRequest getActionRequest()
Type cast portletRequest to ActionRequest

Returns:
type casted portletRequest

getInputStream

public InputStream getInputStream()
                           throws IOException
Description copied from interface: Request
Retrieves the body of the request as binary data using an InputStream.

Returns:
an InputStream containing the body of the request.
Throws:
IOException - if an input or output exception occurred
See Also:
Request.getInputStream()

getReader

public BufferedReader getReader()
                         throws IOException
Throws:
IOException

getContentLength

public int getContentLength()
Action request provides content length for custom upload handling

Specified by:
getContentLength in interface Request
Overrides:
getContentLength in class PortletRequest

getContentType

public String getContentType()
Action request provides content type for custom upload handling

Specified by:
getContentType in interface Request
Overrides:
getContentType in class PortletRequest


Copyright ? 1999-2005 The Apache Software Foundation. All Rights Reserved.