ResourceHttpServletRequest (zk 9.6.1 API)

java.lang.Object
- org.zkoss.web.portlet.ResourceHttpServletRequest

All Implemented Interfaces:

jakarta.servlet.http.HttpServletRequest, jakarta.servlet.ServletRequest
```
public class ResourceHttpServletRequest
extends java.lang.Object
implements jakarta.servlet.http.HttpServletRequest
```
A facade of ResourceRequest that implements HttpServletRequest.

Since:

6.5.2

Author:

Vincent

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)`
`java.lang.Object`	`getAttribute(java.lang.String name)`
`java.util.Enumeration`	`getAttributeNames()`
`java.lang.String`	`getAuthType()`
`java.lang.String`	`getCharacterEncoding()`
`int`	`getContentLength()`
`java.lang.String`	`getContentType()`
`java.lang.String`	`getContextPath()`
`jakarta.servlet.http.Cookie[]`	`getCookies()`
`long`	`getDateHeader(java.lang.String name)`
`java.lang.String`	`getHeader(java.lang.String name)`
`java.util.Enumeration`	`getHeaderNames()`
`java.util.Enumeration`	`getHeaders(java.lang.String name)`
`protected jakarta.servlet.http.HttpServletRequest`	`getHttpServletRequest(javax.portlet.ResourceRequest req)` Returns the HTTP servlet request associated with the render request, or null if not found.
`jakarta.servlet.ServletInputStream`	`getInputStream()`
`static jakarta.servlet.http.HttpServletRequest`	`getInstance(javax.portlet.ResourceRequest req)`
`int`	`getIntHeader(java.lang.String name)`
`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()`
`java.lang.String`	`getProtocol()`
`java.lang.String`	`getQueryString()`
`java.io.BufferedReader`	`getReader()`
`java.lang.String`	`getRealPath(java.lang.String path)` Deprecated.
`java.lang.String`	`getRemoteAddr()`
`java.lang.String`	`getRemoteHost()`
`int`	`getRemotePort()`
`java.lang.String`	`getRemoteUser()`
`jakarta.servlet.RequestDispatcher`	`getRequestDispatcher(java.lang.String path)`
`java.lang.String`	`getRequestedSessionId()`
`java.lang.String`	`getRequestURI()`
`java.lang.StringBuffer`	`getRequestURL()`
`javax.portlet.ResourceRequest`	`getResourceRequest()`
`java.lang.String`	`getScheme()`
`java.lang.String`	`getServerName()`
`int`	`getServerPort()`
`java.lang.String`	`getServletPath()`
`jakarta.servlet.http.HttpSession`	`getSession()`
`jakarta.servlet.http.HttpSession`	`getSession(boolean create)`
`java.security.Principal`	`getUserPrincipal()`
`int`	`hashCode()`
`boolean`	`isRequestedSessionIdFromCookie()`
`boolean`	`isRequestedSessionIdFromUrl()` Deprecated.
`boolean`	`isRequestedSessionIdFromURL()`
`boolean`	`isRequestedSessionIdValid()`
`boolean`	`isSecure()`
`boolean`	`isUserInRole(java.lang.String role)`
`void`	`removeAttribute(java.lang.String name)`
`void`	`setAttribute(java.lang.String name, java.lang.Object o)`
`void`	`setCharacterEncoding(java.lang.String enc)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jakarta.servlet.http.HttpServletRequest
authenticate, changeSessionId, getPart, getParts, login, logout, upgrade

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

- Method Detail
  - getInstance
```
public static jakarta.servlet.http.HttpServletRequest getInstance(javax.portlet.ResourceRequest req)
```
  - getHttpServletRequest
```
protected jakarta.servlet.http.HttpServletRequest getHttpServletRequest(javax.portlet.ResourceRequest req)
```
    Returns the HTTP servlet request associated with the render request, or null if not found.
  - getAttribute
```
public java.lang.Object getAttribute(java.lang.String name)
```
    Specified by:
    
    getAttribute in interface jakarta.servlet.ServletRequest
  - getAttributeNames
```
public java.util.Enumeration getAttributeNames()
```
    Specified by:
    
    getAttributeNames in interface jakarta.servlet.ServletRequest
  - getResourceRequest
```
public javax.portlet.ResourceRequest getResourceRequest()
```
  - getCharacterEncoding
```
public java.lang.String getCharacterEncoding()
```
    Specified by:
    
    getCharacterEncoding in interface jakarta.servlet.ServletRequest
  - getContentLength
```
public int getContentLength()
```
    Specified by:
    
    getContentLength in interface jakarta.servlet.ServletRequest
  - getContentType
```
public java.lang.String getContentType()
```
    Specified by:
    
    getContentType in interface jakarta.servlet.ServletRequest
  - getInputStream
```
public jakarta.servlet.ServletInputStream getInputStream()
```
    Specified by:
    
    getInputStream in interface jakarta.servlet.ServletRequest
  - getLocalAddr
```
public java.lang.String getLocalAddr()
```
    Specified by:
    
    getLocalAddr in interface jakarta.servlet.ServletRequest
  - getLocale
```
public java.util.Locale getLocale()
```
    Specified by:
    
    getLocale in interface jakarta.servlet.ServletRequest
  - getLocales
```
public java.util.Enumeration getLocales()
```
    Specified by:
    
    getLocales in interface jakarta.servlet.ServletRequest
  - getLocalName
```
public java.lang.String getLocalName()
```
    Specified by:
    
    getLocalName in interface jakarta.servlet.ServletRequest
  - getLocalPort
```
public int getLocalPort()
```
    Specified by:
    
    getLocalPort in interface jakarta.servlet.ServletRequest
  - getParameter
```
public java.lang.String getParameter(java.lang.String name)
```
    Specified by:
    
    getParameter in interface jakarta.servlet.ServletRequest
  - getParameterMap
```
public java.util.Map getParameterMap()
```
    Specified by:
    
    getParameterMap in interface jakarta.servlet.ServletRequest
  - getParameterNames
```
public java.util.Enumeration getParameterNames()
```
    Specified by:
    
    getParameterNames in interface jakarta.servlet.ServletRequest
  - getParameterValues
```
public java.lang.String[] getParameterValues(java.lang.String name)
```
    Specified by:
    
    getParameterValues in interface jakarta.servlet.ServletRequest
  - getProtocol
```
public java.lang.String getProtocol()
```
    Specified by:
    
    getProtocol in interface jakarta.servlet.ServletRequest
  - getReader
```
public java.io.BufferedReader getReader()
```
    Specified by:
    
    getReader in interface jakarta.servlet.ServletRequest
  - getRealPath
```
public java.lang.String getRealPath(java.lang.String path)
```
    Deprecated.
    
    Specified by:
    
    getRealPath in interface jakarta.servlet.ServletRequest
  - getRemoteAddr
```
public java.lang.String getRemoteAddr()
```
    Specified by:
    
    getRemoteAddr in interface jakarta.servlet.ServletRequest
  - getRemoteHost
```
public java.lang.String getRemoteHost()
```
    Specified by:
    
    getRemoteHost in interface jakarta.servlet.ServletRequest
  - getRemotePort
```
public int getRemotePort()
```
    Specified by:
    
    getRemotePort in interface jakarta.servlet.ServletRequest
  - getRequestDispatcher
```
public jakarta.servlet.RequestDispatcher getRequestDispatcher(java.lang.String path)
```
    Specified by:
    
    getRequestDispatcher in interface jakarta.servlet.ServletRequest
  - getScheme
```
public java.lang.String getScheme()
```
    Specified by:
    
    getScheme in interface jakarta.servlet.ServletRequest
  - getServerName
```
public java.lang.String getServerName()
```
    Specified by:
    
    getServerName in interface jakarta.servlet.ServletRequest
  - getServerPort
```
public int getServerPort()
```
    Specified by:
    
    getServerPort in interface jakarta.servlet.ServletRequest
  - isSecure
```
public boolean isSecure()
```
    Specified by:
    
    isSecure in interface jakarta.servlet.ServletRequest
  - removeAttribute
```
public void removeAttribute(java.lang.String name)
```
    Specified by:
    
    removeAttribute in interface jakarta.servlet.ServletRequest
  - setAttribute
```
public void setAttribute(java.lang.String name,
                         java.lang.Object o)
```
    Specified by:
    
    setAttribute in interface jakarta.servlet.ServletRequest
  - setCharacterEncoding
```
public void setCharacterEncoding(java.lang.String enc)
                          throws java.io.UnsupportedEncodingException
```
    Specified by:
    
    setCharacterEncoding in interface jakarta.servlet.ServletRequest
    
    Throws:
    
    java.io.UnsupportedEncodingException
  - getAuthType
```
public java.lang.String getAuthType()
```
    Specified by:
    
    getAuthType in interface jakarta.servlet.http.HttpServletRequest
  - getContextPath
```
public java.lang.String getContextPath()
```
    Specified by:
    
    getContextPath in interface jakarta.servlet.http.HttpServletRequest
  - getCookies
```
public jakarta.servlet.http.Cookie[] getCookies()
```
    Specified by:
    
    getCookies in interface jakarta.servlet.http.HttpServletRequest
  - getDateHeader
```
public long getDateHeader(java.lang.String name)
```
    Specified by:
    
    getDateHeader in interface jakarta.servlet.http.HttpServletRequest
  - getHeader
```
public java.lang.String getHeader(java.lang.String name)
```
    Specified by:
    
    getHeader in interface jakarta.servlet.http.HttpServletRequest
  - getHeaderNames
```
public java.util.Enumeration getHeaderNames()
```
    Specified by:
    
    getHeaderNames in interface jakarta.servlet.http.HttpServletRequest
  - getHeaders
```
public java.util.Enumeration getHeaders(java.lang.String name)
```
    Specified by:
    
    getHeaders in interface jakarta.servlet.http.HttpServletRequest
  - getIntHeader
```
public int getIntHeader(java.lang.String name)
```
    Specified by:
    
    getIntHeader in interface jakarta.servlet.http.HttpServletRequest
  - getMethod
```
public java.lang.String getMethod()
```
    Specified by:
    
    getMethod in interface jakarta.servlet.http.HttpServletRequest
  - getPathInfo
```
public java.lang.String getPathInfo()
```
    Specified by:
    
    getPathInfo in interface jakarta.servlet.http.HttpServletRequest
  - getPathTranslated
```
public java.lang.String getPathTranslated()
```
    Specified by:
    
    getPathTranslated in interface jakarta.servlet.http.HttpServletRequest
  - getQueryString
```
public java.lang.String getQueryString()
```
    Specified by:
    
    getQueryString in interface jakarta.servlet.http.HttpServletRequest
  - getRemoteUser
```
public java.lang.String getRemoteUser()
```
    Specified by:
    
    getRemoteUser in interface jakarta.servlet.http.HttpServletRequest
  - getRequestedSessionId
```
public java.lang.String getRequestedSessionId()
```
    Specified by:
    
    getRequestedSessionId in interface jakarta.servlet.http.HttpServletRequest
  - getRequestURI
```
public java.lang.String getRequestURI()
```
    Specified by:
    
    getRequestURI in interface jakarta.servlet.http.HttpServletRequest
  - getRequestURL
```
public java.lang.StringBuffer getRequestURL()
```
    Specified by:
    
    getRequestURL in interface jakarta.servlet.http.HttpServletRequest
  - getServletPath
```
public java.lang.String getServletPath()
```
    Specified by:
    
    getServletPath in interface jakarta.servlet.http.HttpServletRequest
  - getSession
```
public jakarta.servlet.http.HttpSession getSession()
```
    Specified by:
    
    getSession in interface jakarta.servlet.http.HttpServletRequest
  - getSession
```
public jakarta.servlet.http.HttpSession getSession(boolean create)
```
    Specified by:
    
    getSession in interface jakarta.servlet.http.HttpServletRequest
  - getUserPrincipal
```
public java.security.Principal getUserPrincipal()
```
    Specified by:
    
    getUserPrincipal in interface jakarta.servlet.http.HttpServletRequest
  - isRequestedSessionIdFromCookie
```
public boolean isRequestedSessionIdFromCookie()
```
    Specified by:
    
    isRequestedSessionIdFromCookie in interface jakarta.servlet.http.HttpServletRequest
  - isRequestedSessionIdFromUrl
```
public boolean isRequestedSessionIdFromUrl()
```
    Deprecated.
    
    Specified by:
    
    isRequestedSessionIdFromUrl in interface jakarta.servlet.http.HttpServletRequest
  - isRequestedSessionIdFromURL
```
public boolean isRequestedSessionIdFromURL()
```
    Specified by:
    
    isRequestedSessionIdFromURL in interface jakarta.servlet.http.HttpServletRequest
  - isRequestedSessionIdValid
```
public boolean isRequestedSessionIdValid()
```
    Specified by:
    
    isRequestedSessionIdValid in interface jakarta.servlet.http.HttpServletRequest
  - isUserInRole
```
public boolean isUserInRole(java.lang.String role)
```
    Specified by:
    
    isUserInRole in interface jakarta.servlet.http.HttpServletRequest
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object

Class ResourceHttpServletRequest

Field Summary

Fields inherited from interface jakarta.servlet.http.HttpServletRequest

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface jakarta.servlet.http.HttpServletRequest

Methods inherited from interface jakarta.servlet.ServletRequest

Method Detail

getInstance

getHttpServletRequest

getAttribute

getAttributeNames

getResourceRequest

getCharacterEncoding

getContentLength

getContentType

getInputStream

getLocalAddr

getLocale

getLocales

getLocalName

getLocalPort

getParameter

getParameterMap

getParameterNames

getParameterValues

getProtocol

getReader

getRealPath

getRemoteAddr

getRemoteHost

getRemotePort

getRequestDispatcher

getScheme

getServerName

getServerPort

isSecure

removeAttribute

setAttribute

setCharacterEncoding

getAuthType

getContextPath

getCookies

getDateHeader

getHeader

getHeaderNames

getHeaders

getIntHeader

getMethod

getPathInfo

getPathTranslated

getQueryString

getRemoteUser

getRequestedSessionId

getRequestURI

getRequestURL

getServletPath

getSession

getSession

getUserPrincipal

isRequestedSessionIdFromCookie

isRequestedSessionIdFromUrl

isRequestedSessionIdFromURL

isRequestedSessionIdValid

isUserInRole

hashCode

equals