Class Request
- All Implemented Interfaces:
HttpServletRequest,ServletRequest
- Author:
- Remy Maucherat, Craig R. McClanahan
-
Field Summary
FieldsModifier 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 SimpleDateFormat[]Deprecated.Unused.protected static final TimeZoneDeprecated.Unused.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 javax.servlet.http.HttpServletRequest
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH -
Constructor Summary
Constructors -
Method Summary
Modifier 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.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.Returns anEnumerationcontaining the names of the attributes available to this request.Returns the name of the authentication scheme used to protect the servlet.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.Returns the portion of the request URI that indicates the context of the request.Cookie[]Returns an array containing all of theCookieobjects the client sent with this request.Get the Coyote request.longgetDateHeader(String name) Returns the value of the specified request header as alongvalue that represents aDateobject.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.Returns the value of the specified request header as aString.Returns an enumeration of all the header names this request contains.getHeaders(String name) Returns all the values of the specified request header as anEnumerationofStringobjects.getHost()Obtain the mapping information for this request.Retrieves the body of the request as binary data using aServletInputStream.intgetIntHeader(String name) Returns the value of the specified request header as anint.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.getPathParameter(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.Returns the query string that is contained in the request URL after the path.Retrieves the body of the request as character data using aBufferedReader.getRealPath(String path) Deprecated.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.Get the request path.Returns the URI path part of this request's URL which starts after the authority (if any) and ends before the query string delimiter (?), if any.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.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.booleanDeprecated.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) voidvoidremoveAttribute(String name) Removes an attribute from this request.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) Stores an attribute in this request.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.voidsetMaxParameterCount(int maxParameterCount) Set the maximum number of request parameters (GET plus POST including multipart) for a single request.voidsetMaxPartCount(int maxPartCount) Set the maximum number of parts for a single multipart request.voidsetMaxPartHeaderSize(int maxPartHeaderSize) Set the maximum header size per part for a single multipart 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
-
coyoteRequest
Coyote request. -
GMT_ZONE
Deprecated.Unused. This will be removed in Tomcat 10. -
sm
The string manager for this package. -
cookies
The set of cookies associated with this Request. -
formats
Deprecated.Unused. This will be removed in Tomcat 10The set of SimpleDateFormat formats to use in getDateHeader(). Notice that because SimpleDateFormat is not thread-safe, we can't declare formats[] as a static variable. -
defaultLocale
The default Locale if none are specified. -
sslAttributesParsed
protected boolean sslAttributesParsedFlag that indicates if SSL attributes have been parsed to improve performance for applications (usually frameworks) that make multiple calls togetAttributeNames(). -
locales
-
authType
Authentication type. -
internalDispatcherType
The current dispatcher type. -
inputBuffer
The associated input buffer. -
inputStream
ServletInputStream. -
reader
Reader. -
usingInputStream
protected boolean usingInputStreamUsing stream flag. -
usingReader
protected boolean usingReaderUsing reader flag. -
userPrincipal
User principal. -
parametersParsed
protected boolean parametersParsedRequest parameters parsed flag. -
cookiesParsed
protected boolean cookiesParsedCookie headers parsed flag. Indicates that the cookie headers have been parsed into ServerCookies. -
cookiesConverted
protected boolean cookiesConvertedCookie parsed flag. Indicates that the ServerCookies have been converted into user facing Cookie objects. -
secure
protected boolean secureSecure flag. -
subject
The Subject associated with the current AccessControlContext -
CACHED_POST_LEN
protected static final int CACHED_POST_LENPost data buffer.- See Also:
-
postData
protected byte[] postData -
parameterMap
Hash map used in the getParametersMap method. -
parts
The parts, if any, uploaded with this request. -
partsParseException
The exception thrown, if any when parsing the parts. -
session
The currently active session for this request. -
requestDispatcherPath
The current request dispatcher path. -
requestedSessionCookie
protected boolean requestedSessionCookieWas the requested session ID received in a cookie? -
requestedSessionId
The requested session ID (if any) for this request. -
requestedSessionURL
protected boolean requestedSessionURLWas the requested session ID received in a URL? -
requestedSessionSSL
protected boolean requestedSessionSSLWas the requested session ID obtained from the SSL session? -
localesParsed
protected boolean localesParsedParse locales. -
localPort
protected int localPortLocal port -
remoteAddr
Remote address. -
peerAddr
Connection peer address. -
remoteHost
Remote host. -
remotePort
protected int remotePortRemote port -
localAddr
Local address -
localName
Local address -
asyncSupported
-
connector
Associated Catalina connector. -
filterChain
Filter chain associated with the request. -
mappingData
Mapping data. -
facade
The facade associated with this request. -
response
The response with which this request is associated. -
URIConverter
URI byte to char converter.
-
-
Constructor Details
-
Request
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 Details
-
setCoyoteRequest
Set the Coyote request.- Parameters:
coyoteRequest- The Coyote request
-
getCoyoteRequest
-
addPathParameter
-
getPathParameter
-
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
public void recycleSessionInfo() -
recycleCookieInfo
protected void recycleCookieInfo(boolean recycleCoyote) -
getConnector
- Returns:
- the Connector through which this Request was received.
-
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
trueif no connector is associated with this request
-
getFilterChain
Get filter chain associated with the request.- Returns:
- the associated filter chain
-
setFilterChain
Set 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.
-
setRequest
Set 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.
-
setResponse
Set 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.
-
setURIConverter
Set the URI converter.- Parameters:
URIConverter- the new URI converter
-
getWrapper
- Returns:
- the Wrapper within which this Request is being processed.
-
createInputStream
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
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
-
removeNote
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
-
setRemoteAddr
Set the IP address of the remote client associated with this Request.- Parameters:
remoteAddr- The remote IP address
-
setRemoteHost
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 byisSecure()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
-
setMaxParameterCount
public void setMaxParameterCount(int maxParameterCount) Set the maximum number of request parameters (GET plus POST including multipart) for a single request.- Parameters:
maxParameterCount- The maximum number of request parameters
-
setMaxPartCount
public void setMaxPartCount(int maxPartCount) Set the maximum number of parts for a single multipart request.- Parameters:
maxPartCount- The maximum number of request parts
-
setMaxPartHeaderSize
public void setMaxPartHeaderSize(int maxPartHeaderSize) Set the maximum header size per part for a single multipart request.- Parameters:
maxPartHeaderSize- The maximum size of the headers for one part
-
getAttribute
Description copied from interface:javax.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
javax.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
java.*andjavax.*are reserved for use by the Servlet specification. Names beginning withsun.*,com.sun.*,oracle.*andcom.oracle.*) are reserved for use by Oracle Corporation.- Specified by:
getAttributein interfaceServletRequest- Parameters:
name- aStringspecifying the name of the attribute- Returns:
- an
Objectcontaining the value of the attribute, ornullif the attribute does not exist
-
getContentLengthLong
public long getContentLengthLong()Description copied from interface:javax.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 interfaceServletRequest- Returns:
- a long integer containing the length of the request body or -1 if the length is not known
-
getAttributeNames
Returns anEnumerationcontaining the names of the attributes available to this request. This method returns an emptyEnumerationif the request has no attributes available to it.The attribute names returned will only be those for the attributes set via
setAttribute(String, Object). Tomcat internal attributes will not be included even though they are accessible viagetAttribute(String). The Tomcat internal attributes include:Globals.DISPATCHER_TYPE_ATTRGlobals.DISPATCHER_REQUEST_PATH_ATTRGlobals.ASYNC_SUPPORTED_ATTRGlobals.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 interfaceServletRequest- Returns:
- an
Enumerationof strings containing the names of the request's attributes
-
getCharacterEncoding
Description copied from interface:javax.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 interfaceServletRequest- Returns:
- a
Stringcontaining the name of the character encoding, ornullif the request does not specify a character encoding
-
getContentLength
public int getContentLength()Description copied from interface:javax.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 interfaceServletRequest- Returns:
- an integer containing the length of the request body or -1 if the length is not known or is greater than
Integer.MAX_VALUE
-
getContentType
Description copied from interface:javax.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 interfaceServletRequest- Returns:
- a
Stringcontaining the name of the MIME type of the request, or null if the type is not known
-
setContentType
Set the content type for this Request.- Parameters:
contentType- The content type
-
getInputStream
Description copied from interface:javax.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 interfaceServletRequest- Returns:
- a
ServletInputStreamobject containing the body of the request - Throws:
IOException- if an input or output exception occurred
-
getLocale
Description copied from interface:javax.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 interfaceServletRequest- Returns:
- the preferred
Localefor the client
-
getLocales
Description copied from interface:javax.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 interfaceServletRequest- Returns:
- an
Enumerationof preferredLocaleobjects for the client
-
getParameter
Description copied from interface:javax.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 interfaceServletRequest- 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:
-
getParameterMap
Returns 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 interfaceServletRequest- Returns:
- A
Mapcontaining parameter names as keys and parameter values as map values.
-
getParameterNames
Description copied from interface:javax.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 interfaceServletRequest- Returns:
- the names of all defined request parameters for this request.
-
getParameterValues
Description copied from interface:javax.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 interfaceServletRequest- Parameters:
name- Name of the desired request parameter- Returns:
- the defined values for the specified request parameter, if any; otherwise, return
null. - See Also:
-
getProtocol
Description copied from interface:javax.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 interfaceServletRequest- Returns:
- a
Stringcontaining the protocol name and version number
-
getReader
Description copied from interface:javax.servlet.ServletRequestRetrieves the body of the request as character data using aBufferedReader. The reader translates the character data according to the character encoding used on the body. Either this method orServletRequest.getInputStream()may be called to read the body, not both.- Specified by:
getReaderin interfaceServletRequest- Returns:
- a
BufferedReadercontaining the body of the request - Throws:
IOException- if an input or output exception occurred- See Also:
-
getRealPath
Deprecated.- Specified by:
getRealPathin interfaceServletRequest- Parameters:
path- The virtual path to be converted to a real path- Returns:
ServletContext.getRealPath(String)
-
getRemoteAddr
Description copied from interface:javax.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 interfaceServletRequest- Returns:
- a
Stringcontaining the IP address of the client that sent the request
-
getPeerAddr
- Returns:
- the connection peer IP address making this Request.
-
getRemoteHost
Description copied from interface:javax.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 interfaceServletRequest- Returns:
- a
Stringcontaining the fully qualified name of the client
-
getRemotePort
public int getRemotePort()Description copied from interface:javax.servlet.ServletRequestReturns the Internet Protocol (IP) source port of the client or last proxy that sent the request.- Specified by:
getRemotePortin interfaceServletRequest- Returns:
- an integer specifying the port number
-
getLocalName
Description copied from interface:javax.servlet.ServletRequestReturns the host name of the Internet Protocol (IP) interface on which the request was received.- Specified by:
getLocalNamein interfaceServletRequest- Returns:
- a
Stringcontaining the host name of the IP on which the request was received.
-
getLocalAddr
Description copied from interface:javax.servlet.ServletRequestReturns the Internet Protocol (IP) address of the interface on which the request was received.- Specified by:
getLocalAddrin interfaceServletRequest- Returns:
- a
Stringcontaining the IP address on which the request was received.
-
getLocalPort
public int getLocalPort()Description copied from interface:javax.servlet.ServletRequestReturns the Internet Protocol (IP) port number of the interface on which the request was received.- Specified by:
getLocalPortin interfaceServletRequest- Returns:
- an integer specifying the port number
-
getRequestDispatcher
Description copied from interface:javax.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 interfaceServletRequest- Parameters:
path- aStringspecifying the pathname to the resource. If it is relative, it must be relative against the current servlet.- Returns:
- a
RequestDispatcherobject that acts as a wrapper for the resource at the specified path, ornullif the servlet container cannot return aRequestDispatcher - See Also:
-
getScheme
Description copied from interface:javax.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 interfaceServletRequest- Returns:
- a
Stringcontaining the name of the scheme used to make this request
-
getServerName
Description copied from interface:javax.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 interfaceServletRequest- Returns:
- a
Stringcontaining the name of the server
-
getServerPort
public int getServerPort()Description copied from interface:javax.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 interfaceServletRequest- Returns:
- an integer specifying the port number
-
isSecure
public boolean isSecure()Description copied from interface:javax.servlet.ServletRequestReturns a boolean indicating whether this request was made using a secure channel, such as HTTPS.- Specified by:
isSecurein interfaceServletRequest- Returns:
- a boolean indicating if the request was made using a secure channel
-
removeAttribute
Description copied from interface:javax.servlet.ServletRequestRemoves an attribute from this request. This method is not generally needed as attributes only persist as long as the request is being handled.Attribute names should follow the same conventions as package names. Names beginning with
java.*andjavax.*are reserved for use by the Servlet specification. Names beginning withsun.*,com.sun.*,oracle.*andcom.oracle.*) are reserved for use by Oracle Corporation.- Specified by:
removeAttributein interfaceServletRequest- Parameters:
name- aStringspecifying the name of the attribute to remove
-
setAttribute
Description copied from interface:javax.servlet.ServletRequestStores an attribute in this request. Attributes are reset between requests. This method is most often used in conjunction withRequestDispatcher.Attribute names should follow the same conventions as package names. Names beginning with
java.*andjavax.*are reserved for use by the Servlet specification. Names beginning withsun.*,com.sun.*,oracle.*andcom.oracle.*) are reserved for use by Oracle Corporation.
If the object passed in is null, the effect is the same as callingServletRequest.removeAttribute(java.lang.String).
It is warned that when the request is dispatched from the servlet resides in a different web application byRequestDispatcher, the object set by this method may not be correctly retrieved in the caller servlet.- Specified by:
setAttributein interfaceServletRequest- Parameters:
name- aStringspecifying the name of the attributevalue- theObjectto be stored
-
setCharacterEncoding
Description copied from interface:javax.servlet.ServletRequestOverrides 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:
setCharacterEncodingin interfaceServletRequest- Parameters:
enc- aStringcontaining the name of the character encoding- Throws:
UnsupportedEncodingException- if this is not a valid encoding
-
getServletContext
- Specified by:
getServletContextin interfaceServletRequest- Returns:
- TODO
-
startAsync
- Specified by:
startAsyncin interfaceServletRequest- Returns:
- TODO
-
startAsync
- Specified by:
startAsyncin interfaceServletRequest- Parameters:
request- The ServletRequest with which to initialise the asynchronous contextresponse- The ServletResponse with which to initialise the asynchronous context- Returns:
- TODO
-
isAsyncStarted
public boolean isAsyncStarted()- Specified by:
isAsyncStartedin interfaceServletRequest- Returns:
- TODO
-
isAsyncDispatching
public boolean isAsyncDispatching() -
isAsyncCompleting
public boolean isAsyncCompleting() -
isAsync
public boolean isAsync() -
isAsyncSupported
public boolean isAsyncSupported()- Specified by:
isAsyncSupportedin interfaceServletRequest- Returns:
- TODO
-
getAsyncContext
Description copied from interface:javax.servlet.ServletRequestGet the current AsyncContext.- Specified by:
getAsyncContextin interfaceServletRequest- Returns:
- The current AsyncContext
-
getAsyncContextInternal
-
getDispatcherType
- Specified by:
getDispatcherTypein interfaceServletRequest- Returns:
- TODO
-
addCookie
Add a Cookie to the set of Cookies associated with this Request.- Parameters:
cookie- The new cookie
-
addLocale
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
Set 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
-
setPathInfo
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
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
Get the decoded request URI.- Returns:
- the URL decoded request URI
-
getDecodedRequestURIMB
Get the decoded request URI.- Returns:
- the URL decoded request URI
-
setUserPrincipal
Set 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
-
isTrailerFieldsReady
public boolean isTrailerFieldsReady()Description copied from interface:javax.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 interfaceHttpServletRequest- Returns:
trueif trailers are ready to be read
-
getTrailerFields
Description copied from interface:javax.servlet.http.HttpServletRequestObtain a Map of the trailer fields that is not backed by the request object.- Specified by:
getTrailerFieldsin interfaceHttpServletRequest- Returns:
- A Map of the received trailer fields with all keys lower case or an empty Map if no trailers are present
-
newPushBuilder
Description copied from interface:javax.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 interfaceHttpServletRequest- 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
-
upgrade
public <T extends HttpUpgradeHandler> T upgrade(Class<T> httpUpgradeHandlerClass) throws IOException, ServletException Description copied from interface:javax.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 interfaceHttpServletRequest- 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 upgradeServletException- if the given httpUpgradeHandlerClass fails to be instantiated
-
getAuthType
Description copied from interface:javax.servlet.http.HttpServletRequestReturns the name of the authentication scheme used to protect the servlet. All servlet containers support basic, form and client certificate authentication, and may additionally support digest authentication. If the servlet is not authenticatednullis returned.Same as the value of the CGI variable AUTH_TYPE.
- Specified by:
getAuthTypein interfaceHttpServletRequest- 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.
-
getContextPath
Description copied from interface:javax.servlet.http.HttpServletRequestReturns the portion of the request URI that indicates the context of the request. The context path always comes first in a request URI. The path starts with a "/" character but does not end with a "/" character. For servlets in the default (root) context, this method returns "". The container does not decode this string.- Specified by:
getContextPathin interfaceHttpServletRequest- Returns:
- a
Stringspecifying the portion of the request URI that indicates the context of the request
-
getCookies
Description copied from interface:javax.servlet.http.HttpServletRequestReturns an array containing all of theCookieobjects the client sent with this request. This method returnsnullif no cookies were sent.- Specified by:
getCookiesin interfaceHttpServletRequest- Returns:
- an array of all the
Cookiesincluded with this request, ornullif the request has no cookies
-
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
Description copied from interface:javax.servlet.http.HttpServletRequestReturns the value of the specified request header as alongvalue that represents aDateobject. Use this method with headers that contain dates, such asIf-Modified-Since.The date is returned as the number of milliseconds since January 1, 1970 GMT. The header name is case insensitive.
If the request did not have a header of the specified name, this method returns -1. If the header can't be converted to a date, the method throws an
IllegalArgumentException.- Specified by:
getDateHeaderin interfaceHttpServletRequest- Parameters:
name- aStringspecifying the name of the header- Returns:
- a
longvalue representing the date specified in the header expressed as the number of milliseconds since January 1, 1970 GMT, or -1 if the named header was not included with the request
-
getHeader
Description copied from interface:javax.servlet.http.HttpServletRequestReturns the value of the specified request header as aString. If the request did not include a header of the specified name, this method returnsnull. If there are multiple headers with the same name, this method returns the first head in the request. The header name is case insensitive. You can use this method with any request header.- Specified by:
getHeaderin interfaceHttpServletRequest- Parameters:
name- aStringspecifying the header name- Returns:
- a
Stringcontaining the value of the requested header, ornullif the request does not have a header of that name
-
getHeaders
Description copied from interface:javax.servlet.http.HttpServletRequestReturns all the values of the specified request header as anEnumerationofStringobjects.Some headers, such as
Accept-Languagecan be sent by clients as several headers each with a different value rather than sending the header as a comma separated list.If the request did not include any headers of the specified name, this method returns an empty
Enumeration. The header name is case insensitive. You can use this method with any request header.- Specified by:
getHeadersin interfaceHttpServletRequest- Parameters:
name- aStringspecifying the header name- Returns:
- an
Enumerationcontaining the values of the requested header. If the request does not have any headers of that name return an empty enumeration. If the container does not allow access to header information, return null
-
getHeaderNames
Description copied from interface:javax.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 interfaceHttpServletRequest- Returns:
- an enumeration of all the header names sent with this request; if the request has no headers, an empty
enumeration; if the servlet container does not allow servlets to use this method,
null
-
getIntHeader
Description copied from interface:javax.servlet.http.HttpServletRequestReturns the value of the specified request header as anint. If the request does not have a header of the specified name, this method returns -1. If the header cannot be converted to an integer, this method throws aNumberFormatException.The header name is case insensitive.
- Specified by:
getIntHeaderin interfaceHttpServletRequest- Parameters:
name- aStringspecifying the name of a request header- Returns:
- an integer expressing the value of the request header or -1 if the request doesn't have a header of this name
-
getHttpServletMapping
Description copied from interface:javax.servlet.http.HttpServletRequestObtain the mapping information for this request.- Specified by:
getHttpServletMappingin interfaceHttpServletRequest- Returns:
- the mapping information for this request
-
getMethod
Description copied from interface:javax.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 interfaceHttpServletRequest- Returns:
- a
Stringspecifying the name of the method with which this request was made
-
getPathInfo
Description copied from interface:javax.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.Same as the value of the CGI variable PATH_INFO.
- Specified by:
getPathInfoin interfaceHttpServletRequest- Returns:
- a
String, decoded by the web container, specifying extra path information that comes after the servlet path but before the query string in the request URL; ornullif the URL does not have any extra path information
-
getPathTranslated
Description copied from interface:javax.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 interfaceHttpServletRequest- Returns:
- a
Stringspecifying the real path, ornullif the URL does not have any extra path information
-
getQueryString
Description copied from interface:javax.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 interfaceHttpServletRequest- Returns:
- a
Stringcontaining the query string ornullif the URL contains no query string. The value is not decoded by the container.
-
getRemoteUser
Description copied from interface:javax.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 interfaceHttpServletRequest- Returns:
- a
Stringspecifying the login of the user making this request, ornullif the user login is not known
-
getRequestPathMB
-
getRequestedSessionId
Description copied from interface:javax.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 interfaceHttpServletRequest- Returns:
- a
Stringspecifying the session ID, ornullif the request did not specify a session ID - See Also:
-
getRequestURI
Description copied from interface:javax.servlet.http.HttpServletRequestReturns the URI path part of this request's URL which starts after the authority (if any) and ends before the query string delimiter (?), if any. 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 interfaceHttpServletRequest- Returns:
- a
Stringcontaining the path part of the URL from after the authority to before the query string - See Also:
-
getRequestURL
Description copied from interface:javax.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 interfaceHttpServletRequest- Returns:
- a
StringBufferobject containing the reconstructed URL
-
getServletPath
Description copied from interface:javax.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.This method will return an empty string ("") if the servlet used to process this request was matched using the "/*" pattern.
- Specified by:
getServletPathin interfaceHttpServletRequest- Returns:
- a
Stringcontaining the name or path of the servlet being called, as specified in the request URL, decoded, or an empty string if the servlet used to process the request is matched using the "/*" pattern.
-
getSession
Description copied from interface:javax.servlet.http.HttpServletRequestReturns the current session associated with this request, or if the request does not have a session, creates one.- Specified by:
getSessionin interfaceHttpServletRequest- Returns:
- the
HttpSessionassociated with this request - See Also:
-
getSession
Description copied from interface:javax.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 interfaceHttpServletRequest- Parameters:
create-trueto create a new session for this request if necessary;falseto returnnullif there's no current session- Returns:
- the
HttpSessionassociated with this request ornullifcreateisfalseand the request has no valid session - See Also:
-
isRequestedSessionIdFromCookie
public boolean isRequestedSessionIdFromCookie()Description copied from interface:javax.servlet.http.HttpServletRequestChecks whether the requested session ID came in as a cookie.- Specified by:
isRequestedSessionIdFromCookiein interfaceHttpServletRequest- Returns:
trueif the session ID came in as a cookie; otherwise,false- See Also:
-
isRequestedSessionIdFromURL
public boolean isRequestedSessionIdFromURL()Description copied from interface:javax.servlet.http.HttpServletRequestChecks whether the requested session ID came in as part of the request URL.- Specified by:
isRequestedSessionIdFromURLin interfaceHttpServletRequest- Returns:
trueif the session ID came in as part of a URL; otherwise,false- See Also:
-
isRequestedSessionIdFromUrl
Deprecated.- Specified by:
isRequestedSessionIdFromUrlin interfaceHttpServletRequest- Returns:
HttpServletRequest.isRequestedSessionIdFromURL()
-
isRequestedSessionIdValid
public boolean isRequestedSessionIdValid()Description copied from interface:javax.servlet.http.HttpServletRequestChecks whether the requested session ID is still valid.- Specified by:
isRequestedSessionIdValidin interfaceHttpServletRequest- Returns:
trueif this request has an id for a valid session in the current session context;falseotherwise- See Also:
-
isUserInRole
Description copied from interface:javax.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 interfaceHttpServletRequest- Parameters:
role- aStringspecifying the name of the role- Returns:
- a
booleanindicating whether the user making this request belongs to a given role;falseif the user has not been authenticated
-
getPrincipal
- Returns:
- the principal that has been authenticated for this Request.
-
getUserPrincipal
Description copied from interface:javax.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 interfaceHttpServletRequest- Returns:
- a
java.security.Principalcontaining the name of the user making this request;nullif the user has not been authenticated
-
getSessionInternal
- Returns:
- the session associated with this Request, creating one if necessary.
-
changeSessionId
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
-
changeSessionId
Description copied from interface:javax.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 interfaceHttpServletRequest- 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.
-
isParametersParsed
public boolean isParametersParsed()- Returns:
trueif we have parsed parameters
-
isFinished
public boolean isFinished()- Returns:
trueif 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
Description copied from interface:javax.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 interfaceHttpServletRequest- Parameters:
response- The response to use to return any authentication challenge- Returns:
trueif the user is successfully authenticated andfalseif not- Throws:
IOException- if the authentication process attempted to read from the request or write to the response and an I/O error occurredServletException- if the authentication failed and the caller is expected to handle the failure
-
login
Description copied from interface:javax.servlet.http.HttpServletRequestAuthenticate the provided user name and password and then associated the authenticated user with the request.- Specified by:
loginin interfaceHttpServletRequest- Parameters:
username- The user name to authenticatepassword- The password to use to authenticate the user- Throws:
ServletException- If any ofHttpServletRequest.getRemoteUser(),HttpServletRequest.getUserPrincipal()orHttpServletRequest.getAuthType()are non-null, if the configured authenticator does not support user name and password authentication or if the authentication fails
-
logout
Description copied from interface:javax.servlet.http.HttpServletRequestRemoves any authenticated user from the request.- Specified by:
logoutin interfaceHttpServletRequest- Throws:
ServletException- If the logout fails
-
getParts
Description copied from interface:javax.servlet.http.HttpServletRequestReturn a collection of all uploaded Parts.- Specified by:
getPartsin interfaceHttpServletRequest- Returns:
- A collection of all uploaded Parts.
- Throws:
IOException- if an I/O error occursIllegalStateException- if size limits are exceeded or no multipart configuration is providedServletException- if the request is not multipart/form-data
-
getPart
Description copied from interface:javax.servlet.http.HttpServletRequestGets the named Part or null if the Part does not exist. Triggers upload of all Parts.- Specified by:
getPartin interfaceHttpServletRequest- 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 occursIllegalStateException- if size limits are exceededServletException- if the request is not multipart/form-data
-
doGetSession
-
unescape
-
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
Deprecated.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 readlen- The body length- Returns:
- the bytes count that has been read
- Throws:
IOException- if an IO exception occurred
-
readPostBodyFully
Read post body into an array.- Parameters:
body- The bytes array in which the body will be readlen- The body length- Throws:
IOException- if an IO exception occurred or EOF is reached before the body has been fully read
-
readChunkedPostBody
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
-