org.apache.pluto.internal.impl
Class RenderRequestImpl

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

public class RenderRequestImpl
extends PortletRequestImpl
implements RenderRequest, InternalRenderRequest

Implementation of the javax.portlet.RenderRequest interface.


Nested Class Summary
 
Nested classes/interfaces inherited from interface javax.portlet.PortletRequest
PortletRequest.P3PUserInfos
 
Nested classes/interfaces inherited from interface javax.portlet.PortletRequest
PortletRequest.P3PUserInfos
 
Nested classes/interfaces inherited from interface javax.portlet.PortletRequest
PortletRequest.P3PUserInfos
 
Field Summary
 
Fields inherited from class org.apache.pluto.internal.impl.PortletRequestImpl
container, internalPortletWindow
 
Fields inherited from interface javax.portlet.PortletRequest
ACTION_PHASE, ACTION_SCOPE_ID, BASIC_AUTH, CCPP_PROFILE, CLIENT_CERT_AUTH, DIGEST_AUTH, EVENT_PHASE, FORM_AUTH, LIFECYCLE_PHASE, RENDER_HEADERS, RENDER_MARKUP, RENDER_PART, RENDER_PHASE, RESOURCE_PHASE, USER_INFO
 
Fields inherited from interface javax.portlet.PortletRequest
ACTION_PHASE, ACTION_SCOPE_ID, BASIC_AUTH, CCPP_PROFILE, CLIENT_CERT_AUTH, DIGEST_AUTH, EVENT_PHASE, FORM_AUTH, LIFECYCLE_PHASE, RENDER_HEADERS, RENDER_MARKUP, RENDER_PART, RENDER_PHASE, RESOURCE_PHASE, USER_INFO
 
Fields inherited from interface javax.portlet.PortletRequest
ACTION_PHASE, ACTION_SCOPE_ID, BASIC_AUTH, CCPP_PROFILE, CLIENT_CERT_AUTH, DIGEST_AUTH, EVENT_PHASE, FORM_AUTH, LIFECYCLE_PHASE, RENDER_HEADERS, RENDER_MARKUP, RENDER_PART, RENDER_PHASE, RESOURCE_PHASE, 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.http.Cookie[] getCookieProperties()
           
 java.lang.String getETag()
          Returns the validation tag if the portlet container has a cached response for this validation tag, or null if no cached response exists.
 javax.servlet.ServletInputStream getInputStream()
          Checks the included flag and returns the input stream to this render response.
 java.lang.String getLifecyclePhase()
           
 java.lang.String getMethod()
           
 PortletPreferences getPreferences()
          Returns the preferences object associated with the portlet.
 java.io.BufferedReader getReader()
          Checks the included flag and returns the reader to this rende response.
 void setCharacterEncoding(java.lang.String encoding)
          TODO: why check bodyAccessed?
 void setIncluded(boolean included)
          Is set true when a jsp, servlet is included.
 void setIncludedQueryString(java.lang.String queryString)
           
 
Methods inherited from class org.apache.pluto.internal.impl.PortletRequestImpl
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, 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, setForwarded, setForwardedQueryString
 
Methods inherited from class javax.servlet.http.HttpServletRequestWrapper
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, getCookies, getLocale, getLocales, getParameter, getParameterMap, getParameterNames, getParameterValues, getPortalContext, getPortletMode, getPortletSession, getPortletSession, getPrivateParameterMap, getProperties, getProperty, getPropertyNames, getPublicParameterMap, getRemoteUser, getRequestedSessionId, getResponseContentType, getResponseContentTypes, getScheme, getServerName, getServerPort, getUserPrincipal, getWindowID, getWindowState, isPortletModeAllowed, isRequestedSessionIdValid, isSecure, isUserInRole, isWindowStateAllowed, removeAttribute
 
Methods inherited from interface org.apache.pluto.internal.InternalPortletRequest
getHttpServletRequest, getInternalPortletWindow, getPortletContainer, init, isForwarded, isIncluded, release, setAttribute, setForwarded, setForwardedQueryString
 
Methods inherited from interface javax.portlet.PortletRequest
getAttribute, getAttributeNames, getAuthType, getContextPath, getCookies, getLocale, getLocales, getParameter, getParameterMap, getParameterNames, getParameterValues, getPortalContext, getPortletMode, getPortletSession, getPortletSession, getPrivateParameterMap, getProperties, getProperty, getPropertyNames, getPublicParameterMap, getRemoteUser, getRequestedSessionId, getResponseContentType, getResponseContentTypes, getScheme, getServerName, getServerPort, getUserPrincipal, getWindowID, getWindowState, isPortletModeAllowed, isRequestedSessionIdValid, isSecure, isUserInRole, isWindowStateAllowed, removeAttribute
 
Methods inherited from interface javax.portlet.PortletRequest
getAttribute, getAttributeNames, getAuthType, getContextPath, getCookies, getLocale, getLocales, getParameter, getParameterMap, getParameterNames, getParameterValues, getPortalContext, getPortletMode, getPortletSession, getPortletSession, getPrivateParameterMap, getProperties, getProperty, getPropertyNames, getPublicParameterMap, getRemoteUser, getRequestedSessionId, getResponseContentType, getResponseContentTypes, getScheme, getServerName, getServerPort, getUserPrincipal, getWindowID, getWindowState, isPortletModeAllowed, isRequestedSessionIdValid, isSecure, isUserInRole, isWindowStateAllowed, removeAttribute
 

Constructor Detail

RenderRequestImpl

public RenderRequestImpl(InternalPortletRequest request)

RenderRequestImpl

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

getPreferences

public PortletPreferences getPreferences()
Description copied from interface: PortletRequest
Returns the preferences object associated with the portlet.

Specified by:
getPreferences in interface PortletRequest
Overrides:
getPreferences in class PortletRequestImpl
Returns:
the portlet preferences

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
Overrides:
getContentType in class javax.servlet.ServletRequestWrapper

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
Overrides:
getContentLength in class javax.servlet.ServletRequestWrapper

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)
Description copied from interface: InternalPortletRequest
Is set true when a jsp, servlet is included.

Specified by:
setIncluded in interface InternalPortletRequest
Overrides:
setIncluded in class PortletRequestImpl
Parameters:
included - true when included

setIncludedQueryString

public void setIncludedQueryString(java.lang.String queryString)
                            throws java.lang.IllegalStateException
Specified by:
setIncludedQueryString in interface InternalPortletRequest
Overrides:
setIncludedQueryString in class PortletRequestImpl
Throws:
java.lang.IllegalStateException

getCharacterEncoding

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

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
Overrides:
getMethod in class javax.servlet.http.HttpServletRequestWrapper

getETag

public java.lang.String getETag()
Description copied from interface: RenderRequest
Returns the validation tag if the portlet container has a cached response for this validation tag, or null if no cached response exists.

This call returns the same value as RenderRequest.getProperty(RenderRequest.ETAG).

Specified by:
getETag in interface RenderRequest
Returns:
the validation tag if the portlet container has a cached response for this validation tag, or null if no cached response exists.

getLifecyclePhase

public java.lang.String getLifecyclePhase()
Specified by:
getLifecyclePhase in interface InternalPortletRequest
Overrides:
getLifecyclePhase in class PortletRequestImpl

getCookieProperties

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


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