public Class ServletRequestHttpWrapper

Implements jakarta.servlet.http.HttpServletRequest.authenticate.

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

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

This method may modify and commit the argument HttpServletResponse.

Parameters

response:HttpServletResponse

The HttpServletResponse associated with this HttpServletRequest

Returns:boolean

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

Annotations

@Override

Exceptions

IOException:

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

ServletException:

if the authentication failed and the caller is responsible for handling the error (i.e., the underlying login mechanism did NOT establish the message and HTTP status code to be returned to the user)

Implements jakarta.servlet.http.HttpServletRequest.changeSessionId.

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

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

Returns:String

the new session id

Annotations

@Override

Implements jakarta.servlet.http.HttpServletRequest.getAuthType.

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

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

Returns:String

one of the static members BASIC_AUTH, FORM_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH (suitable for == comparison) or the container-specific string indicating the authentication scheme, or null if the request was not authenticated.

Annotations

@Override

Implements jakarta.servlet.http.HttpServletRequest.getContextPath.

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

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

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

Returns:String

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

Annotations

@Override

Implements jakarta.servlet.http.HttpServletRequest.getCookies.

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

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

Returns:Cookie[]

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

Annotations

@Override

Implements jakarta.servlet.http.HttpServletRequest.getDateHeader.

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

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

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

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

Parameters

name:String

a String specifying the name of the header

Returns:long

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

Annotations

@Override

Implements jakarta.servlet.http.HttpServletRequest.getHeader.

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

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

Parameters

name:String

a String specifying the header name

Returns:String

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

Annotations

@Override

Implements jakarta.servlet.http.HttpServletRequest.getHeaderNames.

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

Returns an enumeration of all the header names this request contains. If the request has no headers, this method returns an empty enumeration.

Some servlet containers do not allow servlets to access headers using this method, in which case this method returns null

Returns:Enumeration<String>

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

Annotations

@Override

Implements jakarta.servlet.http.HttpServletRequest.getHeaders.

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

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

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

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

Parameters

name:String

a String specifying the header name

Returns:Enumeration<String>

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

Annotations

@Override

Implements jakarta.servlet.http.HttpServletRequest.getIntHeader.

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

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

The header name is case insensitive.

Parameters

name:String

a String specifying the name of a request header

Returns:int

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

Annotations

@Override

Implements jakarta.servlet.http.HttpServletRequest.getMethod.

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

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

Returns:String

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

Annotations

@Override

Implements jakarta.servlet.http.HttpServletRequest.getPart.

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

Gets the Part with the given name.

Parameters

name:String

the name of the requested Part

Returns:Part

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

Annotations

@Override

Exceptions

IOException:

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

ServletException:

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

Implements jakarta.servlet.http.HttpServletRequest.getParts.

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

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

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

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

Returns:Collection<Part>

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

Annotations

@Override

Exceptions

IOException:

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

ServletException:

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

Implements jakarta.servlet.http.HttpServletRequest.getPathInfo.

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

Returns any extra path information associated with the URL the client sent when it made this request. The extra path information follows the servlet path but precedes the query string and will start with a "/" character.

This method returns null if there was no extra path information.

Returns:String

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

Annotations

@Override

Implements jakarta.servlet.http.HttpServletRequest.getPathTranslated.

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

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

If the URL does not have any extra path information, this method returns null or the servlet container cannot translate the virtual path to a real path for any reason (such as when the web application is executed from an archive). The web container does not decode this string.

Returns:String

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

Annotations

@Override

Implements jakarta.servlet.http.HttpServletRequest.getQueryString.

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

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

Returns:String

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

Annotations

@Override

Implements jakarta.servlet.http.HttpServletRequest.getRemoteUser.

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

Returns the login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated. Whether the user name is sent with each subsequent request depends on the browser and type of authentication.

Returns:String

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

Annotations

@Override

Implements jakarta.servlet.http.HttpServletRequest.getRequestedSessionId.

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

Returns the session ID specified by the client. This may not be the same as the ID of the current valid session for this request. If the client did not specify a session ID, this method returns null.

Returns:String

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

Annotations

@Override

Implements jakarta.servlet.http.HttpServletRequest.getRequestURI.

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

Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request. The web container does not decode this String. For example:

Returns:String

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

Annotations

@Override

Implements jakarta.servlet.http.HttpServletRequest.getRequestURL.

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

Reconstructs the URL the client used to make the request. The returned URL contains a protocol, server name, port number, and server path, but it does not include query string parameters.

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

Because this method returns a StringBuffer, not a string, you can modify the URL easily, for example, to append query parameters.

This method is useful for creating redirect messages and for reporting errors.

Returns:StringBuffer

a StringBuffer object containing the reconstructed URL

Annotations

@Override

Implements jakarta.servlet.http.HttpServletRequest.getServletPath.

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

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

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

Returns:String

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

Annotations

@Override

Implements jakarta.servlet.http.HttpServletRequest.getSession.

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

Returns the current HttpSession associated with this request or, if there is no current session and create is true, returns a new session.

If create is false and the request has no valid HttpSession, this method returns null.

To make sure the session is properly maintained, you must call this method before the response is committed. If the container is using cookies to maintain session integrity and is asked to create a new session when the response is committed, an IllegalStateException is thrown.

Parameters

create:boolean

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

Returns:HttpSession

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

Annotations

@Override

Implements jakarta.servlet.http.HttpServletRequest.getSession.

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

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

Returns:HttpSession

the HttpSession associated with this request

Annotations

@Override

Implements jakarta.servlet.http.HttpServletRequest.getUserPrincipal.

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

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

Returns:Principal

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

Annotations

@Override

Implements jakarta.servlet.http.HttpServletRequest.isRequestedSessionIdFromCookie.

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

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

Returns:boolean

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

Annotations

@Override

Implements jakarta.servlet.http.HttpServletRequest.isRequestedSessionIdFromURL.

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

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

Returns:boolean

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

Annotations

@Override

Implements jakarta.servlet.http.HttpServletRequest.isRequestedSessionIdValid.

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

Checks whether the requested session ID is still valid.

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

Returns:boolean

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

Annotations

@Override

Implements jakarta.servlet.http.HttpServletRequest.isUserInRole.

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

Returns a boolean indicating whether the authenticated user is included in the specified logical "role". Roles and role membership can be defined using deployment descriptors. If the user has not been authenticated, the method returns false.

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

Parameters

role:String

a String specifying the name of the role

Returns:boolean

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

Annotations

@Override

Implements jakarta.servlet.http.HttpServletRequest.login.

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

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

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

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

Parameters

username:String

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

password:String

The password String corresponding to the identified user.

Annotations

@Override

Exceptions

ServletException:

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

Implements jakarta.servlet.http.HttpServletRequest.logout.

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

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

Annotations

@Override

Exceptions

ServletException:

if logout fails

Implements jakarta.servlet.http.HttpServletRequest.upgrade.

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

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

Parameters

<T>

The Class, which extends HttpUpgradeHandler, of the handlerClass.

handlerClass:Class<T>

The HttpUpgradeHandler class used for the upgrade.

Returns:T

an instance of the HttpUpgradeHandler

Annotations

@Override

Exceptions

IOException:

if an I/O error occurred during the upgrade

ServletException:

if the given handlerClass fails to be instantiated