Package org.apache.catalina.connector

Class Request

    • Field Detail

      • coyoteRequest

        protected Request coyoteRequest
        Coyote request.

      • sm

        protected static final StringManager sm
        The string manager for this package.

      • cookies

        protected Cookie[] cookies
        The set of cookies associated with this Request.

      • defaultLocale

        protected static final Locale defaultLocale
        The default Locale if none are specified.

      • sslAttributesParsed

        protected boolean sslAttributesParsed
        Flag that indicates if SSL attributes have been parsed to improve performance for applications (usually frameworks) that make multiple calls to getAttributeNames().

      • locales

        protected final ArrayList<Locale> locales
        The preferred Locales associated with this Request.

      • authType

        protected String authType
        Authentication type.

      • internalDispatcherType

        protected DispatcherType internalDispatcherType
        The current dispatcher type.

      • inputBuffer

        protected final InputBuffer inputBuffer
        The associated input buffer.

      • usingInputStream

        protected boolean usingInputStream
        Using stream flag.

      • usingReader

        protected boolean usingReader
        Using reader flag.

      • userPrincipal

        protected Principal userPrincipal
        User principal.

      • parametersParsed

        protected boolean parametersParsed
        Request parameters parsed flag.

      • cookiesParsed

        protected boolean cookiesParsed
        Cookie headers parsed flag. Indicates that the cookie headers have been parsed into ServerCookies.

      • cookiesConverted

        protected boolean cookiesConverted
        Cookie parsed flag. Indicates that the ServerCookies have been converted into user facing Cookie objects.

      • secure

        protected boolean secure
        Secure flag.

      • subject

        protected transient Subject subject
        The Subject associated with the current AccessControlContext

      • CACHED_POST_LEN

        protected static final int CACHED_POST_LEN
        Post data buffer.
        See Also:
        Constant Field Values

      • postData

        protected byte[] postData

      • parts

        protected Collection<Part> parts
        The parts, if any, uploaded with this request.

      • partsParseException

        protected Exception partsParseException
        The exception thrown, if any when parsing the parts.

      • session

        protected Session session
        The currently active session for this request.

      • requestDispatcherPath

        protected Object requestDispatcherPath
        The current request dispatcher path.

      • requestedSessionCookie

        protected boolean requestedSessionCookie
        Was the requested session ID received in a cookie?

      • requestedSessionId

        protected String requestedSessionId
        The requested session ID (if any) for this request.

      • requestedSessionURL

        protected boolean requestedSessionURL
        Was the requested session ID received in a URL?

      • requestedSessionSSL

        protected boolean requestedSessionSSL
        Was the requested session ID obtained from the SSL session?

      • localesParsed

        protected boolean localesParsed
        Parse locales.

      • localPort

        protected int localPort
        Local port

      • remoteAddr

        protected String remoteAddr
        Remote address.

      • peerAddr

        protected String peerAddr
        Connection peer address.

      • remoteHost

        protected String remoteHost
        Remote host.

      • remotePort

        protected int remotePort
        Remote port

      • localAddr

        protected String localAddr
        Local address

      • localName

        protected String localName
        Local address

      • asyncSupported

        protected Boolean asyncSupported

      • connector

        protected final Connector connector
        Associated Catalina connector.

      • filterChain

        protected FilterChain filterChain
        Filter chain associated with the request.

      • mappingData

        protected final MappingData mappingData
        Mapping data.

      • facade

        protected RequestFacade facade
        The facade associated with this request.

      • response

        protected Response response
        The response with which this request is associated.

      • URIConverter

        protected B2CConverter URIConverter
        URI byte to char converter.

    • Constructor Detail

      • Request

        public Request​(Connector connector)
        Create a new Request object associated with the given Connector.
        Parameters:
        connector - The Connector with which this Request object will always be associated. In normal usage this must be non-null. In some test scenarios, it may be possible to use a null Connector without triggering an NPE.

    • Method Detail

      • setCoyoteRequest

        public void setCoyoteRequest​(Request coyoteRequest)
        Set the Coyote request.
        Parameters:
        coyoteRequest - The Coyote request

      • getCoyoteRequest

        public Request getCoyoteRequest()
        Get the Coyote request.
        Returns:
        the Coyote request object

      • addPathParameter

        protected void addPathParameter​(String name,
                                String value)

      • getPathParameter

        protected String getPathParameter​(String name)

      • setAsyncSupported

        public void setAsyncSupported​(boolean asyncSupported)

      • recycle

        public void recycle()
        Release all object references, and initialize instance variables, in preparation for reuse of this object.

      • recycleSessionInfo

        protected void recycleSessionInfo()

      • recycleCookieInfo

        protected void recycleCookieInfo​(boolean recycleCoyote)

      • getConnector

        public Connector getConnector()
        Returns:
        the Connector through which this Request was received.

      • getContext

        public Context getContext()
        Return the Context within which this Request is being processed.

        This is available as soon as the appropriate Context is identified. Note that availability of a Context allows getContextPath() to return a value, and thus enables parsing of the request URI.

        Returns:
        the Context mapped with the request

      • getDiscardFacades

        public boolean getDiscardFacades()
        Get the recycling strategy of the facade objects.
        Returns:
        the value of the flag as set on the connector, or true if no connector is associated with this request

      • getFilterChain

        public FilterChain getFilterChain()
        Get filter chain associated with the request.
        Returns:
        the associated filter chain

      • setFilterChain

        public void setFilterChain​(FilterChain filterChain)
        Set filter chain associated with the request.
        Parameters:
        filterChain - new filter chain

      • getHost

        public Host getHost()
        Returns:
        the Host within which this Request is being processed.

      • getMappingData

        public MappingData getMappingData()
        Returns:
        mapping data.

      • getRequest

        public HttpServletRequest getRequest()
        Returns:
        the ServletRequest for which this object is the facade. This method must be implemented by a subclass.

      • setRequest

        public void setRequest​(HttpServletRequest applicationRequest)
        Set a wrapped HttpServletRequest to pass to the application. Components wishing to wrap the request should obtain the request via getRequest(), wrap it and then call this method with the wrapped request.
        Parameters:
        applicationRequest - The wrapped request to pass to the application

      • getResponse

        public Response getResponse()
        Returns:
        the Response with which this Request is associated.

      • setResponse

        public void setResponse​(Response response)
        Set the Response with which this Request is associated.
        Parameters:
        response - The new associated response

      • getStream

        public InputStream getStream()
        Returns:
        the input stream associated with this Request.

      • getURIConverter

        protected B2CConverter getURIConverter()
        Returns:
        the URI converter.

      • setURIConverter

        protected void setURIConverter​(B2CConverter URIConverter)
        Set the URI converter.
        Parameters:
        URIConverter - the new URI converter

      • getWrapper

        public Wrapper getWrapper()
        Returns:
        the Wrapper within which this Request is being processed.

      • createInputStream

        public ServletInputStream createInputStream()
                                     throws IOException
        Create and return a ServletInputStream to read the content associated with this Request.
        Returns:
        the created input stream
        Throws:
        IOException - if an input/output error occurs

      • finishRequest

        public void finishRequest()
                   throws IOException
        Perform whatever actions are required to flush and close the input stream or reader, in a single operation.
        Throws:
        IOException - if an input/output error occurs

      • getNote

        public Object getNote​(String name)
        Parameters:
        name - Name of the note to be returned
        Returns:
        the object bound with the specified name to the internal notes for this request, or null if no such binding exists.

      • removeNote

        public void removeNote​(String name)
        Remove any object bound to the specified name in the internal notes for this request.
        Parameters:
        name - Name of the note to be removed

      • setLocalPort

        public void setLocalPort​(int port)
        Set the port number of the server to process this request.
        Parameters:
        port - The server port

      • setNote

        public void setNote​(String name,
                    Object value)
        Bind an object to a specified name in the internal notes associated with this request, replacing any existing binding for this name.
        Parameters:
        name - Name to which the object should be bound
        value - Object to be bound to the specified name

      • setRemoteAddr

        public void setRemoteAddr​(String remoteAddr)
        Set the IP address of the remote client associated with this Request.
        Parameters:
        remoteAddr - The remote IP address

      • setRemoteHost

        public void setRemoteHost​(String remoteHost)
        Set the fully qualified name of the remote client associated with this Request.
        Parameters:
        remoteHost - The remote host name

      • setSecure

        public void setSecure​(boolean secure)
        Set the value to be returned by isSecure() for this Request.
        Parameters:
        secure - The new isSecure value

      • setServerPort

        public void setServerPort​(int port)
        Set the port number of the server to process this request.
        Parameters:
        port - The server port

      • getAttribute

        public Object getAttribute​(String name)
        Description copied from interface: jakarta.servlet.ServletRequest
        Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.

        Attributes can be set two ways. The servlet container may set attributes to make available custom information about a request. For example, for requests made using HTTPS, the attribute jakarta.servlet.request.X509Certificate can be used to retrieve information on the certificate of the client. Attributes can also be set programmatically using ServletRequest.setAttribute(java.lang.String, java.lang.Object). This allows information to be embedded into a request before a RequestDispatcher call.

        Attribute names should follow the same conventions as package names. Names beginning with java.* and javax.* are reserved for use by the Servlet specification. Names beginning with sun.*, com.sun.*, oracle.* and com.oracle.*) are reserved for use by Oracle Corporation.

        Specified by:
        getAttribute in interface ServletRequest
        Parameters:
        name - Name of the request attribute to return
        Returns:
        the specified request attribute if it exists; otherwise, return null.

      • getContentLengthLong

        public long getContentLengthLong()
        Description copied from interface: jakarta.servlet.ServletRequest
        Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known. For HTTP servlets, same as the value of the CGI variable CONTENT_LENGTH.
        Specified by:
        getContentLengthLong in interface ServletRequest
        Returns:
        a long integer containing the length of the request body or -1 if the length is not known

      • getCharacterEncoding

        public String getCharacterEncoding()
        Description copied from interface: jakarta.servlet.ServletRequest
        Returns the name of the character encoding used in the body of this request. This method returns null if the no character encoding has been specified. The following priority order is used to determine the specified encoding:
        1. per request
        2. web application default via the deployment descriptor or ServletContext.setRequestCharacterEncoding(String)
        3. container default via container specific configuration
        Specified by:
        getCharacterEncoding in interface ServletRequest
        Returns:
        the character encoding for this Request.

      • getContentLength

        public int getContentLength()
        Description copied from interface: jakarta.servlet.ServletRequest
        Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known. For HTTP servlets, same as the value of the CGI variable CONTENT_LENGTH.
        Specified by:
        getContentLength in interface ServletRequest
        Returns:
        the content length for this Request.

      • getContentType

        public String getContentType()
        Description copied from interface: jakarta.servlet.ServletRequest
        Returns the MIME type of the body of the request, or null if the type is not known. For HTTP servlets, same as the value of the CGI variable CONTENT_TYPE.
        Specified by:
        getContentType in interface ServletRequest
        Returns:
        the content type for this Request.

      • setContentType

        public void setContentType​(String contentType)
        Set the content type for this Request.
        Parameters:
        contentType - The content type

      • getLocale

        public Locale getLocale()
        Description copied from interface: jakarta.servlet.ServletRequest
        Returns the preferred Locale that the client will accept content in, based on the Accept-Language header. If the client request doesn't provide an Accept-Language header, this method returns the default locale for the server.
        Specified by:
        getLocale in interface ServletRequest
        Returns:
        the preferred Locale that the client will accept content in, based on the value for the first Accept-Language header that was encountered. If the request did not specify a preferred language, the server's default Locale is returned.

      • getLocales

        public Enumeration<Locale> getLocales()
        Description copied from interface: jakarta.servlet.ServletRequest
        Returns an Enumeration of Locale objects indicating, in decreasing order starting with the preferred locale, the locales that are acceptable to the client based on the Accept-Language header. If the client request doesn't provide an Accept-Language header, this method returns an Enumeration containing one Locale, the default locale for the server.
        Specified by:
        getLocales in interface ServletRequest
        Returns:
        the set of preferred Locales that the client will accept content in, based on the values for any Accept-Language headers that were encountered. If the request did not specify a preferred language, the server's default Locale is returned.

      • getParameter

        public String getParameter​(String name)
        Description copied from interface: jakarta.servlet.ServletRequest
        Returns the value of a request parameter as a String, or null if the parameter does not exist. Request parameters are extra information sent with the request. For HTTP servlets, parameters are contained in the query string or posted form data.

        You should only use this method when you are sure the parameter has only one value. If the parameter might have more than one value, use ServletRequest.getParameterValues(java.lang.String).

        If you use this method with a multivalued parameter, the value returned is equal to the first value in the array returned by getParameterValues.

        If the parameter data was sent in the request body, such as occurs with an HTTP POST request, then reading the body directly via ServletRequest.getInputStream() or ServletRequest.getReader() can interfere with the execution of this method.

        Specified by:
        getParameter in interface ServletRequest
        Parameters:
        name - Name of the desired request parameter
        Returns:
        the value of the specified request parameter, if any; otherwise, return null. If there is more than one value defined, return only the first one.
        See Also:
        ServletRequest.getParameterValues(java.lang.String)

      • getParameterMap

        public Map<String,​String[]> getParameterMap()
        Returns a Map of the parameters of this request. Request parameters are extra information sent with the request. For HTTP servlets, parameters are contained in the query string or posted form data.
        Specified by:
        getParameterMap in interface ServletRequest
        Returns:
        A Map containing parameter names as keys and parameter values as map values.

      • getParameterNames

        public Enumeration<String> getParameterNames()
        Description copied from interface: jakarta.servlet.ServletRequest
        Returns an Enumeration of String objects containing the names of the parameters contained in this request. If the request has no parameters, the method returns an empty Enumeration.
        Specified by:
        getParameterNames in interface ServletRequest
        Returns:
        the names of all defined request parameters for this request.

      • getParameterValues

        public String[] getParameterValues​(String name)
        Description copied from interface: jakarta.servlet.ServletRequest
        Returns an array of String objects containing all of the values the given request parameter has, or null if the parameter does not exist.

        If the parameter has a single value, the array has a length of 1.

        Specified by:
        getParameterValues in interface ServletRequest
        Parameters:
        name - Name of the desired request parameter
        Returns:
        the defined values for the specified request parameter, if any; otherwise, return null.
        See Also:
        ServletRequest.getParameter(java.lang.String)

      • getProtocol

        public String getProtocol()
        Description copied from interface: jakarta.servlet.ServletRequest
        Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1. For HTTP servlets, the value returned is the same as the value of the CGI variable SERVER_PROTOCOL.
        Specified by:
        getProtocol in interface ServletRequest
        Returns:
        the protocol and version used to make this Request.

      • getRemoteAddr

        public String getRemoteAddr()
        Description copied from interface: jakarta.servlet.ServletRequest
        Returns the Internet Protocol (IP) address of the client or last proxy that sent the request. For HTTP servlets, same as the value of the CGI variable REMOTE_ADDR.
        Specified by:
        getRemoteAddr in interface ServletRequest
        Returns:
        the remote IP address making this Request.

      • getPeerAddr

        public String getPeerAddr()
        Returns:
        the connection peer IP address making this Request.

      • getRemoteHost

        public String getRemoteHost()
        Description copied from interface: jakarta.servlet.ServletRequest
        Returns the fully qualified name of the client or the last proxy that sent the request. If the engine cannot or chooses not to resolve the hostname (to improve performance), this method returns the dotted-string form of the IP address. For HTTP servlets, same as the value of the CGI variable REMOTE_HOST.
        Specified by:
        getRemoteHost in interface ServletRequest
        Returns:
        the remote host name making this Request.

      • getRemotePort

        public int getRemotePort()
        Description copied from interface: jakarta.servlet.ServletRequest
        Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.
        Specified by:
        getRemotePort in interface ServletRequest
        Returns:
        the Internet Protocol (IP) source port of the client or last proxy that sent the request.

      • getLocalName

        public String getLocalName()
        Description copied from interface: jakarta.servlet.ServletRequest
        Returns the host name of the Internet Protocol (IP) interface on which the request was received.
        Specified by:
        getLocalName in interface ServletRequest
        Returns:
        the host name of the Internet Protocol (IP) interface on which the request was received.

      • getLocalAddr

        public String getLocalAddr()
        Description copied from interface: jakarta.servlet.ServletRequest
        Returns the Internet Protocol (IP) address of the interface on which the request was received.
        Specified by:
        getLocalAddr in interface ServletRequest
        Returns:
        the Internet Protocol (IP) address of the interface on which the request was received.

      • getLocalPort

        public int getLocalPort()
        Description copied from interface: jakarta.servlet.ServletRequest
        Returns the Internet Protocol (IP) port number of the interface on which the request was received.
        Specified by:
        getLocalPort in interface ServletRequest
        Returns:
        the Internet Protocol (IP) port number of the interface on which the request was received.

      • getRequestDispatcher

        public RequestDispatcher getRequestDispatcher​(String path)
        Description copied from interface: jakarta.servlet.ServletRequest
        Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path. A RequestDispatcher object can be used to forward a request to the resource or to include the resource in a response. The resource can be dynamic or static.

        The pathname specified may be relative, although it cannot extend outside the current servlet context. If the path begins with a "/" it is interpreted as relative to the current context root. This method returns null if the servlet container cannot return a RequestDispatcher.

        The difference between this method and ServletContext.getRequestDispatcher(java.lang.String) is that this method can take a relative path.

        Specified by:
        getRequestDispatcher in interface ServletRequest
        Parameters:
        path - Path of the resource to be wrapped
        Returns:
        a RequestDispatcher that wraps the resource at the specified path, which may be interpreted as relative to the current request path.
        See Also:
        RequestDispatcher, ServletContext.getRequestDispatcher(java.lang.String)

      • getScheme

        public String getScheme()
        Description copied from interface: jakarta.servlet.ServletRequest
        Returns the name of the scheme used to make this request, for example, http, https, or ftp. Different schemes have different rules for constructing URLs, as noted in RFC 1738.
        Specified by:
        getScheme in interface ServletRequest
        Returns:
        the scheme used to make this Request.

      • getServerName

        public String getServerName()
        Description copied from interface: jakarta.servlet.ServletRequest
        Returns the host name of the server to which the request was sent. It is the value of the part before ":" in the Host header value, if any, or the resolved server name, or the server IP address.
        Specified by:
        getServerName in interface ServletRequest
        Returns:
        the server name responding to this Request.

      • getServerPort

        public int getServerPort()
        Description copied from interface: jakarta.servlet.ServletRequest
        Returns the port number to which the request was sent. It is the value of the part after ":" in the Host header value, if any, or the server port where the client connection was accepted on.
        Specified by:
        getServerPort in interface ServletRequest
        Returns:
        the server port responding to this Request.

      • isSecure

        public boolean isSecure()
        Description copied from interface: jakarta.servlet.ServletRequest
        Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
        Specified by:
        isSecure in interface ServletRequest
        Returns:
        true if this request was received on a secure connection.

      • removeAttribute

        public void removeAttribute​(String name)
        Remove the specified request attribute if it exists.
        Specified by:
        removeAttribute in interface ServletRequest
        Parameters:
        name - Name of the request attribute to remove

      • setAttribute

        public void setAttribute​(String name,
                         Object value)
        Set the specified request attribute to the specified value.
        Specified by:
        setAttribute in interface ServletRequest
        Parameters:
        name - Name of the request attribute to set
        value - The associated value

      • setCharacterEncoding

        public void setCharacterEncoding​(String enc)
                          throws UnsupportedEncodingException
        Overrides the name of the character encoding used in the body of this request. This method must be called prior to reading request parameters or reading input using getReader().
        Specified by:
        setCharacterEncoding in interface ServletRequest
        Parameters:
        enc - The character encoding to be used
        Throws:
        UnsupportedEncodingException - if the specified encoding is not supported
        Since:
        Servlet 2.3

      • startAsync

        public AsyncContext startAsync​(ServletRequest request,
                               ServletResponse response)
        Specified by:
        startAsync in interface ServletRequest
        Parameters:
        request - The ServletRequest with which to initialise the asynchronous context
        response - The ServletResponse with which to initialise the asynchronous context
        Returns:
        TODO

      • isAsyncDispatching

        public boolean isAsyncDispatching()

      • isAsyncCompleting

        public boolean isAsyncCompleting()

      • isAsync

        public boolean isAsync()

      • getRequestId

        public String getRequestId()
        Description copied from interface: jakarta.servlet.ServletRequest
        Obtain a unique (within the lifetime of the Servlet container) identifier string for this request.

        There is no defined format for this string. The format is implementation dependent.

        Specified by:
        getRequestId in interface ServletRequest
        Returns:
        A unique identifier for the request

      • getProtocolRequestId

        public String getProtocolRequestId()
        Description copied from interface: jakarta.servlet.ServletRequest
        Obtain the request identifier for this request as defined by the protocol in use. Note that some protocols do not define such an identifier.

        Examples of protocol provided request identifiers include:

        HTTP 1.x
        None, so the empty string should be returned
        HTTP 2
        The stream identifier
        HTTP 3
        The stream identifier
        AJP
        None, so the empty string should be returned
        Specified by:
        getProtocolRequestId in interface ServletRequest
        Returns:
        The request identifier if one is defined, otherwise an empty string

      • getServletConnection

        public ServletConnection getServletConnection()
        Description copied from interface: jakarta.servlet.ServletRequest
        Obtain details of the network connection to the Servlet container that is being used by this request. The information presented may differ from information presented elsewhere in the Servlet API as raw information is presented without adjustments for, example, use of reverse proxies that may be applied elsewhere in the Servlet API.
        Specified by:
        getServletConnection in interface ServletRequest
        Returns:
        The network connection details.

      • addCookie

        public void addCookie​(Cookie cookie)
        Add a Cookie to the set of Cookies associated with this Request.
        Parameters:
        cookie - The new cookie

      • addLocale

        public void addLocale​(Locale locale)
        Add a Locale to the set of preferred Locales for this Request. The first added Locale will be the first one returned by getLocales().
        Parameters:
        locale - The new preferred Locale

      • clearCookies

        public void clearCookies()
        Clear the collection of Cookies associated with this Request.

      • clearLocales

        public void clearLocales()
        Clear the collection of Locales associated with this Request.

      • setAuthType

        public void setAuthType​(String type)
        Set the authentication type used for this request, if any; otherwise set the type to null. Typical values are "BASIC", "DIGEST", or "SSL".
        Parameters:
        type - The authentication type used

      • setPathInfo

        public void setPathInfo​(String path)
        Set the path information for this Request. This will normally be called when the associated Context is mapping the Request to a particular Wrapper.
        Parameters:
        path - The path information

      • setRequestedSessionCookie

        public void setRequestedSessionCookie​(boolean flag)
        Set a flag indicating whether or not the requested session ID for this request came in through a cookie. This is normally called by the HTTP Connector, when it parses the request headers.
        Parameters:
        flag - The new flag

      • setRequestedSessionId

        public void setRequestedSessionId​(String id)
        Set the requested session ID for this request. This is normally called by the HTTP Connector, when it parses the request headers.
        Parameters:
        id - The new session id

      • setRequestedSessionURL

        public void setRequestedSessionURL​(boolean flag)
        Set a flag indicating whether or not the requested session ID for this request came in through a URL. This is normally called by the HTTP Connector, when it parses the request headers.
        Parameters:
        flag - The new flag

      • setRequestedSessionSSL

        public void setRequestedSessionSSL​(boolean flag)
        Set a flag indicating whether or not the requested session ID for this request came in through SSL. This is normally called by the HTTP Connector, when it parses the request headers.
        Parameters:
        flag - The new flag

      • getDecodedRequestURI

        public String getDecodedRequestURI()
        Get the decoded request URI.
        Returns:
        the URL decoded request URI

      • getDecodedRequestURIMB

        public MessageBytes getDecodedRequestURIMB()
        Get the decoded request URI.
        Returns:
        the URL decoded request URI

      • setUserPrincipal

        public void setUserPrincipal​(Principal principal)
        Set the Principal who has been authenticated for this Request. This value is also used to calculate the value to be returned by the getRemoteUser() method.
        Parameters:
        principal - The user Principal

      • isTrailerFieldsReady

        public boolean isTrailerFieldsReady()
        Description copied from interface: jakarta.servlet.http.HttpServletRequest
        Are trailer fields ready to be read (there may still be no trailers to read). This method always returns true if the underlying protocol does not support trailer fields. Otherwise, true is returned once all of the following are true:
        • The application has ready all the request data and an EOF has been received or the content-length is zero
        • All trailer fields, if any, have been received
        Specified by:
        isTrailerFieldsReady in interface HttpServletRequest
        Returns:
        true if trailers are ready to be read

      • newPushBuilder

        public PushBuilder newPushBuilder()
        Description copied from interface: jakarta.servlet.http.HttpServletRequest
        Obtain a builder for generating push requests. PushBuilder documents how this request will be used as the basis for a push request. Each call to this method will return a new instance, independent of any previous instance obtained.
        Specified by:
        newPushBuilder in interface HttpServletRequest
        Returns:
        A builder that can be used to generate push requests based on this request or null if push is not supported. Note that even if a PushBuilder instance is returned, by the time that PushBuilder.push() is called, it may no longer be valid to push a request and the push request will be ignored.

      • upgrade

        public <T extends HttpUpgradeHandler> T upgrade​(Class<T> httpUpgradeHandlerClass)
                                         throws IOException,
                                                ServletException
        Description copied from interface: jakarta.servlet.http.HttpServletRequest
        Start the HTTP upgrade process and create and instance of the provided protocol handler class. The connection will be passed this instance once the current request/response pair has completed processing. Calling this method sets the response status to HttpServletResponse.SC_SWITCHING_PROTOCOLS.
        Specified by:
        upgrade in interface HttpServletRequest
        Type Parameters:
        T - The type of the upgrade handler
        Parameters:
        httpUpgradeHandlerClass - The class that implements the upgrade handler
        Returns:
        A newly created instance of the specified upgrade handler type
        Throws:
        IOException - if an I/O error occurred during the upgrade
        ServletException - if the given httpUpgradeHandlerClass fails to be instantiated

      • getAuthType

        public String getAuthType()
        Return the authentication type used for this Request.
        Specified by:
        getAuthType in interface HttpServletRequest
        Returns:
        one of the static members BASIC_AUTH, FORM_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH (suitable for == comparison) or the container-specific string indicating the authentication scheme, or null if the request was not authenticated.

      • getContextPath

        public String getContextPath()
        Return the portion of the request URI used to select the Context of the Request. The value returned is not decoded which also implies it is not normalised.
        Specified by:
        getContextPath in interface HttpServletRequest
        Returns:
        a String specifying the portion of the request URI that indicates the context of the request

      • getCookies

        public Cookie[] getCookies()
        Return the set of Cookies received with this Request. Triggers parsing of the Cookie HTTP headers followed by conversion to Cookie objects if this has not already been performed.
        Specified by:
        getCookies in interface HttpServletRequest
        Returns:
        the array of cookies

      • getServerCookies

        public ServerCookies getServerCookies()
        Return the server representation of the cookies associated with this request. Triggers parsing of the Cookie HTTP headers (but not conversion to Cookie objects) if the headers have not yet been parsed.
        Returns:
        the server cookies

      • getDateHeader

        public long getDateHeader​(String name)
        Return the value of the specified date header, if any; otherwise return -1.
        Specified by:
        getDateHeader in interface HttpServletRequest
        Parameters:
        name - Name of the requested date header
        Returns:
        the date as a long
        Throws:
        IllegalArgumentException - if the specified header value cannot be converted to a date

      • getHeader

        public String getHeader​(String name)
        Return the first value of the specified header, if any; otherwise, return null
        Specified by:
        getHeader in interface HttpServletRequest
        Parameters:
        name - Name of the requested header
        Returns:
        the header value

      • getHeaders

        public Enumeration<String> getHeaders​(String name)
        Return all of the values of the specified header, if any; otherwise, return an empty enumeration.
        Specified by:
        getHeaders in interface HttpServletRequest
        Parameters:
        name - Name of the requested header
        Returns:
        the enumeration with the header values

      • getHeaderNames

        public Enumeration<String> getHeaderNames()
        Description copied from interface: jakarta.servlet.http.HttpServletRequest
        Returns an enumeration of all the header names this request contains. If the request has no headers, this method returns an empty enumeration.

        Some servlet containers do not allow servlets to access headers using this method, in which case this method returns null

        Specified by:
        getHeaderNames in interface HttpServletRequest
        Returns:
        the names of all headers received with this request.

      • getIntHeader

        public int getIntHeader​(String name)
        Return the value of the specified header as an integer, or -1 if there is no such header for this request.
        Specified by:
        getIntHeader in interface HttpServletRequest
        Parameters:
        name - Name of the requested header
        Returns:
        the header value as an int
        Throws:
        IllegalArgumentException - if the specified header value cannot be converted to an integer

      • getMethod

        public String getMethod()
        Description copied from interface: jakarta.servlet.http.HttpServletRequest
        Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT. Same as the value of the CGI variable REQUEST_METHOD.
        Specified by:
        getMethod in interface HttpServletRequest
        Returns:
        the HTTP request method used in this Request.

      • getPathInfo

        public String getPathInfo()
        Description copied from interface: jakarta.servlet.http.HttpServletRequest
        Returns any extra path information associated with the URL the client sent when it made this request. The extra path information follows the servlet path but precedes the query string and will start with a "/" character.

        This method returns null if there was no extra path information.

        The URL will be canonicalized as per section 3.5 of the specification before the path information, if any, is extracted.

        Specified by:
        getPathInfo in interface HttpServletRequest
        Returns:
        the path information associated with this Request.

      • getPathTranslated

        public String getPathTranslated()
        Description copied from interface: jakarta.servlet.http.HttpServletRequest
        Returns any extra path information after the servlet name but before the query string, and translates it to a real path. Same as the value of the CGI variable PATH_TRANSLATED.

        If the URL does not have any extra path information, this method returns null or the servlet container cannot translate the virtual path to a real path for any reason (such as when the web application is executed from an archive). The web container does not decode this string.

        Specified by:
        getPathTranslated in interface HttpServletRequest
        Returns:
        the extra path information for this request, translated to a real path.

      • getQueryString

        public String getQueryString()
        Description copied from interface: jakarta.servlet.http.HttpServletRequest
        Returns the query string that is contained in the request URL after the path. This method returns null if the URL does not have a query string. Same as the value of the CGI variable QUERY_STRING.
        Specified by:
        getQueryString in interface HttpServletRequest
        Returns:
        the query string associated with this request.

      • getRemoteUser

        public String getRemoteUser()
        Description copied from interface: jakarta.servlet.http.HttpServletRequest
        Returns the login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated. Whether the user name is sent with each subsequent request depends on the browser and type of authentication. Same as the value of the CGI variable REMOTE_USER.
        Specified by:
        getRemoteUser in interface HttpServletRequest
        Returns:
        the name of the remote user that has been authenticated for this Request.

      • getRequestPathMB

        public MessageBytes getRequestPathMB()
        Get the request path.
        Returns:
        the request path

      • getRequestURI

        public String getRequestURI()
        Description copied from interface: jakarta.servlet.http.HttpServletRequest
        Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request. The web container does not decode this String. For example:
        Examples of Returned Values
        First line of HTTP request Returned Value
        POST /some/path.html HTTP/1.1 /some/path.html
        GET http://foo.bar/a.html HTTP/1.0 /a.html
        HEAD /xyz?a=b HTTP/1.1 /xyz

        To reconstruct a URL with a scheme and host, use HttpServletRequest.getRequestURL().

        Specified by:
        getRequestURI in interface HttpServletRequest
        Returns:
        the request URI for this request.
        See Also:
        HttpServletRequest.getRequestURL()

      • getRequestURL

        public StringBuffer getRequestURL()
        Description copied from interface: jakarta.servlet.http.HttpServletRequest
        Reconstructs the URL the client used to make the request. The returned URL contains a protocol, server name, port number, and server path, but it does not include query string parameters.

        Because this method returns a StringBuffer, not a string, you can modify the URL easily, for example, to append query parameters.

        This method is useful for creating redirect messages and for reporting errors.

        Specified by:
        getRequestURL in interface HttpServletRequest
        Returns:
        a StringBuffer object containing the reconstructed URL

      • getServletPath

        public String getServletPath()
        Description copied from interface: jakarta.servlet.http.HttpServletRequest
        Returns the part of this request's URL that calls the servlet. This path starts with a "/" character and includes either the servlet name or a path to the servlet, but does not include any extra path information or a query string. Same as the value of the CGI variable SCRIPT_NAME.

        The URL will be canonicalized as per section 3.5 of the specification before the path information, if any, is extracted.

        This method will return an empty string ("") if the servlet used to process this request was matched using the "/*" pattern.

        Specified by:
        getServletPath in interface HttpServletRequest
        Returns:
        the portion of the request URI used to select the servlet that will process this request.

      • getSession

        public HttpSession getSession​(boolean create)
        Description copied from interface: jakarta.servlet.http.HttpServletRequest
        Returns the current HttpSession associated with this request or, if there is no current session and create is true, returns a new session.

        If create is false and the request has no valid HttpSession, this method returns null.

        To make sure the session is properly maintained, you must call this method before the response is committed. If the container is using cookies to maintain session integrity and is asked to create a new session when the response is committed, an IllegalStateException is thrown.

        Specified by:
        getSession in interface HttpServletRequest
        Parameters:
        create - Create a new session if one does not exist
        Returns:
        the session associated with this Request, creating one if necessary and requested.
        See Also:
        HttpServletRequest.getSession()

      • isUserInRole

        public boolean isUserInRole​(String role)
        Description copied from interface: jakarta.servlet.http.HttpServletRequest
        Returns a boolean indicating whether the authenticated user is included in the specified logical "role". Roles and role membership can be defined using deployment descriptors. If the user has not been authenticated, the method returns false.
        Specified by:
        isUserInRole in interface HttpServletRequest
        Parameters:
        role - Role name to be validated
        Returns:
        true if the authenticated user principal possesses the specified role name.

      • getPrincipal

        public Principal getPrincipal()
        Returns:
        the principal that has been authenticated for this Request.

      • getUserPrincipal

        public Principal getUserPrincipal()
        Description copied from interface: jakarta.servlet.http.HttpServletRequest
        Returns a java.security.Principal object containing the name of the current authenticated user. If the user has not been authenticated, the method returns null.
        Specified by:
        getUserPrincipal in interface HttpServletRequest
        Returns:
        the principal that has been authenticated for this Request.

      • getSessionInternal

        public Session getSessionInternal()
        Returns:
        the session associated with this Request, creating one if necessary.

      • changeSessionId

        public void changeSessionId​(String newSessionId)
        Change the ID of the session that this request is associated with. There are several things that may trigger an ID change. These include moving between nodes in a cluster and session fixation prevention during the authentication process.
        Parameters:
        newSessionId - The session to change the session ID for

      • getSessionInternal

        public Session getSessionInternal​(boolean create)
        Parameters:
        create - Create a new session if one does not exist
        Returns:
        the session associated with this Request, creating one if necessary and requested.

      • isParametersParsed

        public boolean isParametersParsed()
        Returns:
        true if we have parsed parameters

      • isFinished

        public boolean isFinished()
        Returns:
        true if an attempt has been made to read the request body and all of the request body has been read.

      • checkSwallowInput

        protected void checkSwallowInput()
        Check the configuration for aborted uploads and if configured to do so, disable the swallowing of any remaining input and close the connection once the response has been written.

      • authenticate

        public boolean authenticate​(HttpServletResponse response)
                     throws IOException,
                            ServletException
        Triggers the same authentication process as would be triggered if the request is for a resource that is protected by a security constraint.
        Specified by:
        authenticate in interface HttpServletRequest
        Parameters:
        response - The response to use to return any authentication challenge
        Returns:
        true if the user is successfully authenticated and false if not
        Throws:
        IOException - if the authentication process attempted to read from the request or write to the response and an I/O error occurred
        ServletException - if the authentication failed and the caller is expected to handle the failure

      • doGetSession

        protected Session doGetSession​(boolean create)

      • parseCookies

        protected void parseCookies()
        Parse cookies. This only parses the cookies into the memory efficient ServerCookies structure. It does not populate the Cookie objects.

      • convertCookies

        protected void convertCookies()
        Converts the parsed cookies (parsing the Cookie headers first if they have not been parsed) into Cookie objects.

      • parseParameters

        protected void parseParameters()
        Parse request parameters.

      • readPostBody

        protected int readPostBody​(byte[] body,
                           int len)
                    throws IOException
        Read post body in an array.
        Parameters:
        body - The bytes array in which the body will be read
        len - The body length
        Returns:
        the bytes count that has been read
        Throws:
        IOException - if an IO exception occurred

      • readChunkedPostBody

        protected byte[] readChunkedPostBody()
                              throws IOException
        Read chunked post body.
        Returns:
        the post body as a bytes array
        Throws:
        IOException - if an IO exception occurred

      • parseLocales

        protected void parseLocales()
        Parse request locales.

      • parseLocalesHeader

        protected void parseLocalesHeader​(String value,
                                  TreeMap<Double,​ArrayList<Locale>> locales)
        Parse accept-language header value.
        Parameters:
        value - the header value
        locales - the map that will hold the result