com.xpn.xwiki.web
Class XWikiPortletRequest

java.lang.Object
  extended by com.xpn.xwiki.web.XWikiPortletRequest
All Implemented Interfaces:
XWikiRequest, javax.portlet.ActionRequest, javax.portlet.PortletRequest, javax.portlet.RenderRequest, javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest

public class XWikiPortletRequest
extends java.lang.Object
implements XWikiRequest


Field Summary
protected  org.apache.commons.logging.Log logger
           
private  javax.portlet.PortletRequest request
           
static java.lang.String ROOT_SPACE_PREF_NAME
           
 
Fields inherited from interface javax.servlet.http.HttpServletRequest
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
 
Fields inherited from interface javax.portlet.PortletRequest
USER_INFO
 
Fields inherited from interface javax.portlet.PortletRequest
USER_INFO
 
Constructor Summary
XWikiPortletRequest(javax.portlet.PortletRequest request)
           
 
Method Summary
 java.lang.String get(java.lang.String name)
           
 java.lang.Object getAttribute(java.lang.String s)
           
 java.util.Enumeration getAttributeNames()
           
 java.lang.String getAuthType()
           
 java.lang.String getCharacterEncoding()
           
 int getContentLength()
           
 java.lang.String getContentType()
           
 java.lang.String getContextPath()
           
 javax.servlet.http.Cookie[] getCookies()
           
 long getDateHeader(java.lang.String s)
           
 java.lang.String getHeader(java.lang.String s)
           
 java.util.Enumeration getHeaderNames()
           
 java.util.Enumeration getHeaders(java.lang.String s)
           
 javax.servlet.http.HttpServletRequest getHttpServletRequest()
           
 javax.servlet.ServletInputStream getInputStream()
           
 int getIntHeader(java.lang.String s)
           
 java.lang.String getLocalAddr()
           
 java.util.Locale getLocale()
           
 java.util.Enumeration getLocales()
           
 java.lang.String getLocalName()
           
 int getLocalPort()
           
 java.lang.String getMethod()
           
 java.lang.String getParameter(java.lang.String name)
           
 java.util.Map getParameterMap()
           
 java.util.Enumeration getParameterNames()
           
 java.lang.String[] getParameterValues(java.lang.String name)
           
 java.lang.String getPathInfo()
           
 java.lang.String getPathTranslated()
           
 javax.portlet.PortalContext getPortalContext()
           
 java.io.InputStream getPortletInputStream()
           
 javax.portlet.PortletMode getPortletMode()
           
 javax.portlet.PortletRequest getPortletRequest()
           
 javax.portlet.PortletSession getPortletSession()
           
 javax.portlet.PortletSession getPortletSession(boolean b)
           
 javax.portlet.PortletPreferences getPreferences()
           
 java.util.Enumeration getProperties(java.lang.String s)
           
 java.lang.String getProperty(java.lang.String s)
           
 java.util.Enumeration getPropertyNames()
           
 java.lang.String getProtocol()
           
 java.lang.String getQueryString()
           
 java.io.BufferedReader getReader()
           
 java.lang.String getRealPath(java.lang.String s)
          Deprecated.  
 java.lang.String getRemoteAddr()
           
 java.lang.String getRemoteHost()
           
 int getRemotePort()
           
 java.lang.String getRemoteUser()
           
 javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String s)
           
 java.lang.String getRequestedSessionId()
           
 java.lang.String getRequestURI()
           
 java.lang.StringBuffer getRequestURL()
           
 java.lang.String getResponseContentType()
           
 java.util.Enumeration getResponseContentTypes()
           
 java.lang.String getScheme()
           
 java.lang.String getServerName()
           
 int getServerPort()
           
 java.lang.String getServletPath()
           
 javax.servlet.http.HttpSession getSession()
           
 javax.servlet.http.HttpSession getSession(boolean b)
           
 java.security.Principal getUserPrincipal()
           
 javax.portlet.WindowState getWindowState()
           
 boolean isPortletModeAllowed(javax.portlet.PortletMode portletMode)
           
 boolean isRequestedSessionIdFromCookie()
           
 boolean isRequestedSessionIdFromUrl()
          Deprecated.  
 boolean isRequestedSessionIdFromURL()
           
 boolean isRequestedSessionIdValid()
           
 boolean isSecure()
           
 boolean isUserInRole(java.lang.String s)
           
 boolean isWindowStateAllowed(javax.portlet.WindowState windowState)
           
 void removeAttribute(java.lang.String s)
           
 void setAttribute(java.lang.String s, java.lang.Object o)
           
 void setCharacterEncoding(java.lang.String s)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

logger

protected final org.apache.commons.logging.Log logger

ROOT_SPACE_PREF_NAME

public static final java.lang.String ROOT_SPACE_PREF_NAME
See Also:
Constant Field Values

request

private javax.portlet.PortletRequest request
Constructor Detail

XWikiPortletRequest

public XWikiPortletRequest(javax.portlet.PortletRequest request)
Method Detail

getPortletRequest

public javax.portlet.PortletRequest getPortletRequest()

get

public java.lang.String get(java.lang.String name)
Specified by:
get in interface XWikiRequest

getParameter

public java.lang.String getParameter(java.lang.String name)
Specified by:
getParameter in interface javax.portlet.PortletRequest
Specified by:
getParameter in interface javax.servlet.ServletRequest

getParameterNames

public java.util.Enumeration getParameterNames()
Specified by:
getParameterNames in interface javax.portlet.PortletRequest
Specified by:
getParameterNames in interface javax.servlet.ServletRequest

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String name)
Specified by:
getParameterValues in interface javax.portlet.PortletRequest
Specified by:
getParameterValues in interface javax.servlet.ServletRequest

isWindowStateAllowed

public boolean isWindowStateAllowed(javax.portlet.WindowState windowState)
Specified by:
isWindowStateAllowed in interface javax.portlet.PortletRequest

isPortletModeAllowed

public boolean isPortletModeAllowed(javax.portlet.PortletMode portletMode)
Specified by:
isPortletModeAllowed in interface javax.portlet.PortletRequest

getPortletMode

public javax.portlet.PortletMode getPortletMode()
Specified by:
getPortletMode in interface javax.portlet.PortletRequest

getWindowState

public javax.portlet.WindowState getWindowState()
Specified by:
getWindowState in interface javax.portlet.PortletRequest

getPreferences

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

getPortletSession

public javax.portlet.PortletSession getPortletSession()
Specified by:
getPortletSession in interface javax.portlet.PortletRequest

getPortletSession

public javax.portlet.PortletSession getPortletSession(boolean b)
Specified by:
getPortletSession in interface javax.portlet.PortletRequest

getProperty

public java.lang.String getProperty(java.lang.String s)
Specified by:
getProperty in interface javax.portlet.PortletRequest

getProperties

public java.util.Enumeration getProperties(java.lang.String s)
Specified by:
getProperties in interface javax.portlet.PortletRequest

getPropertyNames

public java.util.Enumeration getPropertyNames()
Specified by:
getPropertyNames in interface javax.portlet.PortletRequest

getPortalContext

public javax.portlet.PortalContext getPortalContext()
Specified by:
getPortalContext in interface javax.portlet.PortletRequest

getRemoteUser

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

isUserInRole

public boolean isUserInRole(java.lang.String s)
Specified by:
isUserInRole in interface javax.portlet.PortletRequest
Specified by:
isUserInRole in interface javax.servlet.http.HttpServletRequest

getUserPrincipal

public java.security.Principal getUserPrincipal()
Specified by:
getUserPrincipal in interface javax.portlet.PortletRequest
Specified by:
getUserPrincipal in interface javax.servlet.http.HttpServletRequest

getRequestedSessionId

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

getLocale

public java.util.Locale getLocale()
Specified by:
getLocale in interface javax.portlet.PortletRequest
Specified by:
getLocale in interface javax.servlet.ServletRequest

getLocales

public java.util.Enumeration getLocales()
Specified by:
getLocales in interface javax.portlet.PortletRequest
Specified by:
getLocales in interface javax.servlet.ServletRequest

isSecure

public boolean isSecure()
Specified by:
isSecure in interface javax.portlet.PortletRequest
Specified by:
isSecure in interface javax.servlet.ServletRequest

getParameterMap

public java.util.Map getParameterMap()
Specified by:
getParameterMap in interface javax.portlet.PortletRequest
Specified by:
getParameterMap in interface javax.servlet.ServletRequest

getScheme

public java.lang.String getScheme()
Specified by:
getScheme in interface javax.portlet.PortletRequest
Specified by:
getScheme in interface javax.servlet.ServletRequest

getServerName

public java.lang.String getServerName()
Specified by:
getServerName in interface javax.portlet.PortletRequest
Specified by:
getServerName in interface javax.servlet.ServletRequest

getServerPort

public int getServerPort()
Specified by:
getServerPort in interface javax.portlet.PortletRequest
Specified by:
getServerPort in interface javax.servlet.ServletRequest

setAttribute

public void setAttribute(java.lang.String s,
                         java.lang.Object o)
Specified by:
setAttribute in interface javax.portlet.PortletRequest
Specified by:
setAttribute in interface javax.servlet.ServletRequest

removeAttribute

public void removeAttribute(java.lang.String s)
Specified by:
removeAttribute in interface javax.portlet.PortletRequest
Specified by:
removeAttribute in interface javax.servlet.ServletRequest

getResponseContentType

public java.lang.String getResponseContentType()
Specified by:
getResponseContentType in interface javax.portlet.PortletRequest

getResponseContentTypes

public java.util.Enumeration getResponseContentTypes()
Specified by:
getResponseContentTypes in interface javax.portlet.PortletRequest

getContextPath

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

getAttribute

public java.lang.Object getAttribute(java.lang.String s)
Specified by:
getAttribute in interface javax.portlet.PortletRequest
Specified by:
getAttribute in interface javax.servlet.ServletRequest

getAttributeNames

public java.util.Enumeration getAttributeNames()
Specified by:
getAttributeNames in interface javax.portlet.PortletRequest
Specified by:
getAttributeNames in interface javax.servlet.ServletRequest

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()
Specified by:
isRequestedSessionIdValid in interface javax.portlet.PortletRequest
Specified by:
isRequestedSessionIdValid in interface javax.servlet.http.HttpServletRequest

getHttpServletRequest

public javax.servlet.http.HttpServletRequest getHttpServletRequest()
Specified by:
getHttpServletRequest in interface XWikiRequest

getPathInfo

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

getServletPath

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

getRequestURL

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

getQueryString

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

getRequestURI

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

getAuthType

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

getCookies

public javax.servlet.http.Cookie[] getCookies()
Specified by:
getCookies in interface javax.servlet.http.HttpServletRequest

getDateHeader

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

getHeader

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

getHeaders

public java.util.Enumeration getHeaders(java.lang.String s)
Specified by:
getHeaders in interface javax.servlet.http.HttpServletRequest

getHeaderNames

public java.util.Enumeration getHeaderNames()
Specified by:
getHeaderNames in interface javax.servlet.http.HttpServletRequest

getIntHeader

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

getMethod

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

getCharacterEncoding

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

getPortletInputStream

public java.io.InputStream getPortletInputStream()
                                          throws java.io.IOException
Specified by:
getPortletInputStream in interface javax.portlet.ActionRequest
Throws:
java.io.IOException

setCharacterEncoding

public void setCharacterEncoding(java.lang.String s)
                          throws java.io.UnsupportedEncodingException
Specified by:
setCharacterEncoding in interface javax.portlet.ActionRequest
Specified by:
setCharacterEncoding in interface javax.servlet.ServletRequest
Throws:
java.io.UnsupportedEncodingException

getContentLength

public int getContentLength()
Specified by:
getContentLength in interface javax.portlet.ActionRequest
Specified by:
getContentLength in interface javax.servlet.ServletRequest

getContentType

public java.lang.String getContentType()
Specified by:
getContentType in interface javax.portlet.ActionRequest
Specified by:
getContentType in interface javax.servlet.ServletRequest

getInputStream

public javax.servlet.ServletInputStream getInputStream()
                                                throws java.io.IOException
Specified by:
getInputStream in interface javax.servlet.ServletRequest
Throws:
java.io.IOException

getSession

public javax.servlet.http.HttpSession getSession(boolean b)
Specified by:
getSession in interface javax.servlet.http.HttpServletRequest

getSession

public javax.servlet.http.HttpSession getSession()
Specified by:
getSession in interface javax.servlet.http.HttpServletRequest

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()
Specified by:
isRequestedSessionIdFromCookie in interface javax.servlet.http.HttpServletRequest

isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()
Specified by:
isRequestedSessionIdFromURL in interface javax.servlet.http.HttpServletRequest

isRequestedSessionIdFromUrl

public boolean isRequestedSessionIdFromUrl()
Deprecated. 

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

getPathTranslated

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

getRequestDispatcher

public javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String s)
Specified by:
getRequestDispatcher in interface javax.servlet.ServletRequest

getRealPath

public java.lang.String getRealPath(java.lang.String s)
Deprecated. 

Specified by:
getRealPath in interface javax.servlet.ServletRequest

getRemotePort

public int getRemotePort()
Specified by:
getRemotePort in interface javax.servlet.ServletRequest

getLocalName

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

getLocalAddr

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

getLocalPort

public int getLocalPort()
Specified by:
getLocalPort in interface javax.servlet.ServletRequest

getProtocol

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

getReader

public java.io.BufferedReader getReader()
                                 throws java.io.IOException
Specified by:
getReader in interface javax.portlet.ActionRequest
Specified by:
getReader in interface javax.servlet.ServletRequest
Throws:
java.io.IOException

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


Copyright 2003 Ludovic Dubost