public class Request extends Object implements HttpServletRequest
| Modifier and Type | Field and Description | 
|---|---|
| protected Boolean | asyncSupported | 
| protected String | authTypeAuthentication type. | 
| protected static int | CACHED_POST_LENPost data buffer. | 
| protected boolean | cometComet state | 
| protected Connector | connectorAssociated Catalina connector. | 
| protected Context | contextAssociated context. | 
| protected Cookie[] | cookiesThe set of cookies associated with this Request. | 
| protected boolean | cookiesParsedCookie headers parsed flag. | 
| protected Request | coyoteRequestCoyote request. | 
| protected static Locale | defaultLocaleThe default Locale if none are specified. | 
| protected CometEventImpl | eventAssociated event. | 
| protected RequestFacade | facadeThe facade associated with this request. | 
| protected FilterChain | filterChainFilter chain associated with the request. | 
| protected SimpleDateFormat[] | formatsDeprecated. 
 Unused. This will be removed in Tomcat 10 | 
| protected static TimeZone | GMT_ZONEDeprecated. 
 Unused. This will be removed in Tomcat 10. | 
| protected static String | infoDescriptive information about this Request implementation. | 
| protected InputBuffer | inputBufferThe associated input buffer. | 
| protected CoyoteInputStream | inputStreamServletInputStream. | 
| protected DispatcherType | internalDispatcherTypeThe current dispatcher type. | 
| protected String | localAddrLocal address | 
| protected ArrayList<Locale> | localesThe preferred Locales associated with this Request. | 
| protected boolean | localesParsedParse locales. | 
| protected String | localNameLocal address | 
| protected int | localPortLocal port | 
| protected MappingData | mappingDataMapping data. | 
| protected ParameterMap<String,String[]> | parameterMapHash map used in the getParametersMap method. | 
| protected boolean | parametersParsedRequest parameters parsed flag. | 
| protected Collection<Part> | partsThe parts, if any, uploaded with this request. | 
| protected Exception | partsParseExceptionThe exception thrown, if any when parsing the parts. | 
| protected Map<String,String> | pathParametersPath parameters | 
| protected byte[] | postData | 
| protected CoyoteReader | readerReader. | 
| protected String | remoteAddrRemote address. | 
| protected String | remoteHostRemote host. | 
| protected int | remotePortRemote port | 
| protected Object | requestDispatcherPathThe current request dispatcher path. | 
| protected boolean | requestedSessionCookieWas the requested session ID received in a cookie? | 
| protected String | requestedSessionIdThe requested session ID (if any) for this request. | 
| protected boolean | requestedSessionSSLWas the requested session ID obtained from the SSL session? | 
| protected boolean | requestedSessionURLWas the requested session ID received in a URL? | 
| protected Response | responseThe response with which this request is associated. | 
| protected boolean | secureSecure flag. | 
| protected Session | sessionThe currently active session for this request. | 
| protected boolean | sessionParsedDeprecated.  | 
| protected static StringManager | smThe string manager for this package. | 
| protected boolean | sslAttributesParsedFlag that indicates if SSL attributes have been parsed to improve
 performance for applications (usually frameworks) that make multiple
 calls to  getAttributeNames(). | 
| protected Subject | subjectThe Subject associated with the current AccessControlContext | 
| protected B2CConverter | URIConverterURI byte to char converter. | 
| protected Principal | userPrincipalUser principal. | 
| protected boolean | usingInputStreamUsing stream flag. | 
| protected boolean | usingReaderUsing reader flag. | 
| protected Wrapper | wrapperAssociated wrapper. | 
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH| Constructor and Description | 
|---|
| Request() | 
| Modifier and Type | Method and Description | 
|---|---|
| void | addCookie(Cookie cookie)Add a Cookie to the set of Cookies associated with this Request. | 
| void | addLocale(Locale locale)Add a Locale to the set of preferred Locales for this Request. | 
| void | addParameter(String name,
            String[] values)Deprecated.  | 
| protected void | addPathParameter(String name,
                String value) | 
| boolean | authenticate(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. | 
| String | changeSessionId() | 
| void | changeSessionId(String newSessionId)Change the ID of the session that this request is associated with. | 
| 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. | 
| void | clearCookies()Clear the collection of Cookies associated with this Request. | 
| void | clearEncoders()Clear cached encoders (to save memory for Comet requests). | 
| void | clearHeaders()Deprecated.  | 
| void | clearLocales()Clear the collection of Locales associated with this Request. | 
| void | clearParameters()Deprecated.  | 
| void | cometClose() | 
| ServletInputStream | createInputStream()Create and return a ServletInputStream to read the content
 associated with this Request. | 
| protected Session | doGetSession(boolean create) | 
| void | doUpgrade(UpgradeInbound inbound)Deprecated. 
 Will be removed in Tomcat 8.0.x. | 
| void | finishRequest()Perform whatever actions are required to flush and close the input
 stream or reader, in a single operation. | 
| AsyncContext | getAsyncContext()Get the current AsyncContext. | 
| AsyncContextImpl | getAsyncContextInternal() | 
| Object | getAttribute(String name)Returns the value of the named attribute as an  Object, ornullif no attribute of the given name exists. | 
| Enumeration<String> | getAttributeNames()Return the names of all request attributes for this Request, or an
 empty  Enumerationif there are none. | 
| String | getAuthType()Return the authentication type used for this Request. | 
| boolean | getAvailable() | 
| String | getCharacterEncoding()Returns the name of the character encoding used in the body of this
 request. | 
| Connector | getConnector() | 
| int | getContentLength()Returns the length, in bytes, of the request body and made available by
 the input stream, or -1 if the length is not known. | 
| String | getContentType()Returns the MIME type of the body of the request, or  nullif
 the type is not known. | 
| Context | getContext()Return the Context within which this Request is being processed. | 
| String | getContextPath()Return the portion of the request URI used to select the Context
 of the Request. | 
| MessageBytes | getContextPathMB()Deprecated.  | 
| Cookie[] | getCookies()Return the set of Cookies received with this Request. | 
| Request | getCoyoteRequest()Get the Coyote request. | 
| long | getDateHeader(String name)Return the value of the specified date header, if any; otherwise
 return -1. | 
| String | getDecodedRequestURI()Get the decoded request URI. | 
| MessageBytes | getDecodedRequestURIMB()Get the decoded request URI. | 
| boolean | getDiscardFacades()Get the recycling strategy of the facade objects. | 
| DispatcherType | getDispatcherType() | 
| CometEventImpl | getEvent()Get the event associated with the request. | 
| FilterChain | getFilterChain()Get filter chain associated with the request. | 
| String | getHeader(String name)Return the first value of the specified header, if any; otherwise,
 return  null | 
| Enumeration<String> | getHeaderNames()Returns an enumeration of all the header names this request contains. | 
| Enumeration<String> | getHeaders(String name)Return all of the values of the specified header, if any; otherwise,
 return an empty enumeration. | 
| Host | getHost() | 
| String | getInfo() | 
| ServletInputStream | getInputStream()Retrieves the body of the request as binary data using a
  ServletInputStream. | 
| int | getIntHeader(String name)Return the value of the specified header as an integer, or -1 if there
 is no such header for this request. | 
| String | getLocalAddr()Returns the Internet Protocol (IP) address of the interface on which the
 request was received. | 
| Locale | getLocale()Returns the preferred  Localethat the client will accept
 content in, based on the Accept-Language header. | 
| Enumeration<Locale> | getLocales()Returns an  EnumerationofLocaleobjects
 indicating, in decreasing order starting with the preferred locale, the
 locales that are acceptable to the client based on the Accept-Language
 header. | 
| String | getLocalName()Returns the host name of the Internet Protocol (IP) interface on which
 the request was received. | 
| int | getLocalPort()Returns the Internet Protocol (IP) port number of the interface on which
 the request was received. | 
| MappingData | getMappingData() | 
| String | getMethod()Returns the name of the HTTP method with which this request was made, for
 example, GET, POST, or PUT. | 
| Object | getNote(String name) | 
| Iterator<String> | getNoteNames()Deprecated.  | 
| String | getParameter(String name)Returns the value of a request parameter as a  String, ornullif the parameter does not exist. | 
| Map<String,String[]> | getParameterMap()Returns a  Mapof the parameters of this request. | 
| Enumeration<String> | getParameterNames()Returns an  EnumerationofStringobjects
 containing the names of the parameters contained in this request. | 
| String[] | getParameterValues(String name)Returns an array of  Stringobjects containing all of the
 values the given request parameter has, ornullif the
 parameter does not exist. | 
| Part | getPart(String name)Gets the named Part or null if the Part does not exist. | 
| Collection<Part> | getParts()Return a collection of all uploaded Parts. | 
| String | getPathInfo()Returns any extra path information associated with the URL the client
 sent when it made this request. | 
| MessageBytes | getPathInfoMB()Deprecated.  | 
| protected String | getPathParameter(String name) | 
| String | getPathTranslated()Returns any extra path information after the servlet name but before the
 query string, and translates it to a real path. | 
| Principal | getPrincipal() | 
| String | getProtocol()Returns the name and version of the protocol the request uses in the form
 protocol/majorVersion.minorVersion, for example, HTTP/1.1. | 
| String | getQueryString()Returns the query string that is contained in the request URL after the
 path. | 
| BufferedReader | getReader()Read the Reader wrapping the input stream for this Request. | 
| String | getRealPath(String path)Deprecated. 
 As of version 2.1 of the Java Servlet API, use
   ServletContext.getRealPath(). | 
| String | getRemoteAddr()Returns the Internet Protocol (IP) address of the client or last proxy
 that sent the request. | 
| String | getRemoteHost()Returns the fully qualified name of the client or the last proxy that
 sent the request. | 
| int | getRemotePort()Returns the Internet Protocol (IP) source port of the client or last
 proxy that sent the request. | 
| String | getRemoteUser()Returns the login of the user making this request, if the user has been
 authenticated, or  nullif the user has not been
 authenticated. | 
| HttpServletRequest | getRequest() | 
| RequestDispatcher | getRequestDispatcher(String path)Returns a  RequestDispatcherobject that acts as a wrapper for the
 resource located at the given path. | 
| String | getRequestedSessionId()Returns the session ID specified by the client. | 
| MessageBytes | getRequestPathMB()Get the request path. | 
| String | getRequestURI()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. | 
| StringBuffer | getRequestURL()Reconstructs the URL the client used to make the request. | 
| Response | getResponse() | 
| String | getScheme()Returns the name of the scheme used to make this request, for example,
  http,https, orftp. | 
| String | getServerName()Returns the host name of the server to which the request was sent. | 
| int | getServerPort()Returns the port number to which the request was sent. | 
| ServletContext | getServletContext() | 
| String | getServletPath()Returns the part of this request's URL that calls the servlet. | 
| MessageBytes | getServletPathMB()Deprecated.  | 
| HttpSession | getSession()Returns the current session associated with this request, or if the
 request does not have a session, creates one. | 
| HttpSession | getSession(boolean create)Returns the current  HttpSessionassociated with this request
 or, if there is no current session andcreateis true,
 returns a new session. | 
| Session | getSessionInternal() | 
| Session | getSessionInternal(boolean create) | 
| InputStream | getStream() | 
| protected B2CConverter | getURIConverter() | 
| Principal | getUserPrincipal()Returns a  java.security.Principalobject containing the name
 of the current authenticated user. | 
| Wrapper | getWrapper() | 
| boolean | isAsync() | 
| boolean | isAsyncCompleting() | 
| boolean | isAsyncDispatching() | 
| boolean | isAsyncStarted() | 
| boolean | isAsyncSupported() | 
| boolean | isComet() | 
| boolean | isParametersParsed() | 
| protected boolean | isProcessing()Deprecated.  | 
| boolean | isRequestedSessionIdFromCookie()Checks whether the requested session ID came in as a cookie. | 
| boolean | isRequestedSessionIdFromSSL()Deprecated.  | 
| boolean | isRequestedSessionIdFromUrl()Deprecated. 
 As of Version 2.1 of the Java Servlet API, use
   isRequestedSessionIdFromURL()instead. | 
| boolean | isRequestedSessionIdFromURL()Checks whether the requested session ID came in as part of the request
 URL. | 
| boolean | isRequestedSessionIdValid()Checks whether the requested session ID is still valid. | 
| boolean | isSecure()Returns a boolean indicating whether this request was made using a secure
 channel, such as HTTPS. | 
| boolean | isUserInRole(String role)Returns a boolean indicating whether the authenticated user is included
 in the specified logical "role". | 
| void | login(String username,
     String password)Authenticate the provided user name and password and then associated the
 authenticated user with the request. | 
| void | logout()Removes any authenticated user from the request. | 
| protected void | parseCookies()Parse cookies. | 
| protected void | parseLocales()Parse request locales. | 
| protected void | parseLocalesHeader(String value,
                  TreeMap<Double,ArrayList<Locale>> locales)Parse accept-language header value. | 
| protected void | parseParameters()Parse request parameters. | 
| boolean | read() | 
| protected byte[] | readChunkedPostBody()Read chunked post body. | 
| protected int | readPostBody(byte[] body,
            int len)Read post body in an array. | 
| void | recycle()Release all object references, and initialize instance variables, in
 preparation for reuse of this object. | 
| protected void | recycleSessionInfo() | 
| void | removeAttribute(String name)Remove the specified request attribute if it exists. | 
| void | removeNote(String name)Remove any object bound to the specified name in the internal notes
 for this request. | 
| void | setAsyncSupported(boolean asyncSupported) | 
| void | setAttribute(String name,
            Object value)Set the specified request attribute to the specified value. | 
| void | setAuthType(String type)Set the authentication type used for this request, if any; otherwise
 set the type to  null. | 
| void | setCharacterEncoding(String enc)Overrides the name of the character encoding used in the body of
 this request. | 
| void | setComet(boolean comet)Set comet state. | 
| void | setCometTimeout(long timeout) | 
| void | setConnector(Connector connector)Set the Connector through which this Request was received. | 
| void | setContext(Context context)Set the Context within which this Request is being processed. | 
| void | setContextPath(String path)Deprecated.  | 
| void | setCookies(Cookie[] cookies)Deprecated.  | 
| void | setCoyoteRequest(Request coyoteRequest)Set the Coyote request. | 
| void | setFilterChain(FilterChain filterChain)Set filter chain associated with the request. | 
| void | setHost(Host host)Deprecated.  | 
| void | setLocalPort(int port)Set the port number of the server to process this request. | 
| void | setNote(String name,
       Object value)Bind an object to a specified name in the internal notes associated
 with this request, replacing any existing binding for this name. | 
| void | setPathInfo(String path)Set the path information for this Request. | 
| void | setRemoteAddr(String remoteAddr)Set the IP address of the remote client associated with this Request. | 
| void | setRemoteHost(String remoteHost)Set the fully qualified name of the remote client associated with this
 Request. | 
| void | setRequestedSessionCookie(boolean flag)Set a flag indicating whether or not the requested session ID for this
 request came in through a cookie. | 
| void | setRequestedSessionId(String id)Set the requested session ID for this request. | 
| void | setRequestedSessionSSL(boolean flag)Set a flag indicating whether or not the requested session ID for this
 request came in through SSL. | 
| void | setRequestedSessionURL(boolean flag)Set a flag indicating whether or not the requested session ID for this
 request came in through a URL. | 
| void | setResponse(Response response)Set the Response with which this Request is associated. | 
| void | setSecure(boolean secure)Set the value to be returned by  isSecure()for this Request. | 
| void | setServerName(String name)Deprecated.  | 
| void | setServerPort(int port)Set the port number of the server to process this request. | 
| void | setServletPath(String path)Deprecated.  | 
| protected void | setURIConverter(B2CConverter URIConverter)Set the URI converter. | 
| void | setUserPrincipal(Principal principal)Set the Principal who has been authenticated for this Request. | 
| void | setWrapper(Wrapper wrapper)Set the Wrapper within which this Request is being processed. | 
| AsyncContext | startAsync() | 
| AsyncContext | startAsync(ServletRequest request,
          ServletResponse response) | 
| protected String | unescape(String s) | 
| <T extends HttpUpgradeHandler>  | upgrade(Class<T> httpUpgradeHandlerClass) | 
protected Request coyoteRequest
@Deprecated protected static final TimeZone GMT_ZONE
protected static final StringManager sm
protected Cookie[] cookies
@Deprecated protected final SimpleDateFormat[] formats
protected static Locale defaultLocale
protected boolean sslAttributesParsed
getAttributeNames().protected String authType
protected CometEventImpl event
protected boolean comet
protected DispatcherType internalDispatcherType
protected InputBuffer inputBuffer
protected CoyoteInputStream inputStream
protected CoyoteReader reader
protected boolean usingInputStream
protected boolean usingReader
protected Principal userPrincipal
@Deprecated protected boolean sessionParsed
protected boolean parametersParsed
protected boolean cookiesParsed
protected boolean secure
protected transient Subject subject
protected static int CACHED_POST_LEN
protected byte[] postData
protected ParameterMap<String,String[]> parameterMap
protected Collection<Part> parts
protected Exception partsParseException
protected Session session
protected Object requestDispatcherPath
protected boolean requestedSessionCookie
protected String requestedSessionId
protected boolean requestedSessionURL
protected boolean requestedSessionSSL
protected boolean localesParsed
protected int localPort
protected String remoteAddr
protected String remoteHost
protected int remotePort
protected String localAddr
protected String localName
protected Boolean asyncSupported
protected Connector connector
protected Context context
protected FilterChain filterChain
protected static final String info
protected MappingData mappingData
protected RequestFacade facade
protected Response response
protected B2CConverter URIConverter
protected Wrapper wrapper
public void setCoyoteRequest(Request coyoteRequest)
coyoteRequest - The Coyote requestpublic Request getCoyoteRequest()
public void setAsyncSupported(boolean asyncSupported)
public void recycle()
@Deprecated protected boolean isProcessing()
public void clearEncoders()
protected void recycleSessionInfo()
public boolean read()
             throws IOException
IOExceptionpublic Connector getConnector()
public void setConnector(Connector connector)
connector - The new connectorpublic Context getContext()
 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.
public void setContext(Context context)
getContextPath(),
 and thus enables parsing of the request URI.context - The newly associated Contextpublic boolean getDiscardFacades()
true if no connector is associated with this requestpublic FilterChain getFilterChain()
public void setFilterChain(FilterChain filterChain)
filterChain - new filter chainpublic Host getHost()
@Deprecated public void setHost(Host host)
host - The newly associated Hostpublic String getInfo()
<description>/<version>.public MappingData getMappingData()
public HttpServletRequest getRequest()
ServletRequest for which this object
 is the facade.  This method must be implemented by a subclass.public Response getResponse()
public void setResponse(Response response)
response - The new associated responsepublic InputStream getStream()
protected B2CConverter getURIConverter()
protected void setURIConverter(B2CConverter URIConverter)
URIConverter - the new URI converterpublic Wrapper getWrapper()
public void setWrapper(Wrapper wrapper)
wrapper - The newly associated Wrapperpublic ServletInputStream createInputStream() throws IOException
IOException - if an input/output error occurspublic void finishRequest()
                   throws IOException
IOException - if an input/output error occurspublic Object getNote(String name)
name - Name of the note to be returnednull if no such binding exists.@Deprecated public Iterator<String> getNoteNames()
public void removeNote(String name)
name - Name of the note to be removedpublic void setLocalPort(int port)
port - The server portpublic void setNote(String name, Object value)
name - Name to which the object should be boundvalue - Object to be bound to the specified namepublic void setRemoteAddr(String remoteAddr)
remoteAddr - The remote IP addresspublic void setRemoteHost(String remoteHost)
remoteHost - The remote host namepublic void setSecure(boolean secure)
isSecure()
 for this Request.secure - The new isSecure value@Deprecated public void setServerName(String name)
name - The server namepublic void setServerPort(int port)
port - The server portpublic Object getAttribute(String name)
ServletRequestObject, or
 null if no attribute of the given name exists.
 
 Attributes can be set two ways. The servlet container may set attributes
 to make available custom information about a request. For example, for
 requests made using HTTPS, the attribute
 javax.servlet.request.X509Certificate can be used to
 retrieve information on the certificate of the client. Attributes can
 also be set programmatically using ServletRequest.setAttribute(java.lang.String, java.lang.Object).
 This allows information to be embedded into a request before a
 RequestDispatcher call.
 
 Attribute names should follow the same conventions as package names. This
 specification reserves names matching java.*,
 javax.*, and sun.*.
getAttribute in interface ServletRequestname - Name of the request attribute to returnnull.public Enumeration<String> getAttributeNames()
Enumeration if there are none. Note that the attribute
 names returned will only be those for the attributes set via
 setAttribute(String, Object). Tomcat internal attributes will
 not be included although they are accessible via
 getAttribute(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_ID_TOMCAT_ATTR (SSL connections only)
 Globals.SSL_SESSION_MGR_ATTR (SSL connections only)Globals.PARAMETER_PARSE_FAILED_ATTRgetAttributeNames in interface ServletRequestpublic String getCharacterEncoding()
ServletRequestnull if the request does not
 specify a character encodinggetCharacterEncoding in interface ServletRequestpublic int getContentLength()
ServletRequestgetContentLength in interface ServletRequestpublic String getContentType()
ServletRequestnull if
 the type is not known. For HTTP servlets, same as the value of the CGI
 variable CONTENT_TYPE.getContentType in interface ServletRequestpublic ServletInputStream getInputStream() throws IOException
ServletRequestServletInputStream. Either this method or ServletRequest.getReader() may
 be called to read the body, not both.getInputStream in interface ServletRequestcreateInputStream().IllegalStateException - if getReader() has
  already been called for this requestIOException - if an input/output error occurspublic Locale getLocale()
ServletRequestLocale that the client will accept
 content in, based on the Accept-Language header. If the client request
 doesn't provide an Accept-Language header, this method returns the
 default locale for the server.getLocale in interface ServletRequestAccept-Language header
 that was encountered.  If the request did not specify a preferred
 language, the server's default Locale is returned.public Enumeration<Locale> getLocales()
ServletRequestEnumeration of Locale objects
 indicating, in decreasing order starting with the preferred locale, the
 locales that are acceptable to the client based on the Accept-Language
 header. If the client request doesn't provide an Accept-Language header,
 this method returns an Enumeration containing one
 Locale, the default locale for the server.getLocales in interface ServletRequestAccept-Language
 headers that were encountered.  If the request did not specify a
 preferred language, the server's default Locale is returned.public String getParameter(String name)
ServletRequestString, or
 null if the parameter does not exist. Request parameters are
 extra information sent with the request. For HTTP servlets, parameters
 are contained in the query string or posted form data.
 
 You should only use this method when you are sure the parameter has only
 one value. If the parameter might have more than one value, use
 ServletRequest.getParameterValues(java.lang.String).
 
 If you use this method with a multivalued parameter, the value returned
 is equal to the first value in the array returned by
 getParameterValues.
 
 If the parameter data was sent in the request body, such as occurs with
 an HTTP POST request, then reading the body directly via
 ServletRequest.getInputStream() or ServletRequest.getReader() can interfere with the
 execution of this method.
getParameter in interface ServletRequestname - Name of the desired request parameternull.  If there is more than one value defined,
 return only the first one.ServletRequest.getParameterValues(java.lang.String)public Map<String,String[]> getParameterMap()
Map of the parameters of this request.
 Request parameters are extra information sent with the request.
 For HTTP servlets, parameters are contained in the query string
 or posted form data.getParameterMap in interface ServletRequestMap containing parameter names as keys
  and parameter values as map values.public Enumeration<String> getParameterNames()
ServletRequestEnumeration of String objects
 containing the names of the parameters contained in this request. If the
 request has no parameters, the method returns an empty
 Enumeration.getParameterNames in interface ServletRequestpublic String[] getParameterValues(String name)
ServletRequestString objects containing all of the
 values the given request parameter has, or null if the
 parameter does not exist.
 If the parameter has a single value, the array has a length of 1.
getParameterValues in interface ServletRequestname - Name of the desired request parameternull.ServletRequest.getParameter(java.lang.String)public String getProtocol()
ServletRequestSERVER_PROTOCOL.getProtocol in interface ServletRequestpublic BufferedReader getReader() throws IOException
BufferedReader around the
 servlet input stream returned by createInputStream().getReader in interface ServletRequestIllegalStateException - if getInputStream()
  has already been called for this requestIOException - if an input/output error occursServletRequest.getInputStream()@Deprecated public String getRealPath(String path)
ServletContext.getRealPath().getRealPath in interface ServletRequestpath - Path to be translatedpublic String getRemoteAddr()
ServletRequestREMOTE_ADDR.getRemoteAddr in interface ServletRequestpublic String getRemoteHost()
ServletRequestREMOTE_HOST.getRemoteHost in interface ServletRequestpublic int getRemotePort()
ServletRequestgetRemotePort in interface ServletRequestpublic String getLocalName()
ServletRequestgetLocalName in interface ServletRequestpublic String getLocalAddr()
ServletRequestgetLocalAddr in interface ServletRequestpublic int getLocalPort()
ServletRequestgetLocalPort in interface ServletRequestpublic RequestDispatcher getRequestDispatcher(String path)
ServletRequestRequestDispatcher object that acts as a wrapper for the
 resource located at the given path. A RequestDispatcher
 object can be used to forward a request to the resource or to include the
 resource in a response. The resource can be dynamic or static.
 
 The pathname specified may be relative, although it cannot extend outside
 the current servlet context. If the path begins with a "/" it is
 interpreted as relative to the current context root. This method returns
 null if the servlet container cannot return a
 RequestDispatcher.
 
 The difference between this method and
 ServletContext.getRequestDispatcher(java.lang.String) is that this method can take
 a relative path.
getRequestDispatcher in interface ServletRequestpath - Path of the resource to be wrappedRequestDispatcher, 
ServletContext.getRequestDispatcher(java.lang.String)public String getScheme()
ServletRequesthttp, https, or ftp. Different
 schemes have different rules for constructing URLs, as noted in RFC 1738.getScheme in interface ServletRequestpublic String getServerName()
ServletRequestHost header value,
 if any, or the resolved server name, or the server IP address.getServerName in interface ServletRequestpublic int getServerPort()
ServletRequestHost header value, if any, or the
 server port where the client connection was accepted on.getServerPort in interface ServletRequestpublic boolean isSecure()
ServletRequestisSecure in interface ServletRequesttrue if this request was received on a secure connection.public void removeAttribute(String name)
removeAttribute in interface ServletRequestname - Name of the request attribute to removepublic void setAttribute(String name, Object value)
setAttribute in interface ServletRequestname - Name of the request attribute to setvalue - The associated valuepublic void setCharacterEncoding(String enc) throws UnsupportedEncodingException
getReader().setCharacterEncoding in interface ServletRequestenc - The character encoding to be usedUnsupportedEncodingException - if the specified encoding
  is not supportedpublic ServletContext getServletContext()
getServletContext in interface ServletRequestpublic AsyncContext startAsync()
startAsync in interface ServletRequestpublic AsyncContext startAsync(ServletRequest request, ServletResponse response)
startAsync in interface ServletRequestrequest - The ServletRequest with which to initialise the
                          asynchronous contextresponse - The ServletResponse with which to initialise the
                          asynchronous contextpublic boolean isAsyncStarted()
isAsyncStarted in interface ServletRequestpublic boolean isAsyncDispatching()
public boolean isAsyncCompleting()
public boolean isAsync()
public boolean isAsyncSupported()
isAsyncSupported in interface ServletRequestpublic AsyncContext getAsyncContext()
ServletRequestgetAsyncContext in interface ServletRequestpublic AsyncContextImpl getAsyncContextInternal()
public DispatcherType getDispatcherType()
getDispatcherType in interface ServletRequestpublic void addCookie(Cookie cookie)
cookie - The new cookiepublic void addLocale(Locale locale)
locale - The new preferred Locale@Deprecated public void addParameter(String name, String[] values)
name - Name of this request parametervalues - Corresponding values for this request parameterpublic void clearCookies()
@Deprecated public void clearHeaders()
public void clearLocales()
@Deprecated public void clearParameters()
public void setAuthType(String type)
null.  Typical values are "BASIC",
 "DIGEST", or "SSL".type - The authentication type used@Deprecated public void setContextPath(String path)
path - The context pathpublic void setPathInfo(String path)
path - The path informationpublic void setRequestedSessionCookie(boolean flag)
flag - The new flagpublic void setRequestedSessionId(String id)
id - The new session idpublic void setRequestedSessionURL(boolean flag)
flag - The new flagpublic void setRequestedSessionSSL(boolean flag)
flag - The new flagpublic String getDecodedRequestURI()
public MessageBytes getDecodedRequestURIMB()
@Deprecated public void setServletPath(String path)
path - The servlet pathpublic void setUserPrincipal(Principal principal)
getRemoteUser() method.principal - The user Principalpublic String getAuthType()
getAuthType in interface HttpServletRequestnull if the request was not authenticated.public String getContextPath()
getContextPath in interface HttpServletRequestString specifying the portion of the request URI
         that indicates the context of the request@Deprecated public MessageBytes getContextPathMB()
public Cookie[] getCookies()
getCookies in interface HttpServletRequest@Deprecated public void setCookies(Cookie[] cookies)
cookies - The array of recewived cookiespublic long getDateHeader(String name)
getDateHeader in interface HttpServletRequestname - Name of the requested date headerIllegalArgumentException - if the specified header value
  cannot be converted to a datepublic String getHeader(String name)
nullgetHeader in interface HttpServletRequestname - Name of the requested headerpublic Enumeration<String> getHeaders(String name)
getHeaders in interface HttpServletRequestname - Name of the requested headerpublic Enumeration<String> getHeaderNames()
HttpServletRequest
 Some servlet containers do not allow servlets to access headers using
 this method, in which case this method returns null
getHeaderNames in interface HttpServletRequestpublic int getIntHeader(String name)
getIntHeader in interface HttpServletRequestname - Name of the requested headerIllegalArgumentException - if the specified header value
  cannot be converted to an integerpublic String getMethod()
HttpServletRequestgetMethod in interface HttpServletRequestpublic String getPathInfo()
HttpServletRequest
 This method returns null if there was no extra path
 information.
 
Same as the value of the CGI variable PATH_INFO.
getPathInfo in interface HttpServletRequest@Deprecated public MessageBytes getPathInfoMB()
public String getPathTranslated()
HttpServletRequest
 If the URL does not have any extra path information, this method returns
 null or the servlet container cannot translate the virtual
 path to a real path for any reason (such as when the web application is
 executed from an archive). The web container does not decode this string.
getPathTranslated in interface HttpServletRequestpublic String getQueryString()
HttpServletRequestnull if the URL does not have a
 query string. Same as the value of the CGI variable QUERY_STRING.getQueryString in interface HttpServletRequestpublic String getRemoteUser()
HttpServletRequestnull if the user has not been
 authenticated. Whether the user name is sent with each subsequent request
 depends on the browser and type of authentication. Same as the value of
 the CGI variable REMOTE_USER.getRemoteUser in interface HttpServletRequestpublic MessageBytes getRequestPathMB()
public String getRequestedSessionId()
HttpServletRequestnull.getRequestedSessionId in interface HttpServletRequestHttpServletRequest.isRequestedSessionIdValid()public String getRequestURI()
HttpServletRequest| 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().
getRequestURI in interface HttpServletRequestHttpServletRequest.getRequestURL()public StringBuffer getRequestURL()
HttpServletRequest
 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.
getRequestURL in interface HttpServletRequestStringBuffer object containing the reconstructed
         URLpublic String getServletPath()
HttpServletRequestThis method will return an empty string ("") if the servlet used to process this request was matched using the "/*" pattern.
getServletPath in interface HttpServletRequest@Deprecated public MessageBytes getServletPathMB()
public HttpSession getSession()
HttpServletRequestgetSession in interface HttpServletRequestHttpServletRequest.getSession(boolean)public HttpSession getSession(boolean create)
HttpServletRequestHttpSession associated with this request
 or, if there is no current session and create is true,
 returns a new session.
 
 If create is false and the request has no valid
 HttpSession, this method returns null.
 
To make sure the session is properly maintained, you must call this method before the response is committed. If the container is using cookies to maintain session integrity and is asked to create a new session when the response is committed, an IllegalStateException is thrown.
getSession in interface HttpServletRequestcreate - Create a new session if one does not existHttpServletRequest.getSession()public boolean isRequestedSessionIdFromCookie()
HttpServletRequestisRequestedSessionIdFromCookie in interface HttpServletRequesttrue if the session identifier included in this
 request came from a cookie.HttpServletRequest.getSession(boolean)public boolean isRequestedSessionIdFromURL()
HttpServletRequestisRequestedSessionIdFromURL in interface HttpServletRequesttrue if the session identifier included in this
 request came from the request URI.HttpServletRequest.getSession(boolean)@Deprecated public boolean isRequestedSessionIdFromUrl()
isRequestedSessionIdFromURL() instead.isRequestedSessionIdFromUrl in interface HttpServletRequesttrue if the session identifier included in this
 request came from the request URI.public boolean isRequestedSessionIdValid()
HttpServletRequestisRequestedSessionIdValid in interface HttpServletRequesttrue if the session identifier included in this
 request identifies a valid session.HttpServletRequest.getRequestedSessionId(), 
HttpServletRequest.getSession(boolean)public boolean isUserInRole(String role)
HttpServletRequestfalse.isUserInRole in interface HttpServletRequestrole - Role name to be validatedtrue if the authenticated user principal
 possesses the specified role name.public Principal getPrincipal()
public Principal getUserPrincipal()
HttpServletRequestjava.security.Principal object containing the name
 of the current authenticated user. If the user has not been
 authenticated, the method returns null.getUserPrincipal in interface HttpServletRequestpublic Session getSessionInternal()
public void changeSessionId(String newSessionId)
newSessionId - The session to change the session ID forpublic String changeSessionId()
public Session getSessionInternal(boolean create)
create - Create a new session if one does not existpublic CometEventImpl getEvent()
public boolean isComet()
public void setComet(boolean comet)
comet - New value for flag that indicates whether this request is
              handling Comet trafficpublic boolean isParametersParsed()
true if we have parsed parameterspublic boolean getAvailable()
protected void checkSwallowInput()
public void cometClose()
public void setCometTimeout(long timeout)
@Deprecated public boolean isRequestedSessionIdFromSSL()
public boolean authenticate(HttpServletResponse response) throws IOException, ServletException
authenticate in interface HttpServletRequestresponse - The response to use to return any authentication
                  challengetrue if the user is successfully authenticated and
         false if notIOException - 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 failurepublic void login(String username, String password) throws ServletException
login in interface HttpServletRequestusername - The user name to authenticatepassword - The password to use to authenticate the userServletException - 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 failspublic void logout()
            throws ServletException
logout in interface HttpServletRequestServletException - If the logout failspublic Collection<Part> getParts() throws IOException, IllegalStateException, ServletException
getParts in interface HttpServletRequestIOException - if an I/O error occursIllegalStateException - if size limits are exceeded or no multipart configuration is
             providedServletException - if the request is not multipart/form-datapublic Part getPart(String name) throws IOException, IllegalStateException, ServletException
getPart in interface HttpServletRequestname - The name of the Part to obtainIOException - if an I/O error occursIllegalStateException - if size limits are exceededServletException - if the request is not multipart/form-data@Deprecated public void doUpgrade(UpgradeInbound inbound) throws IOException
inbound - The inbound connection to be upgradedIOException - if an I/O error occurrs during the upgrade processpublic <T extends HttpUpgradeHandler> T upgrade(Class<T> httpUpgradeHandlerClass) throws ServletException
ServletExceptionprotected Session doGetSession(boolean create)
protected void parseCookies()
protected void parseParameters()
protected int readPostBody(byte[] body,
               int len)
                    throws IOException
body - The bytes array in which the body will be readlen - The body lengthIOException - if an IO exception occurredprotected byte[] readChunkedPostBody()
                              throws IOException
IOException - if an IO exception occurredprotected void parseLocales()
Copyright © 2000-2020 Apache Software Foundation. All Rights Reserved.