PortletServletRequest (Liferay 7.1.1-ga2 portal-impl API)

Object
- javax.servlet.ServletRequestWrapper
- - javax.servlet.http.HttpServletRequestWrapper
  - - com.liferay.portlet.PortletServletRequest

All Implemented Interfaces:

javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest
```
public class PortletServletRequest
extends javax.servlet.http.HttpServletRequestWrapper
```
Author:

Brian Wing Shun Chan, Brian Myunghun Kim

Field Summary
- Fields inherited from interface javax.servlet.http.HttpServletRequest
  BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors
Constructor and Description
`PortletServletRequest(javax.servlet.http.HttpServletRequest request, PortletRequest portletRequest, String pathInfo, String queryString, String requestURI, String servletPath, boolean named, boolean include)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Object`	`getAttribute(String name)`
`Enumeration<String>`	`getAttributeNames()`
`String`	`getAuthType()`
`String`	`getCharacterEncoding()`
`int`	`getContentLength()`
`String`	`getContentType()`
`String`	`getContextPath()`
`javax.servlet.http.Cookie[]`	`getCookies()`
`long`	`getDateHeader(String name)`
`String`	`getHeader(String name)`
`Enumeration<String>`	`getHeaderNames()`
`Enumeration<String>`	`getHeaders(String name)`
`javax.servlet.ServletInputStream`	`getInputStream()`
`int`	`getIntHeader(String name)`
`String`	`getLocalAddr()`
`Locale`	`getLocale()`
`Enumeration<Locale>`	`getLocales()`
`String`	`getLocalName()`
`int`	`getLocalPort()`
`String`	`getMethod()`
`String`	`getParameter(String name)`
`Map<String,String[]>`	`getParameterMap()`
`Enumeration<String>`	`getParameterNames()`
`String[]`	`getParameterValues(String name)`
`String`	`getPathInfo()`
`String`	`getPathTranslated()`
`String`	`getProtocol()`
`String`	`getQueryString()`
`BufferedReader`	`getReader()`
`String`	`getRealPath(String path)` Deprecated. As of Wilberforce (7.0.x)
`String`	`getRemoteAddr()`
`String`	`getRemoteHost()`
`int`	`getRemotePort()`
`String`	`getRemoteUser()`
`javax.servlet.RequestDispatcher`	`getRequestDispatcher(String path)`
`String`	`getRequestedSessionId()`
`String`	`getRequestURI()`
`StringBuffer`	`getRequestURL()`
`String`	`getScheme()`
`String`	`getServerName()`
`int`	`getServerPort()`
`String`	`getServletPath()`
`javax.servlet.http.HttpSession`	`getSession()`
`javax.servlet.http.HttpSession`	`getSession(boolean create)`
`Principal`	`getUserPrincipal()`
`boolean`	`isRequestedSessionIdFromCookie()`
`boolean`	`isRequestedSessionIdFromURL()`
`boolean`	`isRequestedSessionIdValid()`
`boolean`	`isSecure()`
`boolean`	`isUserInRole(String role)`
`void`	`removeAttribute(String name)`
`void`	`setAttribute(String name, Object obj)`
`void`	`setCharacterEncoding(String encoding)`
`protected javax.servlet.http.HttpSession`	`wrapJettySession(javax.servlet.http.HttpSession session)`

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper
authenticate, changeSessionId, getPart, getParts, isRequestedSessionIdFromUrl, login, logout, upgrade

Methods inherited from class javax.servlet.ServletRequestWrapper
getAsyncContext, getContentLengthLong, getDispatcherType, getRequest, getServletContext, isAsyncStarted, isAsyncSupported, isWrapperFor, isWrapperFor, setRequest, startAsync, startAsync

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.servlet.ServletRequest
getAsyncContext, getContentLengthLong, getDispatcherType, getServletContext, isAsyncStarted, isAsyncSupported, startAsync, startAsync

- Constructor Detail
  - PortletServletRequest
```
public PortletServletRequest(javax.servlet.http.HttpServletRequest request,
                             PortletRequest portletRequest,
                             String pathInfo,
                             String queryString,
                             String requestURI,
                             String servletPath,
                             boolean named,
                             boolean include)
```
- Method Detail
  - getAttribute
```
public Object getAttribute(String name)
```
    Specified by:
    
    getAttribute in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getAttribute in class javax.servlet.ServletRequestWrapper
  - getAttributeNames
```
public Enumeration<String> getAttributeNames()
```
    Specified by:
    
    getAttributeNames in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getAttributeNames in class javax.servlet.ServletRequestWrapper
  - getAuthType
```
public String getAuthType()
```
    Specified by:
    
    getAuthType in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getAuthType in class javax.servlet.http.HttpServletRequestWrapper
  - getCharacterEncoding
```
public String getCharacterEncoding()
```
    Specified by:
    
    getCharacterEncoding in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getCharacterEncoding in class javax.servlet.ServletRequestWrapper
  - getContentLength
```
public int getContentLength()
```
    Specified by:
    
    getContentLength in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getContentLength in class javax.servlet.ServletRequestWrapper
  - getContentType
```
public String getContentType()
```
    Specified by:
    
    getContentType in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getContentType in class javax.servlet.ServletRequestWrapper
  - getContextPath
```
public String getContextPath()
```
    Specified by:
    
    getContextPath in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getContextPath in class javax.servlet.http.HttpServletRequestWrapper
  - getCookies
```
public javax.servlet.http.Cookie[] getCookies()
```
    Specified by:
    
    getCookies in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getCookies in class javax.servlet.http.HttpServletRequestWrapper
  - getDateHeader
```
public long getDateHeader(String name)
```
    Specified by:
    
    getDateHeader in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getDateHeader in class javax.servlet.http.HttpServletRequestWrapper
  - getHeader
```
public String getHeader(String name)
```
    Specified by:
    
    getHeader in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getHeader in class javax.servlet.http.HttpServletRequestWrapper
  - getHeaderNames
```
public Enumeration<String> getHeaderNames()
```
    Specified by:
    
    getHeaderNames in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getHeaderNames in class javax.servlet.http.HttpServletRequestWrapper
  - getHeaders
```
public Enumeration<String> getHeaders(String name)
```
    Specified by:
    
    getHeaders in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getHeaders in class javax.servlet.http.HttpServletRequestWrapper
  - getInputStream
```
public javax.servlet.ServletInputStream getInputStream()
                                                throws IOException
```
    Specified by:
    
    getInputStream in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getInputStream in class javax.servlet.ServletRequestWrapper
    
    Throws:
    
    IOException
  - getIntHeader
```
public int getIntHeader(String name)
```
    Specified by:
    
    getIntHeader in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getIntHeader in class javax.servlet.http.HttpServletRequestWrapper
  - getLocalAddr
```
public String getLocalAddr()
```
    Specified by:
    
    getLocalAddr in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getLocalAddr in class javax.servlet.ServletRequestWrapper
  - getLocale
```
public Locale getLocale()
```
    Specified by:
    
    getLocale in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getLocale in class javax.servlet.ServletRequestWrapper
  - getLocales
```
public Enumeration<Locale> getLocales()
```
    Specified by:
    
    getLocales in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getLocales in class javax.servlet.ServletRequestWrapper
  - getLocalName
```
public String getLocalName()
```
    Specified by:
    
    getLocalName in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getLocalName in class javax.servlet.ServletRequestWrapper
  - getLocalPort
```
public int getLocalPort()
```
    Specified by:
    
    getLocalPort in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getLocalPort in class javax.servlet.ServletRequestWrapper
  - getMethod
```
public String getMethod()
```
    Specified by:
    
    getMethod in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getMethod in class javax.servlet.http.HttpServletRequestWrapper
  - getParameter
```
public String getParameter(String name)
```
    Specified by:
    
    getParameter in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getParameter in class javax.servlet.ServletRequestWrapper
  - getParameterMap
```
public Map<String,String[]> getParameterMap()
```
    Specified by:
    
    getParameterMap in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getParameterMap in class javax.servlet.ServletRequestWrapper
  - getParameterNames
```
public Enumeration<String> getParameterNames()
```
    Specified by:
    
    getParameterNames in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getParameterNames in class javax.servlet.ServletRequestWrapper
  - getParameterValues
```
public String[] getParameterValues(String name)
```
    Specified by:
    
    getParameterValues in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getParameterValues in class javax.servlet.ServletRequestWrapper
  - getPathInfo
```
public String getPathInfo()
```
    Specified by:
    
    getPathInfo in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getPathInfo in class javax.servlet.http.HttpServletRequestWrapper
  - getPathTranslated
```
public String getPathTranslated()
```
    Specified by:
    
    getPathTranslated in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getPathTranslated in class javax.servlet.http.HttpServletRequestWrapper
  - getProtocol
```
public String getProtocol()
```
    Specified by:
    
    getProtocol in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getProtocol in class javax.servlet.ServletRequestWrapper
  - getQueryString
```
public String getQueryString()
```
    Specified by:
    
    getQueryString in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getQueryString in class javax.servlet.http.HttpServletRequestWrapper
  - getReader
```
public BufferedReader getReader()
                         throws IOException
```
    Specified by:
    
    getReader in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getReader in class javax.servlet.ServletRequestWrapper
    
    Throws:
    
    IOException
  - getRealPath
```
@Deprecated
public String getRealPath(String path)
```
    Deprecated. As of Wilberforce (7.0.x)
    
    Specified by:
    
    getRealPath in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getRealPath in class javax.servlet.ServletRequestWrapper
  - getRemoteAddr
```
public String getRemoteAddr()
```
    Specified by:
    
    getRemoteAddr in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getRemoteAddr in class javax.servlet.ServletRequestWrapper
  - getRemoteHost
```
public String getRemoteHost()
```
    Specified by:
    
    getRemoteHost in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getRemoteHost in class javax.servlet.ServletRequestWrapper
  - getRemotePort
```
public int getRemotePort()
```
    Specified by:
    
    getRemotePort in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getRemotePort in class javax.servlet.ServletRequestWrapper
  - getRemoteUser
```
public String getRemoteUser()
```
    Specified by:
    
    getRemoteUser in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getRemoteUser in class javax.servlet.http.HttpServletRequestWrapper
  - getRequestDispatcher
```
public javax.servlet.RequestDispatcher getRequestDispatcher(String path)
```
    Specified by:
    
    getRequestDispatcher in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getRequestDispatcher in class javax.servlet.ServletRequestWrapper
  - getRequestedSessionId
```
public String getRequestedSessionId()
```
    Specified by:
    
    getRequestedSessionId in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getRequestedSessionId in class javax.servlet.http.HttpServletRequestWrapper
  - getRequestURI
```
public String getRequestURI()
```
    Specified by:
    
    getRequestURI in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getRequestURI in class javax.servlet.http.HttpServletRequestWrapper
  - getRequestURL
```
public StringBuffer getRequestURL()
```
    Specified by:
    
    getRequestURL in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getRequestURL in class javax.servlet.http.HttpServletRequestWrapper
  - getScheme
```
public String getScheme()
```
    Specified by:
    
    getScheme in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getScheme in class javax.servlet.ServletRequestWrapper
  - getServerName
```
public String getServerName()
```
    Specified by:
    
    getServerName in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getServerName in class javax.servlet.ServletRequestWrapper
  - getServerPort
```
public int getServerPort()
```
    Specified by:
    
    getServerPort in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getServerPort in class javax.servlet.ServletRequestWrapper
  - getServletPath
```
public String getServletPath()
```
    Specified by:
    
    getServletPath in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getServletPath in class javax.servlet.http.HttpServletRequestWrapper
  - getSession
```
public javax.servlet.http.HttpSession getSession()
```
    Specified by:
    
    getSession in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getSession in class javax.servlet.http.HttpServletRequestWrapper
  - getSession
```
public javax.servlet.http.HttpSession getSession(boolean create)
```
    Specified by:
    
    getSession in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getSession in class javax.servlet.http.HttpServletRequestWrapper
  - getUserPrincipal
```
public Principal getUserPrincipal()
```
    Specified by:
    
    getUserPrincipal in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getUserPrincipal in class javax.servlet.http.HttpServletRequestWrapper
  - isRequestedSessionIdFromCookie
```
public boolean isRequestedSessionIdFromCookie()
```
    Specified by:
    
    isRequestedSessionIdFromCookie in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    isRequestedSessionIdFromCookie in class javax.servlet.http.HttpServletRequestWrapper
  - isRequestedSessionIdFromURL
```
public boolean isRequestedSessionIdFromURL()
```
    Specified by:
    
    isRequestedSessionIdFromURL in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    isRequestedSessionIdFromURL in class javax.servlet.http.HttpServletRequestWrapper
  - isRequestedSessionIdValid
```
public boolean isRequestedSessionIdValid()
```
    Specified by:
    
    isRequestedSessionIdValid in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    isRequestedSessionIdValid in class javax.servlet.http.HttpServletRequestWrapper
  - isSecure
```
public boolean isSecure()
```
    Specified by:
    
    isSecure in interface javax.servlet.ServletRequest
    
    Overrides:
    
    isSecure in class javax.servlet.ServletRequestWrapper
  - isUserInRole
```
public boolean isUserInRole(String role)
```
    Specified by:
    
    isUserInRole in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    isUserInRole in class javax.servlet.http.HttpServletRequestWrapper
  - removeAttribute
```
public void removeAttribute(String name)
```
    Specified by:
    
    removeAttribute in interface javax.servlet.ServletRequest
    
    Overrides:
    
    removeAttribute in class javax.servlet.ServletRequestWrapper
  - setAttribute
```
public void setAttribute(String name,
                         Object obj)
```
    Specified by:
    
    setAttribute in interface javax.servlet.ServletRequest
    
    Overrides:
    
    setAttribute in class javax.servlet.ServletRequestWrapper
  - setCharacterEncoding
```
public void setCharacterEncoding(String encoding)
                          throws UnsupportedEncodingException
```
    Specified by:
    
    setCharacterEncoding in interface javax.servlet.ServletRequest
    
    Overrides:
    
    setCharacterEncoding in class javax.servlet.ServletRequestWrapper
    
    Throws:
    
    UnsupportedEncodingException
  - wrapJettySession
```
protected javax.servlet.http.HttpSession wrapJettySession(javax.servlet.http.HttpSession session)
                                                   throws Exception
```
    Throws:
    
    Exception

Class PortletServletRequest

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

Constructor Summary

Method Summary

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper

Methods inherited from class javax.servlet.ServletRequestWrapper

Methods inherited from class Object

Methods inherited from interface javax.servlet.ServletRequest

Constructor Detail

PortletServletRequest

Method Detail

getAttribute

getAttributeNames

getAuthType

getCharacterEncoding

getContentLength

getContentType

getContextPath

getCookies

getDateHeader

getHeader

getHeaderNames

getHeaders

getInputStream

getIntHeader

getLocalAddr

getLocale

getLocales

getLocalName

getLocalPort

getMethod

getParameter

getParameterMap

getParameterNames

getParameterValues

getPathInfo

getPathTranslated

getProtocol

getQueryString

getReader

getRealPath

getRemoteAddr

getRemoteHost

getRemotePort

getRemoteUser

getRequestDispatcher

getRequestedSessionId

getRequestURI

getRequestURL

getScheme

getServerName

getServerPort

getServletPath

getSession

getSession

getUserPrincipal

isRequestedSessionIdFromCookie

isRequestedSessionIdFromURL

isRequestedSessionIdValid

isSecure

isUserInRole

removeAttribute

setAttribute

setCharacterEncoding

wrapJettySession