EE4J 10.0.0 · jakarta.servlet.http.HttpServletRequest

Modifier and Type	Field and Description
public static final String	BASIC_AUTH String identifier for Basic authentication.
public static final String	CLIENT_CERT_AUTH String identifier for Client Certificate authentication.
public static final String	DIGEST_AUTH String identifier for Digest authentication.
public static final String	FORM_AUTH String identifier for Form authentication.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` when non-null values were or have been established as the values returned by `getUserPrincipal`, `getRemoteUser`, and `getAuthType`. Return `false` if authentication is incomplete and the underlying login mechanism has committed, in the response, the message (e.g., challenge) and HTTP status code to be returned to the user. authenticate(HttpServletResponse The `HttpServletResponse` associated with this `HttpServletRequest` response) Use the container login mechanism configured for the `ServletContext` to authenticate the user making this request.
public String	Returns: the new session id changeSessionId() Change the session id of the current session associated with this request and return the new session id.
public String	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 `null` if the request was not authenticated. getAuthType() Returns the name of the authentication scheme used to protect the servlet.
public String	Returns: a `String` specifying the portion of the request URI that indicates the context of the request. The path will be canonicalized as per section 3.5 of the specification. This method will not return any encoded characters unless the container is configured specifically to allow them. getContextPath() Returns the portion of the request URI that indicates the context of the request.
public Cookie[]	Returns: an array of all the `Cookies` included with this request, or `null` if the request has no cookies getCookies() Returns an array containing all of the `Cookie` objects the client sent with this request.
public long	Returns: a `long` value representing the date specified in the header expressed as the number of milliseconds since January 1, 1970 GMT, or -1 if the named header was not included with the request getDateHeader(String a `String` specifying the name of the header name) Returns the value of the specified request header as a `long` value that represents a `Date` object.
public String	Returns: a `String` containing the value of the requested header, or `null` if the request does not have a header of that name getHeader(String a `String` specifying the header name name) Returns the value of the specified request header as a `String`.
public Enumeration<String>	Returns: an enumeration of all the header names sent with this request; if the request has no headers, an empty enumeration; if the servlet container does not allow servlets to use this method, `null` getHeaderNames() Returns an enumeration of all the header names this request contains.
public Enumeration<String>	Returns: an `Enumeration` containing the values of the requested header. If the request does not have any headers of that name return an empty enumeration. If the container does not allow access to header information, return null getHeaders(String a `String` specifying the header name name) Returns all the values of the specified request header as an `Enumeration` of `String` objects.
public default HttpServletMapping	Returns: An instance of `HttpServletMapping` describing the manner in which the current request was invoked. getHttpServletMapping() Return the HttpServletMapping of the request.
public int	Returns: an integer expressing the value of the request header or -1 if the request doesn't have a header of this name getIntHeader(String a `String` specifying the name of a request header name) Returns the value of the specified request header as an `int`.
public String	Returns: a `String` specifying the name of the method with which this request was made getMethod() Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
public Part	Returns: The `Part` with the given name, or `null` if this request is of type `multipart/form-data`, but does not contain the requested `Part` getPart(String the name of the requested `Part` name) Gets the `Part` with the given name.
public Collection<Part>	Returns: a (possibly empty) `Collection` of the `Part` components of this request getParts() Gets all the `Part` components of this request, provided that it is of type `multipart/form-data`.
public String	Returns: a `String` specifying extra path information that comes after the servlet path but before the query string in the request URL; or `null` if the URL does not have any extra path information. The path will be canonicalized as per section 3.5 of the specification. This method will not return any encoded characters unless the container is configured specifically to allow them. getPathInfo() Returns any extra path information associated with the URL the client sent when it made this request.
public String	Returns: a `String` specifying the real path, or `null` if the URL does not have any extra path information getPathTranslated() Returns any extra path information after the servlet name but before the query string, and translates it to a real path.
public String	Returns: a `String` containing the query string or `null` if the URL contains no query string. The value is not decoded by the container. getQueryString() Returns the query string that is contained in the request URL after the path.
public String	Returns: a `String` specifying the login of the user making this request, or `null` if the user login is not known getRemoteUser() Returns the login of the user making this request, if the user has been authenticated, or `null` if the user has not been authenticated.
public String	Returns: a `String` specifying the session ID, or `null` if the request did not specify a session ID getRequestedSessionId() Returns the session ID specified by the client.
public String	Returns: a `String` containing the part of the URL from the protocol name up to the query 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.
public StringBuffer	Returns: a `StringBuffer` object containing the reconstructed URL getRequestURL() Reconstructs the URL the client used to make the request.
public String	Returns: a `String` containing the path of the servlet being called, as specified in the request URL, or an empty string if the servlet used to process the request is matched using the "/*" pattern. The path will be canonicalized as per section 3.5 of the specification. This method will not return any encoded characters unless the container is configured specifically to allow them. getServletPath() Returns the part of this request's URL that calls the servlet.
public HttpSession	Returns: the `HttpSession` associated with this request or `null` if `create` is `false` and the request has no valid session getSession(boolean `true` to create a new session for this request if necessary; `false` to return `null` if there's no current session create) Returns the current `HttpSession` associated with this request or, if there is no current session and `create` is true, returns a new session.
public HttpSession	Returns: the `HttpSession` associated with this request getSession() Returns the current session associated with this request, or if the request does not have a session, creates one.
public default Map<String, String>	Returns: A map of trailer fields in which all the keys are in lowercase, regardless of the case they had at the protocol level. If there are no trailer fields, yet `isTrailerFieldsReady` is returning true, the empty map is returned. getTrailerFields() Get the request trailer fields.
public Principal	Returns: a `java.security.Principal` containing the name of the user making this request; `null` if the user has not been authenticated getUserPrincipal() Returns a `java.security.Principal` object containing the name of the current authenticated user.
public boolean	Returns: `true` if the session ID was conveyed to the server an an HTTP cookie; otherwise, `false` isRequestedSessionIdFromCookie() Checks whether the requested session ID was conveyed to the server as an HTTP cookie.
public boolean	Returns: `true` if the session ID was conveyed to the server as part of a URL; otherwise, `false` isRequestedSessionIdFromURL() Checks whether the requested session ID was conveyed to the server as part of the request URL.
public boolean	Returns: `true` if this request has an id for a valid session in the current session context; `false` otherwise isRequestedSessionIdValid() Checks whether the requested session ID is still valid.
public default boolean	Returns: a boolean whether trailer fields are ready to read isTrailerFieldsReady() Return a boolean indicating whether trailer fields are ready to read using `getTrailerFields`.
public boolean	Returns: a `boolean` indicating whether the user making this request belongs to a given role; `false` if the user has not been authenticated isUserInRole(String a `String` specifying the name of the role role) Returns a boolean indicating whether the authenticated user is included in the specified logical "role".
public void	login(String The `String` value corresponding to the login identifier of the user. username, String The password `String` corresponding to the identified user. password) Validate the provided username and password in the password validation realm used by the web container login mechanism configured for the `ServletContext`.
public void	logout() Establish `null` as the value returned when `getUserPrincipal`, `getRemoteUser`, and `getAuthType` is called on the request.
public default PushBuilder	Returns: a `PushBuilder` for issuing server push responses from the current request, or null if push is not supported newPushBuilder() Instantiates a new instance of `PushBuilder` for issuing server push responses from the current request.
public < The `Class`, which extends `HttpUpgradeHandler`, of the `handlerClass`. T extends HttpUpgradeHandler> T	Returns: an instance of the `HttpUpgradeHandler` upgrade(Class<T> The `HttpUpgradeHandler` class used for the upgrade. handlerClass) Creates an instance of `HttpUpgradeHandler` for a given class and uses it for the http protocol upgrade processing.

BASIC_AUTH	back to summary
public static final String BASIC_AUTH String identifier for Basic authentication. Value "BASIC"

CLIENT_CERT_AUTH	back to summary
public static final String CLIENT_CERT_AUTH String identifier for Client Certificate authentication. Value "CLIENT_CERT"

DIGEST_AUTH	back to summary
public static final String DIGEST_AUTH String identifier for Digest authentication. Value "DIGEST"

FORM_AUTH	back to summary
public static final String FORM_AUTH String identifier for Form authentication. Value "FORM"

Method Detail

authenticate back to summary

authenticate	back to summary
public boolean authenticate(HttpServletResponse response) throws IOException, ServletException Use the container login mechanism configured for the `ServletContext` to authenticate the user making this request. This method may modify and commit the argument `HttpServletResponse`. Parameters response:HttpServletResponse The `HttpServletResponse` associated with this `HttpServletRequest` Returns:boolean `true` when non-null values were or have been established as the values returned by `getUserPrincipal`, `getRemoteUser`, and `getAuthType`. Return `false` if authentication is incomplete and the underlying login mechanism has committed, in the response, the message (e.g., challenge) and HTTP status code to be returned to the user. Exceptions IOException: if an input or output error occurred while reading from this request or writing to the given response ServletException: if the authentication failed and the caller is responsible for handling the error (i.e., the underlying login mechanism did NOT establish the message and HTTP status code to be returned to the user) IllegalStateException: if the login mechanism attempted to modify the response and it was already committed Since Servlet 3.0

public boolean authenticate(HttpServletResponse response) throws IOException, ServletException

Use the container login mechanism configured for the ServletContext to authenticate the user making this request.

This method may modify and commit the argument HttpServletResponse.

Parameters

response:HttpServletResponse: The HttpServletResponse associated with this HttpServletRequest

Returns:boolean

true when non-null values were or have been established as the values returned by getUserPrincipal, getRemoteUser, and getAuthType. Return false if authentication is incomplete and the underlying login mechanism has committed, in the response, the message (e.g., challenge) and HTTP status code to be returned to the user.

Exceptions

IOException:: if an input or output error occurred while reading from this request or writing to the given response
ServletException:: if the authentication failed and the caller is responsible for handling the error (i.e., the underlying login mechanism did NOT establish the message and HTTP status code to be returned to the user)
IllegalStateException:: if the login mechanism attempted to modify the response and it was already committed

Since

Servlet 3.0

changeSessionId	back to summary
public String changeSessionId() Change the session id of the current session associated with this request and return the new session id. Returns:String the new session id Exceptions IllegalStateException: if there is no session associated with the request Since Servlet 3.1

changeSessionId

back to summary

public String changeSessionId()

Change the session id of the current session associated with this request and return the new session id.

Returns:String

the new session id

Exceptions

IllegalStateException:: if there is no session associated with the request

Since

Servlet 3.1

getAuthType back to summary

getAuthType	back to summary
public String getAuthType() Returns the name of the authentication scheme used to protect the servlet. All servlet containers support basic, form and client certificate authentication, and may additionally support digest authentication. If the servlet is not authenticated `null` is returned. Returns:String 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 `null` if the request was not authenticated.

public String getAuthType()

Returns the name of the authentication scheme used to protect the servlet. All servlet containers support basic, form and client certificate authentication, and may additionally support digest authentication. If the servlet is not authenticated null is returned.

Returns:String: 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 null if the request was not authenticated.

getContextPath back to summary

getContextPath	back to summary
public String getContextPath() Returns the portion of the request URI that indicates the context of the request. The context path always comes first in a request URI. The path starts with a "/" character but does not end with a "/" character. For servlets in the default (root) context, this method returns "". The container does not decode this string. It is possible that a servlet container may match a context by more than one context path. In such cases this method will return the actual context path used by the request and it may differ from the path returned by the `jakarta.servlet.ServletContext#getContextPath()` method. The context path returned by `jakarta.servlet.ServletContext#getContextPath()` should be considered as the prime or preferred context path of the application. Returns:String a `String` specifying the portion of the request URI that indicates the context of the request. The path will be canonicalized as per section 3.5 of the specification. This method will not return any encoded characters unless the container is configured specifically to allow them. Exceptions IllegalArgumentException: In standard configuration, this method will never throw. However, a container may be configured to not reject some suspicious sequences identified by 3.5.2, furthermore the container may be configured to allow such paths to only be accessed via safer methods like `getRequestURI()` and to throw IllegalArgumentException if this method is called for such suspicious paths. See Also `jakarta.servlet.ServletContext#getContextPath()`

public String getContextPath()

Returns the portion of the request URI that indicates the context of the request. The context path always comes first in a request URI. The path starts with a "/" character but does not end with a "/" character. For servlets in the default (root) context, this method returns "". The container does not decode this string.

It is possible that a servlet container may match a context by more than one context path. In such cases this method will return the actual context path used by the request and it may differ from the path returned by the jakarta.servlet.ServletContext#getContextPath() method. The context path returned by jakarta.servlet.ServletContext#getContextPath() should be considered as the prime or preferred context path of the application.

Returns:String

a String specifying the portion of the request URI that indicates the context of the request. The path will be canonicalized as per section 3.5 of the specification. This method will not return any encoded characters unless the container is configured specifically to allow them.

Exceptions

IllegalArgumentException:: In standard configuration, this method will never throw. However, a container may be configured to not reject some suspicious sequences identified by 3.5.2, furthermore the container may be configured to allow such paths to only be accessed via safer methods like getRequestURI() and to throw IllegalArgumentException if this method is called for such suspicious paths.

getCookies back to summary

public Cookie[] getCookies()

Returns an array containing all of the Cookie objects the client sent with this request. This method returns null if no cookies were sent.

Returns:Cookie[]: an array of all the Cookies included with this request, or null if the request has no cookies

getDateHeader back to summary

getDateHeader	back to summary
public long getDateHeader(String name) Returns the value of the specified request header as a `long` value that represents a `Date` object. Use this method with headers that contain dates, such as `If-Modified-Since`. The date is returned as the number of milliseconds since January 1, 1970 GMT. The header name is case insensitive. If the request did not have a header of the specified name, this method returns -1. If the header can't be converted to a date, the method throws an `IllegalArgumentException`. Parameters name:String a `String` specifying the name of the header Returns:long a `long` value representing the date specified in the header expressed as the number of milliseconds since January 1, 1970 GMT, or -1 if the named header was not included with the request Exceptions IllegalArgumentException: If the header value can't be converted to a date

public long getDateHeader(String name)

Returns the value of the specified request header as a long value that represents a Date object. Use this method with headers that contain dates, such as If-Modified-Since.

The date is returned as the number of milliseconds since January 1, 1970 GMT. The header name is case insensitive.

If the request did not have a header of the specified name, this method returns -1. If the header can't be converted to a date, the method throws an IllegalArgumentException.

Parameters

name:String: a String specifying the name of the header

Returns:long

a long value representing the date specified in the header expressed as the number of milliseconds since January 1, 1970 GMT, or -1 if the named header was not included with the request

Exceptions

IllegalArgumentException:: If the header value can't be converted to a date

getHeader back to summary

getHeader	back to summary
public String getHeader(String name) Returns the value of the specified request header as a `String`. If the request did not include a header of the specified name, this method returns `null`. If there are multiple headers with the same name, this method returns the first head in the request. The header name is case insensitive. You can use this method with any request header. Parameters name:String a `String` specifying the header name Returns:String a `String` containing the value of the requested header, or `null` if the request does not have a header of that name

public String getHeader(String name)

Returns the value of the specified request header as a String. If the request did not include a header of the specified name, this method returns null. If there are multiple headers with the same name, this method returns the first head in the request. The header name is case insensitive. You can use this method with any request header.

Parameters

name:String: a String specifying the header name

Returns:String

a String containing the value of the requested header, or null if the request does not have a header of that name

getHeaderNames back to summary

getHeaderNames	back to summary
public Enumeration<String> getHeaderNames() Returns 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` Returns:Enumeration<String> an enumeration of all the header names sent with this request; if the request has no headers, an empty enumeration; if the servlet container does not allow servlets to use this method, `null`

public Enumeration<String> getHeaderNames()

Returns 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

Returns:Enumeration<String>: an enumeration of all the header names sent with this request; if the request has no headers, an empty enumeration; if the servlet container does not allow servlets to use this method, null

getHeaders back to summary

getHeaders	back to summary
public Enumeration<String> getHeaders(String name) Returns all the values of the specified request header as an `Enumeration` of `String` objects. Some headers, such as `Accept-Language` can be sent by clients as several headers each with a different value rather than sending the header as a comma separated list. If the request did not include any headers of the specified name, this method returns an empty `Enumeration`. The header name is case insensitive. You can use this method with any request header. Parameters name:String a `String` specifying the header name Returns:Enumeration<String> an `Enumeration` containing the values of the requested header. If the request does not have any headers of that name return an empty enumeration. If the container does not allow access to header information, return null

public Enumeration<String> getHeaders(String name)

Returns all the values of the specified request header as an Enumeration of String objects.

Some headers, such as Accept-Language can be sent by clients as several headers each with a different value rather than sending the header as a comma separated list.

If the request did not include any headers of the specified name, this method returns an empty Enumeration. The header name is case insensitive. You can use this method with any request header.

Parameters

name:String: a String specifying the header name

Returns:Enumeration<String>

an Enumeration containing the values of the requested header. If the request does not have any headers of that name return an empty enumeration. If the container does not allow access to header information, return null

getHttpServletMapping back to summary

getHttpServletMapping	back to summary
public default HttpServletMapping getHttpServletMapping() Return the HttpServletMapping of the request. The mapping returned depends on the current `jakarta.servlet.DispatcherType` as obtained from `getDispatcherType()`: `jakarta.servlet.DispatcherType#REQUEST`, `jakarta.servlet.DispatcherType#ASYNC`, `jakarta.servlet.DispatcherType#ERROR` Return the mapping for the target of the dispatch i.e. the mapping for the current `jakarta.servlet.Servlet`. `jakarta.servlet.DispatcherType#INCLUDE` Return the mapping as prior to the current dispatch. i.e the mapping returned is unchanged by a call to `RequestDispatcher#include(ServletRequest, jakarta.servlet.ServletResponse)`. `jakarta.servlet.DispatcherType#FORWARD` Return the mapping for the target of the dispatch i.e. the mapping for the current `jakarta.servlet.Servlet`, unless the `jakarta.servlet.RequestDispatcher` was obtained via `jakarta.servlet.ServletContext#getNamedDispatcher(String)`, in which case return the mapping as prior to the current dispatch. i.e the mapping returned is changed during a call to `RequestDispatcher#forward(ServletRequest, jakarta.servlet.ServletResponse)` only if the dispatcher is not a named dispatcher. For example: For a sequence Servlet1 --include--> Servlet2 --include--> Servlet3, a call to this method in Servlet3 will return the mapping for Servlet1. For a sequence Servlet1 --async--> Servlet2 --named-forward--> Servlet3, a call to this method in Servlet3 will return the mapping for Servlet2. The returned object is immutable. Servlet 4.0 compliant implementations must override this method. Implementation Specification The default implementation returns a `HttpServletMapping` that returns the empty string for the match value, pattern and servlet name and `null` for the match type. Returns:HttpServletMapping An instance of `HttpServletMapping` describing the manner in which the current request was invoked. Since Servlet 4.0

public default HttpServletMapping getHttpServletMapping()

Return the HttpServletMapping of the request.

The mapping returned depends on the current jakarta.servlet.DispatcherType as obtained from getDispatcherType():

jakarta.servlet.DispatcherType#REQUEST, jakarta.servlet.DispatcherType#ASYNC, jakarta.servlet.DispatcherType#ERROR: Return the mapping for the target of the dispatch i.e. the mapping for the current jakarta.servlet.Servlet.
jakarta.servlet.DispatcherType#INCLUDE: Return the mapping as prior to the current dispatch. i.e the mapping returned is unchanged by a call to
jakarta.servlet.DispatcherType#FORWARD: Return the mapping for the target of the dispatch i.e. the mapping for the current jakarta.servlet.Servlet, unless the jakarta.servlet.RequestDispatcher was obtained via jakarta.servlet.ServletContext#getNamedDispatcher(String), in which case return the mapping as prior to the current dispatch. i.e the mapping returned is changed during a call to RequestDispatcher#forward(ServletRequest, jakarta.servlet.ServletResponse) only if the dispatcher is not a named dispatcher.

For example:

For a sequence Servlet1 --include--> Servlet2 --include--> Servlet3, a call to this method in Servlet3 will return the mapping for Servlet1.
For a sequence Servlet1 --async--> Servlet2 --named-forward--> Servlet3, a call to this method in Servlet3 will return the mapping for Servlet2.

The returned object is immutable. Servlet 4.0 compliant implementations must override this method.

Implementation Specification

The default implementation returns a HttpServletMapping that returns the empty string for the match value, pattern and servlet name and null for the match type.

Returns:HttpServletMapping: An instance of HttpServletMapping describing the manner in which the current request was invoked.
Since: Servlet 4.0

getIntHeader back to summary

getIntHeader	back to summary
public int getIntHeader(String name) Returns the value of the specified request header as an `int`. If the request does not have a header of the specified name, this method returns -1. If the header cannot be converted to an integer, this method throws a `NumberFormatException`. The header name is case insensitive. Parameters name:String a `String` specifying the name of a request header Returns:int an integer expressing the value of the request header or -1 if the request doesn't have a header of this name Exceptions NumberFormatException: If the header value can't be converted to an `int`

public int getIntHeader(String name)

Returns the value of the specified request header as an int. If the request does not have a header of the specified name, this method returns -1. If the header cannot be converted to an integer, this method throws a NumberFormatException.

The header name is case insensitive.

Parameters

name:String: a String specifying the name of a request header

Returns:int

an integer expressing the value of the request header or -1 if the request doesn't have a header of this name

Exceptions

NumberFormatException:: If the header value can't be converted to an int

getMethod back to summary

getMethod	back to summary
public String getMethod() Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT. Returns:String a `String` specifying the name of the method with which this request was made

public String getMethod()

Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.

Returns:String: a String specifying the name of the method with which this request was made

getPart back to summary

getPart	back to summary
public Part getPart(String name) throws IOException, ServletException Gets the `Part` with the given name. Parameters name:String the name of the requested `Part` Returns:Part The `Part` with the given name, or `null` if this request is of type `multipart/form-data`, but does not contain the requested `Part` Exceptions IOException: if an I/O error occurred during the retrieval of the requested `Part` ServletException: if this request is not of type `multipart/form-data` IllegalStateException: if the request body is larger than `maxRequestSize`, or any `Part` in the request is larger than `maxFileSize`, or there is no `@MultipartConfig` or `multipart-config` in deployment descriptors Since Servlet 3.0 See Also `jakarta.servlet.annotation.MultipartConfig#maxFileSize`, `jakarta.servlet.annotation.MultipartConfig#maxRequestSize`

public Part getPart(String name) throws IOException, ServletException

Gets the Part with the given name.

Parameters

name:String: the name of the requested Part

Returns:Part

The Part with the given name, or null if this request is of type multipart/form-data, but does not contain the requested Part

Exceptions

IOException:: if an I/O error occurred during the retrieval of the requested Part
ServletException:: if this request is not of type multipart/form-data
IllegalStateException:: if the request body is larger than maxRequestSize, or any Part in the request is larger than maxFileSize, or there is no @MultipartConfig or multipart-config in deployment descriptors

Since

Servlet 3.0

getParts back to summary

getParts	back to summary
public Collection<Part> getParts() throws IOException, ServletException Gets all the `Part` components of this request, provided that it is of type `multipart/form-data`. If this request is of type `multipart/form-data`, but does not contain any `Part` components, the returned `Collection` will be empty. Any changes to the returned `Collection` must not affect this `HttpServletRequest`. Returns:Collection<Part> a (possibly empty) `Collection` of the `Part` components of this request Exceptions IOException: if an I/O error occurred during the retrieval of the `Part` components of this request ServletException: if this request is not of type `multipart/form-data` IllegalStateException: if the request body is larger than `maxRequestSize`, or any `Part` in the request is larger than `maxFileSize`, or there is no `@MultipartConfig` or `multipart-config` in deployment descriptors Since Servlet 3.0 See Also `jakarta.servlet.annotation.MultipartConfig#maxFileSize`, `jakarta.servlet.annotation.MultipartConfig#maxRequestSize`

public Collection<Part> getParts() throws IOException, ServletException

Gets all the Part components of this request, provided that it is of type multipart/form-data.

If this request is of type multipart/form-data, but does not contain any Part components, the returned Collection will be empty.

Any changes to the returned Collection must not affect this HttpServletRequest.

Returns:Collection<Part>

a (possibly empty) Collection of the Part components of this request

Exceptions

IOException:: if an I/O error occurred during the retrieval of the Part components of this request
ServletException:: if this request is not of type multipart/form-data
IllegalStateException:: if the request body is larger than maxRequestSize, or any Part in the request is larger than maxFileSize, or there is no @MultipartConfig or multipart-config in deployment descriptors

Since

Servlet 3.0

getPathInfo back to summary

getPathInfo	back to summary
public String getPathInfo() Returns 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 `null` if there was no extra path information. Returns:String a `String` specifying extra path information that comes after the servlet path but before the query string in the request URL; or `null` if the URL does not have any extra path information. The path will be canonicalized as per section 3.5 of the specification. This method will not return any encoded characters unless the container is configured specifically to allow them. Exceptions IllegalArgumentException: In standard configuration, this method will never throw. However, a container may be configured to not reject some suspicious sequences identified by 3.5.2, furthermore the container may be configured to allow such paths to only be accessed via safer methods like `getRequestURI()` and to throw IllegalArgumentException if this method is called for such suspicious paths.

public String getPathInfo()

Returns 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 null if there was no extra path information.

Returns:String

a String specifying extra path information that comes after the servlet path but before the query string in the request URL; or null if the URL does not have any extra path information. The path will be canonicalized as per section 3.5 of the specification. This method will not return any encoded characters unless the container is configured specifically to allow them.

Exceptions

IllegalArgumentException:: In standard configuration, this method will never throw. However, a container may be configured to not reject some suspicious sequences identified by 3.5.2, furthermore the container may be configured to allow such paths to only be accessed via safer methods like getRequestURI() and to throw IllegalArgumentException if this method is called for such suspicious paths.

getPathTranslated back to summary

getPathTranslated	back to summary
public String getPathTranslated() Returns any extra path information after the servlet name but before the query string, and translates it to a real path. 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. Returns:String a `String` specifying the real path, or `null` if the URL does not have any extra path information

public String getPathTranslated()

Returns any extra path information after the servlet name but before the query string, and translates it to a real path.

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.

Returns:String: a String specifying the real path, or null if the URL does not have any extra path information

getQueryString back to summary

getQueryString	back to summary
public String getQueryString() Returns the query string that is contained in the request URL after the path. This method returns `null` if the URL does not have a query string. Returns:String a `String` containing the query string or `null` if the URL contains no query string. The value is not decoded by the container.

public String getQueryString()

Returns the query string that is contained in the request URL after the path. This method returns null if the URL does not have a query string.

Returns:String: a String containing the query string or null if the URL contains no query string. The value is not decoded by the container.

getRemoteUser back to summary

getRemoteUser	back to summary
public String getRemoteUser() Returns the login of the user making this request, if the user has been authenticated, or `null` 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. Returns:String a `String` specifying the login of the user making this request, or `null` if the user login is not known

public String getRemoteUser()

Returns the login of the user making this request, if the user has been authenticated, or null 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.

Returns:String: a String specifying the login of the user making this request, or null if the user login is not known

getRequestedSessionId back to summary

getRequestedSessionId	back to summary
public String getRequestedSessionId() Returns 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 returns `null`. Returns:String a `String` specifying the session ID, or `null` if the request did not specify a session ID See Also `isRequestedSessionIdValid`

public String getRequestedSessionId()

Returns 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 returns null.

Returns:String: a String specifying the session ID, or null if the request did not specify a session ID
See Also: isRequestedSessionIdValid

getRequestURI back to summary

public 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. The web container does not decode this String. For example:

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

Returns:String: a String containing the part of the URL from the protocol name up to the query string

getRequestURL back to summary

getRequestURL	back to summary
public StringBuffer getRequestURL() Reconstructs 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. If this request has been forwarded using `jakarta.servlet.RequestDispatcher#forward`, the server path in the reconstructed URL must reflect the path used to obtain the RequestDispatcher, and not the server path specified by the client. 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. Returns:StringBuffer a `StringBuffer` object containing the reconstructed URL

public StringBuffer getRequestURL()

Reconstructs 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.

If this request has been forwarded using jakarta.servlet.RequestDispatcher#forward, the server path in the reconstructed URL must reflect the path used to obtain the RequestDispatcher, and not the server path specified by the client.

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.

Returns:StringBuffer: a StringBuffer object containing the reconstructed URL

getServletPath back to summary

getServletPath	back to summary
public String getServletPath() Returns the part of this request's URL that calls the servlet. This path starts with a "/" character and includes the path to the servlet, but does not include any extra path information or a query string. This method will return an empty string ("") if the servlet used to process this request was matched using the "/" pattern. Returns:String a `String` containing the path of the servlet being called, as specified in the request URL, or an empty string if the servlet used to process the request is matched using the "/" pattern. The path will be canonicalized as per section 3.5 of the specification. This method will not return any encoded characters unless the container is configured specifically to allow them. Exceptions IllegalArgumentException: In standard configuration, this method will never throw. However, a container may be configured to not reject some suspicious sequences identified by 3.5.2, furthermore the container may be configured to allow such paths to only be accessed via safer methods like `getRequestURI()` and to throw IllegalArgumentException if this method is called for such suspicious paths.

public String getServletPath()

Returns the part of this request's URL that calls the servlet. This path starts with a "/" character and includes the path to the servlet, but does not include any extra path information or a query string.

This method will return an empty string ("") if the servlet used to process this request was matched using the "/*" pattern.

Returns:String

a String containing the path of the servlet being called, as specified in the request URL, or an empty string if the servlet used to process the request is matched using the "/*" pattern. The path will be canonicalized as per section 3.5 of the specification. This method will not return any encoded characters unless the container is configured specifically to allow them.

Exceptions

IllegalArgumentException:: In standard configuration, this method will never throw. However, a container may be configured to not reject some suspicious sequences identified by 3.5.2, furthermore the container may be configured to allow such paths to only be accessed via safer methods like getRequestURI() and to throw IllegalArgumentException if this method is called for such suspicious paths.

getSession back to summary

getSession	back to summary
public HttpSession getSession(boolean create) Returns the current `HttpSession` 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. Parameters create:boolean `true` to create a new session for this request if necessary; `false` to return `null` if there's no current session Returns:HttpSession the `HttpSession` associated with this request or `null` if `create` is `false` and the request has no valid session See Also `getSession()`

public HttpSession getSession(boolean create)

Returns the current HttpSession 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.

Parameters

create:boolean: true to create a new session for this request if necessary; false to return null if there's no current session

Returns:HttpSession

the HttpSession associated with this request or null if create is false and the request has no valid session

See Also

getSession()

getSession back to summary

getSession	back to summary
public HttpSession getSession() Returns the current session associated with this request, or if the request does not have a session, creates one. Returns:HttpSession the `HttpSession` associated with this request See Also `getSession(boolean)`

public HttpSession getSession()

Returns the current session associated with this request, or if the request does not have a session, creates one.

Returns:HttpSession: the HttpSession associated with this request
See Also: getSession(boolean)

getTrailerFields back to summary

getTrailerFields	back to summary
public default Map<String, String> getTrailerFields() Get the request trailer fields. The returned map is not backed by the `HttpServletRequest` object, so changes in the returned map are not reflected in the `HttpServletRequest` object, and vice-versa. `isTrailerFieldsReady()` should be called first to determine if it is safe to call this method without causing an exception. Implementation Specification The default implementation returns an empty map. Returns:Map<String, String> A map of trailer fields in which all the keys are in lowercase, regardless of the case they had at the protocol level. If there are no trailer fields, yet `isTrailerFieldsReady` is returning true, the empty map is returned. Exceptions IllegalStateException: if `isTrailerFieldsReady()` is false Since Servlet 4.0

public default Map<String, String> getTrailerFields()

Get the request trailer fields.

The returned map is not backed by the HttpServletRequest object, so changes in the returned map are not reflected in the HttpServletRequest object, and vice-versa.

isTrailerFieldsReady() should be called first to determine if it is safe to call this method without causing an exception.

Implementation Specification

The default implementation returns an empty map.

Returns:Map<String, String>

A map of trailer fields in which all the keys are in lowercase, regardless of the case they had at the protocol level. If there are no trailer fields, yet isTrailerFieldsReady is returning true, the empty map is returned.

Exceptions

IllegalStateException:: if isTrailerFieldsReady() is false

Since

Servlet 4.0

getUserPrincipal back to summary

getUserPrincipal	back to summary
public Principal getUserPrincipal() Returns a `java.security.Principal` object containing the name of the current authenticated user. If the user has not been authenticated, the method returns `null`. Returns:Principal a `java.security.Principal` containing the name of the user making this request; `null` if the user has not been authenticated

public Principal getUserPrincipal()

Returns a java.security.Principal object containing the name of the current authenticated user. If the user has not been authenticated, the method returns null.

Returns:Principal: a java.security.Principal containing the name of the user making this request; null if the user has not been authenticated

isRequestedSessionIdFromCookie back to summary

public boolean isRequestedSessionIdFromCookie()

Checks whether the requested session ID was conveyed to the server as an HTTP cookie.

Returns:boolean: true if the session ID was conveyed to the server an an HTTP cookie; otherwise, false
See Also: getSession

isRequestedSessionIdFromURL back to summary

isRequestedSessionIdFromURL	back to summary
public boolean isRequestedSessionIdFromURL() Checks whether the requested session ID was conveyed to the server as part of the request URL. Returns:boolean `true` if the session ID was conveyed to the server as part of a URL; otherwise, `false` See Also `getSession`

public boolean isRequestedSessionIdFromURL()

Checks whether the requested session ID was conveyed to the server as part of the request URL.

Returns:boolean: true if the session ID was conveyed to the server as part of a URL; otherwise, false
See Also: getSession

isRequestedSessionIdValid back to summary

isRequestedSessionIdValid	back to summary
public boolean isRequestedSessionIdValid() Checks whether the requested session ID is still valid. If the client did not specify any session ID, this method returns `false`. Returns:boolean `true` if this request has an id for a valid session in the current session context; `false` otherwise See Also `getRequestedSessionId`, `getSession`

public boolean isRequestedSessionIdValid()

Checks whether the requested session ID is still valid.

If the client did not specify any session ID, this method returns false.

Returns:boolean: true if this request has an id for a valid session in the current session context; false otherwise
See Also: getRequestedSessionId, getSession

isTrailerFieldsReady back to summary

isTrailerFieldsReady	back to summary
public default boolean isTrailerFieldsReady() Return a boolean indicating whether trailer fields are ready to read using `getTrailerFields`. This methods returns true immediately if it is known that there is no trailer in the request, for instance, the underlying protocol (such as HTTP 1.0) does not supports the trailer fields, or the request is not in chunked encoding in HTTP 1.1. And the method also returns true if both of the following conditions are satisfied: the application has read all the request data and an EOF indication has been returned from the `getReader` or `getInputStream`. all the trailer fields sent by the client have been received. Note that it is possible that the client has sent no trailer fields. Implementation Specification The default implementation returns false. Returns:boolean a boolean whether trailer fields are ready to read Since Servlet 4.0

public default boolean isTrailerFieldsReady()

Return a boolean indicating whether trailer fields are ready to read using getTrailerFields. This methods returns true immediately if it is known that there is no trailer in the request, for instance, the underlying protocol (such as HTTP 1.0) does not supports the trailer fields, or the request is not in chunked encoding in HTTP 1.1. And the method also returns true if both of the following conditions are satisfied:

the application has read all the request data and an EOF indication has been returned from the getReader or getInputStream.
all the trailer fields sent by the client have been received. Note that it is possible that the client has sent no trailer fields.

Implementation Specification

The default implementation returns false.

Returns:boolean: a boolean whether trailer fields are ready to read
Since: Servlet 4.0

isUserInRole back to summary

isUserInRole	back to summary
public boolean isUserInRole(String role) Returns 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 returns `false`. The role name "" should never be used as an argument in calling `isUserInRole`. Any call to `isUserInRole` with "" must return false. If the role-name of the security-role to be tested is "", and the application has NOT declared an application security-role with role-name "", `isUserInRole` must only return true if the user has been authenticated; that is, only when `getRemoteUser` and `getUserPrincipal` would both return a non-null value. Otherwise, the container must check the user for membership in the application role. Parameters role:String a `String` specifying the name of the role Returns:boolean a `boolean` indicating whether the user making this request belongs to a given role; `false` if the user has not been authenticated

public boolean isUserInRole(String role)

Returns 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 returns false.

The role name "*" should never be used as an argument in calling isUserInRole. Any call to isUserInRole with "*" must return false. If the role-name of the security-role to be tested is "**", and the application has NOT declared an application security-role with role-name "**", isUserInRole must only return true if the user has been authenticated; that is, only when getRemoteUser and getUserPrincipal would both return a non-null value. Otherwise, the container must check the user for membership in the application role.

Parameters

role:String: a String specifying the name of the role

Returns:boolean

a boolean indicating whether the user making this request belongs to a given role; false if the user has not been authenticated

login	back to summary
public void login(String username, String password) throws ServletException Validate the provided username and password in the password validation realm used by the web container login mechanism configured for the `ServletContext`. This method returns without throwing a `ServletException` when the login mechanism configured for the `ServletContext` supports username password validation, and when, at the time of the call to login, the identity of the caller of the request had not been established (i.e, all of `getUserPrincipal`, `getRemoteUser`, and `getAuthType` return null), and when validation of the provided credentials is successful. Otherwise, this method throws a `ServletException` as described below. When this method returns without throwing an exception, it must have established non-null values as the values returned by `getUserPrincipal`, `getRemoteUser`, and `getAuthType`. Parameters username:String The `String` value corresponding to the login identifier of the user. password:String The password `String` corresponding to the identified user. Exceptions ServletException: if the configured login mechanism does not support username password authentication, or if a non-null caller identity had already been established (prior to the call to login), or if validation of the provided username and password fails. Since Servlet 3.0

public void login(String username, String password) throws ServletException

Validate the provided username and password in the password validation realm used by the web container login mechanism configured for the ServletContext.

This method returns without throwing a ServletException when the login mechanism configured for the ServletContext supports username password validation, and when, at the time of the call to login, the identity of the caller of the request had not been established (i.e, all of getUserPrincipal, getRemoteUser, and getAuthType return null), and when validation of the provided credentials is successful. Otherwise, this method throws a ServletException as described below.

When this method returns without throwing an exception, it must have established non-null values as the values returned by getUserPrincipal, getRemoteUser, and getAuthType.

Parameters

username:String: The String value corresponding to the login identifier of the user.
password:String: The password String corresponding to the identified user.

Exceptions

ServletException:: if the configured login mechanism does not support username password authentication, or if a non-null caller identity had already been established (prior to the call to login), or if validation of the provided username and password fails.

Since

Servlet 3.0

logout back to summary

logout	back to summary
public void logout() throws ServletException Establish `null` as the value returned when `getUserPrincipal`, `getRemoteUser`, and `getAuthType` is called on the request. Exceptions ServletException: if logout fails Since Servlet 3.0

public void logout() throws ServletException

Establish null as the value returned when getUserPrincipal, getRemoteUser, and getAuthType is called on the request.

Exceptions

ServletException:: if logout fails

Since

Servlet 3.0

newPushBuilder back to summary

newPushBuilder	back to summary
public default PushBuilder newPushBuilder() Instantiates a new instance of `PushBuilder` for issuing server push responses from the current request. This method returns null if the current connection does not support server push, or server push has been disabled by the client via a `SETTINGS_ENABLE_PUSH` settings frame value of `0` (zero). Implementation Specification The default implementation returns null. Returns:PushBuilder a `PushBuilder` for issuing server push responses from the current request, or null if push is not supported Since Servlet 4.0

public default PushBuilder newPushBuilder()

Instantiates a new instance of PushBuilder for issuing server push responses from the current request. This method returns null if the current connection does not support server push, or server push has been disabled by the client via a SETTINGS_ENABLE_PUSH settings frame value of 0 (zero).

Implementation Specification

The default implementation returns null.

Returns:PushBuilder: a PushBuilder for issuing server push responses from the current request, or null if push is not supported
Since: Servlet 4.0

upgrade back to summary

upgrade	back to summary
public <T extends HttpUpgradeHandler> T upgrade(Class<T> handlerClass) throws IOException, ServletException Creates an instance of `HttpUpgradeHandler` for a given class and uses it for the http protocol upgrade processing. Parameters <T> The `Class`, which extends `HttpUpgradeHandler`, of the `handlerClass`. handlerClass:Class<T> The `HttpUpgradeHandler` class used for the upgrade. Returns:T an instance of the `HttpUpgradeHandler` Exceptions IOException: if an I/O error occurred during the upgrade ServletException: if the given `handlerClass` fails to be instantiated Since Servlet 3.1 See Also `jakarta.servlet.http.HttpUpgradeHandler`, `jakarta.servlet.http.WebConnection`

public <T extends HttpUpgradeHandler> T upgrade(Class<T> handlerClass) throws IOException, ServletException

Creates an instance of HttpUpgradeHandler for a given class and uses it for the http protocol upgrade processing.

Parameters

<T>: The Class, which extends HttpUpgradeHandler, of the handlerClass.
handlerClass:Class<T>: The HttpUpgradeHandler class used for the upgrade.

Returns:T

an instance of the HttpUpgradeHandler

Exceptions

IOException:: if an I/O error occurred during the upgrade
ServletException:: if the given handlerClass fails to be instantiated

Since

Servlet 3.1

public Interface HttpServletRequest

Field Summary

Method Summary

Field Detail

Method Detail