org.apache.pluto.internal.impl
Class ActionRequestImpl

java.lang.Object
  javax.servlet.ServletRequestWrapper
      javax.servlet.http.HttpServletRequestWrapper
          org.apache.pluto.internal.impl.PortletRequestImpl
              org.apache.pluto.internal.impl.ActionRequestImpl

All Implemented Interfaces:

ActionRequest, ClientDataRequest, PortletRequest, javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest, InternalActionRequest, InternalPortletRequest

public class ActionRequestImpl
extends PortletRequestImpl
implements ActionRequest, InternalActionRequest

Implementation of the javax.portlet.ActionRequest interface.

Field Summary

Fields inherited from class org.apache.pluto.internal.impl.PortletRequestImpl

container, internalPortletWindow

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

ActionRequestImpl(PortletContainer container, InternalPortletWindow internalPortletWindow, javax.servlet.http.HttpServletRequest servletRequest)

Method Summary

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.
javax.servlet.http.Cookie[]	getCookieProperties()
javax.servlet.ServletInputStream	getInputStream()
java.lang.String	getLifecyclePhase()
java.io.InputStream	getPortletInputStream() Retrieves the body of the HTTP request from client to portal as binary data using an InputStream.
PortletPreferences	getPreferences() FIXME:

Methods inherited from class org.apache.pluto.internal.impl.PortletRequestImpl

baseGetParameterMap, createUserInfoMap, getAttribute, getAttributeNames, getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getHttpServletRequest, getInternalPortletWindow, getIntHeader, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getPathInfo, getPathTranslated, getPortalContext, getPortletContainer, getPortletMode, getPortletSession, getPortletSession, getPrivateParameterMap, getProperties, getProperty, getPropertyNames, getProtocol, getPublicParameterMap, getQueryString, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRemoteUser, getRequestDispatcher, getRequestedSessionId, getRequestURI, getRequestURL, getResponseContentType, getResponseContentTypes, getScheme, getServerName, getServerPort, getServletPath, getSession, getSession, getUserPrincipal, getWindowId, getWindowID, getWindowState, init, isForwarded, isIncluded, isPortletModeAllowed, isRequestedSessionIdValid, isSecure, isUserInRole, isWindowStateAllowed, release, removeAttribute, setAttribute, setBodyAccessed, setCharacterEncoding, setForwarded, setForwardedQueryString, setIncluded, setIncludedQueryString

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper

getMethod, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL

Methods inherited from class javax.servlet.ServletRequestWrapper

getCharacterEncoding, getContentType, getRequest, setRequest

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.pluto.internal.InternalPortletRequest

getHttpServletRequest, getInternalPortletWindow, getPortletContainer, init, isForwarded, isIncluded, release, setAttribute, setForwarded, setForwardedQueryString, setIncluded, setIncludedQueryString

Methods inherited from interface javax.servlet.ServletRequest

getCharacterEncoding, getContentType

Constructor Detail

ActionRequestImpl

public ActionRequestImpl(PortletContainer container,
                         InternalPortletWindow internalPortletWindow,
                         javax.servlet.http.HttpServletRequest servletRequest)

Method Detail

getPortletInputStream

public java.io.InputStream getPortletInputStream()
                                          throws java.io.IOException

Description copied from interface: ClientDataRequest

Retrieves the body of the HTTP request from client to portal as binary data using an InputStream. Either this method or ClientDataRequest.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.

Specified by:

getPortletInputStream in interface ClientDataRequest

Returns:

an input stream containing the body of the request

Throws:

java.io.IOException - if an input or output exception occurred

getPreferences

public PortletPreferences getPreferences()

FIXME:

Specified by:

getPreferences in interface PortletRequest

Overrides:

getPreferences in class PortletRequestImpl

Returns:

the portlet preferences

getLifecyclePhase

public java.lang.String getLifecyclePhase()

Specified by:

getLifecyclePhase in interface InternalPortletRequest

Overrides:

getLifecyclePhase in class PortletRequestImpl

getCookieProperties

public javax.servlet.http.Cookie[] getCookieProperties()

getContentLength

public int getContentLength()

Description copied from interface: ClientDataRequest

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.

Specified by:

getContentLength in interface ClientDataRequest

Specified by:

getContentLength in interface javax.servlet.ServletRequest

Overrides:

getContentLength in class javax.servlet.ServletRequestWrapper

Returns:

an integer containing the length of the request body or -1 if the length is not known

getInputStream

public javax.servlet.ServletInputStream getInputStream()
                                                throws java.io.IOException

Specified by:

getInputStream in interface javax.servlet.ServletRequest

Overrides:

getInputStream in class PortletRequestImpl

Throws:

java.io.IOException