org.apache.pluto.internal.impl
Class RenderRequestImpl

java.lang.Object
  extended byjavax.servlet.ServletRequestWrapper
      extended byjavax.servlet.http.HttpServletRequestWrapper
          extended byorg.apache.pluto.internal.impl.PortletRequestImpl
              extended byorg.apache.pluto.internal.impl.RenderRequestImpl
All Implemented Interfaces:
javax.servlet.http.HttpServletRequest, InternalPortletRequest, InternalRenderRequest, javax.portlet.PortletRequest, javax.portlet.RenderRequest, javax.servlet.ServletRequest

public class RenderRequestImpl
extends PortletRequestImpl
implements javax.portlet.RenderRequest, InternalRenderRequest

Implementation of the javax.portlet.RenderRequest interface.


Field Summary
 
Fields inherited from interface javax.portlet.PortletRequest
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH, USER_INFO
 
Fields inherited from interface javax.servlet.http.HttpServletRequest
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
 
Constructor Summary
RenderRequestImpl(InternalPortletRequest request)
           
RenderRequestImpl(PortletContainer container, InternalPortletWindow internalPortletWindow, javax.servlet.http.HttpServletRequest servletRequest)
           
 
Method Summary
protected  java.util.Map baseGetParameterMap()
          The base method that returns the parameter map in this portlet request.
 java.lang.String getCharacterEncoding()
           
 int getContentLength()
          Checks the included flag and returns the content length.
 java.lang.String getContentType()
          Checks the included flag and returns the content type.
 javax.servlet.ServletInputStream getInputStream()
          Checks the included flag and returns the input stream to this render response.
 java.lang.String getMethod()
           
 java.lang.String getPathInfo()
           
 java.lang.String getPathTranslated()
          TODO: check PLT.16.3.3.
 javax.portlet.PortletPreferences getPreferences()
           
 java.lang.String getProtocol()
           
 java.lang.String getQueryString()
           
 java.io.BufferedReader getReader()
          Checks the included flag and returns the reader to this rende response.
 java.lang.String getRealPath(java.lang.String path)
           
 java.lang.String getRemoteAddr()
           
 java.lang.String getRemoteHost()
           
 java.lang.String getRequestURI()
           
 java.lang.StringBuffer getRequestURL()
           
 java.lang.String getServletPath()
           
 boolean isIncluded()
           
 void setCharacterEncoding(java.lang.String encoding)
          TODO: why check bodyAccessed?
 void setIncluded(boolean included)
           
 void setIncludedQueryString(java.lang.String queryString)
           
 
Methods inherited from class org.apache.pluto.internal.impl.PortletRequestImpl
createUserInfoMap, getAttribute, getAttributeNames, getAuthType, getContextPath, getHttpServletRequest, getInternalPortletWindow, getLocale, getLocales, getParameter, getParameterMap, getParameterNames, getParameterValues, getPortalContext, getPortletContainer, getPortletMode, getPortletSession, getPortletSession, getProperties, getProperty, getPropertyNames, getRemoteUser, getRequestDispatcher, getRequestedSessionId, getResponseContentType, getResponseContentTypes, getScheme, getServerName, getServerPort, getUserPrincipal, getWindowState, init, isPortletModeAllowed, isRequestedSessionIdValid, isSecure, isUserInRole, isWindowStateAllowed, release, removeAttribute, setAttribute, setBodyAccessed
 
Methods inherited from class javax.servlet.http.HttpServletRequestWrapper
getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getSession, getSession, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL
 
Methods inherited from class javax.servlet.ServletRequestWrapper
getRequest, setRequest
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.portlet.PortletRequest
getAttribute, getAttributeNames, getAuthType, getContextPath, getLocale, getLocales, getParameter, getParameterMap, getParameterNames, getParameterValues, getPortalContext, getPortletMode, getPortletSession, getPortletSession, getProperties, getProperty, getPropertyNames, getRemoteUser, getRequestedSessionId, getResponseContentType, getResponseContentTypes, getScheme, getServerName, getServerPort, getUserPrincipal, getWindowState, isPortletModeAllowed, isRequestedSessionIdValid, isSecure, isUserInRole, isWindowStateAllowed, removeAttribute, setAttribute
 
Methods inherited from interface org.apache.pluto.internal.InternalPortletRequest
getHttpServletRequest, getInternalPortletWindow, getPortletContainer, init, release
 

Constructor Detail

RenderRequestImpl

public RenderRequestImpl(InternalPortletRequest request)

RenderRequestImpl

public RenderRequestImpl(PortletContainer container,
                         InternalPortletWindow internalPortletWindow,
                         javax.servlet.http.HttpServletRequest servletRequest)
Method Detail

getPreferences

public javax.portlet.PortletPreferences getPreferences()
Specified by:
getPreferences in interface javax.portlet.PortletRequest

getContentType

public java.lang.String getContentType()
Checks the included flag and returns the content type. If the included flag is set to true, this method returns null.

Specified by:
getContentType in interface javax.servlet.ServletRequest

getContentLength

public int getContentLength()
Checks the included flag and returns the content length. If the included flag is set to true, this method returns 0.

Specified by:
getContentLength in interface javax.servlet.ServletRequest

getReader

public java.io.BufferedReader getReader()
                                 throws java.io.UnsupportedEncodingException,
                                        java.io.IOException
Checks the included flag and returns the reader to this rende response. If the included flag is set to true, this method returns null.

Specified by:
getReader in interface javax.servlet.ServletRequest
Overrides:
getReader in class PortletRequestImpl
Throws:
java.io.UnsupportedEncodingException
java.io.IOException

getInputStream

public javax.servlet.ServletInputStream getInputStream()
                                                throws java.io.IOException
Checks the included flag and returns the input stream to this render response. If the included flag is set to true, this method returns null.

Specified by:
getInputStream in interface javax.servlet.ServletRequest
Overrides:
getInputStream in class PortletRequestImpl
Throws:
java.io.IOException

baseGetParameterMap

protected java.util.Map baseGetParameterMap()
Description copied from class: PortletRequestImpl
The base method that returns the parameter map in this portlet request. All parameter-related methods call this base method. Subclasses may just overwrite this protected method to change behavior of all parameter- related methods.

Overrides:
baseGetParameterMap in class PortletRequestImpl
Returns:
the base parameter map from which parameters are retrieved.

setIncluded

public void setIncluded(boolean included)
Specified by:
setIncluded in interface InternalRenderRequest

isIncluded

public boolean isIncluded()
Specified by:
isIncluded in interface InternalRenderRequest

setIncludedQueryString

public void setIncludedQueryString(java.lang.String queryString)
                            throws java.lang.IllegalStateException
Specified by:
setIncludedQueryString in interface InternalRenderRequest
Throws:
java.lang.IllegalStateException

getPathInfo

public java.lang.String getPathInfo()
Specified by:
getPathInfo in interface javax.servlet.http.HttpServletRequest

getQueryString

public java.lang.String getQueryString()
Specified by:
getQueryString in interface javax.servlet.http.HttpServletRequest

getPathTranslated

public java.lang.String getPathTranslated()
TODO: check PLT.16.3.3. page 67, line 10.

Specified by:
getPathTranslated in interface javax.servlet.http.HttpServletRequest

getRequestURI

public java.lang.String getRequestURI()
Specified by:
getRequestURI in interface javax.servlet.http.HttpServletRequest

getServletPath

public java.lang.String getServletPath()
Specified by:
getServletPath in interface javax.servlet.http.HttpServletRequest

getProtocol

public java.lang.String getProtocol()
Specified by:
getProtocol in interface javax.servlet.ServletRequest

getRemoteAddr

public java.lang.String getRemoteAddr()
Specified by:
getRemoteAddr in interface javax.servlet.ServletRequest

getRemoteHost

public java.lang.String getRemoteHost()
Specified by:
getRemoteHost in interface javax.servlet.ServletRequest

getRealPath

public java.lang.String getRealPath(java.lang.String path)
Specified by:
getRealPath in interface javax.servlet.ServletRequest

getRequestURL

public java.lang.StringBuffer getRequestURL()
Specified by:
getRequestURL in interface javax.servlet.http.HttpServletRequest

getCharacterEncoding

public java.lang.String getCharacterEncoding()
Specified by:
getCharacterEncoding in interface javax.servlet.ServletRequest

setCharacterEncoding

public void setCharacterEncoding(java.lang.String encoding)
                          throws java.io.UnsupportedEncodingException
Description copied from class: PortletRequestImpl
TODO: why check bodyAccessed?

Specified by:
setCharacterEncoding in interface javax.servlet.ServletRequest
Overrides:
setCharacterEncoding in class PortletRequestImpl
Throws:
java.io.UnsupportedEncodingException

getMethod

public java.lang.String getMethod()
Specified by:
getMethod in interface javax.servlet.http.HttpServletRequest


Copyright © 2003-2008 Apache Software Foundation. All Rights Reserved.