Class Request
- All Implemented Interfaces:
- HttpServletRequest,- ServletRequest
- Author:
- Remy Maucherat, Craig R. McClanahan
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected Booleanprotected StringAuthentication type.protected static final intPost data buffer.protected final ConnectorAssociated Catalina connector.protected Cookie[]The set of cookies associated with this Request.protected booleanCookie parsed flag.protected booleanCookie headers parsed flag.protected RequestCoyote request.protected static final LocaleThe default Locale if none are specified.protected RequestFacadeThe facade associated with this request.protected FilterChainFilter chain associated with the request.protected final InputBufferThe associated input buffer.protected CoyoteInputStreamServletInputStream.protected DispatcherTypeThe current dispatcher type.protected StringLocal addressThe preferred Locales associated with this Request.protected booleanParse locales.protected StringLocal addressprotected intLocal portprotected final MappingDataMapping data.protected ParameterMap<String,String[]> Hash map used in the getParametersMap method.protected booleanRequest parameters parsed flag.protected Collection<Part>The parts, if any, uploaded with this request.protected ExceptionThe exception thrown, if any when parsing the parts.protected StringConnection peer address.protected byte[]protected CoyoteReaderReader.protected StringRemote address.protected StringRemote host.protected intRemote portprotected ObjectThe current request dispatcher path.protected booleanWas the requested session ID received in a cookie?protected StringThe requested session ID (if any) for this request.protected booleanWas the requested session ID obtained from the SSL session?protected booleanWas the requested session ID received in a URL?protected ResponseThe response with which this request is associated.protected booleanSecure flag.protected SessionThe currently active session for this request.protected static final StringManagerThe string manager for this package.protected booleanFlag that indicates if SSL attributes have been parsed to improve performance for applications (usually frameworks) that make multiple calls togetAttributeNames().protected SubjectThe Subject associated with the current AccessControlContextprotected B2CConverterURI byte to char converter.protected PrincipalUser principal.protected booleanUsing stream flag.protected booleanUsing reader flag.Fields inherited from interface jakarta.servlet.http.HttpServletRequestBASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidAdd a Cookie to the set of Cookies associated with this Request.voidAdd a Locale to the set of preferred Locales for this Request.protected voidaddPathParameter(String name, String value) booleanauthenticate(HttpServletResponse response) Triggers the same authentication process as would be triggered if the request is for a resource that is protected by a security constraint.Changes the session ID of the session associated with this request.voidchangeSessionId(String newSessionId) Change the ID of the session that this request is associated with.protected voidCheck 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.voidClear the collection of Cookies associated with this Request.voidClear the collection of Locales associated with this Request.protected voidConverts the parsed cookies (parsing the Cookie headers first if they have not been parsed) into Cookie objects.Create and return a ServletInputStream to read the content associated with this Request.protected SessiondoGetSession(boolean create) voidPerform whatever actions are required to flush and close the input stream or reader, in a single operation.Get the current AsyncContext.getAttribute(String name) Returns the value of the named attribute as anObject, ornullif no attribute of the given name exists.Return the names of all request attributes for this Request, or an emptyEnumerationif there are none.Return the authentication type used for this Request.Returns the name of the character encoding used in the body of this request.intReturns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known.longReturns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known.Returns the MIME type of the body of the request, ornullif the type is not known.Return the Context within which this Request is being processed.Return the portion of the request URI used to select the Context of the Request.Cookie[]Return the set of Cookies received with this Request.Get the Coyote request.longgetDateHeader(String name) Return the value of the specified date header, if any; otherwise return -1.Get the decoded request URI.Get the decoded request URI.booleanGet the recycling strategy of the facade objects.Get filter chain associated with the request.Return the first value of the specified header, if any; otherwise, returnnullReturns an enumeration of all the header names this request contains.getHeaders(String name) Return all of the values of the specified header, if any; otherwise, return an empty enumeration.getHost()Obtain the mapping information for this request.Retrieves the body of the request as binary data using aServletInputStream.intgetIntHeader(String name) Return the value of the specified header as an integer, or -1 if there is no such header for this request.Returns the Internet Protocol (IP) address of the interface on which the request was received.Returns the preferredLocalethat the client will accept content in, based on the Accept-Language header.Returns anEnumerationofLocaleobjects indicating, in decreasing order starting with the preferred locale, the locales that are acceptable to the client based on the Accept-Language header.Returns the host name of the Internet Protocol (IP) interface on which the request was received.intReturns the Internet Protocol (IP) port number of the interface on which the request was received.Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.getParameter(String name) Returns the value of a request parameter as aString, ornullif the parameter does not exist.Returns aMapof the parameters of this request.Returns anEnumerationofStringobjects containing the names of the parameters contained in this request.String[]getParameterValues(String name) Returns an array ofStringobjects containing all of the values the given request parameter has, ornullif the parameter does not exist.Gets the named Part or null if the Part does not exist.getParts()Return a collection of all uploaded Parts.Returns any extra path information associated with the URL the client sent when it made this request.protected StringgetPathParameter(String name) Returns any extra path information after the servlet name but before the query string, and translates it to a real path.Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1.Obtain the request identifier for this request as defined by the protocol in use.Returns the query string that is contained in the request URL after the path.Read the Reader wrapping the input stream for this Request.Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.Returns the fully qualified name of the client or the last proxy that sent the request.intReturns the Internet Protocol (IP) source port of the client or last proxy that sent the request.Returns the login of the user making this request, if the user has been authenticated, ornullif the user has not been authenticated.getRequestDispatcher(String path) Returns aRequestDispatcherobject that acts as a wrapper for the resource located at the given path.Returns the session ID specified by the client.Obtain a unique (within the lifetime of the Servlet container) identifier string for this request.Get the request path.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.Reconstructs the URL the client used to make the request.Returns the name of the scheme used to make this request, for example,http,https, orftp.Return the server representation of the cookies associated with this request.Returns the host name of the server to which the request was sent.intReturns the port number to which the request was sent.Obtain details of the network connection to the Servlet container that is being used by this request.Returns the part of this request's URL that calls the servlet.Returns the current session associated with this request, or if the request does not have a session, creates one.getSession(boolean create) Returns the currentHttpSessionassociated with this request or, if there is no current session andcreateis true, returns a new session.getSessionInternal(boolean create) Obtain a Map of the trailer fields that is not backed by the request object.protected B2CConverterReturns ajava.security.Principalobject containing the name of the current authenticated user.booleanisAsync()booleanbooleanbooleanbooleanbooleanbooleanbooleanChecks whether the requested session ID came in as a cookie.booleanChecks whether the requested session ID came in as part of the request URL.booleanChecks whether the requested session ID is still valid.booleanisSecure()Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.booleanAre trailer fields ready to be read (there may still be no trailers to read).booleanisUserInRole(String role) Returns a boolean indicating whether the authenticated user is included in the specified logical "role".voidAuthenticate the provided user name and password and then associated the authenticated user with the request.voidlogout()Removes any authenticated user from the request.Obtain a builder for generating push requests.newPushBuilder(HttpServletRequest request) protected voidParse cookies.protected voidParse request locales.protected voidParse accept-language header value.protected voidParse request parameters.protected byte[]Read chunked post body.protected intreadPostBody(byte[] body, int len) Deprecated.Unused.protected voidreadPostBodyFully(byte[] body, int len) Read post body into an array.voidrecycle()Release all object references, and initialize instance variables, in preparation for reuse of this object.protected voidrecycleCookieInfo(boolean recycleCoyote) protected voidvoidremoveAttribute(String name) Remove the specified request attribute if it exists.voidremoveNote(String name) Remove any object bound to the specified name in the internal notes for this request.voidsetAsyncSupported(boolean asyncSupported) voidsetAttribute(String name, Object value) Set the specified request attribute to the specified value.voidsetAuthType(String type) Set the authentication type used for this request, if any; otherwise set the type tonull.voidOverrides the name of the character encoding used in the body of this request.voidsetContentType(String contentType) Set the content type for this Request.voidsetCoyoteRequest(Request coyoteRequest) Set the Coyote request.voidsetFilterChain(FilterChain filterChain) Set filter chain associated with the request.voidsetLocalPort(int port) Set the port number of the server to process this request.voidBind an object to a specified name in the internal notes associated with this request, replacing any existing binding for this name.voidsetPathInfo(String path) Set the path information for this Request.voidsetRemoteAddr(String remoteAddr) Set the IP address of the remote client associated with this Request.voidsetRemoteHost(String remoteHost) Set the fully qualified name of the remote client associated with this Request.voidsetRequest(HttpServletRequest applicationRequest) Set a wrapped HttpServletRequest to pass to the application.voidsetRequestedSessionCookie(boolean flag) Set a flag indicating whether or not the requested session ID for this request came in through a cookie.voidSet the requested session ID for this request.voidsetRequestedSessionSSL(boolean flag) Set a flag indicating whether or not the requested session ID for this request came in through SSL.voidsetRequestedSessionURL(boolean flag) Set a flag indicating whether or not the requested session ID for this request came in through a URL.voidsetResponse(Response response) Set the Response with which this Request is associated.voidsetSecure(boolean secure) Set the value to be returned byisSecure()for this Request.voidsetServerPort(int port) Set the port number of the server to process this request.protected voidsetURIConverter(B2CConverter URIConverter) Set the URI converter.voidsetUserPrincipal(Principal principal) Set the Principal who has been authenticated for this Request.startAsync(ServletRequest request, ServletResponse response) protected String<T extends HttpUpgradeHandler>
 TStart the HTTP upgrade process and create and instance of the provided protocol handler class.
- 
Field Details- 
coyoteRequestCoyote request.
- 
smThe string manager for this package.
- 
cookiesThe set of cookies associated with this Request.
- 
defaultLocaleThe default Locale if none are specified.
- 
sslAttributesParsedprotected boolean sslAttributesParsedFlag that indicates if SSL attributes have been parsed to improve performance for applications (usually frameworks) that make multiple calls togetAttributeNames().
- 
localesThe preferred Locales associated with this Request.
- 
authTypeAuthentication type.
- 
internalDispatcherTypeThe current dispatcher type.
- 
inputBufferThe associated input buffer.
- 
inputStreamServletInputStream.
- 
readerReader.
- 
usingInputStreamprotected boolean usingInputStreamUsing stream flag.
- 
usingReaderprotected boolean usingReaderUsing reader flag.
- 
userPrincipalUser principal.
- 
parametersParsedprotected boolean parametersParsedRequest parameters parsed flag.
- 
cookiesParsedprotected boolean cookiesParsedCookie headers parsed flag. Indicates that the cookie headers have been parsed into ServerCookies.
- 
cookiesConvertedprotected boolean cookiesConvertedCookie parsed flag. Indicates that the ServerCookies have been converted into user facing Cookie objects.
- 
secureprotected boolean secureSecure flag.
- 
subjectThe Subject associated with the current AccessControlContext
- 
CACHED_POST_LENprotected static final int CACHED_POST_LENPost data buffer.- See Also:
 
- 
postDataprotected byte[] postData
- 
parameterMapHash map used in the getParametersMap method.
- 
partsThe parts, if any, uploaded with this request.
- 
partsParseExceptionThe exception thrown, if any when parsing the parts.
- 
sessionThe currently active session for this request.
- 
requestDispatcherPathThe current request dispatcher path.
- 
requestedSessionCookieprotected boolean requestedSessionCookieWas the requested session ID received in a cookie?
- 
requestedSessionIdThe requested session ID (if any) for this request.
- 
requestedSessionURLprotected boolean requestedSessionURLWas the requested session ID received in a URL?
- 
requestedSessionSSLprotected boolean requestedSessionSSLWas the requested session ID obtained from the SSL session?
- 
localesParsedprotected boolean localesParsedParse locales.
- 
localPortprotected int localPortLocal port
- 
remoteAddrRemote address.
- 
peerAddrConnection peer address.
- 
remoteHostRemote host.
- 
remotePortprotected int remotePortRemote port
- 
localAddrLocal address
- 
localNameLocal address
- 
asyncSupported
- 
connectorAssociated Catalina connector.
- 
filterChainFilter chain associated with the request.
- 
mappingDataMapping data.
- 
facadeThe facade associated with this request.
- 
responseThe response with which this request is associated.
- 
URIConverterURI byte to char converter.
 
- 
- 
Constructor Details- 
RequestCreate 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 Details- 
setCoyoteRequestSet the Coyote request.- Parameters:
- coyoteRequest- The Coyote request
 
- 
getCoyoteRequestGet the Coyote request.- Returns:
- the Coyote request object
 
- 
addPathParameter
- 
getPathParameter
- 
setAsyncSupportedpublic void setAsyncSupported(boolean asyncSupported) 
- 
recyclepublic void recycle()Release all object references, and initialize instance variables, in preparation for reuse of this object.
- 
recycleSessionInfoprotected void recycleSessionInfo()
- 
recycleCookieInfoprotected void recycleCookieInfo(boolean recycleCoyote) 
- 
getConnector- Returns:
- the Connector through which this Request was received.
 
- 
getContextReturn 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
 
- 
getDiscardFacadespublic boolean getDiscardFacades()Get the recycling strategy of the facade objects.- Returns:
- the value of the flag as set on the connector, or trueif no connector is associated with this request
 
- 
getFilterChainGet filter chain associated with the request.- Returns:
- the associated filter chain
 
- 
setFilterChainSet filter chain associated with the request.- Parameters:
- filterChain- new filter chain
 
- 
getHost- Returns:
- the Host within which this Request is being processed.
 
- 
getMappingData- Returns:
- mapping data.
 
- 
getRequest- Returns:
- the ServletRequestfor which this object is the facade. This method must be implemented by a subclass.
 
- 
setRequestSet a wrapped HttpServletRequest to pass to the application. Components wishing to wrap the request should obtain the request viagetRequest(), wrap it and then call this method with the wrapped request.- Parameters:
- applicationRequest- The wrapped request to pass to the application
 
- 
getResponse- Returns:
- the Response with which this Request is associated.
 
- 
setResponseSet the Response with which this Request is associated.- Parameters:
- response- The new associated response
 
- 
getStream- Returns:
- the input stream associated with this Request.
 
- 
getURIConverter- Returns:
- the URI converter.
 
- 
setURIConverterSet the URI converter.- Parameters:
- URIConverter- the new URI converter
 
- 
getWrapper- Returns:
- the Wrapper within which this Request is being processed.
 
- 
createInputStreamCreate 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
 
- 
finishRequestPerform 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- 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 nullif no such binding exists.
 
- 
removeNoteRemove any object bound to the specified name in the internal notes for this request.- Parameters:
- name- Name of the note to be removed
 
- 
setLocalPortpublic void setLocalPort(int port) Set the port number of the server to process this request.- Parameters:
- port- The server port
 
- 
setNoteBind 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
 
- 
setRemoteAddrSet the IP address of the remote client associated with this Request.- Parameters:
- remoteAddr- The remote IP address
 
- 
setRemoteHostSet the fully qualified name of the remote client associated with this Request.- Parameters:
- remoteHost- The remote host name
 
- 
setSecurepublic void setSecure(boolean secure) Set the value to be returned byisSecure()for this Request.- Parameters:
- secure- The new isSecure value
 
- 
setServerPortpublic void setServerPort(int port) Set the port number of the server to process this request.- Parameters:
- port- The server port
 
- 
getAttributeDescription copied from interface:jakarta.servlet.ServletRequestReturns the value of the named attribute as anObject, ornullif 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.X509Certificatecan be used to retrieve information on the certificate of the client. Attributes can also be set programmatically usingServletRequest.setAttribute(java.lang.String, java.lang.Object). This allows information to be embedded into a request before aRequestDispatchercall.Attribute names should follow the same conventions as package names. Names beginning with jakarta.*are reserved for use by the Jakarta EE platform.- Specified by:
- getAttributein interface- ServletRequest
- Parameters:
- name- Name of the request attribute to return
- Returns:
- the specified request attribute if it exists; otherwise, return null.
 
- 
getContentLengthLongpublic long getContentLengthLong()Description copied from interface:jakarta.servlet.ServletRequestReturns 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:
- getContentLengthLongin interface- ServletRequest
- Returns:
- a long integer containing the length of the request body or -1 if the length is not known
 
- 
getAttributeNamesReturn the names of all request attributes for this Request, or an emptyEnumerationif there are none. Note that the attribute names returned will only be those for the attributes set viasetAttribute(String, Object). Tomcat internal attributes will not be included although they are accessible viagetAttribute(String). The Tomcat internal attributes include:- Globals.DISPATCHER_TYPE_ATTR
- Globals.DISPATCHER_REQUEST_PATH_ATTR
- Globals.ASYNC_SUPPORTED_ATTR
- Globals.CERTIFICATES_ATTR(SSL connections only)
- Globals.CIPHER_SUITE_ATTR(SSL connections only)
- Globals.KEY_SIZE_ATTR(SSL connections only)
- Globals.SSL_SESSION_ID_ATTR(SSL connections only)
- Globals.SSL_SESSION_MGR_ATTR(SSL connections only)
- Globals.PARAMETER_PARSE_FAILED_ATTR
 - Specified by:
- getAttributeNamesin interface- ServletRequest
- Returns:
- the attribute names enumeration
 
- 
getCharacterEncodingDescription copied from interface:jakarta.servlet.ServletRequestReturns the name of the character encoding used in the body of this request. This method returnsnullif the no character encoding has been specified. The following priority order is used to determine the specified encoding:- per request
- web application default via the deployment descriptor or
 ServletContext.setRequestCharacterEncoding(String)
- container default via container specific configuration
 - Specified by:
- getCharacterEncodingin interface- ServletRequest
- Returns:
- the character encoding for this Request.
 
- 
getContentLengthpublic int getContentLength()Description copied from interface:jakarta.servlet.ServletRequestReturns 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:
- getContentLengthin interface- ServletRequest
- Returns:
- the content length for this Request.
 
- 
getContentTypeDescription copied from interface:jakarta.servlet.ServletRequestReturns the MIME type of the body of the request, ornullif the type is not known. For HTTP servlets, same as the value of the CGI variable CONTENT_TYPE.- Specified by:
- getContentTypein interface- ServletRequest
- Returns:
- the content type for this Request.
 
- 
setContentTypeSet the content type for this Request.- Parameters:
- contentType- The content type
 
- 
getInputStreamDescription copied from interface:jakarta.servlet.ServletRequestRetrieves the body of the request as binary data using aServletInputStream. Either this method orServletRequest.getReader()may be called to read the body, not both.- Specified by:
- getInputStreamin interface- ServletRequest
- Returns:
- the servlet input stream for this Request. The default implementation returns a servlet input stream
             created by createInputStream().
- Throws:
- IllegalStateException- if- getReader()has already been called for this request
- IOException- if an input/output error occurs
 
- 
getLocaleDescription copied from interface:jakarta.servlet.ServletRequestReturns the preferredLocalethat 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:
- getLocalein interface- ServletRequest
- Returns:
- the preferred Locale that the client will accept content in, based on the value for the first
             Accept-Languageheader that was encountered. If the request did not specify a preferred language, the server's default Locale is returned.
 
- 
getLocalesDescription copied from interface:jakarta.servlet.ServletRequestReturns anEnumerationofLocaleobjects 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 anEnumerationcontaining oneLocale, the default locale for the server.- Specified by:
- getLocalesin interface- ServletRequest
- Returns:
- the set of preferred Locales that the client will accept content in, based on the values for any
             Accept-Languageheaders that were encountered. If the request did not specify a preferred language, the server's default Locale is returned.
 
- 
getParameterDescription copied from interface:jakarta.servlet.ServletRequestReturns the value of a request parameter as aString, ornullif 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()orServletRequest.getReader()can interfere with the execution of this method.- Specified by:
- getParameterin 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:
 
- 
getParameterMapReturns aMapof 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:
- getParameterMapin interface- ServletRequest
- Returns:
- A Mapcontaining parameter names as keys and parameter values as map values.
 
- 
getParameterNamesDescription copied from interface:jakarta.servlet.ServletRequestReturns anEnumerationofStringobjects containing the names of the parameters contained in this request. If the request has no parameters, the method returns an emptyEnumeration.- Specified by:
- getParameterNamesin interface- ServletRequest
- Returns:
- the names of all defined request parameters for this request.
 
- 
getParameterValuesDescription copied from interface:jakarta.servlet.ServletRequestReturns an array ofStringobjects containing all of the values the given request parameter has, ornullif the parameter does not exist.If the parameter has a single value, the array has a length of 1. - Specified by:
- getParameterValuesin 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:
 
- 
getProtocolDescription copied from interface:jakarta.servlet.ServletRequestReturns 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 variableSERVER_PROTOCOL.- Specified by:
- getProtocolin interface- ServletRequest
- Returns:
- the protocol and version used to make this Request.
 
- 
getReaderRead the Reader wrapping the input stream for this Request. The default implementation wraps aBufferedReaderaround the servlet input stream returned bycreateInputStream().- Specified by:
- getReaderin interface- ServletRequest
- Returns:
- a buffered reader for the request
- Throws:
- IllegalStateException- if- getInputStream()has already been called for this request
- IOException- if an input/output error occurs
- See Also:
 
- 
getRemoteAddrDescription copied from interface:jakarta.servlet.ServletRequestReturns 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 variableREMOTE_ADDR.- Specified by:
- getRemoteAddrin interface- ServletRequest
- Returns:
- the remote IP address making this Request.
 
- 
getPeerAddr- Returns:
- the connection peer IP address making this Request.
 
- 
getRemoteHostDescription copied from interface:jakarta.servlet.ServletRequestReturns 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 variableREMOTE_HOST.- Specified by:
- getRemoteHostin interface- ServletRequest
- Returns:
- the remote host name making this Request.
 
- 
getRemotePortpublic int getRemotePort()Description copied from interface:jakarta.servlet.ServletRequestReturns the Internet Protocol (IP) source port of the client or last proxy that sent the request.- Specified by:
- getRemotePortin interface- ServletRequest
- Returns:
- the Internet Protocol (IP) source port of the client or last proxy that sent the request.
 
- 
getLocalNameDescription copied from interface:jakarta.servlet.ServletRequestReturns the host name of the Internet Protocol (IP) interface on which the request was received.- Specified by:
- getLocalNamein interface- ServletRequest
- Returns:
- the host name of the Internet Protocol (IP) interface on which the request was received.
 
- 
getLocalAddrDescription copied from interface:jakarta.servlet.ServletRequestReturns the Internet Protocol (IP) address of the interface on which the request was received.- Specified by:
- getLocalAddrin interface- ServletRequest
- Returns:
- the Internet Protocol (IP) address of the interface on which the request was received.
 
- 
getLocalPortpublic int getLocalPort()Description copied from interface:jakarta.servlet.ServletRequestReturns the Internet Protocol (IP) port number of the interface on which the request was received.- Specified by:
- getLocalPortin interface- ServletRequest
- Returns:
- the Internet Protocol (IP) port number of the interface on which the request was received.
 
- 
getRequestDispatcherDescription copied from interface:jakarta.servlet.ServletRequestReturns aRequestDispatcherobject that acts as a wrapper for the resource located at the given path. ARequestDispatcherobject 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 nullif the servlet container cannot return aRequestDispatcher.The difference between this method and ServletContext.getRequestDispatcher(java.lang.String)is that this method can take a relative path.- Specified by:
- getRequestDispatcherin 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:
 
- 
getSchemeDescription copied from interface:jakarta.servlet.ServletRequestReturns the name of the scheme used to make this request, for example,http,https, orftp. Different schemes have different rules for constructing URLs, as noted in RFC 1738.- Specified by:
- getSchemein interface- ServletRequest
- Returns:
- the scheme used to make this Request.
 
- 
getServerNameDescription copied from interface:jakarta.servlet.ServletRequestReturns the host name of the server to which the request was sent. It is the value of the part before ":" in theHostheader value, if any, or the resolved server name, or the server IP address.- Specified by:
- getServerNamein interface- ServletRequest
- Returns:
- the server name responding to this Request.
 
- 
getServerPortpublic int getServerPort()Description copied from interface:jakarta.servlet.ServletRequestReturns the port number to which the request was sent. It is the value of the part after ":" in theHostheader value, if any, or the server port where the client connection was accepted on.- Specified by:
- getServerPortin interface- ServletRequest
- Returns:
- the server port responding to this Request.
 
- 
isSecurepublic boolean isSecure()Description copied from interface:jakarta.servlet.ServletRequestReturns a boolean indicating whether this request was made using a secure channel, such as HTTPS.- Specified by:
- isSecurein interface- ServletRequest
- Returns:
- trueif this request was received on a secure connection.
 
- 
removeAttributeRemove the specified request attribute if it exists.- Specified by:
- removeAttributein interface- ServletRequest
- Parameters:
- name- Name of the request attribute to remove
 
- 
setAttributeSet the specified request attribute to the specified value.- Specified by:
- setAttributein interface- ServletRequest
- Parameters:
- name- Name of the request attribute to set
- value- The associated value
 
- 
setCharacterEncodingOverrides 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 usinggetReader().- Specified by:
- setCharacterEncodingin interface- ServletRequest
- Parameters:
- enc- The character encoding to be used
- Throws:
- UnsupportedEncodingException- if the specified encoding is not supported
- Since:
- Servlet 2.3
 
- 
getServletContext- Specified by:
- getServletContextin interface- ServletRequest
- Returns:
- TODO
 
- 
startAsync- Specified by:
- startAsyncin interface- ServletRequest
- Returns:
- TODO
 
- 
startAsync- Specified by:
- startAsyncin 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
 
- 
isAsyncStartedpublic boolean isAsyncStarted()- Specified by:
- isAsyncStartedin interface- ServletRequest
- Returns:
- TODO
 
- 
isAsyncDispatchingpublic boolean isAsyncDispatching()
- 
isAsyncCompletingpublic boolean isAsyncCompleting()
- 
isAsyncpublic boolean isAsync()
- 
isAsyncSupportedpublic boolean isAsyncSupported()- Specified by:
- isAsyncSupportedin interface- ServletRequest
- Returns:
- TODO
 
- 
getAsyncContextDescription copied from interface:jakarta.servlet.ServletRequestGet the current AsyncContext.- Specified by:
- getAsyncContextin interface- ServletRequest
- Returns:
- The current AsyncContext
 
- 
getAsyncContextInternal
- 
getDispatcherType- Specified by:
- getDispatcherTypein interface- ServletRequest
- Returns:
- TODO
 
- 
getRequestIdDescription copied from interface:jakarta.servlet.ServletRequestObtain 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:
- getRequestIdin interface- ServletRequest
- Returns:
- A unique identifier for the request
 
- 
getProtocolRequestIdDescription copied from interface:jakarta.servlet.ServletRequestObtain 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:
- getProtocolRequestIdin interface- ServletRequest
- Returns:
- The request identifier if one is defined, otherwise an empty string
 
- 
getServletConnectionDescription copied from interface:jakarta.servlet.ServletRequestObtain 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:
- getServletConnectionin interface- ServletRequest
- Returns:
- The network connection details.
 
- 
addCookieAdd a Cookie to the set of Cookies associated with this Request.- Parameters:
- cookie- The new cookie
 
- 
addLocaleAdd 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
 
- 
clearCookiespublic void clearCookies()Clear the collection of Cookies associated with this Request.
- 
clearLocalespublic void clearLocales()Clear the collection of Locales associated with this Request.
- 
setAuthTypeSet the authentication type used for this request, if any; otherwise set the type tonull. Typical values are "BASIC", "DIGEST", or "SSL".- Parameters:
- type- The authentication type used
 
- 
setPathInfoSet 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
 
- 
setRequestedSessionCookiepublic 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
 
- 
setRequestedSessionIdSet 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
 
- 
setRequestedSessionURLpublic 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
 
- 
setRequestedSessionSSLpublic 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
 
- 
getDecodedRequestURIGet the decoded request URI.- Returns:
- the URL decoded request URI
 
- 
getDecodedRequestURIMBGet the decoded request URI.- Returns:
- the URL decoded request URI
 
- 
setUserPrincipalSet the Principal who has been authenticated for this Request. This value is also used to calculate the value to be returned by thegetRemoteUser()method.- Parameters:
- principal- The user Principal
 
- 
isTrailerFieldsReadypublic boolean isTrailerFieldsReady()Description copied from interface:jakarta.servlet.http.HttpServletRequestAre trailer fields ready to be read (there may still be no trailers to read). This method always returnstrueif the underlying protocol does not support trailer fields. Otherwise,trueis 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:
- isTrailerFieldsReadyin interface- HttpServletRequest
- Returns:
- trueif trailers are ready to be read
 
- 
getTrailerFieldsDescription copied from interface:jakarta.servlet.http.HttpServletRequestObtain a Map of the trailer fields that is not backed by the request object.- Specified by:
- getTrailerFieldsin interface- HttpServletRequest
- Returns:
- A Map of the received trailer fields with all keys lower case or an empty Map if no trailers are present
 
- 
newPushBuilderDescription copied from interface:jakarta.servlet.http.HttpServletRequestObtain a builder for generating push requests.PushBuilderdocuments 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:
- newPushBuilderin interface- HttpServletRequest
- Returns:
- A builder that can be used to generate push requests based on this request or nullif push is not supported. Note that even if a PushBuilder instance is returned, by the time thatPushBuilder.push()is called, it may no longer be valid to push a request and the push request will be ignored.
 
- 
newPushBuilder
- 
upgradepublic <T extends HttpUpgradeHandler> T upgrade(Class<T> httpUpgradeHandlerClass) throws IOException, ServletException Description copied from interface:jakarta.servlet.http.HttpServletRequestStart 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 toHttpServletResponse.SC_SWITCHING_PROTOCOLS.- Specified by:
- upgradein 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
 
- 
getAuthTypeReturn the authentication type used for this Request.- Specified by:
- getAuthTypein 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
             nullif the request was not authenticated.
 
- 
getContextPathReturn 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:
- getContextPathin interface- HttpServletRequest
- Returns:
- a Stringspecifying the portion of the request URI that indicates the context of the request
 
- 
getCookiesReturn 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:
- getCookiesin interface- HttpServletRequest
- Returns:
- the array of cookies
 
- 
getServerCookiesReturn 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
 
- 
getDateHeaderReturn the value of the specified date header, if any; otherwise return -1.- Specified by:
- getDateHeaderin 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
 
- 
getHeaderReturn the first value of the specified header, if any; otherwise, returnnull- Specified by:
- getHeaderin interface- HttpServletRequest
- Parameters:
- name- Name of the requested header
- Returns:
- the header value
 
- 
getHeadersReturn all of the values of the specified header, if any; otherwise, return an empty enumeration.- Specified by:
- getHeadersin interface- HttpServletRequest
- Parameters:
- name- Name of the requested header
- Returns:
- the enumeration with the header values
 
- 
getHeaderNamesDescription copied from interface:jakarta.servlet.http.HttpServletRequestReturns 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:
- getHeaderNamesin interface- HttpServletRequest
- Returns:
- the names of all headers received with this request.
 
- 
getIntHeaderReturn the value of the specified header as an integer, or -1 if there is no such header for this request.- Specified by:
- getIntHeaderin 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
 
- 
getHttpServletMappingDescription copied from interface:jakarta.servlet.http.HttpServletRequestObtain the mapping information for this request.- Specified by:
- getHttpServletMappingin interface- HttpServletRequest
- Returns:
- the mapping information for this request
 
- 
getMethodDescription copied from interface:jakarta.servlet.http.HttpServletRequestReturns 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:
- getMethodin interface- HttpServletRequest
- Returns:
- the HTTP request method used in this Request.
 
- 
getPathInfoDescription copied from interface:jakarta.servlet.http.HttpServletRequestReturns 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 nullif 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:
- getPathInfoin interface- HttpServletRequest
- Returns:
- the path information associated with this Request.
 
- 
getPathTranslatedDescription copied from interface:jakarta.servlet.http.HttpServletRequestReturns 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 nullor 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:
- getPathTranslatedin interface- HttpServletRequest
- Returns:
- the extra path information for this request, translated to a real path.
 
- 
getQueryStringDescription copied from interface:jakarta.servlet.http.HttpServletRequestReturns the query string that is contained in the request URL after the path. This method returnsnullif the URL does not have a query string. Same as the value of the CGI variable QUERY_STRING.- Specified by:
- getQueryStringin interface- HttpServletRequest
- Returns:
- the query string associated with this request.
 
- 
getRemoteUserDescription copied from interface:jakarta.servlet.http.HttpServletRequestReturns the login of the user making this request, if the user has been authenticated, ornullif 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:
- getRemoteUserin interface- HttpServletRequest
- Returns:
- the name of the remote user that has been authenticated for this Request.
 
- 
getRequestPathMBGet the request path.- Returns:
- the request path
 
- 
getRequestedSessionIdDescription copied from interface:jakarta.servlet.http.HttpServletRequestReturns the session ID specified by the client. This may not be the same as the ID of the current valid session for this request. If the client did not specify a session ID, this method returnsnull.- Specified by:
- getRequestedSessionIdin interface- HttpServletRequest
- Returns:
- the session identifier included in this request, if any.
- See Also:
 
- 
getRequestURIDescription copied from interface:jakarta.servlet.http.HttpServletRequestReturns 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:
- getRequestURIin interface- HttpServletRequest
- Returns:
- the request URI for this request.
- See Also:
 
- 
getRequestURLDescription copied from interface:jakarta.servlet.http.HttpServletRequestReconstructs 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:
- getRequestURLin interface- HttpServletRequest
- Returns:
- a StringBufferobject containing the reconstructed URL
 
- 
getServletPathDescription copied from interface:jakarta.servlet.http.HttpServletRequestReturns 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:
- getServletPathin interface- HttpServletRequest
- Returns:
- the portion of the request URI used to select the servlet that will process this request.
 
- 
getSessionDescription copied from interface:jakarta.servlet.http.HttpServletRequestReturns the current session associated with this request, or if the request does not have a session, creates one.- Specified by:
- getSessionin interface- HttpServletRequest
- Returns:
- the session associated with this Request, creating one if necessary.
- See Also:
 
- 
getSessionDescription copied from interface:jakarta.servlet.http.HttpServletRequestReturns the currentHttpSessionassociated with this request or, if there is no current session andcreateis true, returns a new session.If createisfalseand the request has no validHttpSession, this method returnsnull.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:
- getSessionin 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:
 
- 
isRequestedSessionIdFromCookiepublic boolean isRequestedSessionIdFromCookie()Description copied from interface:jakarta.servlet.http.HttpServletRequestChecks whether the requested session ID came in as a cookie.- Specified by:
- isRequestedSessionIdFromCookiein interface- HttpServletRequest
- Returns:
- trueif the session identifier included in this request came from a cookie.
- See Also:
 
- 
isRequestedSessionIdFromURLpublic boolean isRequestedSessionIdFromURL()Description copied from interface:jakarta.servlet.http.HttpServletRequestChecks whether the requested session ID came in as part of the request URL.- Specified by:
- isRequestedSessionIdFromURLin interface- HttpServletRequest
- Returns:
- trueif the session identifier included in this request came from the request URI.
- See Also:
 
- 
isRequestedSessionIdValidpublic boolean isRequestedSessionIdValid()Description copied from interface:jakarta.servlet.http.HttpServletRequestChecks whether the requested session ID is still valid.- Specified by:
- isRequestedSessionIdValidin interface- HttpServletRequest
- Returns:
- trueif the session identifier included in this request identifies a valid session.
- See Also:
 
- 
isUserInRoleDescription copied from interface:jakarta.servlet.http.HttpServletRequestReturns 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 returnsfalse.- Specified by:
- isUserInRolein interface- HttpServletRequest
- Parameters:
- role- Role name to be validated
- Returns:
- trueif the authenticated user principal possesses the specified role name.
 
- 
getPrincipal- Returns:
- the principal that has been authenticated for this Request.
 
- 
getUserPrincipalDescription copied from interface:jakarta.servlet.http.HttpServletRequestReturns ajava.security.Principalobject containing the name of the current authenticated user. If the user has not been authenticated, the method returnsnull.- Specified by:
- getUserPrincipalin interface- HttpServletRequest
- Returns:
- the principal that has been authenticated for this Request.
 
- 
getSessionInternal- Returns:
- the session associated with this Request, creating one if necessary.
 
- 
changeSessionIdChange 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
 
- 
changeSessionIdDescription copied from interface:jakarta.servlet.http.HttpServletRequestChanges the session ID of the session associated with this request. This method does not create a new session object it only changes the ID of the current session.- Specified by:
- changeSessionIdin interface- HttpServletRequest
- Returns:
- the new session ID allocated to the session
- See Also:
 
- 
getSessionInternal- Parameters:
- create- Create a new session if one does not exist
- Returns:
- the session associated with this Request, creating one if necessary and requested.
 
- 
isParametersParsedpublic boolean isParametersParsed()- Returns:
- trueif we have parsed parameters
 
- 
isFinishedpublic boolean isFinished()- Returns:
- trueif an attempt has been made to read the request body and all of the request body has been read.
 
- 
checkSwallowInputprotected 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.
- 
authenticateDescription copied from interface:jakarta.servlet.http.HttpServletRequestTriggers the same authentication process as would be triggered if the request is for a resource that is protected by a security constraint.- Specified by:
- authenticatein interface- HttpServletRequest
- Parameters:
- response- The response to use to return any authentication challenge
- Returns:
- trueif the user is successfully authenticated and- falseif 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
 
- 
loginDescription copied from interface:jakarta.servlet.http.HttpServletRequestAuthenticate the provided user name and password and then associated the authenticated user with the request.- Specified by:
- loginin interface- HttpServletRequest
- Parameters:
- username- The user name to authenticate
- password- The password to use to authenticate the user
- Throws:
- ServletException- If any of- HttpServletRequest.getRemoteUser(),- HttpServletRequest.getUserPrincipal()or- HttpServletRequest.getAuthType()are non-null, if the configured authenticator does not support user name and password authentication or if the authentication fails
 
- 
logoutDescription copied from interface:jakarta.servlet.http.HttpServletRequestRemoves any authenticated user from the request.- Specified by:
- logoutin interface- HttpServletRequest
- Throws:
- ServletException- If the logout fails
 
- 
getPartsDescription copied from interface:jakarta.servlet.http.HttpServletRequestReturn a collection of all uploaded Parts.- Specified by:
- getPartsin interface- HttpServletRequest
- Returns:
- A collection of all uploaded Parts.
- Throws:
- IOException- if an I/O error occurs
- IllegalStateException- if size limits are exceeded or no multipart configuration is provided
- ServletException- if the request is not multipart/form-data
 
- 
getPartDescription copied from interface:jakarta.servlet.http.HttpServletRequestGets the named Part or null if the Part does not exist. Triggers upload of all Parts.- Specified by:
- getPartin interface- HttpServletRequest
- Parameters:
- name- The name of the Part to obtain
- Returns:
- The named Part or null if the Part does not exist
- Throws:
- IOException- if an I/O error occurs
- IllegalStateException- if size limits are exceeded
- ServletException- if the request is not multipart/form-data
 
- 
doGetSession
- 
unescape
- 
parseCookiesprotected void parseCookies()Parse cookies. This only parses the cookies into the memory efficient ServerCookies structure. It does not populate the Cookie objects.
- 
convertCookiesprotected void convertCookies()Converts the parsed cookies (parsing the Cookie headers first if they have not been parsed) into Cookie objects.
- 
parseParametersprotected void parseParameters()Parse request parameters.
- 
readPostBodyDeprecated.Unused. Will be removed in Tomcat 11.0.x onwards. UsereadPostBodyFully(byte[], int)Read post body into 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
 
- 
readPostBodyFullyRead post body into an array.- Parameters:
- body- The bytes array in which the body will be read
- len- The body length
- Throws:
- IOException- if an IO exception occurred or EOF is reached before the body has been fully read
 
- 
readChunkedPostBodyRead chunked post body.- Returns:
- the post body as a bytes array
- Throws:
- IOException- if an IO exception occurred
 
- 
parseLocalesprotected void parseLocales()Parse request locales.
- 
parseLocalesHeaderParse accept-language header value.- Parameters:
- value- the header value
- locales- the map that will hold the result
 
 
-