| Modifier and Type | Class and Description |
|---|---|
| private static interface |
| Modifier and Type | Field and Description |
|---|---|
| private final ApplicationMapping | |
| private HttpServletRequest | |
| private volatile AsyncContextImpl | asyncContext
AsyncContext |
| protected Boolean | |
| private final Map | attributes
The attributes associated with this Request, keyed by attribute name. |
| protected String | authType
Authentication type. |
| protected static final int | CACHED_POST_LEN
Post data buffer. |
| protected final Connector | connector
Associated Catalina connector. |
| protected Cookie[] | cookies
The set of cookies associated with this Request. |
| protected boolean | cookiesConverted
Cookie parsed flag. |
| protected boolean | cookiesParsed
Cookie headers parsed flag. |
| protected Request | coyoteRequest
Coyote request. |
| protected static final Locale | defaultLocale
The default Locale if none are specified. |
| protected RequestFacade | facade
The facade associated with this request. |
| protected FilterChain | filterChain
Filter chain associated with the request. |
| private static final String | |
| protected final InputBuffer | inputBuffer
The associated input buffer. |
| protected CoyoteInputStream | inputStream
ServletInputStream. |
| protected DispatcherType | internalDispatcherType
The current dispatcher type. |
| protected String | localAddr
Local address |
| protected final ArrayList | locales
The preferred Locales associated with this Request. |
| protected boolean | localesParsed
Parse locales. |
| protected String | localName
Local address |
| protected int | localPort
Local port |
| private static final Log | |
| protected final MappingData | mappingData
Mapping data. |
| private final transient HashMap | notes
Internal notes associated with this request by Catalina components and event listeners. |
| protected ParameterMap | parameterMap
Hash map used in the getParametersMap method. |
| protected boolean | parametersParsed
Request parameters parsed flag. |
| protected Collection | parts
The parts, if any, uploaded with this request. |
| protected Exception | partsParseException
The exception thrown, if any when parsing the parts. |
| protected String | peerAddr
Connection peer address. |
| protected byte[] | |
| protected CoyoteReader | reader
Reader. |
| protected String | remoteAddr
Remote address. |
| protected String | remoteHost
Remote host. |
| protected int | remotePort
Remote port |
| protected Object | requestDispatcherPath
The current request dispatcher path. |
| protected boolean | requestedSessionCookie
Was the requested session ID received in a cookie? |
| protected String | requestedSessionId
The requested session ID (if any) for this request. |
| protected boolean | requestedSessionSSL
Was the requested session ID obtained from the SSL session? |
| protected boolean | requestedSessionURL
Was the requested session ID received in a URL? |
| protected Response | response
The response with which this request is associated. |
| protected boolean | secure
Secure flag. |
| protected Session | session
The currently active session for this request. |
| protected static final StringManager | sm
The string manager for this package. |
| private static final Map | |
| protected boolean | sslAttributesParsed
Flag that indicates if SSL attributes have been parsed to improve performance for applications (usually
frameworks) that make multiple calls to |
| protected transient Subject | subject
The Subject associated with the current AccessControlContext |
| protected B2CConverter | URIConverter
URI byte to char converter. |
| protected Principal | userPrincipal
User principal. |
| protected boolean | usingInputStream
Using stream flag. |
| protected boolean | usingReader
Using reader flag. |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public void | |
| public void | |
| protected void | |
| public boolean | authenticate(HttpServletResponse
The response to use to return any authentication challenge response)Implements jakarta. Triggers the same authentication process as would be triggered if the request is for a resource that is protected by a security constraint. |
| public void | changeSessionId(String
The session to change the session ID for newSessionId)Change the ID of the session that this request is associated with. |
| public String | changeSessionId()
Implements jakarta. Changes the session ID of the session associated with this request. |
| 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. |
| public void | |
| public void | |
| protected void | convertCookies()
Converts the parsed cookies (parsing the Cookie headers first if they have not been parsed) into Cookie objects. |
| public ServletInputStream | Returns: the created input streamCreate and return a ServletInputStream to read the content associated with this Request. |
| protected Session | |
| public void | finishRequest()
Perform whatever actions are required to flush and close the input stream or reader, in a single operation. |
| public AsyncContext | getAsyncContext()
Implements jakarta. Get the current AsyncContext. |
| public AsyncContextImpl | |
| public Object | Returns: the specified request attribute if it exists; otherwise, returnnull.Name of the request attribute to return name)Implements jakarta. Returns the value of the named attribute as an |
| public Enumeration | Returns: the attribute names enumerationImplements jakarta. Return the names of all request attributes for this Request, or an empty |
| public String | getAuthType()
Implements jakarta. Return the authentication type used for this Request. |
| public String | Returns: the character encoding for this Request.Implements jakarta. Returns the name of the character encoding used in the body of this request. |
| private Charset | |
| public Connector | |
| public int | Returns: the content length for this Request.Implements jakarta. Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known. |
| public long | getContentLengthLong()
Implements jakarta. Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known. |
| public String | Returns: the content type for this Request.Implements jakarta. Returns the MIME type of the body of the request, or |
| public Context | Returns: the Context mapped with the requestReturn the Context within which this Request is being processed. |
| public String | getContextPath()
Implements jakarta. Return the portion of the request URI used to select the Context of the Request. |
| private CookieProcessor | |
| public Cookie[] | Returns: the array of cookiesImplements jakarta. Return the set of Cookies received with this Request. |
| public Request | |
| public long | Returns: the date as a longName of the requested date header name)Implements jakarta. Return the value of the specified date header, if any; otherwise return -1. |
| public String | |
| public MessageBytes | |
| public boolean | Returns: the value of the flag as set on the connector, ortrue if no connector is associated with
this requestGet the recycling strategy of the facade objects. |
| public DispatcherType | |
| public FilterChain | |
| public String | Returns: the header valueName of the requested header name)Implements jakarta. Return the first value of the specified header, if any; otherwise, return |
| public Enumeration | Returns: the names of all headers received with this request.Implements jakarta. Returns an enumeration of all the header names this request contains. |
| public Enumeration | Returns: the enumeration with the header valuesName of the requested header name)Implements jakarta. Return all of the values of the specified header, if any; otherwise, return an empty enumeration. |
| public Host | |
| public HttpServletMapping | getHttpServletMapping()
Overrides default jakarta. Obtain the mapping information for this request. |
| public ServletInputStream | Returns: the servlet input stream for this Request. The default implementation returns a servlet input stream created bycreateInputStream().Implements jakarta. Retrieves the body of the request as binary data using a |
| public int | Returns: the header value as an intName of the requested header name)Implements jakarta. Return the value of the specified header as an integer, or -1 if there is no such header for this request. |
| public String | Returns: the Internet Protocol (IP) address of the interface on which the request was received.Implements jakarta. Returns the Internet Protocol (IP) address of the interface on which the request was received. |
| public Locale | Returns: the preferred Locale that the client will accept content in, based on the value for the firstAccept-Language header that was encountered. If the request did not specify a preferred
language, the server's default Locale is returned.Implements jakarta. Returns the preferred |
| public Enumeration | Returns: the set of preferred Locales that the client will accept content in, based on the values for anyAccept-Language headers that were encountered. If the request did not specify a
preferred language, the server's default Locale is returned.Implements jakarta. Returns an |
| public String | Returns: the host name of the Internet Protocol (IP) interface on which the request was received.Implements jakarta. Returns the host name of the Internet Protocol (IP) interface on which the request was received. |
| public int | Returns: the Internet Protocol (IP) port number of the interface on which the request was received.Implements jakarta. Returns the Internet Protocol (IP) port number of the interface on which the request was received. |
| public MappingData | |
| public String | Returns: the HTTP request method used in this Request.Implements jakarta. Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT. |
| private Set | |
| public Object | |
| public String | Returns: the value of the specified request parameter, if any; otherwise, returnnull. If there is
more than one value defined, return only the first one.Name of the desired request parameter name)Implements jakarta. Returns the value of a request parameter as a |
| public Map | Returns: AMap containing parameter names as keys and parameter values as map values.Implements jakarta. Returns a |
| public Enumeration | Returns: the names of all defined request parameters for this request.Implements jakarta. Returns an |
| public String[] | Returns: the defined values for the specified request parameter, if any; otherwise, returnnull.Name of the desired request parameter name)Implements jakarta. Returns an array of |
| public Part | getPart(String
The name of the Part to obtain name)Implements jakarta. Gets the named Part or null if the Part does not exist. |
| public Collection | getParts()
Implements jakarta. Return a collection of all uploaded Parts. |
| public String | Returns: the path information associated with this Request.Implements jakarta. Returns any extra path information associated with the URL the client sent when it made this request. |
| protected String | |
| public String | Returns: the extra path information for this request, translated to a real path.Implements jakarta. Returns any extra path information after the servlet name but before the query string, and translates it to a real path. |
| public String | |
| public Principal | |
| public String | Returns: the protocol and version used to make this Request.Implements jakarta. Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1. |
| public String | getProtocolRequestId()
Implements jakarta. Obtain the request identifier for this request as defined by the protocol in use. |
| public String | Returns: the query string associated with this request.Implements jakarta. Returns the query string that is contained in the request URL after the path. |
| public BufferedReader | Returns: a buffered reader for the requestImplements jakarta. Read the Reader wrapping the input stream for this Request. |
| public String | Returns: the remote IP address making this Request.Implements jakarta. Returns the Internet Protocol (IP) address of the client or last proxy that sent the request. |
| public String | Returns: the remote host name making this Request.Implements jakarta. Returns the fully qualified name of the client or the last proxy that sent the request. |
| public int | Returns: the Internet Protocol (IP) source port of the client or last proxy that sent the request.Implements jakarta. Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request. |
| public String | Returns: the name of the remote user that has been authenticated for this Request.Implements jakarta. Returns the login of the user making this request, if the user has been authenticated, or |
| public HttpServletRequest | Returns: theServletRequest for which this object is the facade. This method must be implemented by a
subclass.
|
| public RequestDispatcher | Returns: a RequestDispatcher that wraps the resource at the specified path, which may be interpreted as relative to the current request path.Path of the resource to be wrapped path)Implements jakarta. Returns a |
| public String | Returns: the session identifier included in this request, if any.Implements jakarta. Returns the session ID specified by the client. |
| public String | getRequestId()
Implements jakarta. Obtain a unique (within the lifetime of the Servlet container) identifier string for this request. |
| public MessageBytes | |
| public String | Returns: the request URI for this request.Implements jakarta. 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. |
| public StringBuffer | getRequestURL()
Implements jakarta. Reconstructs the URL the client used to make the request. |
| public Response | |
| public String | Returns: the scheme used to make this Request.Implements jakarta. Returns the name of the scheme used to make this request, for example, |
| public ServerCookies | Returns: the server cookiesReturn the server representation of the cookies associated with this request. |
| public String | Returns: the server name responding to this Request.Implements jakarta. Returns the host name of the server to which the request was sent. |
| public int | Returns: the server port responding to this Request.Implements jakarta. Returns the port number to which the request was sent. |
| public ServletConnection | getServletConnection()
Implements jakarta. Obtain details of the network connection to the Servlet container that is being used by this request. |
| public ServletContext | |
| public String | Returns: the portion of the request URI used to select the servlet that will process this request.Implements jakarta. Returns the part of this request's URL that calls the servlet. |
| public HttpSession | Returns: the session associated with this Request, creating one if necessary.Implements jakarta. Returns the current session associated with this request, or if the request does not have a session, creates one. |
| public HttpSession | Returns: the session associated with this Request, creating one if necessary and requested.Create a new session if one does not exist create)Implements jakarta. Returns the current |
| public Session | |
| public Session | Returns: the session associated with this Request, creating one if necessary and requested.Create a new session if one does not exist create)
|
| public InputStream | |
| public Map | getTrailerFields()
Overrides default jakarta. Obtain a Map of the trailer fields that is not backed by the request object. |
| private String | |
| protected B2CConverter | |
| public Principal | Returns: the principal that has been authenticated for this Request.Implements jakarta. Returns a |
| public Wrapper | |
| public boolean | |
| public boolean | |
| public boolean | |
| public boolean | |
| public boolean | |
| public boolean | Returns: true if an attempt has been made to read the request body and all of the request body has
been read.
|
| public boolean | |
| public boolean | Returns: true if the session identifier included in this request came from a cookie.Implements jakarta. Checks whether the requested session ID came in as a cookie. |
| public boolean | Returns: true if the session identifier included in this request came from the request URI.Implements jakarta. Checks whether the requested session ID came in as part of the request URL. |
| public boolean | Returns: true if the session identifier included in this request identifies a valid session.Implements jakarta. Checks whether the requested session ID is still valid. |
| public boolean | Returns: true if this request was received on a secure connection.Implements jakarta. Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS. |
| public boolean | isTrailerFieldsReady()
Overrides default jakarta. Are trailer fields ready to be read (there may still be no trailers to read). |
| public boolean | Returns: true if the authenticated user principal possesses the specified role name.Role name to be validated role)Implements jakarta. Returns a boolean indicating whether the authenticated user is included in the specified logical "role". |
| public void | login(String
The user name to authenticate username, String The password to use to authenticate the user password)Implements jakarta. Authenticate the provided user name and password and then associated the authenticated user with the request. |
| public void | logout()
Implements jakarta. Removes any authenticated user from the request. |
| public PushBuilder | newPushBuilder()
Overrides default jakarta. Obtain a builder for generating push requests. |
| public PushBuilder | |
| private Subject | |
| private int | |
| private void | notifyAttributeAssigned(String
Attribute name name, Object New attribute value value, Object Old attribute value oldValue)Notify interested listeners that attribute has been assigned a value. |
| private void | notifyAttributeRemoved(String
Attribute name name, Object Attribute value value)Notify interested listeners that attribute has been removed. |
| protected void | |
| protected void | |
| protected void | |
| protected void | |
| private void | |
| protected byte[] | |
| protected int | Returns: the bytes count that has been readThe bytes array in which the body will be read body, int The body length len)
Deprecated
Unused. Will be removed in Tomcat 11.0.x onwards. Use
readPostBodyFully(byte[], int)
Read post body into an array. |
| protected void | readPostBodyFully(byte[]
The bytes array in which the body will be read body, int The body length len)Read post body into an array. |
| public void | recycle()
Release all object references, and initialize instance variables, in preparation for reuse of this object. |
| protected void | |
| protected void | |
| public void | removeAttribute(String
Name of the request attribute to remove name)Implements jakarta. Remove the specified request attribute if it exists. |
| public void | removeNote(String
Name of the note to be removed name)Remove any object bound to the specified name in the internal notes for this request. |
| private String | |
| public void | |
| public void | setAttribute(String
Name of the request attribute to set name, Object The associated value value)Implements jakarta. Set the specified request attribute to the specified value. |
| public void | setAuthType(String
The authentication type used type)Set the authentication type used for this request, if any; otherwise set the type to |
| public void | setCharacterEncoding(String
The character encoding to be used enc)Implements jakarta. Overrides the name of the character encoding used in the body of this request. |
| public void | |
| public void | |
| public void | setFilterChain(FilterChain
new filter chain filterChain)Set filter chain associated with the request. |
| public void | |
| public void | |
| public void | |
| public void | setRemoteAddr(String
The remote IP address remoteAddr)Set the IP address of the remote client associated with this Request. |
| public void | setRemoteHost(String
The remote host name remoteHost)Set the fully qualified name of the remote client associated with this Request. |
| public void | setRequest(HttpServletRequest
The wrapped request to pass to the application applicationRequest)Set a wrapped HttpServletRequest to pass to the application. |
| public void | setRequestedSessionCookie(boolean
The new flag flag)Set a flag indicating whether or not the requested session ID for this request came in through a cookie. |
| public void | |
| public void | setRequestedSessionSSL(boolean
The new flag flag)Set a flag indicating whether or not the requested session ID for this request came in through SSL. |
| public void | setRequestedSessionURL(boolean
The new flag flag)Set a flag indicating whether or not the requested session ID for this request came in through a URL. |
| public void | setResponse(Response
The new associated response response)Set the Response with which this Request is associated. |
| public void | setSecure(boolean
The new isSecure value secure)Set the value to be returned by |
| public void | |
| protected void | |
| public void | setUserPrincipal(final Principal
The user Principal principal)Set the Principal who has been authenticated for this Request. |
| public AsyncContext | |
| public AsyncContext | startAsync(ServletRequest
The ServletRequest with which to initialise the asynchronous context request, ServletResponse The ServletResponse with which to initialise the asynchronous context response)Implements jakarta.
|
| protected String | |
| public <T extends HttpUpgradeHandler> T | upgrade(Class<T>
The class that implements the upgrade handler httpUpgradeHandlerClass)Implements jakarta. Start the HTTP upgrade process and create and instance of the provided protocol handler class. |