Class Request
- java.lang.Object
- 
- org.apache.catalina.connector.Request
 
- 
- All Implemented Interfaces:
- HttpServletRequest,- ServletRequest
 
 public class Request extends java.lang.Object implements HttpServletRequest Wrapper object for the Coyote request.- Author:
- Remy Maucherat, Craig R. McClanahan
 
- 
- 
Field SummaryFields Modifier and Type Field Description protected java.lang.BooleanasyncSupportedprotected java.lang.StringauthTypeAuthentication type.protected static intCACHED_POST_LENPost data buffer.protected ConnectorconnectorAssociated Catalina connector.protected Cookie[]cookiesThe set of cookies associated with this Request.protected booleancookiesConvertedCookie parsed flag.protected booleancookiesParsedCookie headers parsed flag.protected RequestcoyoteRequestCoyote request.protected static java.util.LocaledefaultLocaleThe default Locale if none are specified.protected RequestFacadefacadeThe facade associated with this request.protected FilterChainfilterChainFilter chain associated with the request.protected java.text.SimpleDateFormat[]formatsDeprecated.Unused.protected static java.util.TimeZoneGMT_ZONEDeprecated.Unused.protected InputBufferinputBufferThe associated input buffer.protected CoyoteInputStreaminputStreamServletInputStream.protected DispatcherTypeinternalDispatcherTypeThe current dispatcher type.protected java.lang.StringlocalAddrLocal addressprotected java.util.ArrayList<java.util.Locale>localesThe preferred Locales associated with this Request.protected booleanlocalesParsedParse locales.protected java.lang.StringlocalNameLocal addressprotected intlocalPortLocal portprotected MappingDatamappingDataMapping data.protected ParameterMap<java.lang.String,java.lang.String[]>parameterMapHash map used in the getParametersMap method.protected booleanparametersParsedRequest parameters parsed flag.protected java.util.Collection<Part>partsThe parts, if any, uploaded with this request.protected java.lang.ExceptionpartsParseExceptionThe exception thrown, if any when parsing the parts.protected java.lang.StringpeerAddrConnection peer address.protected byte[]postDataprotected CoyoteReaderreaderReader.protected java.lang.StringremoteAddrRemote address.protected java.lang.StringremoteHostRemote host.protected intremotePortRemote portprotected java.lang.ObjectrequestDispatcherPathThe current request dispatcher path.protected booleanrequestedSessionCookieWas the requested session ID received in a cookie?protected java.lang.StringrequestedSessionIdThe requested session ID (if any) for this request.protected booleanrequestedSessionSSLWas the requested session ID obtained from the SSL session?protected booleanrequestedSessionURLWas the requested session ID received in a URL?protected ResponseresponseThe response with which this request is associated.protected booleansecureSecure flag.protected SessionsessionThe currently active session for this request.protected static StringManagersmThe string manager for this package.protected booleansslAttributesParsedFlag that indicates if SSL attributes have been parsed to improve performance for applications (usually frameworks) that make multiple calls togetAttributeNames().protected javax.security.auth.SubjectsubjectThe Subject associated with the current AccessControlContextprotected B2CConverterURIConverterURI byte to char converter.protected java.security.PrincipaluserPrincipalUser principal.protected booleanusingInputStreamUsing stream flag.protected booleanusingReaderUsing reader flag.- 
Fields inherited from interface javax.servlet.http.HttpServletRequestBASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
 
- 
 - 
Constructor SummaryConstructors Constructor Description Request()
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaddCookie(Cookie cookie)Add a Cookie to the set of Cookies associated with this Request.voidaddLocale(java.util.Locale locale)Add a Locale to the set of preferred Locales for this Request.protected voidaddPathParameter(java.lang.String name, java.lang.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.java.lang.StringchangeSessionId()Changes the session ID of the session associated with this request.voidchangeSessionId(java.lang.String newSessionId)Change the ID of the session that this request is associated with.protected voidcheckSwallowInput()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.voidclearCookies()Clear the collection of Cookies associated with this Request.voidclearLocales()Clear the collection of Locales associated with this Request.protected voidconvertCookies()Converts the parsed cookies (parsing the Cookie headers first if they have not been parsed) into Cookie objects.ServletInputStreamcreateInputStream()Create and return a ServletInputStream to read the content associated with this Request.protected SessiondoGetSession(boolean create)voidfinishRequest()Perform whatever actions are required to flush and close the input stream or reader, in a single operation.AsyncContextgetAsyncContext()Get the current AsyncContext.AsyncContextImplgetAsyncContextInternal()java.lang.ObjectgetAttribute(java.lang.String name)Returns the value of the named attribute as anObject, ornullif no attribute of the given name exists.java.util.Enumeration<java.lang.String>getAttributeNames()Return the names of all request attributes for this Request, or an emptyEnumerationif there are none.java.lang.StringgetAuthType()Return the authentication type used for this Request.java.lang.StringgetCharacterEncoding()Returns the name of the character encoding used in the body of this request.ConnectorgetConnector()intgetContentLength()Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known.longgetContentLengthLong()Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known.java.lang.StringgetContentType()Returns the MIME type of the body of the request, ornullif the type is not known.ContextgetContext()Return the Context within which this Request is being processed.java.lang.StringgetContextPath()Return the portion of the request URI used to select the Context of the Request.Cookie[]getCookies()Return the set of Cookies received with this Request.RequestgetCoyoteRequest()Get the Coyote request.longgetDateHeader(java.lang.String name)Return the value of the specified date header, if any; otherwise return -1.java.lang.StringgetDecodedRequestURI()Get the decoded request URI.MessageBytesgetDecodedRequestURIMB()Get the decoded request URI.booleangetDiscardFacades()Get the recycling strategy of the facade objects.DispatcherTypegetDispatcherType()FilterChaingetFilterChain()Get filter chain associated with the request.java.lang.StringgetHeader(java.lang.String name)Return the first value of the specified header, if any; otherwise, returnnulljava.util.Enumeration<java.lang.String>getHeaderNames()Returns an enumeration of all the header names this request contains.java.util.Enumeration<java.lang.String>getHeaders(java.lang.String name)Return all of the values of the specified header, if any; otherwise, return an empty enumeration.HostgetHost()ApplicationMappingImplgetHttpServletMapping()ServletInputStreamgetInputStream()Retrieves the body of the request as binary data using aServletInputStream.intgetIntHeader(java.lang.String name)Return the value of the specified header as an integer, or -1 if there is no such header for this request.java.lang.StringgetLocalAddr()Returns the Internet Protocol (IP) address of the interface on which the request was received.java.util.LocalegetLocale()Returns the preferredLocalethat the client will accept content in, based on the Accept-Language header.java.util.Enumeration<java.util.Locale>getLocales()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.java.lang.StringgetLocalName()Returns the host name of the Internet Protocol (IP) interface on which the request was received.intgetLocalPort()Returns the Internet Protocol (IP) port number of the interface on which the request was received.MappingDatagetMappingData()java.lang.StringgetMethod()Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.java.lang.ObjectgetNote(java.lang.String name)java.lang.StringgetParameter(java.lang.String name)Returns the value of a request parameter as aString, ornullif the parameter does not exist.java.util.Map<java.lang.String,java.lang.String[]>getParameterMap()Returns aMapof the parameters of this request.java.util.Enumeration<java.lang.String>getParameterNames()Returns anEnumerationofStringobjects containing the names of the parameters contained in this request.java.lang.String[]getParameterValues(java.lang.String name)Returns an array ofStringobjects containing all of the values the given request parameter has, ornullif the parameter does not exist.PartgetPart(java.lang.String name)Gets the named Part or null if the Part does not exist.java.util.Collection<Part>getParts()Return a collection of all uploaded Parts.java.lang.StringgetPathInfo()Returns any extra path information associated with the URL the client sent when it made this request.protected java.lang.StringgetPathParameter(java.lang.String name)java.lang.StringgetPathTranslated()Returns any extra path information after the servlet name but before the query string, and translates it to a real path.java.lang.StringgetPeerAddr()java.security.PrincipalgetPrincipal()java.lang.StringgetProtocol()Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1.java.lang.StringgetQueryString()Returns the query string that is contained in the request URL after the path.java.io.BufferedReadergetReader()Read the Reader wrapping the input stream for this Request.java.lang.StringgetRealPath(java.lang.String path)Deprecated.As of version 2.1 of the Java Servlet API, useServletContext.getRealPath().java.lang.StringgetRemoteAddr()Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.java.lang.StringgetRemoteHost()Returns the fully qualified name of the client or the last proxy that sent the request.intgetRemotePort()Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.java.lang.StringgetRemoteUser()Returns the login of the user making this request, if the user has been authenticated, ornullif the user has not been authenticated.HttpServletRequestgetRequest()RequestDispatchergetRequestDispatcher(java.lang.String path)Returns aRequestDispatcherobject that acts as a wrapper for the resource located at the given path.java.lang.StringgetRequestedSessionId()Returns the session ID specified by the client.MessageBytesgetRequestPathMB()Get the request path.java.lang.StringgetRequestURI()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.java.lang.StringBuffergetRequestURL()Reconstructs the URL the client used to make the request.ResponsegetResponse()java.lang.StringgetScheme()Returns the name of the scheme used to make this request, for example,http,https, orftp.ServerCookiesgetServerCookies()Return the server representation of the cookies associated with this request.java.lang.StringgetServerName()Returns the host name of the server to which the request was sent.intgetServerPort()Returns the port number to which the request was sent.ServletContextgetServletContext()java.lang.StringgetServletPath()Returns the part of this request's URL that calls the servlet.HttpSessiongetSession()Returns the current session associated with this request, or if the request does not have a session, creates one.HttpSessiongetSession(boolean create)Returns the currentHttpSessionassociated with this request or, if there is no current session andcreateis true, returns a new session.SessiongetSessionInternal()SessiongetSessionInternal(boolean create)java.io.InputStreamgetStream()protected B2CConvertergetURIConverter()java.security.PrincipalgetUserPrincipal()Returns ajava.security.Principalobject containing the name of the current authenticated user.WrappergetWrapper()booleanisAsync()booleanisAsyncCompleting()booleanisAsyncDispatching()booleanisAsyncStarted()booleanisAsyncSupported()booleanisFinished()booleanisParametersParsed()booleanisRequestedSessionIdFromCookie()Checks whether the requested session ID came in as a cookie.booleanisRequestedSessionIdFromUrl()Deprecated.As of Version 2.1 of the Java Servlet API, useisRequestedSessionIdFromURL()instead.booleanisRequestedSessionIdFromURL()Checks whether the requested session ID came in as part of the request URL.booleanisRequestedSessionIdValid()Checks 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.booleanisUserInRole(java.lang.String role)Returns a boolean indicating whether the authenticated user is included in the specified logical "role".voidlogin(java.lang.String username, java.lang.String password)Authenticate the provided user name and password and then associated the authenticated user with the request.voidlogout()Removes any authenticated user from the request.ApplicationPushBuildernewPushBuilder()ApplicationPushBuildernewPushBuilder(HttpServletRequest request)protected voidparseCookies()Parse cookies.protected voidparseLocales()Parse request locales.protected voidparseLocalesHeader(java.lang.String value, java.util.TreeMap<java.lang.Double,java.util.ArrayList<java.util.Locale>> locales)Parse accept-language header value.protected voidparseParameters()Parse request parameters.protected byte[]readChunkedPostBody()Read chunked post body.protected intreadPostBody(byte[] body, int len)Read post body in an array.voidrecycle()Release all object references, and initialize instance variables, in preparation for reuse of this object.protected voidrecycleCookieInfo(boolean recycleCoyote)protected voidrecycleSessionInfo()voidremoveAttribute(java.lang.String name)Remove the specified request attribute if it exists.voidremoveNote(java.lang.String name)Remove any object bound to the specified name in the internal notes for this request.voidsetAsyncSupported(boolean asyncSupported)voidsetAttribute(java.lang.String name, java.lang.Object value)Set the specified request attribute to the specified value.voidsetAuthType(java.lang.String type)Set the authentication type used for this request, if any; otherwise set the type tonull.voidsetCharacterEncoding(java.lang.String enc)Overrides the name of the character encoding used in the body of this request.voidsetConnector(Connector connector)Set the Connector through which this Request was received.voidsetContentType(java.lang.String contentType)Set the content type for this Request.voidsetContext(Context context)Deprecated.Use setters onMappingDataobject.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.voidsetNote(java.lang.String name, java.lang.Object value)Bind an object to a specified name in the internal notes associated with this request, replacing any existing binding for this name.voidsetPathInfo(java.lang.String path)Set the path information for this Request.voidsetRemoteAddr(java.lang.String remoteAddr)Set the IP address of the remote client associated with this Request.voidsetRemoteHost(java.lang.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.voidsetRequestedSessionId(java.lang.String id)Set 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(java.security.Principal principal)Set the Principal who has been authenticated for this Request.voidsetWrapper(Wrapper wrapper)Deprecated.Use setters onMappingDataobject.AsyncContextstartAsync()AsyncContextstartAsync(ServletRequest request, ServletResponse response)protected java.lang.Stringunescape(java.lang.String s)<T extends HttpUpgradeHandler>
 Tupgrade(java.lang.Class<T> httpUpgradeHandlerClass)Start the HTTP upgrade process and create and instance of the provided protocol handler class.
 
- 
- 
- 
Field Detail- 
coyoteRequestprotected Request coyoteRequest Coyote request.
 - 
GMT_ZONE@Deprecated protected static final java.util.TimeZone GMT_ZONE Deprecated.Unused. This will be removed in Tomcat 10.
 - 
smprotected static final StringManager sm The string manager for this package.
 - 
cookiesprotected Cookie[] cookies The set of cookies associated with this Request.
 - 
formats@Deprecated protected final java.text.SimpleDateFormat[] 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.
 - 
defaultLocaleprotected static final java.util.Locale defaultLocale The default Locale if none are specified.
 - 
sslAttributesParsedprotected boolean sslAttributesParsed Flag that indicates if SSL attributes have been parsed to improve performance for applications (usually frameworks) that make multiple calls togetAttributeNames().
 - 
localesprotected final java.util.ArrayList<java.util.Locale> locales The preferred Locales associated with this Request.
 - 
authTypeprotected java.lang.String authType Authentication type.
 - 
internalDispatcherTypeprotected DispatcherType internalDispatcherType The current dispatcher type.
 - 
inputBufferprotected final InputBuffer inputBuffer The associated input buffer.
 - 
inputStreamprotected CoyoteInputStream inputStream ServletInputStream.
 - 
readerprotected CoyoteReader reader Reader.
 - 
usingInputStreamprotected boolean usingInputStream Using stream flag.
 - 
usingReaderprotected boolean usingReader Using reader flag.
 - 
userPrincipalprotected java.security.Principal userPrincipal User principal.
 - 
parametersParsedprotected boolean parametersParsed Request parameters parsed flag.
 - 
cookiesParsedprotected boolean cookiesParsed Cookie headers parsed flag. Indicates that the cookie headers have been parsed into ServerCookies.
 - 
cookiesConvertedprotected boolean cookiesConverted Cookie parsed flag. Indicates that the ServerCookies have been converted into user facing Cookie objects.
 - 
secureprotected boolean secure Secure flag.
 - 
subjectprotected transient javax.security.auth.Subject subject The Subject associated with the current AccessControlContext
 - 
CACHED_POST_LENprotected static final int CACHED_POST_LEN Post data buffer.- See Also:
- Constant Field Values
 
 - 
postDataprotected byte[] postData 
 - 
parameterMapprotected ParameterMap<java.lang.String,java.lang.String[]> parameterMap Hash map used in the getParametersMap method.
 - 
partsprotected java.util.Collection<Part> parts The parts, if any, uploaded with this request.
 - 
partsParseExceptionprotected java.lang.Exception partsParseException The exception thrown, if any when parsing the parts.
 - 
sessionprotected Session session The currently active session for this request.
 - 
requestDispatcherPathprotected java.lang.Object requestDispatcherPath The current request dispatcher path.
 - 
requestedSessionCookieprotected boolean requestedSessionCookie Was the requested session ID received in a cookie?
 - 
requestedSessionIdprotected java.lang.String requestedSessionId The requested session ID (if any) for this request.
 - 
requestedSessionURLprotected boolean requestedSessionURL Was the requested session ID received in a URL?
 - 
requestedSessionSSLprotected boolean requestedSessionSSL Was the requested session ID obtained from the SSL session?
 - 
localesParsedprotected boolean localesParsed Parse locales.
 - 
localPortprotected int localPort Local port
 - 
remoteAddrprotected java.lang.String remoteAddr Remote address.
 - 
peerAddrprotected java.lang.String peerAddr Connection peer address.
 - 
remoteHostprotected java.lang.String remoteHost Remote host.
 - 
remotePortprotected int remotePort Remote port
 - 
localAddrprotected java.lang.String localAddr Local address
 - 
localNameprotected java.lang.String localName Local address
 - 
asyncSupportedprotected java.lang.Boolean asyncSupported 
 - 
connectorprotected Connector connector Associated Catalina connector.
 - 
filterChainprotected FilterChain filterChain Filter chain associated with the request.
 - 
mappingDataprotected final MappingData mappingData Mapping data.
 - 
facadeprotected RequestFacade facade The facade associated with this request.
 - 
responseprotected Response response The response with which this request is associated.
 - 
URIConverterprotected B2CConverter URIConverter URI byte to char converter.
 
- 
 - 
Method Detail- 
setCoyoteRequestpublic void setCoyoteRequest(Request coyoteRequest) Set the Coyote request.- Parameters:
- coyoteRequest- The Coyote request
 
 - 
getCoyoteRequestpublic Request getCoyoteRequest() Get the Coyote request.- Returns:
- the Coyote request object
 
 - 
addPathParameterprotected void addPathParameter(java.lang.String name, java.lang.String value)
 - 
getPathParameterprotected java.lang.String getPathParameter(java.lang.String name) 
 - 
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) 
 - 
getConnectorpublic Connector getConnector() - Returns:
- the Connector through which this Request was received.
 
 - 
setConnectorpublic void setConnector(Connector connector) Set the Connector through which this Request was received.- Parameters:
- connector- The new connector
 
 - 
getContextpublic Context getContext() Return the Context within which this Request is being processed.This is available as soon as the appropriate Context is identified. Note that availability of a Context allows getContextPath()to return a value, and thus enables parsing of the request URI.- Returns:
- the Context mapped with the request
 
 - 
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
 
 - 
setContext@Deprecated public void setContext(Context context) Deprecated.Use setters onMappingDataobject. Depending on use case, you may need to update otherMappingDatafields as well, such ascontextSlashCountandhost.- Parameters:
- context- The newly associated Context
 
 - 
getFilterChainpublic FilterChain getFilterChain() Get filter chain associated with the request.- Returns:
- the associated filter chain
 
 - 
setFilterChainpublic void setFilterChain(FilterChain filterChain) Set filter chain associated with the request.- Parameters:
- filterChain- new filter chain
 
 - 
getHostpublic Host getHost() - Returns:
- the Host within which this Request is being processed.
 
 - 
getMappingDatapublic MappingData getMappingData() - Returns:
- mapping data.
 
 - 
getRequestpublic HttpServletRequest getRequest() - Returns:
- the ServletRequestfor which this object is the facade. This method must be implemented by a subclass.
 
 - 
setRequestpublic void setRequest(HttpServletRequest applicationRequest) 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
 
 - 
getResponsepublic Response getResponse() - Returns:
- the Response with which this Request is associated.
 
 - 
setResponsepublic void setResponse(Response response) Set the Response with which this Request is associated.- Parameters:
- response- The new associated response
 
 - 
getStreampublic java.io.InputStream getStream() - Returns:
- the input stream associated with this Request.
 
 - 
getURIConverterprotected B2CConverter getURIConverter() - Returns:
- the URI converter.
 
 - 
setURIConverterprotected void setURIConverter(B2CConverter URIConverter) Set the URI converter.- Parameters:
- URIConverter- the new URI converter
 
 - 
getWrapperpublic Wrapper getWrapper() - Returns:
- the Wrapper within which this Request is being processed.
 
 - 
setWrapper@Deprecated public void setWrapper(Wrapper wrapper) Deprecated.Use setters onMappingDataobject. Depending on use case, you may need to update otherMappingDatafields as well, such ascontextandcontextSlashCount.- Parameters:
- wrapper- The newly associated Wrapper
 
 - 
createInputStreampublic ServletInputStream createInputStream() throws java.io.IOException Create and return a ServletInputStream to read the content associated with this Request.- Returns:
- the created input stream
- Throws:
- java.io.IOException- if an input/output error occurs
 
 - 
finishRequestpublic void finishRequest() throws java.io.IOExceptionPerform whatever actions are required to flush and close the input stream or reader, in a single operation.- Throws:
- java.io.IOException- if an input/output error occurs
 
 - 
getNotepublic java.lang.Object getNote(java.lang.String name) - Parameters:
- name- Name of the note to be returned
- Returns:
- the object bound with the specified name to the internal notes
 for this request, or nullif no such binding exists.
 
 - 
removeNotepublic void removeNote(java.lang.String name) Remove any object bound to the specified name in the internal notes for this request.- Parameters:
- name- Name of the note to be removed
 
 - 
setLocalPortpublic void setLocalPort(int port) Set the port number of the server to process this request.- Parameters:
- port- The server port
 
 - 
setNotepublic void setNote(java.lang.String name, java.lang.Object value)Bind an object to a specified name in the internal notes associated with this request, replacing any existing binding for this name.- Parameters:
- name- Name to which the object should be bound
- value- Object to be bound to the specified name
 
 - 
setRemoteAddrpublic void setRemoteAddr(java.lang.String remoteAddr) Set the IP address of the remote client associated with this Request.- Parameters:
- remoteAddr- The remote IP address
 
 - 
setRemoteHostpublic void setRemoteHost(java.lang.String remoteHost) Set 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
 
 - 
getAttributepublic java.lang.Object getAttribute(java.lang.String name) 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 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: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 interface- ServletRequest
- Returns:
- a long integer containing the length of the request body or -1 if the length is not known
 
 - 
getAttributeNamespublic java.util.Enumeration<java.lang.String> getAttributeNames() Return 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
 
 - 
getCharacterEncodingpublic java.lang.String 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 request does not specify a character encoding- Specified by:
- getCharacterEncodingin interface- ServletRequest
- Returns:
- the character encoding for this Request.
 
 - 
getContentLengthpublic 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 interface- ServletRequest
- Returns:
- the content length for this Request.
 
 - 
getContentTypepublic java.lang.String 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 interface- ServletRequest
- Returns:
- the content type for this Request.
 
 - 
setContentTypepublic void setContentType(java.lang.String contentType) Set the content type for this Request.- Parameters:
- contentType- The content type
 
 - 
getInputStreampublic ServletInputStream getInputStream() throws java.io.IOException 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 interface- ServletRequest
- Returns:
- the servlet input stream for this Request.  The default
 implementation returns a servlet input stream created by
 createInputStream().
- Throws:
- java.lang.IllegalStateException- if- getReader()has already been called for this request
- java.io.IOException- if an input/output error occurs
 
 - 
getLocalepublic java.util.Locale 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 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.
 
 - 
getLocalespublic java.util.Enumeration<java.util.Locale> 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 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.
 
 - 
getParameterpublic java.lang.String getParameter(java.lang.String name) 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 interface- ServletRequest
- Parameters:
- name- Name of the desired request parameter
- Returns:
- the value of the specified request parameter, if any; otherwise,
 return null. If there is more than one value defined, return only the first one.
- See Also:
- ServletRequest.getParameterValues(java.lang.String)
 
 - 
getParameterMappublic java.util.Map<java.lang.String,java.lang.String[]> 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 interface- ServletRequest
- Returns:
- A Mapcontaining parameter names as keys and parameter values as map values.
 
 - 
getParameterNamespublic java.util.Enumeration<java.lang.String> 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 interface- ServletRequest
- Returns:
- the names of all defined request parameters for this request.
 
 - 
getParameterValuespublic java.lang.String[] getParameterValues(java.lang.String name) 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 interface- ServletRequest
- Parameters:
- name- Name of the desired request parameter
- Returns:
- the defined values for the specified request parameter, if any;
 otherwise, return null.
- See Also:
- ServletRequest.getParameter(java.lang.String)
 
 - 
getProtocolpublic java.lang.String 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 interface- ServletRequest
- Returns:
- the protocol and version used to make this Request.
 
 - 
getReaderpublic java.io.BufferedReader getReader() throws java.io.IOExceptionRead 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:
- java.lang.IllegalStateException- if- getInputStream()has already been called for this request
- java.io.IOException- if an input/output error occurs
- See Also:
- ServletRequest.getInputStream()
 
 - 
getRealPath@Deprecated public java.lang.String getRealPath(java.lang.String path) Deprecated.As of version 2.1 of the Java Servlet API, useServletContext.getRealPath().- Specified by:
- getRealPathin interface- ServletRequest
- Parameters:
- path- Path to be translated
- Returns:
- the real path of the specified virtual path.
 
 - 
getRemoteAddrpublic java.lang.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 interface- ServletRequest
- Returns:
- the remote IP address making this Request.
 
 - 
getPeerAddrpublic java.lang.String getPeerAddr() - Returns:
- the connection peer IP address making this Request.
 
 - 
getRemoteHostpublic java.lang.String 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 interface- ServletRequest
- Returns:
- the remote host name making this Request.
 
 - 
getRemotePortpublic 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 interface- ServletRequest
- Returns:
- the Internet Protocol (IP) source port of the client or last proxy that sent the request.
 
 - 
getLocalNamepublic java.lang.String 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 interface- ServletRequest
- Returns:
- the host name of the Internet Protocol (IP) interface on which the request was received.
 
 - 
getLocalAddrpublic java.lang.String 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 interface- ServletRequest
- Returns:
- the Internet Protocol (IP) address of the interface on which the request was received.
 
 - 
getLocalPortpublic 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 interface- ServletRequest
- Returns:
- the Internet Protocol (IP) port number of the interface on which the request was received.
 
 - 
getRequestDispatcherpublic RequestDispatcher getRequestDispatcher(java.lang.String path) 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 interface- ServletRequest
- Parameters:
- path- Path of the resource to be wrapped
- Returns:
- a RequestDispatcher that wraps the resource at the specified path, which may be interpreted as relative to the current request path.
- See Also:
- RequestDispatcher,- ServletContext.getRequestDispatcher(java.lang.String)
 
 - 
getSchemepublic java.lang.String 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 interface- ServletRequest
- Returns:
- the scheme used to make this Request.
 
 - 
getServerNamepublic java.lang.String 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 interface- ServletRequest
- Returns:
- the server name responding to this Request.
 
 - 
getServerPortpublic 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 interface- ServletRequest
- Returns:
- the server port responding to this Request.
 
 - 
isSecurepublic 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 interface- ServletRequest
- Returns:
- trueif this request was received on a secure connection.
 
 - 
removeAttributepublic void removeAttribute(java.lang.String name) Remove the specified request attribute if it exists.- Specified by:
- removeAttributein interface- ServletRequest
- Parameters:
- name- Name of the request attribute to remove
 
 - 
setAttributepublic void setAttribute(java.lang.String name, java.lang.Object value)Set 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
 
 - 
setCharacterEncodingpublic void setCharacterEncoding(java.lang.String enc) throws java.io.UnsupportedEncodingExceptionOverrides 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:
- java.io.UnsupportedEncodingException- if the specified encoding is not supported
- Since:
- Servlet 2.3
 
 - 
getServletContextpublic ServletContext getServletContext() - Specified by:
- getServletContextin interface- ServletRequest
- Returns:
- TODO
 
 - 
startAsyncpublic AsyncContext startAsync() - Specified by:
- startAsyncin interface- ServletRequest
- Returns:
- TODO
 
 - 
startAsyncpublic AsyncContext startAsync(ServletRequest request, ServletResponse response) - 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
 
 - 
getAsyncContextpublic AsyncContext getAsyncContext() Description copied from interface:javax.servlet.ServletRequestGet the current AsyncContext.- Specified by:
- getAsyncContextin interface- ServletRequest
- Returns:
- The current AsyncContext
 
 - 
getAsyncContextInternalpublic AsyncContextImpl getAsyncContextInternal() 
 - 
getDispatcherTypepublic DispatcherType getDispatcherType() - Specified by:
- getDispatcherTypein interface- ServletRequest
- Returns:
- TODO
 
 - 
addCookiepublic void addCookie(Cookie cookie) Add a Cookie to the set of Cookies associated with this Request.- Parameters:
- cookie- The new cookie
 
 - 
addLocalepublic void addLocale(java.util.Locale locale) Add a Locale to the set of preferred Locales for this Request. The first added Locale will be the first one returned by getLocales().- Parameters:
- locale- The new preferred Locale
 
 - 
clearCookiespublic void clearCookies() Clear the collection of Cookies associated with this Request.
 - 
clearLocalespublic void clearLocales() Clear the collection of Locales associated with this Request.
 - 
setAuthTypepublic void setAuthType(java.lang.String type) 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
 
 - 
setPathInfopublic void setPathInfo(java.lang.String path) Set the path information for this Request. This will normally be called when the associated Context is mapping the Request to a particular Wrapper.- Parameters:
- path- The path information
 
 - 
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
 
 - 
setRequestedSessionIdpublic void setRequestedSessionId(java.lang.String id) Set the requested session ID for this request. This is normally called by the HTTP Connector, when it parses the request headers.- Parameters:
- id- The new session id
 
 - 
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
 
 - 
getDecodedRequestURIpublic java.lang.String getDecodedRequestURI() Get the decoded request URI.- Returns:
- the URL decoded request URI
 
 - 
getDecodedRequestURIMBpublic MessageBytes getDecodedRequestURIMB() Get the decoded request URI.- Returns:
- the URL decoded request URI
 
 - 
setUserPrincipalpublic void setUserPrincipal(java.security.Principal principal) Set the Principal who has been authenticated for this Request. This value is also used to calculate the value to be returned by thegetRemoteUser()method.- Parameters:
- principal- The user Principal
 
 - 
newPushBuilderpublic ApplicationPushBuilder newPushBuilder() 
 - 
newPushBuilderpublic ApplicationPushBuilder newPushBuilder(HttpServletRequest request) 
 - 
upgradepublic <T extends HttpUpgradeHandler> T upgrade(java.lang.Class<T> httpUpgradeHandlerClass) throws java.io.IOException, ServletException Start the HTTP upgrade process and create and instance of the provided protocol handler class. The connection will be passed this instance once the current request/response pair has completed processing. Calling this method sets the response status 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:
- java.io.IOException- if an I/O error occurred during the upgrade
- ServletException- if the given httpUpgradeHandlerClass fails to be instantiated
- Since:
- Servlet 3.1
 
 - 
getAuthTypepublic java.lang.String getAuthType() Return 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.
 
 - 
getContextPathpublic java.lang.String getContextPath() Return the portion of the request URI used to select the Context of the Request. The value returned is not decoded which also implies it is not normalised.- Specified by:
- getContextPathin interface- HttpServletRequest
- Returns:
- a Stringspecifying the portion of the request URI that indicates the context of the request
 
 - 
getCookiespublic Cookie[] getCookies() Return the set of Cookies received with this Request. Triggers parsing of the Cookie HTTP headers followed by conversion to Cookie objects if this has not already been performed.- Specified by:
- getCookiesin interface- HttpServletRequest
- Returns:
- the array of cookies
 
 - 
getServerCookiespublic ServerCookies getServerCookies() Return the server representation of the cookies associated with this request. Triggers parsing of the Cookie HTTP headers (but not conversion to Cookie objects) if the headers have not yet been parsed.- Returns:
- the server cookies
 
 - 
getDateHeaderpublic long getDateHeader(java.lang.String name) Return 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:
- java.lang.IllegalArgumentException- if the specified header value cannot be converted to a date
 
 - 
getHeaderpublic java.lang.String getHeader(java.lang.String name) Return 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
 
 - 
getHeaderspublic java.util.Enumeration<java.lang.String> getHeaders(java.lang.String name) Return 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
 
 - 
getHeaderNamespublic java.util.Enumeration<java.lang.String> 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 interface- HttpServletRequest
- Returns:
- the names of all headers received with this request.
 
 - 
getIntHeaderpublic int getIntHeader(java.lang.String name) Return the value of the specified header as an integer, or -1 if there is no such header for this request.- Specified by:
- getIntHeaderin interface- HttpServletRequest
- Parameters:
- name- Name of the requested header
- Returns:
- the header value as an int
- Throws:
- java.lang.IllegalArgumentException- if the specified header value cannot be converted to an integer
 
 - 
getHttpServletMappingpublic ApplicationMappingImpl getHttpServletMapping() 
 - 
getMethodpublic java.lang.String 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 interface- HttpServletRequest
- Returns:
- the HTTP request method used in this Request.
 
 - 
getPathInfopublic java.lang.String 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 interface- HttpServletRequest
- Returns:
- the path information associated with this Request.
 
 - 
getPathTranslatedpublic java.lang.String 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 interface- HttpServletRequest
- Returns:
- the extra path information for this request, translated to a real path.
 
 - 
getQueryStringpublic java.lang.String 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 interface- HttpServletRequest
- Returns:
- the query string associated with this request.
 
 - 
getRemoteUserpublic java.lang.String 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 interface- HttpServletRequest
- Returns:
- the name of the remote user that has been authenticated for this Request.
 
 - 
getRequestPathMBpublic MessageBytes getRequestPathMB() Get the request path.- Returns:
- the request path
 
 - 
getRequestedSessionIdpublic java.lang.String 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 interface- HttpServletRequest
- Returns:
- the session identifier included in this request, if any.
- See Also:
- HttpServletRequest.isRequestedSessionIdValid()
 
 - 
getRequestURIpublic java.lang.String getRequestURI() Description copied from interface:javax.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:
- HttpServletRequest.getRequestURL()
 
 - 
getRequestURLpublic java.lang.StringBuffer 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 interface- HttpServletRequest
- Returns:
- a StringBufferobject containing the reconstructed URL
 
 - 
getServletPathpublic java.lang.String 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 interface- HttpServletRequest
- Returns:
- the portion of the request URI used to select the servlet that will process this request.
 
 - 
getSessionpublic HttpSession 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 interface- HttpServletRequest
- Returns:
- the session associated with this Request, creating one if necessary.
- See Also:
- HttpServletRequest.getSession(boolean)
 
 - 
getSessionpublic HttpSession getSession(boolean create) 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 interface- HttpServletRequest
- Parameters:
- create- Create a new session if one does not exist
- Returns:
- the session associated with this Request, creating one if necessary and requested.
- See Also:
- HttpServletRequest.getSession()
 
 - 
isRequestedSessionIdFromCookiepublic boolean isRequestedSessionIdFromCookie() Description copied from interface:javax.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:
- HttpServletRequest.getSession(boolean)
 
 - 
isRequestedSessionIdFromURLpublic 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 interface- HttpServletRequest
- Returns:
- trueif the session identifier included in this request came from the request URI.
- See Also:
- HttpServletRequest.getSession(boolean)
 
 - 
isRequestedSessionIdFromUrl@Deprecated public boolean isRequestedSessionIdFromUrl() Deprecated.As of Version 2.1 of the Java Servlet API, useisRequestedSessionIdFromURL()instead.- Specified by:
- isRequestedSessionIdFromUrlin interface- HttpServletRequest
- Returns:
- trueif the session identifier included in this request came from the request URI.
 
 - 
isRequestedSessionIdValidpublic boolean isRequestedSessionIdValid() Description copied from interface:javax.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:
- HttpServletRequest.getRequestedSessionId(),- HttpServletRequest.getSession(boolean)
 
 - 
isUserInRolepublic boolean isUserInRole(java.lang.String role) 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 interface- HttpServletRequest
- Parameters:
- role- Role name to be validated
- Returns:
- trueif the authenticated user principal possesses the specified role name.
 
 - 
getPrincipalpublic java.security.Principal getPrincipal() - Returns:
- the principal that has been authenticated for this Request.
 
 - 
getUserPrincipalpublic java.security.Principal 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 interface- HttpServletRequest
- Returns:
- the principal that has been authenticated for this Request.
 
 - 
getSessionInternalpublic Session getSessionInternal() - Returns:
- the session associated with this Request, creating one if necessary.
 
 - 
changeSessionIdpublic void changeSessionId(java.lang.String newSessionId) Change the ID of the session that this request is associated with. There are several things that may trigger an ID change. These include moving between nodes in a cluster and session fixation prevention during the authentication process.- Parameters:
- newSessionId- The session to change the session ID for
 
 - 
changeSessionIdpublic java.lang.String 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 interface- HttpServletRequest
- Returns:
- the new session ID allocated to the session
- See Also:
- HttpSessionIdListener
 
 - 
getSessionInternalpublic Session getSessionInternal(boolean create) - Parameters:
- create- Create a new session if one does not exist
- Returns:
- the session associated with this Request, creating one if necessary and requested.
 
 - 
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.
 - 
authenticatepublic boolean authenticate(HttpServletResponse response) throws java.io.IOException, ServletException Triggers the same authentication process as would be triggered if the request is for a resource that is protected by a security constraint.- Specified by:
- 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:
- java.io.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
 
 - 
loginpublic void login(java.lang.String username, java.lang.String password) throws ServletExceptionAuthenticate 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
 
 - 
logoutpublic void logout() throws ServletExceptionRemoves any authenticated user from the request.- Specified by:
- logoutin interface- HttpServletRequest
- Throws:
- ServletException- If the logout fails
 
 - 
getPartspublic java.util.Collection<Part> getParts() throws java.io.IOException, java.lang.IllegalStateException, ServletException Return a collection of all uploaded Parts.- Specified by:
- getPartsin interface- HttpServletRequest
- Returns:
- A collection of all uploaded Parts.
- Throws:
- java.io.IOException- if an I/O error occurs
- java.lang.IllegalStateException- if size limits are exceeded or no multipart configuration is provided
- ServletException- if the request is not multipart/form-data
 
 - 
getPartpublic Part getPart(java.lang.String name) throws java.io.IOException, java.lang.IllegalStateException, ServletException Gets 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:
- java.io.IOException- if an I/O error occurs
- java.lang.IllegalStateException- if size limits are exceeded
- ServletException- if the request is not multipart/form-data
 
 - 
doGetSessionprotected Session doGetSession(boolean create) 
 - 
unescapeprotected java.lang.String unescape(java.lang.String s) 
 - 
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.
 - 
readPostBodyprotected int readPostBody(byte[] body, int len) throws java.io.IOExceptionRead post body in an array.- Parameters:
- body- The bytes array in which the body will be read
- len- The body length
- Returns:
- the bytes count that has been read
- Throws:
- java.io.IOException- if an IO exception occurred
 
 - 
readChunkedPostBodyprotected byte[] readChunkedPostBody() throws java.io.IOExceptionRead chunked post body.- Returns:
- the post body as a bytes array
- Throws:
- java.io.IOException- if an IO exception occurred
 
 - 
parseLocalesprotected void parseLocales() Parse request locales.
 - 
parseLocalesHeaderprotected void parseLocalesHeader(java.lang.String value, java.util.TreeMap<java.lang.Double,java.util.ArrayList<java.util.Locale>> locales)Parse accept-language header value.- Parameters:
- value- the header value
- locales- the map that will hold the result
 
 
- 
 
-