Package io.undertow.servlet.spec

Class HttpServletRequestImpl

  • All Implemented Interfaces:
    jakarta.servlet.http.HttpServletRequest, jakarta.servlet.ServletRequest
    public final class HttpServletRequestImpl
extends java.lang.Object
implements jakarta.servlet.http.HttpServletRequest
    The http servlet request implementation. This class is not thread safe
    Author:
    Stuart Douglas, Richard Opalka

    • Field Detail

      • SECURE_REQUEST

        @Deprecated
public static final io.undertow.util.AttachmentKey<java.lang.Boolean> SECURE_REQUEST
        Deprecated.

    • Constructor Detail

      • HttpServletRequestImpl

        public HttpServletRequestImpl​(io.undertow.server.HttpServerExchange exchange,
                              ServletContextImpl servletContext)

    • Method Detail

      • getExchange

        public io.undertow.server.HttpServerExchange getExchange()

      • getAuthType

        public java.lang.String getAuthType()
        Specified by:
        getAuthType 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

      • getHeader

        public java.lang.String getHeader​(io.undertow.util.HttpString name)

      • getHeaders

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

      • getHeaderNames

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

      • getHttpServletMapping

        public jakarta.servlet.http.HttpServletMapping getHttpServletMapping()
        Specified by:
        getHttpServletMapping 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

      • getContextPath

        public java.lang.String getContextPath()
        Specified by:
        getContextPath 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

      • isUserInRole

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

      • getUserPrincipal

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

      • getRequestedSessionId

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

      • changeSessionId

        public java.lang.String changeSessionId()
        Specified by:
        changeSessionId in interface jakarta.servlet.http.HttpServletRequest

      • getRequestId

        public java.lang.String getRequestId()
        Specified by:
        getRequestId in interface jakarta.servlet.ServletRequest

      • getProtocolRequestId

        public java.lang.String getProtocolRequestId()
        Specified by:
        getProtocolRequestId in interface jakarta.servlet.ServletRequest

      • getServletConnection

        public jakarta.servlet.ServletConnection getServletConnection()
        Specified by:
        getServletConnection in interface jakarta.servlet.ServletRequest

      • 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​(boolean create)
        Specified by:
        getSession in interface jakarta.servlet.http.HttpServletRequest

      • getSession

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

      • isRequestedSessionIdValid

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

      • isRequestedSessionIdFromCookie

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

      • isRequestedSessionIdFromURL

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

      • 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
        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
        Throws:
        jakarta.servlet.ServletException

      • logout

        public void logout()
            throws jakarta.servlet.ServletException
        Specified by:
        logout in interface jakarta.servlet.http.HttpServletRequest
        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
        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
        Throws:
        java.io.IOException
        jakarta.servlet.ServletException

      • upgrade

        public <T extends jakarta.servlet.http.HttpUpgradeHandler> T upgrade​(java.lang.Class<T> handlerClass)
                                                              throws java.io.IOException
        Specified by:
        upgrade in interface jakarta.servlet.http.HttpServletRequest
        Throws:
        java.io.IOException

      • getAttribute

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

      • getAttributeNames

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

      • getCharacterEncoding

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

      • setCharacterEncoding

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

      • getContentLength

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

      • getContentLengthLong

        public long getContentLengthLong()
        Specified by:
        getContentLengthLong 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()
                                                  throws java.io.IOException
        Specified by:
        getInputStream in interface jakarta.servlet.ServletRequest
        Throws:
        java.io.IOException

      • closeAndDrainRequest

        public void closeAndDrainRequest()
                          throws java.io.IOException
        Throws:
        java.io.IOException

      • freeResources

        public void freeResources()
                   throws java.io.IOException
        Frees any resources (namely buffers) that may be associated with this request.
        Throws:
        java.io.IOException

      • getParameter

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

      • getParameterNames

        public java.util.Enumeration<java.lang.String> 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

      • getParameterMap

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

      • getProtocol

        public java.lang.String getProtocol()
        Specified by:
        getProtocol 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

      • getReader

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

      • 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

      • setAttribute

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

      • removeAttribute

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

      • getLocale

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

      • getLocales

        public java.util.Enumeration<java.util.Locale> getLocales()
        Specified by:
        getLocales in interface jakarta.servlet.ServletRequest

      • isSecure

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

      • getRequestDispatcher

        public jakarta.servlet.RequestDispatcher getRequestDispatcher​(java.lang.String path)
        Specified by:
        getRequestDispatcher in interface jakarta.servlet.ServletRequest

      • getRemotePort

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

      • getLocalName

        public java.lang.String getLocalName()
        String java.net.InetAddress.getHostName() Gets the host name for this IP address. If this InetAddress was created with a host name, this host name will be remembered and returned; otherwise, a reverse name lookup will be performed and the result will be returned based on the system configured name lookup service. If a lookup of the name service is required, call getCanonicalHostName. If there is a security manager, its checkConnect method is first called with the hostname and -1 as its arguments to see if the operation is allowed. If the operation is not allowed, it will return the textual representation of the IP address.
        Specified by:
        getLocalName in interface jakarta.servlet.ServletRequest
        See Also:
        InetAddres#getHostName

      • getLocalAddr

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

      • getLocalPort

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

      • getServletContext

        public ServletContextImpl getServletContext()
        Specified by:
        getServletContext in interface jakarta.servlet.ServletRequest

      • startAsync

        public jakarta.servlet.AsyncContext startAsync()
                                        throws java.lang.IllegalStateException
        Specified by:
        startAsync in interface jakarta.servlet.ServletRequest
        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
        Throws:
        java.lang.IllegalStateException

      • isAsyncStarted

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

      • isAsyncSupported

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

      • getAsyncContext

        public AsyncContextImpl getAsyncContext()
        Specified by:
        getAsyncContext in interface jakarta.servlet.ServletRequest

      • getDispatcherType

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

      • getQueryParameters

        public java.util.Map<java.lang.String,​java.util.Deque<java.lang.String>> getQueryParameters()

      • setQueryParameters

        public void setQueryParameters​(java.util.Map<java.lang.String,​java.util.Deque<java.lang.String>> queryParameters)

      • setServletContext

        public void setServletContext​(ServletContextImpl servletContext)

      • getOriginalRequestURI

        public java.lang.String getOriginalRequestURI()

      • getOriginalServletPath

        public java.lang.String getOriginalServletPath()

      • getOriginalPathInfo

        public java.lang.String getOriginalPathInfo()

      • getOriginalContextPath

        public java.lang.String getOriginalContextPath()

      • getOriginalQueryString

        public java.lang.String getOriginalQueryString()

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • clearAttributes

        public void clearAttributes()

      • newPushBuilder

        public jakarta.servlet.http.PushBuilder newPushBuilder()
        Specified by:
        newPushBuilder in interface jakarta.servlet.http.HttpServletRequest

      • getTrailerFields

        public java.util.Map<java.lang.String,​java.lang.String> getTrailerFields()
        Specified by:
        getTrailerFields in interface jakarta.servlet.http.HttpServletRequest

      • isTrailerFieldsReady

        public boolean isTrailerFieldsReady()
        Specified by:
        isTrailerFieldsReady in interface jakarta.servlet.http.HttpServletRequest