Tomcat 10.1.19 · jakarta.servlet.http.HttpServletRequestWrapper

Access	Constructor and Description
public	HttpServletRequestWrapper(HttpServletRequest The request to wrap 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 response to use to return any authentication challenge response) Implements jakarta.servlet.http.HttpServletRequest.authenticate. Triggers the same authentication process as would be triggered if the request is for a resource that is protected by a security constraint.
public String	changeSessionId() Implements jakarta.servlet.http.HttpServletRequest.changeSessionId. The default behavior of this method is to call 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 `HttpServletRequest#getHttpServletMapping()` 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 Part to obtain name) Implements jakarta.servlet.http.HttpServletRequest.getPart. Gets the named Part or null if the Part does not exist.
public Collection<Part>	getParts() Implements jakarta.servlet.http.HttpServletRequest.getParts. Return a collection of all uploaded Parts.
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. Obtain a Map of the trailer fields that is not backed by the 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. Are trailer fields ready to be read (there may still be no trailers to read).
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 user name to authenticate username, String The password to use to authenticate the user password) Implements jakarta.servlet.http.HttpServletRequest.login. Authenticate the provided user name and password and then associated the authenticated user with the request.
public void	logout() Implements jakarta.servlet.http.HttpServletRequest.logout. Removes any authenticated user from the request.
public PushBuilder	newPushBuilder() Overrides default jakarta.servlet.http.HttpServletRequest.newPushBuilder. Obtain a builder for generating push requests.
public <T extends HttpUpgradeHandler> T	upgrade(Class<T> The class that implements the upgrade handler httpUpgradeHandlerClass) Implements jakarta.servlet.http.HttpServletRequest.upgrade. Start the HTTP upgrade process and create and instance of the provided protocol handler class.

HttpServletRequestWrapper	back to summary
public HttpServletRequestWrapper(HttpServletRequest request) Constructs a request object wrapping the given request. Parameters request:HttpServletRequest The request to wrap 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. Doc from jakarta.servlet.http.HttpServletRequest.authenticate. Triggers the same authentication process as would be triggered if the request is for a resource that is protected by a security constraint. The default behavior of this method is to return `HttpServletRequest#authenticate(HttpServletResponse)` on the wrapped request object. Parameters response:HttpServletResponse The response to use to return any authentication challenge Returns:boolean `true` if the user is successfully authenticated and `false` if not Annotations @Override Exceptions IOException: if the authentication process attempted to read from the request or write to the response and an I/O error occurred ServletException: if the authentication failed and the caller is expected to handle the failure Since Servlet 3.0

public boolean authenticate(HttpServletResponse response) throws IOException, ServletException

Implements jakarta.servlet.http.HttpServletRequest.authenticate.

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

Triggers the same authentication process as would be triggered if the request is for a resource that is protected by a security constraint.

The default behavior of this method is to return HttpServletRequest#authenticate(HttpServletResponse) on the wrapped request object.

Parameters

response:HttpServletResponse: The response to use to return any authentication challenge

Returns:boolean

true if the user is successfully authenticated and false if not

Annotations

@Override

Exceptions

IOException:: if the authentication process attempted to read from the request or write to the response and an I/O error occurred
ServletException:: if the authentication failed and the caller is expected to handle the failure

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 call changeSessionId() on the wrapped request object. Returns:String Doc from jakarta.servlet.http.HttpServletRequest.changeSessionId. the new session ID allocated to the session 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 call changeSessionId() on the wrapped request object.

Returns:String

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

the new session ID allocated to the session

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 `HttpServletRequest#getHttpServletMapping()` on the wrapped request object. Returns:HttpServletMapping Doc from jakarta.servlet.http.HttpServletRequest.getHttpServletMapping. the mapping information for this request 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 HttpServletRequest#getHttpServletMapping() on the wrapped request object.

Returns:HttpServletMapping

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

the mapping information for this request

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. Doc from jakarta.servlet.http.HttpServletRequest.getPart. Gets the named Part or null if the Part does not exist. Triggers upload of all Parts. The default behavior of this method is to return `HttpServletRequest#getPart(String)` on the wrapped request object. Parameters name:String The name of the Part to obtain Returns:Part The named Part or null if the Part does not exist Annotations @Override Exceptions IOException: if an I/O error occurs ServletException: if the request is not multipart/form-data Since Servlet 3.0

public Part getPart(String name) throws IOException, ServletException

Implements jakarta.servlet.http.HttpServletRequest.getPart.

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

Gets the named Part or null if the Part does not exist. Triggers upload of all Parts.

The default behavior of this method is to return HttpServletRequest#getPart(String) on the wrapped request object.

Parameters

name:String: The name of the Part to obtain

Returns:Part

The named Part or null if the Part does not exist

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs
ServletException:: if the request is not 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. Doc from jakarta.servlet.http.HttpServletRequest.getParts. Return a collection of all uploaded Parts. The default behavior of this method is to return `HttpServletRequest#getParts()` on the wrapped request object. Returns:Collection<Part> A collection of all uploaded Parts. Annotations @Override Exceptions IOException: if an I/O error occurs ServletException: if the request is not multipart/form-data Since Servlet 3.0

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

Implements jakarta.servlet.http.HttpServletRequest.getParts.

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

Return a collection of all uploaded Parts.

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

Returns:Collection<Part>

A collection of all uploaded Parts.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs
ServletException:: if the request is not 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`, canonicalized by the web container, 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 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, canonicalized by the web container, 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

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`, canonicalized by the web container, containing the name or 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. 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, canonicalized by the web container, containing the name or 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.

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. Doc from jakarta.servlet.http.HttpServletRequest.getTrailerFields. Obtain a Map of the trailer fields that is not backed by the request object. The default behavior of this method is to return `HttpServletRequest#getTrailerFields()` on the wrapped request object. Returns:Map<String, String> A Map of the received trailer fields with all keys lower case or an empty Map if no trailers are present Annotations @Override Since Servlet 4.0

public Map<String, String> getTrailerFields()

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

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

Obtain a Map of the trailer fields that is not backed by the request object.

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

Returns:Map<String, String>

A Map of the received trailer fields with all keys lower case or an empty Map if no trailers are present

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 came in as a 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 came in 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 came in 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

isTrailerFieldsReady	back to summary
public boolean isTrailerFieldsReady() Overrides default jakarta.servlet.http.HttpServletRequest.isTrailerFieldsReady. Doc from jakarta.servlet.http.HttpServletRequest.isTrailerFieldsReady. Are trailer fields ready to be read (there may still be no trailers to read). This method always returns `true` if the underlying protocol does not support trailer fields. Otherwise, `true` is returned once all of the following are true: The application has ready all the request data and an EOF has been received or the content-length is zero All trailer fields, if any, have been received The default behavior of this method is to return `HttpServletRequest#isTrailerFieldsReady()` on the wrapped request object. Returns:boolean `true` if trailers are ready to be read Annotations @Override Since Servlet 4.0

public boolean isTrailerFieldsReady()

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

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

Are trailer fields ready to be read (there may still be no trailers to read). This method always returns true if the underlying protocol does not support trailer fields. Otherwise, true is returned once all of the following are true:

The application has ready all the request data and an EOF has been received or the content-length is zero
All trailer fields, if any, have been received

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

Returns:boolean

true if trailers are ready to be 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. Doc from jakarta.servlet.http.HttpServletRequest.login. Authenticate the provided user name and password and then associated the authenticated user with the request. The default behavior of this method is to return `HttpServletRequest#login(String, String)` on the wrapped request object. Parameters username:String The user name to authenticate password:String The password to use to authenticate the user Annotations @Override Exceptions ServletException: If any of `getRemoteUser()`, `getUserPrincipal()` or `getAuthType()` are non-null, if the configured authenticator does not support user name and password authentication or if the authentication fails Since Servlet 3.0

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

Implements jakarta.servlet.http.HttpServletRequest.login.

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

Authenticate the provided user name and password and then associated the authenticated user with the request.

The default behavior of this method is to return HttpServletRequest#login(String, String) on the wrapped request object.

Parameters

username:String: The user name to authenticate
password:String: The password to use to authenticate the user

Annotations

@Override

Exceptions

ServletException:: If any of getRemoteUser(), getUserPrincipal() or getAuthType() are non-null, if the configured authenticator does not support user name and password authentication or if the authentication fails

Since

Servlet 3.0

logout back to summary

logout	back to summary
public void logout() throws ServletException Implements jakarta.servlet.http.HttpServletRequest.logout. Doc from jakarta.servlet.http.HttpServletRequest.logout. Removes any authenticated user from the request. The default behavior of this method is to return `HttpServletRequest#logout()` on the wrapped request object. Annotations @Override Exceptions ServletException: If the logout fails Since Servlet 3.0

public void logout() throws ServletException

Implements jakarta.servlet.http.HttpServletRequest.logout.

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

Removes any authenticated user from the request.

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

Annotations

@Override

Exceptions

ServletException:: If the logout fails

Since

Servlet 3.0

newPushBuilder back to summary

newPushBuilder	back to summary
public PushBuilder newPushBuilder() Overrides default jakarta.servlet.http.HttpServletRequest.newPushBuilder. Doc from jakarta.servlet.http.HttpServletRequest.newPushBuilder. Obtain a builder for generating push requests. `PushBuilder` documents how this request will be used as the basis for a push request. Each call to this method will return a new instance, independent of any previous instance obtained. The default behavior of this method is to return `HttpServletRequest#newPushBuilder()` on the wrapped request object. Returns:PushBuilder A builder that can be used to generate push requests based on this request or `null` if push is not supported. Note that even if a PushBuilder instance is returned, by the time that `PushBuilder#push()` is called, it may no longer be valid to push a request and the push request will be ignored. Annotations @Override Since Servlet 4.0

public PushBuilder newPushBuilder()

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

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

Obtain a builder for generating push requests. PushBuilder documents how this request will be used as the basis for a push request. Each call to this method will return a new instance, independent of any previous instance obtained.

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

Returns:PushBuilder

A builder that can be used to generate push requests based on this request or null if push is not supported. Note that even if a PushBuilder instance is returned, by the time that PushBuilder#push() is called, it may no longer be valid to push a request and the push request will be ignored.

Annotations

@Override

Since

Servlet 4.0

upgrade back to summary

upgrade	back to summary
public <T extends HttpUpgradeHandler> T upgrade(Class<T> httpUpgradeHandlerClass) throws IOException, ServletException Implements jakarta.servlet.http.HttpServletRequest.upgrade. Doc from jakarta.servlet.http.HttpServletRequest.upgrade. Start the HTTP upgrade process and create and instance of the provided protocol handler class. The connection will be passed this instance once the current request/response pair has completed processing. Calling this method sets the response status to `HttpServletResponse#SC_SWITCHING_PROTOCOLS`. The default behavior of this method is to return `HttpServletRequest#upgrade(Class)` on the wrapped request object. Parameters <T> The type of the upgrade handler httpUpgradeHandlerClass:Class<T> The class that implements the upgrade handler Returns:T A newly created instance of the specified upgrade handler type Annotations @Override Exceptions IOException: if an I/O error occurred during the upgrade ServletException: if the given httpUpgradeHandlerClass fails to be instantiated Since Servlet 3.1

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

Implements jakarta.servlet.http.HttpServletRequest.upgrade.

Doc from jakarta.servlet.http.HttpServletRequest.upgrade.

Start the HTTP upgrade process and create and instance of the provided protocol handler class. The connection will be passed this instance once the current request/response pair has completed processing. Calling this method sets the response status to HttpServletResponse#SC_SWITCHING_PROTOCOLS.

The default behavior of this method is to return HttpServletRequest#upgrade(Class) on the wrapped request object.

Parameters

<T>: The type of the upgrade handler
httpUpgradeHandlerClass:Class<T>: The class that implements the upgrade handler

Returns:T

A newly created instance of the specified upgrade handler type

Annotations

@Override

Exceptions

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

Since

Servlet 3.1

public Class HttpServletRequestWrapper

Constructor Summary

Method Summary

Constructor Detail

Method Detail