Jakarta EE 11.0.0 · jakarta.servlet.http.HttpServletRequestWrapper

Access	Constructor and Description
public	HttpServletRequestWrapper(HttpServletRequest the `HttpServletRequest` to be wrapped. request) Constructs a request object wrapping the given request.

Method Summary

Modifier and Type	Method and Description
private HttpServletRequest	_getHttpServletRequest()
public boolean	authenticate(HttpServletResponse The `HttpServletResponse` associated with this `HttpServletRequest` response) Implements jakarta.servlet.http.HttpServletRequest.authenticate. The default behavior of this method is to call authenticate on the wrapped request object.
public String	changeSessionId() Implements jakarta.servlet.http.HttpServletRequest.changeSessionId. The default behavior of this method is to return changeSessionId() on the wrapped request object.
public String	getAuthType() Implements jakarta.servlet.http.HttpServletRequest.getAuthType. The default behavior of this method is to return getAuthType() on the wrapped request object.
public String	getContextPath() Implements jakarta.servlet.http.HttpServletRequest.getContextPath. The default behavior of this method is to return getContextPath() on the wrapped request object.
public Cookie[]	getCookies() Implements jakarta.servlet.http.HttpServletRequest.getCookies. The default behavior of this method is to return getCookies() on the wrapped request object.
public long	getDateHeader(String a `String` specifying the name of the header name) Implements jakarta.servlet.http.HttpServletRequest.getDateHeader. The default behavior of this method is to return getDateHeader(String name) on the wrapped request object.
public String	getHeader(String a `String` specifying the header name name) Implements jakarta.servlet.http.HttpServletRequest.getHeader. The default behavior of this method is to return getHeader(String name) on the wrapped request object.
public Enumeration<String>	getHeaderNames() Implements jakarta.servlet.http.HttpServletRequest.getHeaderNames. The default behavior of this method is to return getHeaderNames() on the wrapped request object.
public Enumeration<String>	getHeaders(String a `String` specifying the header name name) Implements jakarta.servlet.http.HttpServletRequest.getHeaders. The default behavior of this method is to return getHeaders(String name) on the wrapped request object.
public HttpServletMapping	getHttpServletMapping() Overrides default jakarta.servlet.http.HttpServletRequest.getHttpServletMapping. The default behavior of this method is to return getServletMapping() on the wrapped request object.
public int	getIntHeader(String a `String` specifying the name of a request header name) Implements jakarta.servlet.http.HttpServletRequest.getIntHeader. The default behavior of this method is to return getIntHeader(String name) on the wrapped request object.
public String	getMethod() Implements jakarta.servlet.http.HttpServletRequest.getMethod. The default behavior of this method is to return getMethod() on the wrapped request object.
public Part	getPart(String the name of the requested `Part` name) Implements jakarta.servlet.http.HttpServletRequest.getPart. The default behavior of this method is to call getPart on the wrapped request object.
public Collection<Part>	getParts() Implements jakarta.servlet.http.HttpServletRequest.getParts. The default behavior of this method is to call getParts on the wrapped request object.
public String	getPathInfo() Implements jakarta.servlet.http.HttpServletRequest.getPathInfo. The default behavior of this method is to return getPathInfo() on the wrapped request object.
public String	getPathTranslated() Implements jakarta.servlet.http.HttpServletRequest.getPathTranslated. The default behavior of this method is to return getPathTranslated() on the wrapped request object.
public String	getQueryString() Implements jakarta.servlet.http.HttpServletRequest.getQueryString. The default behavior of this method is to return getQueryString() on the wrapped request object.
public String	getRemoteUser() Implements jakarta.servlet.http.HttpServletRequest.getRemoteUser. The default behavior of this method is to return getRemoteUser() on the wrapped request object.
public String	getRequestedSessionId() Implements jakarta.servlet.http.HttpServletRequest.getRequestedSessionId. The default behavior of this method is to return getRequestedSessionId() on the wrapped request object.
public String	getRequestURI() Implements jakarta.servlet.http.HttpServletRequest.getRequestURI. The default behavior of this method is to return getRequestURI() on the wrapped request object.
public StringBuffer	getRequestURL() Implements jakarta.servlet.http.HttpServletRequest.getRequestURL. The default behavior of this method is to return getRequestURL() on the wrapped request object.
public String	getServletPath() Implements jakarta.servlet.http.HttpServletRequest.getServletPath. The default behavior of this method is to return getServletPath() on the wrapped request object.
public HttpSession	getSession(boolean `true` to create a new session for this request if necessary; `false` to return `null` if there's no current session create) Implements jakarta.servlet.http.HttpServletRequest.getSession. The default behavior of this method is to return getSession(boolean create) on the wrapped request object.
public HttpSession	getSession() Implements jakarta.servlet.http.HttpServletRequest.getSession. The default behavior of this method is to return getSession() on the wrapped request object.
public Map<String, String>	getTrailerFields() Overrides default jakarta.servlet.http.HttpServletRequest.getTrailerFields. The default behavior of this method is to call getTrailerFields on the wrapped request object.
public Principal	getUserPrincipal() Implements jakarta.servlet.http.HttpServletRequest.getUserPrincipal. The default behavior of this method is to return getUserPrincipal() on the wrapped request object.
public boolean	isRequestedSessionIdFromCookie() Implements jakarta.servlet.http.HttpServletRequest.isRequestedSessionIdFromCookie. The default behavior of this method is to return isRequestedSessionIdFromCookie() on the wrapped request object.
public boolean	isRequestedSessionIdFromURL() Implements jakarta.servlet.http.HttpServletRequest.isRequestedSessionIdFromURL. The default behavior of this method is to return isRequestedSessionIdFromURL() on the wrapped request object.
public boolean	isRequestedSessionIdValid() Implements jakarta.servlet.http.HttpServletRequest.isRequestedSessionIdValid. The default behavior of this method is to return isRequestedSessionIdValid() on the wrapped request object.
public boolean	isTrailerFieldsReady() Overrides default jakarta.servlet.http.HttpServletRequest.isTrailerFieldsReady. The default behavior of this method is to call isTrailerFieldsReady on the wrapped request object.
public boolean	isUserInRole(String a `String` specifying the name of the role role) Implements jakarta.servlet.http.HttpServletRequest.isUserInRole. The default behavior of this method is to return isUserInRole(String role) on the wrapped request object.
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) Implements jakarta.servlet.http.HttpServletRequest.login. The default behavior of this method is to call login on the wrapped request object.
public void	logout() Implements jakarta.servlet.http.HttpServletRequest.logout. The default behavior of this method is to call login on the wrapped request object.
public PushBuilder	newPushBuilder() Overrides default jakarta.servlet.http.HttpServletRequest.newPushBuilder. Deprecated In favor of 103 early hints The default behavior of this method is to call newPushBuilder on the wrapped request object.
public <T extends HttpUpgradeHandler> T	upgrade(Class<T> The `HttpUpgradeHandler` class used for the upgrade. handlerClass) Implements jakarta.servlet.http.HttpServletRequest.upgrade. Create an instance of `HttpUpgradeHandler` for a given class and uses it for the http protocol upgrade processing.

HttpServletRequestWrapper	back to summary
public HttpServletRequestWrapper(HttpServletRequest request) Constructs a request object wrapping the given request. Parameters request:HttpServletRequest the `HttpServletRequest` to be wrapped. Exceptions IllegalArgumentException: if the request is null

Method Detail

_getHttpServletRequest	back to summary
private HttpServletRequest _getHttpServletRequest()

authenticate back to summary

authenticate	back to summary
public boolean authenticate(HttpServletResponse response) throws IOException, ServletException Implements jakarta.servlet.http.HttpServletRequest.authenticate. The default behavior of this method is to call authenticate on the wrapped request object. Parameters response:HttpServletResponse Doc from jakarta.servlet.http.HttpServletRequest.authenticate. The `HttpServletResponse` associated with this `HttpServletRequest` Returns:boolean Doc from jakarta.servlet.http.HttpServletRequest.authenticate. `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. Annotations @Override Exceptions IOException: Doc from jakarta.servlet.http.HttpServletRequest.authenticate. if an input or output error occurred while reading from this request or writing to the given response ServletException: Doc from jakarta.servlet.http.HttpServletRequest.authenticate. 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) Since Servlet 3.0

public boolean authenticate(HttpServletResponse response) throws IOException, ServletException

Implements jakarta.servlet.http.HttpServletRequest.authenticate.

The default behavior of this method is to call authenticate on the wrapped request object.

Parameters

response:HttpServletResponse

Doc from jakarta.servlet.http.HttpServletRequest.authenticate.

The HttpServletResponse associated with this HttpServletRequest

Returns:boolean

Doc from jakarta.servlet.http.HttpServletRequest.authenticate.

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.

Annotations

@Override

Exceptions

IOException:

Doc from jakarta.servlet.http.HttpServletRequest.authenticate.

if an input or output error occurred while reading from this request or writing to the given response

ServletException:

Doc from jakarta.servlet.http.HttpServletRequest.authenticate.

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)

Since

Servlet 3.0

changeSessionId	back to summary
public String changeSessionId() Implements jakarta.servlet.http.HttpServletRequest.changeSessionId. The default behavior of this method is to return changeSessionId() on the wrapped request object. Returns:String Doc from jakarta.servlet.http.HttpServletRequest.changeSessionId. the new session id Annotations @Override Since Servlet 3.1

changeSessionId

back to summary

public String changeSessionId()

Implements jakarta.servlet.http.HttpServletRequest.changeSessionId.

The default behavior of this method is to return changeSessionId() on the wrapped request object.

Returns:String

Doc from jakarta.servlet.http.HttpServletRequest.changeSessionId.

the new session id

Annotations

@Override

Since

Servlet 3.1

getAuthType back to summary

getAuthType	back to summary
public String getAuthType() Implements jakarta.servlet.http.HttpServletRequest.getAuthType. The default behavior of this method is to return getAuthType() on the wrapped request object. Returns:String Doc from jakarta.servlet.http.HttpServletRequest.getAuthType. 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. Annotations @Override

public String getAuthType()

Implements jakarta.servlet.http.HttpServletRequest.getAuthType.

The default behavior of this method is to return getAuthType() on the wrapped request object.

Returns:String

Doc from jakarta.servlet.http.HttpServletRequest.getAuthType.

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.

Annotations

@Override

getContextPath back to summary

getContextPath	back to summary
public String getContextPath() Implements jakarta.servlet.http.HttpServletRequest.getContextPath. The default behavior of this method is to return getContextPath() on the wrapped request object. Returns:String Doc from jakarta.servlet.http.HttpServletRequest.getContextPath. a `String` specifying the portion of the request URI that indicates the context of the request. Annotations @Override

public String getContextPath()

Implements jakarta.servlet.http.HttpServletRequest.getContextPath.

The default behavior of this method is to return getContextPath() on the wrapped request object.

Returns:String

Doc from jakarta.servlet.http.HttpServletRequest.getContextPath.

a String specifying the portion of the request URI that indicates the context of the request.

Annotations

@Override

getCookies back to summary

public Cookie[] getCookies()

Implements jakarta.servlet.http.HttpServletRequest.getCookies.

The default behavior of this method is to return getCookies() on the wrapped request object.

Returns:Cookie[]

Doc from jakarta.servlet.http.HttpServletRequest.getCookies.

an array of all the Cookies included with this request, or null if the request has no cookies

Annotations

@Override

getDateHeader back to summary

getDateHeader	back to summary
public long getDateHeader(String name) Implements jakarta.servlet.http.HttpServletRequest.getDateHeader. The default behavior of this method is to return getDateHeader(String name) on the wrapped request object. Parameters name:String Doc from jakarta.servlet.http.HttpServletRequest.getDateHeader. a `String` specifying the name of the header Returns:long Doc from jakarta.servlet.http.HttpServletRequest.getDateHeader. 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 Annotations @Override

public long getDateHeader(String name)

Implements jakarta.servlet.http.HttpServletRequest.getDateHeader.

The default behavior of this method is to return getDateHeader(String name) on the wrapped request object.

Parameters

name:String

Doc from jakarta.servlet.http.HttpServletRequest.getDateHeader.

a String specifying the name of the header

Returns:long

Doc from jakarta.servlet.http.HttpServletRequest.getDateHeader.

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

Annotations

@Override

getHeader back to summary

getHeader	back to summary
public String getHeader(String name) Implements jakarta.servlet.http.HttpServletRequest.getHeader. The default behavior of this method is to return getHeader(String name) on the wrapped request object. Parameters name:String Doc from jakarta.servlet.http.HttpServletRequest.getHeader. a `String` specifying the header name Returns:String Doc from jakarta.servlet.http.HttpServletRequest.getHeader. a `String` containing the value of the requested header, or `null` if the request does not have a header of that name Annotations @Override

public String getHeader(String name)

Implements jakarta.servlet.http.HttpServletRequest.getHeader.

The default behavior of this method is to return getHeader(String name) on the wrapped request object.

Parameters

name:String

Doc from jakarta.servlet.http.HttpServletRequest.getHeader.

a String specifying the header name

Returns:String

Doc from jakarta.servlet.http.HttpServletRequest.getHeader.

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

Annotations

@Override

getHeaderNames back to summary

getHeaderNames	back to summary
public Enumeration<String> getHeaderNames() Implements jakarta.servlet.http.HttpServletRequest.getHeaderNames. The default behavior of this method is to return getHeaderNames() on the wrapped request object. Returns:Enumeration<String> Doc from jakarta.servlet.http.HttpServletRequest.getHeaderNames. 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` Annotations @Override

public Enumeration<String> getHeaderNames()

Implements jakarta.servlet.http.HttpServletRequest.getHeaderNames.

The default behavior of this method is to return getHeaderNames() on the wrapped request object.

Returns:Enumeration<String>

Doc from jakarta.servlet.http.HttpServletRequest.getHeaderNames.

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

Annotations

@Override

getHeaders back to summary

getHeaders	back to summary
public Enumeration<String> getHeaders(String name) Implements jakarta.servlet.http.HttpServletRequest.getHeaders. The default behavior of this method is to return getHeaders(String name) on the wrapped request object. Parameters name:String Doc from jakarta.servlet.http.HttpServletRequest.getHeaders. a `String` specifying the header name Returns:Enumeration<String> Doc from jakarta.servlet.http.HttpServletRequest.getHeaders. 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 Annotations @Override

public Enumeration<String> getHeaders(String name)

Implements jakarta.servlet.http.HttpServletRequest.getHeaders.

The default behavior of this method is to return getHeaders(String name) on the wrapped request object.

Parameters

name:String

Doc from jakarta.servlet.http.HttpServletRequest.getHeaders.

a String specifying the header name

Returns:Enumeration<String>

Doc from jakarta.servlet.http.HttpServletRequest.getHeaders.

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

Annotations

@Override

getHttpServletMapping back to summary

getHttpServletMapping	back to summary
public HttpServletMapping getHttpServletMapping() Overrides default jakarta.servlet.http.HttpServletRequest.getHttpServletMapping. The default behavior of this method is to return getServletMapping() on the wrapped request object. Returns:HttpServletMapping Doc from jakarta.servlet.http.HttpServletRequest.getHttpServletMapping. An instance of `HttpServletMapping` describing the manner in which the current request was invoked. Annotations @Override Since Servlet 4.0

public HttpServletMapping getHttpServletMapping()

Overrides default jakarta.servlet.http.HttpServletRequest.getHttpServletMapping.

The default behavior of this method is to return getServletMapping() on the wrapped request object.

Returns:HttpServletMapping

Doc from jakarta.servlet.http.HttpServletRequest.getHttpServletMapping.

An instance of HttpServletMapping describing the manner in which the current request was invoked.

Annotations

@Override

Since

Servlet 4.0

getIntHeader back to summary

getIntHeader	back to summary
public int getIntHeader(String name) Implements jakarta.servlet.http.HttpServletRequest.getIntHeader. The default behavior of this method is to return getIntHeader(String name) on the wrapped request object. Parameters name:String Doc from jakarta.servlet.http.HttpServletRequest.getIntHeader. a `String` specifying the name of a request header Returns:int Doc from jakarta.servlet.http.HttpServletRequest.getIntHeader. an integer expressing the value of the request header or -1 if the request doesn't have a header of this name Annotations @Override

public int getIntHeader(String name)

Implements jakarta.servlet.http.HttpServletRequest.getIntHeader.

The default behavior of this method is to return getIntHeader(String name) on the wrapped request object.

Parameters

name:String

Doc from jakarta.servlet.http.HttpServletRequest.getIntHeader.

a String specifying the name of a request header

Returns:int

Doc from jakarta.servlet.http.HttpServletRequest.getIntHeader.

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

Annotations

@Override

getMethod back to summary

getMethod	back to summary
public String getMethod() Implements jakarta.servlet.http.HttpServletRequest.getMethod. The default behavior of this method is to return getMethod() on the wrapped request object. Returns:String Doc from jakarta.servlet.http.HttpServletRequest.getMethod. a `String` specifying the name of the method with which this request was made Annotations @Override

public String getMethod()

Implements jakarta.servlet.http.HttpServletRequest.getMethod.

The default behavior of this method is to return getMethod() on the wrapped request object.

Returns:String

Doc from jakarta.servlet.http.HttpServletRequest.getMethod.

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

Annotations

@Override

getPart back to summary

getPart	back to summary
public Part getPart(String name) throws IOException, ServletException Implements jakarta.servlet.http.HttpServletRequest.getPart. The default behavior of this method is to call getPart on the wrapped request object. Parameters name:String Doc from jakarta.servlet.http.HttpServletRequest.getPart. the name of the requested `Part` Returns:Part Doc from jakarta.servlet.http.HttpServletRequest.getPart. The `Part` with the given name, or `null` if this request is of type `multipart/form-data`, but does not contain the requested `Part` Annotations @Override Exceptions IOException: Doc from jakarta.servlet.http.HttpServletRequest.getPart. if an I/O error occurred during the retrieval of the requested `Part` ServletException: Doc from jakarta.servlet.http.HttpServletRequest.getPart. if this request is not of type `multipart/form-data` Since Servlet 3.0

public Part getPart(String name) throws IOException, ServletException

Implements jakarta.servlet.http.HttpServletRequest.getPart.

The default behavior of this method is to call getPart on the wrapped request object.

Parameters

name:String

Doc from jakarta.servlet.http.HttpServletRequest.getPart.

the name of the requested Part

Returns:Part

Doc from jakarta.servlet.http.HttpServletRequest.getPart.

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

Annotations

@Override

Exceptions

IOException:

Doc from jakarta.servlet.http.HttpServletRequest.getPart.

if an I/O error occurred during the retrieval of the requested Part

ServletException:

Doc from jakarta.servlet.http.HttpServletRequest.getPart.

if this request is not of type multipart/form-data

Since

Servlet 3.0

getParts back to summary

getParts	back to summary
public Collection<Part> getParts() throws IOException, ServletException Implements jakarta.servlet.http.HttpServletRequest.getParts. The default behavior of this method is to call getParts on the wrapped request object. Any changes to the returned `Collection` must not affect this `HttpServletRequestWrapper`. Returns:Collection<Part> Doc from jakarta.servlet.http.HttpServletRequest.getParts. a (possibly empty) `Collection` of the `Part` components of this request Annotations @Override Exceptions IOException: Doc from jakarta.servlet.http.HttpServletRequest.getParts. if an I/O error occurred during the retrieval of the `Part` components of this request ServletException: Doc from jakarta.servlet.http.HttpServletRequest.getParts. if this request is not of type `multipart/form-data` Since Servlet 3.0

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

Implements jakarta.servlet.http.HttpServletRequest.getParts.

The default behavior of this method is to call getParts on the wrapped request object.

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

Returns:Collection<Part>

Doc from jakarta.servlet.http.HttpServletRequest.getParts.

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

Annotations

@Override

Exceptions

IOException:

Doc from jakarta.servlet.http.HttpServletRequest.getParts.

if an I/O error occurred during the retrieval of the Part components of this request

ServletException:

Doc from jakarta.servlet.http.HttpServletRequest.getParts.

if this request is not of type multipart/form-data

Since

Servlet 3.0

getPathInfo back to summary

getPathInfo	back to summary
public String getPathInfo() Implements jakarta.servlet.http.HttpServletRequest.getPathInfo. The default behavior of this method is to return getPathInfo() on the wrapped request object. Returns:String Doc from jakarta.servlet.http.HttpServletRequest.getPathInfo. 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 Servlet 6.0, 3.5. This method will not return any encoded characters unless the container is configured specifically to allow them. Annotations @Override

public String getPathInfo()

Implements jakarta.servlet.http.HttpServletRequest.getPathInfo.

The default behavior of this method is to return getPathInfo() on the wrapped request object.

Returns:String

Doc from jakarta.servlet.http.HttpServletRequest.getPathInfo.

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 Servlet 6.0, 3.5. This method will not return any encoded characters unless the container is configured specifically to allow them.

Annotations

@Override

getPathTranslated back to summary

getPathTranslated	back to summary
public String getPathTranslated() Implements jakarta.servlet.http.HttpServletRequest.getPathTranslated. The default behavior of this method is to return getPathTranslated() on the wrapped request object. Returns:String Doc from jakarta.servlet.http.HttpServletRequest.getPathTranslated. a `String` specifying the real path, or `null` if the URL does not have any extra path information Annotations @Override

public String getPathTranslated()

Implements jakarta.servlet.http.HttpServletRequest.getPathTranslated.

The default behavior of this method is to return getPathTranslated() on the wrapped request object.

Returns:String

Doc from jakarta.servlet.http.HttpServletRequest.getPathTranslated.

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

Annotations

@Override

getQueryString back to summary

getQueryString	back to summary
public String getQueryString() Implements jakarta.servlet.http.HttpServletRequest.getQueryString. The default behavior of this method is to return getQueryString() on the wrapped request object. Returns:String Doc from jakarta.servlet.http.HttpServletRequest.getQueryString. a `String` containing the query string or `null` if the URL contains no query string. The value is not decoded by the container. Annotations @Override

public String getQueryString()

Implements jakarta.servlet.http.HttpServletRequest.getQueryString.

The default behavior of this method is to return getQueryString() on the wrapped request object.

Returns:String

Doc from jakarta.servlet.http.HttpServletRequest.getQueryString.

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

Annotations

@Override

getRemoteUser back to summary

getRemoteUser	back to summary
public String getRemoteUser() Implements jakarta.servlet.http.HttpServletRequest.getRemoteUser. The default behavior of this method is to return getRemoteUser() on the wrapped request object. Returns:String Doc from jakarta.servlet.http.HttpServletRequest.getRemoteUser. a `String` specifying the login of the user making this request, or `null` if the user login is not known Annotations @Override

public String getRemoteUser()

Implements jakarta.servlet.http.HttpServletRequest.getRemoteUser.

The default behavior of this method is to return getRemoteUser() on the wrapped request object.

Returns:String

Doc from jakarta.servlet.http.HttpServletRequest.getRemoteUser.

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

Annotations

@Override

getRequestedSessionId back to summary

getRequestedSessionId	back to summary
public String getRequestedSessionId() Implements jakarta.servlet.http.HttpServletRequest.getRequestedSessionId. The default behavior of this method is to return getRequestedSessionId() on the wrapped request object. Returns:String Doc from jakarta.servlet.http.HttpServletRequest.getRequestedSessionId. a `String` specifying the session ID, or `null` if the request did not specify a session ID Annotations @Override

public String getRequestedSessionId()

Implements jakarta.servlet.http.HttpServletRequest.getRequestedSessionId.

The default behavior of this method is to return getRequestedSessionId() on the wrapped request object.

Returns:String

Doc from jakarta.servlet.http.HttpServletRequest.getRequestedSessionId.

a String specifying the session ID, or null if the request did not specify a session ID

Annotations

@Override

getRequestURI back to summary

getRequestURI	back to summary
public String getRequestURI() Implements jakarta.servlet.http.HttpServletRequest.getRequestURI. The default behavior of this method is to return getRequestURI() on the wrapped request object. Returns:String Doc from jakarta.servlet.http.HttpServletRequest.getRequestURI. a `String` containing the part of the URL from the protocol name up to the query string Annotations @Override

public String getRequestURI()

Implements jakarta.servlet.http.HttpServletRequest.getRequestURI.

The default behavior of this method is to return getRequestURI() on the wrapped request object.

Returns:String

Doc from jakarta.servlet.http.HttpServletRequest.getRequestURI.

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

Annotations

@Override

getRequestURL back to summary

getRequestURL	back to summary
public StringBuffer getRequestURL() Implements jakarta.servlet.http.HttpServletRequest.getRequestURL. The default behavior of this method is to return getRequestURL() on the wrapped request object. Returns:StringBuffer Doc from jakarta.servlet.http.HttpServletRequest.getRequestURL. a `StringBuffer` object containing the reconstructed URL Annotations @Override

public StringBuffer getRequestURL()

Implements jakarta.servlet.http.HttpServletRequest.getRequestURL.

The default behavior of this method is to return getRequestURL() on the wrapped request object.

Returns:StringBuffer

Doc from jakarta.servlet.http.HttpServletRequest.getRequestURL.

a StringBuffer object containing the reconstructed URL

Annotations

@Override

getServletPath back to summary

getServletPath	back to summary
public String getServletPath() Implements jakarta.servlet.http.HttpServletRequest.getServletPath. The default behavior of this method is to return getServletPath() on the wrapped request object. Returns:String Doc from jakarta.servlet.http.HttpServletRequest.getServletPath. 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 Servlet 6.0, 3.5. This method will not return any encoded characters unless the container is configured specifically to allow them. Annotations @Override

public String getServletPath()

Implements jakarta.servlet.http.HttpServletRequest.getServletPath.

The default behavior of this method is to return getServletPath() on the wrapped request object.

Returns:String

Doc from jakarta.servlet.http.HttpServletRequest.getServletPath.

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 Servlet 6.0, 3.5. This method will not return any encoded characters unless the container is configured specifically to allow them.

Annotations

@Override

getSession back to summary

getSession	back to summary
public HttpSession getSession(boolean create) Implements jakarta.servlet.http.HttpServletRequest.getSession. The default behavior of this method is to return getSession(boolean create) on the wrapped request object. Parameters create:boolean Doc from jakarta.servlet.http.HttpServletRequest.getSession. `true` to create a new session for this request if necessary; `false` to return `null` if there's no current session Returns:HttpSession Doc from jakarta.servlet.http.HttpServletRequest.getSession. the `HttpSession` associated with this request or `null` if `create` is `false` and the request has no valid session Annotations @Override

public HttpSession getSession(boolean create)

Implements jakarta.servlet.http.HttpServletRequest.getSession.

The default behavior of this method is to return getSession(boolean create) on the wrapped request object.

Parameters

create:boolean

Doc from jakarta.servlet.http.HttpServletRequest.getSession.

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

Returns:HttpSession

Doc from jakarta.servlet.http.HttpServletRequest.getSession.

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

Annotations

@Override

getSession back to summary

getSession	back to summary
public HttpSession getSession() Implements jakarta.servlet.http.HttpServletRequest.getSession. The default behavior of this method is to return getSession() on the wrapped request object. Returns:HttpSession Doc from jakarta.servlet.http.HttpServletRequest.getSession. the `HttpSession` associated with this request Annotations @Override

public HttpSession getSession()

Implements jakarta.servlet.http.HttpServletRequest.getSession.

The default behavior of this method is to return getSession() on the wrapped request object.

Returns:HttpSession

Doc from jakarta.servlet.http.HttpServletRequest.getSession.

the HttpSession associated with this request

Annotations

@Override

getTrailerFields back to summary

getTrailerFields	back to summary
public Map<String, String> getTrailerFields() Overrides default jakarta.servlet.http.HttpServletRequest.getTrailerFields. The default behavior of this method is to call getTrailerFields on the wrapped request object. Returns:Map<String, String> Doc from jakarta.servlet.http.HttpServletRequest.getTrailerFields. 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. Annotations @Override Since Servlet 4.0

public Map<String, String> getTrailerFields()

Overrides default jakarta.servlet.http.HttpServletRequest.getTrailerFields.

The default behavior of this method is to call getTrailerFields on the wrapped request object.

Returns:Map<String, String>

Doc from jakarta.servlet.http.HttpServletRequest.getTrailerFields.

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.

Annotations

@Override

Since

Servlet 4.0

getUserPrincipal back to summary

getUserPrincipal	back to summary
public Principal getUserPrincipal() Implements jakarta.servlet.http.HttpServletRequest.getUserPrincipal. The default behavior of this method is to return getUserPrincipal() on the wrapped request object. Returns:Principal Doc from jakarta.servlet.http.HttpServletRequest.getUserPrincipal. a `java.security.Principal` containing the name of the user making this request; `null` if the user has not been authenticated Annotations @Override

public Principal getUserPrincipal()

Implements jakarta.servlet.http.HttpServletRequest.getUserPrincipal.

The default behavior of this method is to return getUserPrincipal() on the wrapped request object.

Returns:Principal

Doc from jakarta.servlet.http.HttpServletRequest.getUserPrincipal.

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

Annotations

@Override

isRequestedSessionIdFromCookie back to summary

public boolean isRequestedSessionIdFromCookie()

Implements jakarta.servlet.http.HttpServletRequest.isRequestedSessionIdFromCookie.

The default behavior of this method is to return isRequestedSessionIdFromCookie() on the wrapped request object.

Returns:boolean

Doc from jakarta.servlet.http.HttpServletRequest.isRequestedSessionIdFromCookie.

true if the session ID was conveyed to the server an an HTTP cookie; otherwise, false

Annotations

@Override

isRequestedSessionIdFromURL back to summary

isRequestedSessionIdFromURL	back to summary
public boolean isRequestedSessionIdFromURL() Implements jakarta.servlet.http.HttpServletRequest.isRequestedSessionIdFromURL. The default behavior of this method is to return isRequestedSessionIdFromURL() on the wrapped request object. Returns:boolean Doc from jakarta.servlet.http.HttpServletRequest.isRequestedSessionIdFromURL. `true` if the session ID was conveyed to the server as part of a URL; otherwise, `false` Annotations @Override

public boolean isRequestedSessionIdFromURL()

Implements jakarta.servlet.http.HttpServletRequest.isRequestedSessionIdFromURL.

The default behavior of this method is to return isRequestedSessionIdFromURL() on the wrapped request object.

Returns:boolean

Doc from jakarta.servlet.http.HttpServletRequest.isRequestedSessionIdFromURL.

true if the session ID was conveyed to the server as part of a URL; otherwise, false

Annotations

@Override

isRequestedSessionIdValid back to summary

isRequestedSessionIdValid	back to summary
public boolean isRequestedSessionIdValid() Implements jakarta.servlet.http.HttpServletRequest.isRequestedSessionIdValid. The default behavior of this method is to return isRequestedSessionIdValid() on the wrapped request object. Returns:boolean Doc from jakarta.servlet.http.HttpServletRequest.isRequestedSessionIdValid. `true` if this request has an id for a valid session in the current session context; `false` otherwise Annotations @Override

public boolean isRequestedSessionIdValid()

Implements jakarta.servlet.http.HttpServletRequest.isRequestedSessionIdValid.

The default behavior of this method is to return isRequestedSessionIdValid() on the wrapped request object.

Returns:boolean

Doc from jakarta.servlet.http.HttpServletRequest.isRequestedSessionIdValid.

true if this request has an id for a valid session in the current session context; false otherwise

Annotations

@Override

isTrailerFieldsReady	back to summary
public boolean isTrailerFieldsReady() Overrides default jakarta.servlet.http.HttpServletRequest.isTrailerFieldsReady. The default behavior of this method is to call isTrailerFieldsReady on the wrapped request object. Returns:boolean Doc from jakarta.servlet.http.HttpServletRequest.isTrailerFieldsReady. a boolean whether trailer fields are ready to read Annotations @Override Since Servlet 4.0

isTrailerFieldsReady

back to summary

public boolean isTrailerFieldsReady()

Overrides default jakarta.servlet.http.HttpServletRequest.isTrailerFieldsReady.

The default behavior of this method is to call isTrailerFieldsReady on the wrapped request object.

Returns:boolean

Doc from jakarta.servlet.http.HttpServletRequest.isTrailerFieldsReady.

a boolean whether trailer fields are ready to read

Annotations

@Override

Since

Servlet 4.0

isUserInRole back to summary

isUserInRole	back to summary
public boolean isUserInRole(String role) Implements jakarta.servlet.http.HttpServletRequest.isUserInRole. The default behavior of this method is to return isUserInRole(String role) on the wrapped request object. Parameters role:String Doc from jakarta.servlet.http.HttpServletRequest.isUserInRole. a `String` specifying the name of the role Returns:boolean Doc from jakarta.servlet.http.HttpServletRequest.isUserInRole. a `boolean` indicating whether the user making this request belongs to a given role; `false` if the user has not been authenticated Annotations @Override

public boolean isUserInRole(String role)

Implements jakarta.servlet.http.HttpServletRequest.isUserInRole.

The default behavior of this method is to return isUserInRole(String role) on the wrapped request object.

Parameters

role:String

Doc from jakarta.servlet.http.HttpServletRequest.isUserInRole.

a String specifying the name of the role

Returns:boolean

Doc from jakarta.servlet.http.HttpServletRequest.isUserInRole.

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

Annotations

@Override

login	back to summary
public void login(String username, String password) throws ServletException Implements jakarta.servlet.http.HttpServletRequest.login. The default behavior of this method is to call login on the wrapped request object. Parameters username:String Doc from jakarta.servlet.http.HttpServletRequest.login. The `String` value corresponding to the login identifier of the user. password:String Doc from jakarta.servlet.http.HttpServletRequest.login. The password `String` corresponding to the identified user. Annotations @Override Exceptions ServletException: Doc from jakarta.servlet.http.HttpServletRequest.login. 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

Implements jakarta.servlet.http.HttpServletRequest.login.

The default behavior of this method is to call login on the wrapped request object.

Parameters

username:String

Doc from jakarta.servlet.http.HttpServletRequest.login.

The String value corresponding to the login identifier of the user.

password:String

Doc from jakarta.servlet.http.HttpServletRequest.login.

The password String corresponding to the identified user.

Annotations

@Override

Exceptions

ServletException:

Doc from jakarta.servlet.http.HttpServletRequest.login.

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
public void logout() throws ServletException Implements jakarta.servlet.http.HttpServletRequest.logout. The default behavior of this method is to call login on the wrapped request object. Annotations @Override Exceptions ServletException: Doc from jakarta.servlet.http.HttpServletRequest.logout. if logout fails Since Servlet 3.0

logout

back to summary

public void logout() throws ServletException

Implements jakarta.servlet.http.HttpServletRequest.logout.

The default behavior of this method is to call login on the wrapped request object.

Annotations

@Override

Exceptions

ServletException:

Doc from jakarta.servlet.http.HttpServletRequest.logout.

if logout fails

Since

Servlet 3.0

newPushBuilder back to summary

newPushBuilder	back to summary
public PushBuilder newPushBuilder() Overrides default jakarta.servlet.http.HttpServletRequest.newPushBuilder. Deprecated In favor of 103 early hints The default behavior of this method is to call newPushBuilder on the wrapped request object. Returns:PushBuilder Doc from jakarta.servlet.http.HttpServletRequest.newPushBuilder. a `PushBuilder` for issuing server push responses from the current request, or `null` if push is not supported. Note that some implementations may opt not to support server push and will therefore always return `null` Annotations @Deprecated @Override Since Servlet 4.0

public PushBuilder newPushBuilder()

Overrides default jakarta.servlet.http.HttpServletRequest.newPushBuilder.

Deprecated

In favor of 103 early hints

The default behavior of this method is to call newPushBuilder on the wrapped request object.

Returns:PushBuilder

Doc from jakarta.servlet.http.HttpServletRequest.newPushBuilder.

a PushBuilder for issuing server push responses from the current request, or null if push is not supported. Note that some implementations may opt not to support server push and will therefore always return null

Annotations

@Deprecated
@Override

Since

Servlet 4.0

upgrade back to summary

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