Package org.zkoss.zkmax.ui.http

Class FacadeHttpServletRequest

java.lang.Object
jakarta.servlet.ServletRequestWrapper
jakarta.servlet.http.HttpServletRequestWrapper
org.zkoss.zkmax.ui.http.FacadeHttpServletRequest
All Implemented Interfaces:
jakarta.servlet.http.HttpServletRequest, jakarta.servlet.ServletRequest
public class FacadeHttpServletRequest extends jakarta.servlet.http.HttpServletRequestWrapper
A facade request object to avoid holding a recycled request instance.
Since:
8.5.0
Author:
wenninghsu

  • Constructor Details

    • FacadeHttpServletRequest

      public FacadeHttpServletRequest(jakarta.servlet.http.HttpServletRequest request)

    • FacadeHttpServletRequest

      public FacadeHttpServletRequest(jakarta.servlet.http.HttpServletRequest request, boolean keepAttributes)
      Parameters:
      request - the original request
      keepAttributes - whether to keep the attributes
      Since:
      9.6.0

  • Method Details

    • getAuthType

      public String getAuthType()
      Specified by:
      getAuthType in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getAuthType in class jakarta.servlet.http.HttpServletRequestWrapper

    • getCookies

      public jakarta.servlet.http.Cookie[] getCookies()
      Specified by:
      getCookies in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getCookies in class jakarta.servlet.http.HttpServletRequestWrapper

    • getDateHeader

      public long getDateHeader(String name)
      Specified by:
      getDateHeader in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getDateHeader in class jakarta.servlet.http.HttpServletRequestWrapper

    • getHeader

      public String getHeader(String name)
      Specified by:
      getHeader in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getHeader in class jakarta.servlet.http.HttpServletRequestWrapper

    • getHeaders

      public Enumeration<String> getHeaders(String name)
      Specified by:
      getHeaders in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getHeaders in class jakarta.servlet.http.HttpServletRequestWrapper

    • getHeaderNames

      public Enumeration<String> getHeaderNames()
      Specified by:
      getHeaderNames in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getHeaderNames in class jakarta.servlet.http.HttpServletRequestWrapper

    • getIntHeader

      public int getIntHeader(String name) throws NumberFormatException
      Specified by:
      getIntHeader in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getIntHeader in class jakarta.servlet.http.HttpServletRequestWrapper
      Throws:
      NumberFormatException

    • getMethod

      public String getMethod()
      Specified by:
      getMethod in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getMethod in class jakarta.servlet.http.HttpServletRequestWrapper

    • getPathInfo

      public String getPathInfo()
      Specified by:
      getPathInfo in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getPathInfo in class jakarta.servlet.http.HttpServletRequestWrapper

    • getPathTranslated

      public String getPathTranslated()
      Specified by:
      getPathTranslated in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getPathTranslated in class jakarta.servlet.http.HttpServletRequestWrapper

    • getContextPath

      public String getContextPath()
      Specified by:
      getContextPath in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getContextPath in class jakarta.servlet.http.HttpServletRequestWrapper

    • getQueryString

      public String getQueryString()
      Specified by:
      getQueryString in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getQueryString in class jakarta.servlet.http.HttpServletRequestWrapper

    • getRemoteUser

      public String getRemoteUser()
      Specified by:
      getRemoteUser in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getRemoteUser in class jakarta.servlet.http.HttpServletRequestWrapper

    • isUserInRole

      public boolean isUserInRole(String role)
      Specified by:
      isUserInRole in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      isUserInRole in class jakarta.servlet.http.HttpServletRequestWrapper

    • getUserPrincipal

      public Principal getUserPrincipal()
      Specified by:
      getUserPrincipal in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getUserPrincipal in class jakarta.servlet.http.HttpServletRequestWrapper

    • getRequestedSessionId

      public String getRequestedSessionId()
      Specified by:
      getRequestedSessionId in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getRequestedSessionId in class jakarta.servlet.http.HttpServletRequestWrapper

    • getRequestURI

      public String getRequestURI()
      Specified by:
      getRequestURI in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getRequestURI in class jakarta.servlet.http.HttpServletRequestWrapper

    • getRequestURL

      public StringBuffer getRequestURL()
      Specified by:
      getRequestURL in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getRequestURL in class jakarta.servlet.http.HttpServletRequestWrapper

    • getServletPath

      public String getServletPath()
      Specified by:
      getServletPath in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getServletPath in class jakarta.servlet.http.HttpServletRequestWrapper

    • getSession

      public jakarta.servlet.http.HttpSession getSession(boolean create)
      Specified by:
      getSession in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getSession in class jakarta.servlet.http.HttpServletRequestWrapper

    • getSession

      public jakarta.servlet.http.HttpSession getSession()
      Specified by:
      getSession in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getSession in class jakarta.servlet.http.HttpServletRequestWrapper

    • isRequestedSessionIdValid

      public boolean isRequestedSessionIdValid()
      Specified by:
      isRequestedSessionIdValid in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      isRequestedSessionIdValid in class jakarta.servlet.http.HttpServletRequestWrapper

    • isRequestedSessionIdFromCookie

      public boolean isRequestedSessionIdFromCookie()
      Specified by:
      isRequestedSessionIdFromCookie in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      isRequestedSessionIdFromCookie in class jakarta.servlet.http.HttpServletRequestWrapper

    • isRequestedSessionIdFromURL

      public boolean isRequestedSessionIdFromURL()
      Specified by:
      isRequestedSessionIdFromURL in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      isRequestedSessionIdFromURL in class jakarta.servlet.http.HttpServletRequestWrapper

    • isRequestedSessionIdFromUrl

      public boolean isRequestedSessionIdFromUrl()
      Specified by:
      isRequestedSessionIdFromUrl in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      isRequestedSessionIdFromUrl in class jakarta.servlet.http.HttpServletRequestWrapper

    • authenticate

      public boolean authenticate(jakarta.servlet.http.HttpServletResponse response) throws IOException, jakarta.servlet.ServletException
      Specified by:
      authenticate in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      authenticate in class jakarta.servlet.http.HttpServletRequestWrapper
      Throws:
      IOException
      jakarta.servlet.ServletException

    • login

      public void login(String username, String password) throws jakarta.servlet.ServletException
      Specified by:
      login in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      login in class jakarta.servlet.http.HttpServletRequestWrapper
      Throws:
      jakarta.servlet.ServletException

    • logout

      public void logout() throws jakarta.servlet.ServletException
      Specified by:
      logout in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      logout in class jakarta.servlet.http.HttpServletRequestWrapper
      Throws:
      jakarta.servlet.ServletException

    • getParts

      public Collection<jakarta.servlet.http.Part> getParts() throws IOException, jakarta.servlet.ServletException
      Specified by:
      getParts in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getParts in class jakarta.servlet.http.HttpServletRequestWrapper
      Throws:
      IOException
      jakarta.servlet.ServletException

    • getPart

      public jakarta.servlet.http.Part getPart(String name) throws IOException, jakarta.servlet.ServletException
      Specified by:
      getPart in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getPart in class jakarta.servlet.http.HttpServletRequestWrapper
      Throws:
      IOException
      jakarta.servlet.ServletException

    • getAttribute

      public Object getAttribute(String name)
      Specified by:
      getAttribute in interface jakarta.servlet.ServletRequest
      Overrides:
      getAttribute in class jakarta.servlet.ServletRequestWrapper

    • getAttributeNames

      public Enumeration<String> getAttributeNames()
      Specified by:
      getAttributeNames in interface jakarta.servlet.ServletRequest
      Overrides:
      getAttributeNames in class jakarta.servlet.ServletRequestWrapper

    • getCharacterEncoding

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

    • setCharacterEncoding

      public void setCharacterEncoding(String env) throws UnsupportedEncodingException
      Specified by:
      setCharacterEncoding in interface jakarta.servlet.ServletRequest
      Overrides:
      setCharacterEncoding in class jakarta.servlet.ServletRequestWrapper
      Throws:
      UnsupportedEncodingException

    • getContentLength

      public int getContentLength()
      Specified by:
      getContentLength in interface jakarta.servlet.ServletRequest
      Overrides:
      getContentLength in class jakarta.servlet.ServletRequestWrapper

    • getContentType

      public String getContentType()
      Specified by:
      getContentType in interface jakarta.servlet.ServletRequest
      Overrides:
      getContentType in class jakarta.servlet.ServletRequestWrapper

    • getInputStream

      public jakarta.servlet.ServletInputStream getInputStream() throws IOException
      Specified by:
      getInputStream in interface jakarta.servlet.ServletRequest
      Overrides:
      getInputStream in class jakarta.servlet.ServletRequestWrapper
      Throws:
      IOException

    • getParameter

      public String getParameter(String name)
      Specified by:
      getParameter in interface jakarta.servlet.ServletRequest
      Overrides:
      getParameter in class jakarta.servlet.ServletRequestWrapper

    • getParameterNames

      public Enumeration<String> getParameterNames()
      Specified by:
      getParameterNames in interface jakarta.servlet.ServletRequest
      Overrides:
      getParameterNames in class jakarta.servlet.ServletRequestWrapper

    • getParameterValues

      public String[] getParameterValues(String name)
      Specified by:
      getParameterValues in interface jakarta.servlet.ServletRequest
      Overrides:
      getParameterValues in class jakarta.servlet.ServletRequestWrapper

    • getParameterMap

      public Map<String,String[]> getParameterMap()
      Specified by:
      getParameterMap in interface jakarta.servlet.ServletRequest
      Overrides:
      getParameterMap in class jakarta.servlet.ServletRequestWrapper

    • getProtocol

      public String getProtocol()
      Specified by:
      getProtocol in interface jakarta.servlet.ServletRequest
      Overrides:
      getProtocol in class jakarta.servlet.ServletRequestWrapper

    • getScheme

      public String getScheme()
      Specified by:
      getScheme in interface jakarta.servlet.ServletRequest
      Overrides:
      getScheme in class jakarta.servlet.ServletRequestWrapper

    • getServerName

      public String getServerName()
      Specified by:
      getServerName in interface jakarta.servlet.ServletRequest
      Overrides:
      getServerName in class jakarta.servlet.ServletRequestWrapper

    • getServerPort

      public int getServerPort()
      Specified by:
      getServerPort in interface jakarta.servlet.ServletRequest
      Overrides:
      getServerPort in class jakarta.servlet.ServletRequestWrapper

    • getReader

      public BufferedReader getReader() throws IOException
      Specified by:
      getReader in interface jakarta.servlet.ServletRequest
      Overrides:
      getReader in class jakarta.servlet.ServletRequestWrapper
      Throws:
      IOException

    • getRemoteAddr

      public String getRemoteAddr()
      Specified by:
      getRemoteAddr in interface jakarta.servlet.ServletRequest
      Overrides:
      getRemoteAddr in class jakarta.servlet.ServletRequestWrapper

    • getRemoteHost

      public String getRemoteHost()
      Specified by:
      getRemoteHost in interface jakarta.servlet.ServletRequest
      Overrides:
      getRemoteHost in class jakarta.servlet.ServletRequestWrapper

    • setAttribute

      public void setAttribute(String name, Object value)
      Specified by:
      setAttribute in interface jakarta.servlet.ServletRequest
      Overrides:
      setAttribute in class jakarta.servlet.ServletRequestWrapper

    • removeAttribute

      public void removeAttribute(String name)
      Specified by:
      removeAttribute in interface jakarta.servlet.ServletRequest
      Overrides:
      removeAttribute in class jakarta.servlet.ServletRequestWrapper

    • removeAllAttributes

      public void removeAllAttributes()

    • getLocale

      public Locale getLocale()
      Specified by:
      getLocale in interface jakarta.servlet.ServletRequest
      Overrides:
      getLocale in class jakarta.servlet.ServletRequestWrapper

    • getLocales

      public Enumeration<Locale> getLocales()
      Specified by:
      getLocales in interface jakarta.servlet.ServletRequest
      Overrides:
      getLocales in class jakarta.servlet.ServletRequestWrapper

    • isSecure

      public boolean isSecure()
      Specified by:
      isSecure in interface jakarta.servlet.ServletRequest
      Overrides:
      isSecure in class jakarta.servlet.ServletRequestWrapper

    • getRequestDispatcher

      public jakarta.servlet.RequestDispatcher getRequestDispatcher(String path)
      Specified by:
      getRequestDispatcher in interface jakarta.servlet.ServletRequest
      Overrides:
      getRequestDispatcher in class jakarta.servlet.ServletRequestWrapper

    • getRealPath

      public String getRealPath(String path)
      Specified by:
      getRealPath in interface jakarta.servlet.ServletRequest
      Overrides:
      getRealPath in class jakarta.servlet.ServletRequestWrapper

    • getRemotePort

      public int getRemotePort()
      Specified by:
      getRemotePort in interface jakarta.servlet.ServletRequest
      Overrides:
      getRemotePort in class jakarta.servlet.ServletRequestWrapper

    • getLocalName

      public String getLocalName()
      Specified by:
      getLocalName in interface jakarta.servlet.ServletRequest
      Overrides:
      getLocalName in class jakarta.servlet.ServletRequestWrapper

    • getLocalAddr

      public String getLocalAddr()
      Specified by:
      getLocalAddr in interface jakarta.servlet.ServletRequest
      Overrides:
      getLocalAddr in class jakarta.servlet.ServletRequestWrapper

    • getLocalPort

      public int getLocalPort()
      Specified by:
      getLocalPort in interface jakarta.servlet.ServletRequest
      Overrides:
      getLocalPort in class jakarta.servlet.ServletRequestWrapper

    • getServletContext

      public jakarta.servlet.ServletContext getServletContext()
      Specified by:
      getServletContext in interface jakarta.servlet.ServletRequest
      Overrides:
      getServletContext in class jakarta.servlet.ServletRequestWrapper

    • startAsync

      public jakarta.servlet.AsyncContext startAsync() throws IllegalStateException
      Specified by:
      startAsync in interface jakarta.servlet.ServletRequest
      Overrides:
      startAsync in class jakarta.servlet.ServletRequestWrapper
      Throws:
      IllegalStateException

    • startAsync

      public jakarta.servlet.AsyncContext startAsync(jakarta.servlet.ServletRequest servletRequest, jakarta.servlet.ServletResponse servletResponse) throws IllegalStateException
      Specified by:
      startAsync in interface jakarta.servlet.ServletRequest
      Overrides:
      startAsync in class jakarta.servlet.ServletRequestWrapper
      Throws:
      IllegalStateException

    • isAsyncStarted

      public boolean isAsyncStarted()
      Specified by:
      isAsyncStarted in interface jakarta.servlet.ServletRequest
      Overrides:
      isAsyncStarted in class jakarta.servlet.ServletRequestWrapper

    • isAsyncSupported

      public boolean isAsyncSupported()
      Specified by:
      isAsyncSupported in interface jakarta.servlet.ServletRequest
      Overrides:
      isAsyncSupported in class jakarta.servlet.ServletRequestWrapper

    • getAsyncContext

      public jakarta.servlet.AsyncContext getAsyncContext()
      Specified by:
      getAsyncContext in interface jakarta.servlet.ServletRequest
      Overrides:
      getAsyncContext in class jakarta.servlet.ServletRequestWrapper

    • getDispatcherType

      public jakarta.servlet.DispatcherType getDispatcherType()
      Specified by:
      getDispatcherType in interface jakarta.servlet.ServletRequest
      Overrides:
      getDispatcherType in class jakarta.servlet.ServletRequestWrapper