Package org.zkoss.zkmax.ui.http

Class 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 Detail

      • 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 Detail

      • getAuthType

        public java.lang.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​(java.lang.String name)
        Specified by:
        getDateHeader in interface jakarta.servlet.http.HttpServletRequest
        Overrides:
        getDateHeader in class jakarta.servlet.http.HttpServletRequestWrapper

      • getHeader

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

      • getHeaders

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

      • getHeaderNames

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

      • getIntHeader

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

      • getMethod

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

      • getPathInfo

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

      • getPathTranslated

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

      • getContextPath

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

      • getQueryString

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

      • getRemoteUser

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

      • isUserInRole

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

      • getUserPrincipal

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

      • getRequestedSessionId

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

      • getRequestURI

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

      • getRequestURL

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

      • getServletPath

        public java.lang.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 java.io.IOException,
                            jakarta.servlet.ServletException
        Specified by:
        authenticate in interface jakarta.servlet.http.HttpServletRequest
        Overrides:
        authenticate in class jakarta.servlet.http.HttpServletRequestWrapper
        Throws:
        java.io.IOException
        jakarta.servlet.ServletException

      • login

        public void login​(java.lang.String username,
                  java.lang.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 java.util.Collection<jakarta.servlet.http.Part> getParts()
                                                       throws java.io.IOException,
                                                              jakarta.servlet.ServletException
        Specified by:
        getParts in interface jakarta.servlet.http.HttpServletRequest
        Overrides:
        getParts in class jakarta.servlet.http.HttpServletRequestWrapper
        Throws:
        java.io.IOException
        jakarta.servlet.ServletException

      • getPart

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

      • getAttribute

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

      • getAttributeNames

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

      • getCharacterEncoding

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

      • setCharacterEncoding

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

      • getContentLength

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

      • getContentType

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

      • getInputStream

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

      • getParameter

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

      • getParameterNames

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

      • getParameterValues

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

      • getParameterMap

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

      • getProtocol

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

      • getScheme

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

      • getServerName

        public java.lang.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 java.io.BufferedReader getReader()
                                 throws java.io.IOException
        Specified by:
        getReader in interface jakarta.servlet.ServletRequest
        Overrides:
        getReader in class jakarta.servlet.ServletRequestWrapper
        Throws:
        java.io.IOException

      • getRemoteAddr

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

      • getRemoteHost

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

      • setAttribute

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

      • removeAttribute

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

      • removeAllAttributes

        public void removeAllAttributes()

      • getLocale

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

      • getLocales

        public java.util.Enumeration<java.util.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​(java.lang.String path)
        Specified by:
        getRequestDispatcher in interface jakarta.servlet.ServletRequest
        Overrides:
        getRequestDispatcher in class jakarta.servlet.ServletRequestWrapper

      • getRealPath

        public java.lang.String getRealPath​(java.lang.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 java.lang.String getLocalName()
        Specified by:
        getLocalName in interface jakarta.servlet.ServletRequest
        Overrides:
        getLocalName in class jakarta.servlet.ServletRequestWrapper

      • getLocalAddr

        public java.lang.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 java.lang.IllegalStateException
        Specified by:
        startAsync in interface jakarta.servlet.ServletRequest
        Overrides:
        startAsync in class jakarta.servlet.ServletRequestWrapper
        Throws:
        java.lang.IllegalStateException

      • startAsync

        public jakarta.servlet.AsyncContext startAsync​(jakarta.servlet.ServletRequest servletRequest,
                                             jakarta.servlet.ServletResponse servletResponse)
                                      throws java.lang.IllegalStateException
        Specified by:
        startAsync in interface jakarta.servlet.ServletRequest
        Overrides:
        startAsync in class jakarta.servlet.ServletRequestWrapper
        Throws:
        java.lang.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