|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectjavax.servlet.ServletRequestWrapper
javax.servlet.http.HttpServletRequestWrapper
org.apache.pluto.internal.impl.PortletRequestImpl
Abstract javax.portlet.PortletRequest implementation.
This class also implements InternalPortletRequest.
| 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 | |
PortletRequestImpl(InternalPortletRequest internalPortletRequest)
|
|
PortletRequestImpl(PortletContainer container,
InternalPortletWindow internalPortletWindow,
javax.servlet.http.HttpServletRequest servletRequest)
Creates a PortletRequestImpl instance. |
|
| Method Summary | |
protected java.util.Map |
baseGetParameterMap()
The base method that returns the parameter map in this portlet request. |
java.util.Map |
createUserInfoMap()
|
java.lang.Object |
getAttribute(java.lang.String name)
|
java.util.Enumeration |
getAttributeNames()
|
java.lang.String |
getAuthType()
|
java.lang.String |
getContextPath()
|
javax.servlet.http.HttpServletRequest |
getHttpServletRequest()
|
javax.servlet.ServletInputStream |
getInputStream()
|
InternalPortletWindow |
getInternalPortletWindow()
|
java.util.Locale |
getLocale()
|
java.util.Enumeration |
getLocales()
|
java.lang.String |
getParameter(java.lang.String name)
|
java.util.Map |
getParameterMap()
|
java.util.Enumeration |
getParameterNames()
|
java.lang.String[] |
getParameterValues(java.lang.String name)
|
javax.portlet.PortalContext |
getPortalContext()
|
PortletContainer |
getPortletContainer()
|
javax.portlet.PortletMode |
getPortletMode()
|
javax.portlet.PortletSession |
getPortletSession()
|
javax.portlet.PortletSession |
getPortletSession(boolean create)
Returns the portlet session. |
java.util.Enumeration |
getProperties(java.lang.String name)
|
java.lang.String |
getProperty(java.lang.String name)
|
java.util.Enumeration |
getPropertyNames()
|
java.io.BufferedReader |
getReader()
|
java.lang.String |
getRemoteUser()
|
javax.servlet.RequestDispatcher |
getRequestDispatcher(java.lang.String path)
|
java.lang.String |
getRequestedSessionId()
|
java.lang.String |
getResponseContentType()
|
java.util.Enumeration |
getResponseContentTypes()
|
java.lang.String |
getScheme()
|
java.lang.String |
getServerName()
|
int |
getServerPort()
|
java.security.Principal |
getUserPrincipal()
|
javax.portlet.WindowState |
getWindowState()
|
void |
init(javax.portlet.PortletContext portletContext,
javax.servlet.http.HttpServletRequest req)
Initializes the portlet request for use within the target context. |
boolean |
isPortletModeAllowed(javax.portlet.PortletMode mode)
|
boolean |
isRequestedSessionIdValid()
|
boolean |
isSecure()
|
boolean |
isUserInRole(java.lang.String roleName)
Determines whether a user is mapped to the specified role. |
boolean |
isWindowStateAllowed(javax.portlet.WindowState state)
Determine whether or not the specified WindowState is allowed for this portlet. |
void |
release()
TODO: Implement this properly. |
void |
removeAttribute(java.lang.String name)
|
void |
setAttribute(java.lang.String name,
java.lang.Object value)
|
protected void |
setBodyAccessed()
|
void |
setCharacterEncoding(java.lang.String encoding)
TODO: why check bodyAccessed? |
| Methods inherited from class javax.servlet.http.HttpServletRequestWrapper |
getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPathInfo, getPathTranslated, getQueryString, getRequestURI, getRequestURL, getServletPath, getSession, getSession, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL |
| Methods inherited from class javax.servlet.ServletRequestWrapper |
getCharacterEncoding, getContentLength, getContentType, getProtocol, getRealPath, getRemoteAddr, getRemoteHost, 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 |
getPreferences |
| Methods inherited from interface javax.servlet.ServletRequest |
getCharacterEncoding, getContentLength, getContentType, getProtocol, getRealPath, getRemoteAddr, getRemoteHost |
| Constructor Detail |
public PortletRequestImpl(InternalPortletRequest internalPortletRequest)
public PortletRequestImpl(PortletContainer container,
InternalPortletWindow internalPortletWindow,
javax.servlet.http.HttpServletRequest servletRequest)
container - the portlet container.internalPortletWindow - the internal portlet window.servletRequest - the underlying servlet request.| Method Detail |
public boolean isWindowStateAllowed(javax.portlet.WindowState state)
isWindowStateAllowed in interface javax.portlet.PortletRequeststate - the state in question
public boolean isPortletModeAllowed(javax.portlet.PortletMode mode)
isPortletModeAllowed in interface javax.portlet.PortletRequestpublic javax.portlet.PortletMode getPortletMode()
getPortletMode in interface javax.portlet.PortletRequestpublic javax.portlet.WindowState getWindowState()
getWindowState in interface javax.portlet.PortletRequestpublic javax.portlet.PortletSession getPortletSession()
getPortletSession in interface javax.portlet.PortletRequestpublic javax.portlet.PortletSession getPortletSession(boolean create)
getPortletSession in interface javax.portlet.PortletRequest
public java.lang.String getProperty(java.lang.String name)
throws java.lang.IllegalArgumentException
getProperty in interface javax.portlet.PortletRequestjava.lang.IllegalArgumentExceptionpublic java.util.Enumeration getProperties(java.lang.String name)
getProperties in interface javax.portlet.PortletRequestpublic java.util.Enumeration getPropertyNames()
getPropertyNames in interface javax.portlet.PortletRequestpublic javax.portlet.PortalContext getPortalContext()
getPortalContext in interface javax.portlet.PortletRequestpublic java.lang.String getAuthType()
getAuthType in interface javax.portlet.PortletRequestpublic java.lang.String getContextPath()
getContextPath in interface javax.portlet.PortletRequestpublic java.lang.String getRemoteUser()
getRemoteUser in interface javax.portlet.PortletRequestpublic java.security.Principal getUserPrincipal()
getUserPrincipal in interface javax.portlet.PortletRequestpublic boolean isUserInRole(java.lang.String roleName)
isUserInRole in interface javax.portlet.PortletRequestroleName - the name of the role
public java.lang.Object getAttribute(java.lang.String name)
getAttribute in interface javax.portlet.PortletRequestpublic java.util.Enumeration getAttributeNames()
getAttributeNames in interface javax.portlet.PortletRequestpublic java.util.Map createUserInfoMap()
public java.lang.String getParameter(java.lang.String name)
getParameter in interface javax.portlet.PortletRequestpublic java.util.Enumeration getParameterNames()
getParameterNames in interface javax.portlet.PortletRequestpublic java.lang.String[] getParameterValues(java.lang.String name)
getParameterValues in interface javax.portlet.PortletRequestpublic java.util.Map getParameterMap()
getParameterMap in interface javax.portlet.PortletRequestpublic boolean isSecure()
isSecure in interface javax.portlet.PortletRequest
public void setAttribute(java.lang.String name,
java.lang.Object value)
setAttribute in interface javax.portlet.PortletRequestpublic void removeAttribute(java.lang.String name)
removeAttribute in interface javax.portlet.PortletRequestpublic java.lang.String getRequestedSessionId()
getRequestedSessionId in interface javax.portlet.PortletRequestpublic boolean isRequestedSessionIdValid()
isRequestedSessionIdValid in interface javax.portlet.PortletRequestpublic java.lang.String getResponseContentType()
getResponseContentType in interface javax.portlet.PortletRequestpublic java.util.Enumeration getResponseContentTypes()
getResponseContentTypes in interface javax.portlet.PortletRequestpublic java.util.Locale getLocale()
getLocale in interface javax.portlet.PortletRequestpublic java.util.Enumeration getLocales()
getLocales in interface javax.portlet.PortletRequestpublic java.lang.String getScheme()
getScheme in interface javax.portlet.PortletRequestpublic java.lang.String getServerName()
getServerName in interface javax.portlet.PortletRequestpublic int getServerPort()
getServerPort in interface javax.portlet.PortletRequestprotected java.util.Map baseGetParameterMap()
protected void setBodyAccessed()
public InternalPortletWindow getInternalPortletWindow()
getInternalPortletWindow in interface InternalPortletRequestpublic PortletContainer getPortletContainer()
getPortletContainer in interface InternalPortletRequestpublic javax.servlet.http.HttpServletRequest getHttpServletRequest()
getHttpServletRequest in interface InternalPortletRequest
public void init(javax.portlet.PortletContext portletContext,
javax.servlet.http.HttpServletRequest req)
InternalPortletRequest
init in interface InternalPortletRequestportletContext - the target portlet context.req - the servlet request.public void release()
release in interface InternalPortletRequest
public java.io.BufferedReader getReader()
throws java.io.UnsupportedEncodingException,
java.io.IOException
getReader in interface javax.servlet.ServletRequestjava.io.UnsupportedEncodingException
java.io.IOException
public javax.servlet.ServletInputStream getInputStream()
throws java.io.IOException
getInputStream in interface javax.servlet.ServletRequestjava.io.IOExceptionpublic javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String path)
getRequestDispatcher in interface javax.servlet.ServletRequest
public void setCharacterEncoding(java.lang.String encoding)
throws java.io.UnsupportedEncodingException
setCharacterEncoding in interface javax.servlet.ServletRequestjava.io.UnsupportedEncodingException
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||