EE4J 10.0.0 · jakarta.servlet.ServletRequestWrapper

Modifier and Type	Field and Description
private ServletRequest	request

Access	Constructor and Description
public	ServletRequestWrapper(ServletRequest the `ServletRequest` to be wrapped request) Creates a ServletRequest adaptor wrapping the given request object.

Method Summary

Modifier and Type	Method and Description
public AsyncContext	Returns: the AsyncContext that was created or reinitialized by the most recent invocation of `startAsync` or `startAsync(ServletRequest, ServletResponse)` on the wrapped request getAsyncContext() Implements jakarta.servlet.ServletRequest.getAsyncContext. Gets the AsyncContext that was created or reinitialized by the most recent invocation of `startAsync` or `startAsync(ServletRequest, ServletResponse)` on the wrapped request.
public Object	getAttribute(String a `String` specifying the name of the attribute name) Implements jakarta.servlet.ServletRequest.getAttribute. The default behavior of this method is to call getAttribute(String name) on the wrapped request object.
public Enumeration<String>	getAttributeNames() Implements jakarta.servlet.ServletRequest.getAttributeNames. The default behavior of this method is to return getAttributeNames() on the wrapped request object.
public String	getCharacterEncoding() Implements jakarta.servlet.ServletRequest.getCharacterEncoding. The default behavior of this method is to return getCharacterEncoding() on the wrapped request object.
public int	getContentLength() Implements jakarta.servlet.ServletRequest.getContentLength. The default behavior of this method is to return getContentLength() on the wrapped request object.
public long	getContentLengthLong() Implements jakarta.servlet.ServletRequest.getContentLengthLong. The default behavior of this method is to return getContentLengthLong() on the wrapped request object.
public String	getContentType() Implements jakarta.servlet.ServletRequest.getContentType. The default behavior of this method is to return getContentType() on the wrapped request object.
public DispatcherType	Returns: the dispatcher type of the wrapped request getDispatcherType() Implements jakarta.servlet.ServletRequest.getDispatcherType. Gets the dispatcher type of the wrapped request.
public ServletInputStream	getInputStream() Implements jakarta.servlet.ServletRequest.getInputStream. The default behavior of this method is to return getInputStream() on the wrapped request object.
public String	getLocalAddr() Implements jakarta.servlet.ServletRequest.getLocalAddr. The default behavior of this method is to return getLocalAddr() on the wrapped request object.
public Locale	getLocale() Implements jakarta.servlet.ServletRequest.getLocale. The default behavior of this method is to return getLocale() on the wrapped request object.
public Enumeration<Locale>	getLocales() Implements jakarta.servlet.ServletRequest.getLocales. The default behavior of this method is to return getLocales() on the wrapped request object.
public String	getLocalName() Implements jakarta.servlet.ServletRequest.getLocalName. The default behavior of this method is to return getLocalName() on the wrapped request object.
public int	getLocalPort() Implements jakarta.servlet.ServletRequest.getLocalPort. The default behavior of this method is to return getLocalPort() on the wrapped request object.
public String	getParameter(String a `String` specifying the name of the parameter name) Implements jakarta.servlet.ServletRequest.getParameter. The default behavior of this method is to return getParameter(String name) on the wrapped request object.
public Map<String, String[]>	getParameterMap() Implements jakarta.servlet.ServletRequest.getParameterMap. The default behavior of this method is to return getParameterMap() on the wrapped request object.
public Enumeration<String>	getParameterNames() Implements jakarta.servlet.ServletRequest.getParameterNames. The default behavior of this method is to return getParameterNames() on the wrapped request object.
public String[]	getParameterValues(String a `String` containing the name of the parameter whose value is requested name) Implements jakarta.servlet.ServletRequest.getParameterValues. The default behavior of this method is to return getParameterValues(String name) on the wrapped request object.
public String	getProtocol() Implements jakarta.servlet.ServletRequest.getProtocol. The default behavior of this method is to return getProtocol() on the wrapped request object.
public String	Returns: the protocol defined request ID, if any, for the wrapped request getProtocolRequestId() Implements jakarta.servlet.ServletRequest.getProtocolRequestId. Gets the protocol defined request ID, if any, for the wrapped request.
public BufferedReader	getReader() Implements jakarta.servlet.ServletRequest.getReader. The default behavior of this method is to return getReader() on the wrapped request object.
public String	getRemoteAddr() Implements jakarta.servlet.ServletRequest.getRemoteAddr. The default behavior of this method is to return getRemoteAddr() on the wrapped request object.
public String	getRemoteHost() Implements jakarta.servlet.ServletRequest.getRemoteHost. The default behavior of this method is to return getRemoteHost() on the wrapped request object.
public int	getRemotePort() Implements jakarta.servlet.ServletRequest.getRemotePort. The default behavior of this method is to return getRemotePort() on the wrapped request object.
public ServletRequest	Returns: the wrapped `ServletRequest` getRequest() Return the wrapped request object.
public RequestDispatcher	getRequestDispatcher(String a `String` specifying the pathname to the resource. If it is relative, it must be relative against the current servlet. path) Implements jakarta.servlet.ServletRequest.getRequestDispatcher. The default behavior of this method is to return getRequestDispatcher(String path) on the wrapped request object.
public String	Returns: the request ID for the wrapped request getRequestId() Implements jakarta.servlet.ServletRequest.getRequestId. Gets the request ID for the wrapped request.
public String	getScheme() Implements jakarta.servlet.ServletRequest.getScheme. The default behavior of this method is to return getScheme() on the wrapped request object.
public String	getServerName() Implements jakarta.servlet.ServletRequest.getServerName. The default behavior of this method is to return getServerName() on the wrapped request object.
public int	getServerPort() Implements jakarta.servlet.ServletRequest.getServerPort. The default behavior of this method is to return getServerPort() on the wrapped request object.
public ServletConnection	Returns: the connection information for the wrapped request getServletConnection() Implements jakarta.servlet.ServletRequest.getServletConnection. Gets the connection information for the wrapped request.
public ServletContext	Returns: the servlet context to which the wrapped servlet request was last dispatched getServletContext() Implements jakarta.servlet.ServletRequest.getServletContext. Gets the servlet context to which the wrapped servlet request was last dispatched.
public boolean	Returns: true if this request has been put into asynchronous mode, false otherwise isAsyncStarted() Implements jakarta.servlet.ServletRequest.isAsyncStarted. Checks if the wrapped request has been put into asynchronous mode.
public boolean	Returns: true if this request supports asynchronous operation, false otherwise isAsyncSupported() Implements jakarta.servlet.ServletRequest.isAsyncSupported. Checks if the wrapped request supports asynchronous operation.
public boolean	isSecure() Implements jakarta.servlet.ServletRequest.isSecure. The default behavior of this method is to return isSecure() on the wrapped request object.
public boolean	Returns: true if this ServletRequestWrapper wraps the given ServletRequest instance, false otherwise isWrapperFor(ServletRequest the ServletRequest instance to search for wrapped) Checks (recursively) if this ServletRequestWrapper wraps the given `ServletRequest` instance.
public boolean	Returns: true if this ServletRequestWrapper wraps a ServletRequest of the given class type, false otherwise isWrapperFor(Class<?> the ServletRequest class type to search for wrappedType) Checks (recursively) if this ServletRequestWrapper wraps a `ServletRequest` of the given class type.
public void	removeAttribute(String a `String` specifying the name of the attribute to remove name) Implements jakarta.servlet.ServletRequest.removeAttribute. The default behavior of this method is to call removeAttribute(String name) on the wrapped request object.
public void	setAttribute(String a `String` specifying the name of the attribute name, Object the `Object` to be stored o) Implements jakarta.servlet.ServletRequest.setAttribute. The default behavior of this method is to return setAttribute(String name, Object o) on the wrapped request object.
public void	setCharacterEncoding(String `String` containing the name of the character encoding. enc) Implements jakarta.servlet.ServletRequest.setCharacterEncoding. The default behavior of this method is to set the character encoding on the wrapped request object.
public void	setRequest(ServletRequest the `ServletRequest` to be installed request) Sets the request object being wrapped.
public AsyncContext	Returns: the (re)initialized AsyncContext startAsync() Implements jakarta.servlet.ServletRequest.startAsync. The default behavior of this method is to invoke `ServletRequest#startAsync` on the wrapped request object.
public AsyncContext	Returns: the (re)initialized AsyncContext startAsync(ServletRequest the ServletRequest used to initialize the AsyncContext servletRequest, ServletResponse the ServletResponse used to initialize the AsyncContext servletResponse) Implements jakarta.servlet.ServletRequest.startAsync. The default behavior of this method is to invoke `ServletRequest#startAsync(ServletRequest, ServletResponse)` on the wrapped request object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

request	back to summary
private ServletRequest request

ServletRequestWrapper	back to summary
public ServletRequestWrapper(ServletRequest request) Creates a ServletRequest adaptor wrapping the given request object. Parameters request:ServletRequest the `ServletRequest` to be wrapped Exceptions IllegalArgumentException: if the request is null

Method Detail

getAsyncContext back to summary

getAsyncContext	back to summary
public AsyncContext getAsyncContext() Implements jakarta.servlet.ServletRequest.getAsyncContext. Gets the AsyncContext that was created or reinitialized by the most recent invocation of `startAsync` or `startAsync(ServletRequest, ServletResponse)` on the wrapped request. Returns:AsyncContext the AsyncContext that was created or reinitialized by the most recent invocation of `startAsync` or `startAsync(ServletRequest, ServletResponse)` on the wrapped request Annotations @Override Exceptions IllegalStateException: if this request has not been put into asynchronous mode, i.e., if neither `startAsync` nor `startAsync(ServletRequest, ServletResponse)` has been called Since Servlet 3.0 See Also `ServletRequest#getAsyncContext`

public AsyncContext getAsyncContext()

Implements jakarta.servlet.ServletRequest.getAsyncContext.

Gets the AsyncContext that was created or reinitialized by the most recent invocation of startAsync or startAsync(ServletRequest, ServletResponse) on the wrapped request.

Returns:AsyncContext

the AsyncContext that was created or reinitialized by the most recent invocation of startAsync or startAsync(ServletRequest, ServletResponse) on the wrapped request

Annotations

@Override

Exceptions

IllegalStateException:: if this request has not been put into asynchronous mode, i.e., if neither startAsync nor startAsync(ServletRequest, ServletResponse) has been called

Since

Servlet 3.0

See Also

ServletRequest#getAsyncContext

getAttribute back to summary

getAttribute	back to summary
public Object getAttribute(String name) Implements jakarta.servlet.ServletRequest.getAttribute. The default behavior of this method is to call getAttribute(String name) on the wrapped request object. Parameters name:String Doc from jakarta.servlet.ServletRequest.getAttribute. a `String` specifying the name of the attribute Returns:Object Doc from jakarta.servlet.ServletRequest.getAttribute. an `Object` containing the value of the attribute, or `null` if the attribute does not exist Annotations @Override

public Object getAttribute(String name)

Implements jakarta.servlet.ServletRequest.getAttribute.

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

Parameters

name:String

Doc from jakarta.servlet.ServletRequest.getAttribute.

a String specifying the name of the attribute

Returns:Object

Doc from jakarta.servlet.ServletRequest.getAttribute.

an Object containing the value of the attribute, or null if the attribute does not exist

Annotations

@Override

getAttributeNames back to summary

getAttributeNames	back to summary
public Enumeration<String> getAttributeNames() Implements jakarta.servlet.ServletRequest.getAttributeNames. The default behavior of this method is to return getAttributeNames() on the wrapped request object. Returns:Enumeration<String> Doc from jakarta.servlet.ServletRequest.getAttributeNames. an `Enumeration` of strings containing the names of the request's attributes Annotations @Override

public Enumeration<String> getAttributeNames()

Implements jakarta.servlet.ServletRequest.getAttributeNames.

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

Returns:Enumeration<String>

Doc from jakarta.servlet.ServletRequest.getAttributeNames.

an Enumeration of strings containing the names of the request's attributes

Annotations

@Override

getCharacterEncoding back to summary

getCharacterEncoding	back to summary
public String getCharacterEncoding() Implements jakarta.servlet.ServletRequest.getCharacterEncoding. The default behavior of this method is to return getCharacterEncoding() on the wrapped request object. Returns:String Doc from jakarta.servlet.ServletRequest.getCharacterEncoding. a `String` containing the name of the character encoding, or `null` if the request does not specify a character encoding Annotations @Override

public String getCharacterEncoding()

Implements jakarta.servlet.ServletRequest.getCharacterEncoding.

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

Returns:String

Doc from jakarta.servlet.ServletRequest.getCharacterEncoding.

a String containing the name of the character encoding, or null if the request does not specify a character encoding

Annotations

@Override

getContentLength	back to summary
public int getContentLength() Implements jakarta.servlet.ServletRequest.getContentLength. The default behavior of this method is to return getContentLength() on the wrapped request object. Returns:int Doc from jakarta.servlet.ServletRequest.getContentLength. an integer containing the length of the request body or -1 if the length is not known or is greater than Integer.MAX_VALUE. Annotations @Override

getContentLength

back to summary

public int getContentLength()

Implements jakarta.servlet.ServletRequest.getContentLength.

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

Returns:int

Doc from jakarta.servlet.ServletRequest.getContentLength.

an integer containing the length of the request body or -1 if the length is not known or is greater than Integer.MAX_VALUE.

Annotations

@Override

getContentLengthLong	back to summary
public long getContentLengthLong() Implements jakarta.servlet.ServletRequest.getContentLengthLong. The default behavior of this method is to return getContentLengthLong() on the wrapped request object. Returns:long Doc from jakarta.servlet.ServletRequest.getContentLengthLong. a long containing the length of the request body or -1L if the length is not known Annotations @Override Since Servlet 3.1

getContentLengthLong

back to summary

public long getContentLengthLong()

Implements jakarta.servlet.ServletRequest.getContentLengthLong.

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

Returns:long

Doc from jakarta.servlet.ServletRequest.getContentLengthLong.

a long containing the length of the request body or -1L if the length is not known

Annotations

@Override

Since

Servlet 3.1

getContentType back to summary

getContentType	back to summary
public String getContentType() Implements jakarta.servlet.ServletRequest.getContentType. The default behavior of this method is to return getContentType() on the wrapped request object. Returns:String Doc from jakarta.servlet.ServletRequest.getContentType. a `String` containing the name of the MIME type of the request, or null if the type is not known Annotations @Override

public String getContentType()

Implements jakarta.servlet.ServletRequest.getContentType.

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

Returns:String

Doc from jakarta.servlet.ServletRequest.getContentType.

a String containing the name of the MIME type of the request, or null if the type is not known

Annotations

@Override

getDispatcherType back to summary

getDispatcherType	back to summary
public DispatcherType getDispatcherType() Implements jakarta.servlet.ServletRequest.getDispatcherType. Gets the dispatcher type of the wrapped request. Returns:DispatcherType the dispatcher type of the wrapped request Annotations @Override Since Servlet 3.0 See Also `ServletRequest#getDispatcherType`

public DispatcherType getDispatcherType()

Implements jakarta.servlet.ServletRequest.getDispatcherType.

Gets the dispatcher type of the wrapped request.

Returns:DispatcherType

the dispatcher type of the wrapped request

Annotations

@Override

Since

Servlet 3.0

See Also

ServletRequest#getDispatcherType

getInputStream back to summary

getInputStream	back to summary
public ServletInputStream getInputStream() throws IOException Implements jakarta.servlet.ServletRequest.getInputStream. The default behavior of this method is to return getInputStream() on the wrapped request object. Returns:ServletInputStream Doc from jakarta.servlet.ServletRequest.getInputStream. a `ServletInputStream` object containing the body of the request Annotations @Override Exceptions IOException: Doc from jakarta.servlet.ServletRequest.getInputStream. if an input or output exception occurred

public ServletInputStream getInputStream() throws IOException

Implements jakarta.servlet.ServletRequest.getInputStream.

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

Returns:ServletInputStream

Doc from jakarta.servlet.ServletRequest.getInputStream.

a ServletInputStream object containing the body of the request

Annotations

@Override

Exceptions

IOException:

Doc from jakarta.servlet.ServletRequest.getInputStream.

if an input or output exception occurred

getLocalAddr back to summary

getLocalAddr	back to summary
public String getLocalAddr() Implements jakarta.servlet.ServletRequest.getLocalAddr. The default behavior of this method is to return getLocalAddr() on the wrapped request object. Returns:String Doc from jakarta.servlet.ServletRequest.getLocalAddr. a `String` containing an IP address. Annotations @Override Since Servlet 2.4

public String getLocalAddr()

Implements jakarta.servlet.ServletRequest.getLocalAddr.

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

Returns:String

Doc from jakarta.servlet.ServletRequest.getLocalAddr.

a String containing an IP address.

Annotations

@Override

Since

Servlet 2.4

getLocale back to summary

getLocale	back to summary
public Locale getLocale() Implements jakarta.servlet.ServletRequest.getLocale. The default behavior of this method is to return getLocale() on the wrapped request object. Returns:Locale Doc from jakarta.servlet.ServletRequest.getLocale. the preferred `Locale` for the client Annotations @Override

public Locale getLocale()

Implements jakarta.servlet.ServletRequest.getLocale.

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

Returns:Locale

Doc from jakarta.servlet.ServletRequest.getLocale.

the preferred Locale for the client

Annotations

@Override

getLocales back to summary

getLocales	back to summary
public Enumeration<Locale> getLocales() Implements jakarta.servlet.ServletRequest.getLocales. The default behavior of this method is to return getLocales() on the wrapped request object. Returns:Enumeration<Locale> Doc from jakarta.servlet.ServletRequest.getLocales. an `Enumeration` of preferred `Locale` objects for the client Annotations @Override

public Enumeration<Locale> getLocales()

Implements jakarta.servlet.ServletRequest.getLocales.

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

Returns:Enumeration<Locale>

Doc from jakarta.servlet.ServletRequest.getLocales.

an Enumeration of preferred Locale objects for the client

Annotations

@Override

getLocalName back to summary

getLocalName	back to summary
public String getLocalName() Implements jakarta.servlet.ServletRequest.getLocalName. The default behavior of this method is to return getLocalName() on the wrapped request object. Returns:String Doc from jakarta.servlet.ServletRequest.getLocalName. a `String` containing the host name of the IP on which the request was received. Annotations @Override Since Servlet 2.4

public String getLocalName()

Implements jakarta.servlet.ServletRequest.getLocalName.

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

Returns:String

Doc from jakarta.servlet.ServletRequest.getLocalName.

a String containing the host name of the IP on which the request was received.

Annotations

@Override

Since

Servlet 2.4

getLocalPort	back to summary
public int getLocalPort() Implements jakarta.servlet.ServletRequest.getLocalPort. The default behavior of this method is to return getLocalPort() on the wrapped request object. Returns:int Doc from jakarta.servlet.ServletRequest.getLocalPort. an integer specifying a port number Annotations @Override Since Servlet 2.4

getLocalPort

back to summary

public int getLocalPort()

Implements jakarta.servlet.ServletRequest.getLocalPort.

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

Returns:int

Doc from jakarta.servlet.ServletRequest.getLocalPort.

an integer specifying a port number

Annotations

@Override

Since

Servlet 2.4

getParameter back to summary

getParameter	back to summary
public String getParameter(String name) Implements jakarta.servlet.ServletRequest.getParameter. The default behavior of this method is to return getParameter(String name) on the wrapped request object. Parameters name:String Doc from jakarta.servlet.ServletRequest.getParameter. a `String` specifying the name of the parameter Returns:String Doc from jakarta.servlet.ServletRequest.getParameter. a `String` representing the single value of the parameter Annotations @Override

public String getParameter(String name)

Implements jakarta.servlet.ServletRequest.getParameter.

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

Parameters

name:String

Doc from jakarta.servlet.ServletRequest.getParameter.

a String specifying the name of the parameter

Returns:String

Doc from jakarta.servlet.ServletRequest.getParameter.

a String representing the single value of the parameter

Annotations

@Override

getParameterMap	back to summary
public Map<String, String[]> getParameterMap() Implements jakarta.servlet.ServletRequest.getParameterMap. The default behavior of this method is to return getParameterMap() on the wrapped request object. Returns:Map<String, String[]> Doc from jakarta.servlet.ServletRequest.getParameterMap. an immutable java.util.Map containing parameter names as keys and parameter values as map values. The keys in the parameter map are of type String. The values in the parameter map are of type String array. Annotations @Override

getParameterMap

back to summary

public Map<String, String[]> getParameterMap()

Implements jakarta.servlet.ServletRequest.getParameterMap.

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

Returns:Map<String, String[]>

Doc from jakarta.servlet.ServletRequest.getParameterMap.

an immutable java.util.Map containing parameter names as keys and parameter values as map values. The keys in the parameter map are of type String. The values in the parameter map are of type String array.

Annotations

@Override

getParameterNames back to summary

getParameterNames	back to summary
public Enumeration<String> getParameterNames() Implements jakarta.servlet.ServletRequest.getParameterNames. The default behavior of this method is to return getParameterNames() on the wrapped request object. Returns:Enumeration<String> Doc from jakarta.servlet.ServletRequest.getParameterNames. an `Enumeration` of `String` objects, each `String` containing the name of a request parameter; or an empty `Enumeration` if the request has no parameters Annotations @Override

public Enumeration<String> getParameterNames()

Implements jakarta.servlet.ServletRequest.getParameterNames.

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

Returns:Enumeration<String>

Doc from jakarta.servlet.ServletRequest.getParameterNames.

an Enumeration of String objects, each String containing the name of a request parameter; or an empty Enumeration if the request has no parameters

Annotations

@Override

getParameterValues back to summary

getParameterValues	back to summary
public String[] getParameterValues(String name) Implements jakarta.servlet.ServletRequest.getParameterValues. The default behavior of this method is to return getParameterValues(String name) on the wrapped request object. Parameters name:String Doc from jakarta.servlet.ServletRequest.getParameterValues. a `String` containing the name of the parameter whose value is requested Returns:String[] Doc from jakarta.servlet.ServletRequest.getParameterValues. an array of `String` objects containing the parameter's values Annotations @Override

public String[] getParameterValues(String name)

Implements jakarta.servlet.ServletRequest.getParameterValues.

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

Parameters

name:String

Doc from jakarta.servlet.ServletRequest.getParameterValues.

a String containing the name of the parameter whose value is requested

Returns:String[]

Doc from jakarta.servlet.ServletRequest.getParameterValues.

an array of String objects containing the parameter's values

Annotations

@Override

getProtocol back to summary

getProtocol	back to summary
public String getProtocol() Implements jakarta.servlet.ServletRequest.getProtocol. The default behavior of this method is to return getProtocol() on the wrapped request object. Returns:String Doc from jakarta.servlet.ServletRequest.getProtocol. a `String` containing the protocol name and version number Annotations @Override

public String getProtocol()

Implements jakarta.servlet.ServletRequest.getProtocol.

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

Returns:String

Doc from jakarta.servlet.ServletRequest.getProtocol.

a String containing the protocol name and version number

Annotations

@Override

getProtocolRequestId	back to summary
public String getProtocolRequestId() Implements jakarta.servlet.ServletRequest.getProtocolRequestId. Gets the protocol defined request ID, if any, for the wrapped request. Returns:String the protocol defined request ID, if any, for the wrapped request Annotations @Override Since Servlet 6.0

getProtocolRequestId

back to summary

public String getProtocolRequestId()

Implements jakarta.servlet.ServletRequest.getProtocolRequestId.

Gets the protocol defined request ID, if any, for the wrapped request.

Returns:String

the protocol defined request ID, if any, for the wrapped request

Annotations

@Override

Since

Servlet 6.0

getReader back to summary

getReader	back to summary
public BufferedReader getReader() throws IOException Implements jakarta.servlet.ServletRequest.getReader. The default behavior of this method is to return getReader() on the wrapped request object. Returns:BufferedReader Doc from jakarta.servlet.ServletRequest.getReader. a `BufferedReader` containing the body of the request Annotations @Override Exceptions IOException: Doc from jakarta.servlet.ServletRequest.getReader. if an input or output exception occurred

public BufferedReader getReader() throws IOException

Implements jakarta.servlet.ServletRequest.getReader.

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

Returns:BufferedReader

Doc from jakarta.servlet.ServletRequest.getReader.

a BufferedReader containing the body of the request

Annotations

@Override

Exceptions

IOException:

Doc from jakarta.servlet.ServletRequest.getReader.

if an input or output exception occurred

getRemoteAddr back to summary

getRemoteAddr	back to summary
public String getRemoteAddr() Implements jakarta.servlet.ServletRequest.getRemoteAddr. The default behavior of this method is to return getRemoteAddr() on the wrapped request object. Returns:String Doc from jakarta.servlet.ServletRequest.getRemoteAddr. a `String` containing an IP address Annotations @Override

public String getRemoteAddr()

Implements jakarta.servlet.ServletRequest.getRemoteAddr.

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

Returns:String

Doc from jakarta.servlet.ServletRequest.getRemoteAddr.

a String containing an IP address

Annotations

@Override

getRemoteHost back to summary

getRemoteHost	back to summary
public String getRemoteHost() Implements jakarta.servlet.ServletRequest.getRemoteHost. The default behavior of this method is to return getRemoteHost() on the wrapped request object. Returns:String Doc from jakarta.servlet.ServletRequest.getRemoteHost. a `String` containing a fully qualified name or IP address. Annotations @Override

public String getRemoteHost()

Implements jakarta.servlet.ServletRequest.getRemoteHost.

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

Returns:String

Doc from jakarta.servlet.ServletRequest.getRemoteHost.

a String containing a fully qualified name or IP address.

Annotations

@Override

getRemotePort	back to summary
public int getRemotePort() Implements jakarta.servlet.ServletRequest.getRemotePort. The default behavior of this method is to return getRemotePort() on the wrapped request object. Returns:int Doc from jakarta.servlet.ServletRequest.getRemotePort. an integer specifying the port number Annotations @Override Since Servlet 2.4

getRemotePort

back to summary

public int getRemotePort()

Implements jakarta.servlet.ServletRequest.getRemotePort.

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

Returns:int

Doc from jakarta.servlet.ServletRequest.getRemotePort.

an integer specifying the port number

Annotations

@Override

Since

Servlet 2.4

getRequest back to summary

getRequest	back to summary
public ServletRequest getRequest() Return the wrapped request object. Returns:ServletRequest the wrapped `ServletRequest`

public ServletRequest getRequest()

Return the wrapped request object.

Returns:ServletRequest: the wrapped ServletRequest

getRequestDispatcher back to summary

getRequestDispatcher	back to summary
public RequestDispatcher getRequestDispatcher(String path) Implements jakarta.servlet.ServletRequest.getRequestDispatcher. The default behavior of this method is to return getRequestDispatcher(String path) on the wrapped request object. Parameters path:String Doc from jakarta.servlet.ServletRequest.getRequestDispatcher. a `String` specifying the pathname to the resource. If it is relative, it must be relative against the current servlet. Returns:RequestDispatcher Doc from jakarta.servlet.ServletRequest.getRequestDispatcher. a `RequestDispatcher` object that acts as a wrapper for the resource at the specified path, or `null` if the servlet container cannot return a `RequestDispatcher` Annotations @Override

public RequestDispatcher getRequestDispatcher(String path)

Implements jakarta.servlet.ServletRequest.getRequestDispatcher.

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

Parameters

path:String

Doc from jakarta.servlet.ServletRequest.getRequestDispatcher.

a String specifying the pathname to the resource. If it is relative, it must be relative against the current servlet.

Returns:RequestDispatcher

Doc from jakarta.servlet.ServletRequest.getRequestDispatcher.

a RequestDispatcher object that acts as a wrapper for the resource at the specified path, or null if the servlet container cannot return a RequestDispatcher

Annotations

@Override

getRequestId	back to summary
public String getRequestId() Implements jakarta.servlet.ServletRequest.getRequestId. Gets the request ID for the wrapped request. Returns:String the request ID for the wrapped request Annotations @Override Since Servlet 6.0

getRequestId

back to summary

public String getRequestId()

Implements jakarta.servlet.ServletRequest.getRequestId.

Gets the request ID for the wrapped request.

Returns:String

the request ID for the wrapped request

Annotations

@Override

Since

Servlet 6.0

getScheme back to summary

getScheme	back to summary
public String getScheme() Implements jakarta.servlet.ServletRequest.getScheme. The default behavior of this method is to return getScheme() on the wrapped request object. Returns:String Doc from jakarta.servlet.ServletRequest.getScheme. a `String` containing the name of the scheme used to make this request Annotations @Override

public String getScheme()

Implements jakarta.servlet.ServletRequest.getScheme.

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

Returns:String

Doc from jakarta.servlet.ServletRequest.getScheme.

a String containing the name of the scheme used to make this request

Annotations

@Override

getServerName back to summary

getServerName	back to summary
public String getServerName() Implements jakarta.servlet.ServletRequest.getServerName. The default behavior of this method is to return getServerName() on the wrapped request object. Returns:String Doc from jakarta.servlet.ServletRequest.getServerName. a `String` containing the name of the server Annotations @Override

public String getServerName()

Implements jakarta.servlet.ServletRequest.getServerName.

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

Returns:String

Doc from jakarta.servlet.ServletRequest.getServerName.

a String containing the name of the server

Annotations

@Override

getServerPort	back to summary
public int getServerPort() Implements jakarta.servlet.ServletRequest.getServerPort. The default behavior of this method is to return getServerPort() on the wrapped request object. Returns:int Doc from jakarta.servlet.ServletRequest.getServerPort. an integer specifying the port number Annotations @Override

getServerPort

back to summary

public int getServerPort()

Implements jakarta.servlet.ServletRequest.getServerPort.

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

Returns:int

Doc from jakarta.servlet.ServletRequest.getServerPort.

an integer specifying the port number

Annotations

@Override

getServletConnection	back to summary
public ServletConnection getServletConnection() Implements jakarta.servlet.ServletRequest.getServletConnection. Gets the connection information for the wrapped request. Returns:ServletConnection the connection information for the wrapped request Annotations @Override Since Servlet 6.0

getServletConnection

back to summary

public ServletConnection getServletConnection()

Implements jakarta.servlet.ServletRequest.getServletConnection.

Gets the connection information for the wrapped request.

Returns:ServletConnection

the connection information for the wrapped request

Annotations

@Override

Since

Servlet 6.0

getServletContext	back to summary
public ServletContext getServletContext() Implements jakarta.servlet.ServletRequest.getServletContext. Gets the servlet context to which the wrapped servlet request was last dispatched. Returns:ServletContext the servlet context to which the wrapped servlet request was last dispatched Annotations @Override Since Servlet 3.0

getServletContext

back to summary

public ServletContext getServletContext()

Implements jakarta.servlet.ServletRequest.getServletContext.

Gets the servlet context to which the wrapped servlet request was last dispatched.

Returns:ServletContext

the servlet context to which the wrapped servlet request was last dispatched

Annotations

@Override

Since

Servlet 3.0

isAsyncStarted back to summary

isAsyncStarted	back to summary
public boolean isAsyncStarted() Implements jakarta.servlet.ServletRequest.isAsyncStarted. Checks if the wrapped request has been put into asynchronous mode. Returns:boolean true if this request has been put into asynchronous mode, false otherwise Annotations @Override Since Servlet 3.0 See Also `ServletRequest#isAsyncStarted`

public boolean isAsyncStarted()

Implements jakarta.servlet.ServletRequest.isAsyncStarted.

Checks if the wrapped request has been put into asynchronous mode.

Returns:boolean

true if this request has been put into asynchronous mode, false otherwise

Annotations

@Override

Since

Servlet 3.0

See Also

ServletRequest#isAsyncStarted

isAsyncSupported back to summary

isAsyncSupported	back to summary
public boolean isAsyncSupported() Implements jakarta.servlet.ServletRequest.isAsyncSupported. Checks if the wrapped request supports asynchronous operation. Returns:boolean true if this request supports asynchronous operation, false otherwise Annotations @Override Since Servlet 3.0 See Also `ServletRequest#isAsyncSupported`

public boolean isAsyncSupported()

Implements jakarta.servlet.ServletRequest.isAsyncSupported.

Checks if the wrapped request supports asynchronous operation.

Returns:boolean

true if this request supports asynchronous operation, false otherwise

Annotations

@Override

Since

Servlet 3.0

See Also

ServletRequest#isAsyncSupported

isSecure	back to summary
public boolean isSecure() Implements jakarta.servlet.ServletRequest.isSecure. The default behavior of this method is to return isSecure() on the wrapped request object. Returns:boolean Doc from jakarta.servlet.ServletRequest.isSecure. a boolean indicating if the request was made using a secure channel Annotations @Override

isSecure

back to summary

public boolean isSecure()

Implements jakarta.servlet.ServletRequest.isSecure.

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

Returns:boolean

Doc from jakarta.servlet.ServletRequest.isSecure.

a boolean indicating if the request was made using a secure channel

Annotations

@Override

isWrapperFor back to summary

isWrapperFor	back to summary
public boolean isWrapperFor(ServletRequest wrapped) Checks (recursively) if this ServletRequestWrapper wraps the given `ServletRequest` instance. Parameters wrapped:ServletRequest the ServletRequest instance to search for Returns:boolean true if this ServletRequestWrapper wraps the given ServletRequest instance, false otherwise Since Servlet 3.0

public boolean isWrapperFor(ServletRequest wrapped)

Checks (recursively) if this ServletRequestWrapper wraps the given ServletRequest instance.

Parameters

wrapped:ServletRequest: the ServletRequest instance to search for

Returns:boolean

true if this ServletRequestWrapper wraps the given ServletRequest instance, false otherwise

Since

Servlet 3.0

isWrapperFor back to summary

isWrapperFor	back to summary
public boolean isWrapperFor(Class<?> wrappedType) Checks (recursively) if this ServletRequestWrapper wraps a `ServletRequest` of the given class type. Parameters wrappedType:Class<?> the ServletRequest class type to search for Returns:boolean true if this ServletRequestWrapper wraps a ServletRequest of the given class type, false otherwise Exceptions IllegalArgumentException: if the given class does not implement `ServletRequest` Since Servlet 3.0

public boolean isWrapperFor(Class<?> wrappedType)

Checks (recursively) if this ServletRequestWrapper wraps a ServletRequest of the given class type.

Parameters

wrappedType:Class<?>: the ServletRequest class type to search for

Returns:boolean

true if this ServletRequestWrapper wraps a ServletRequest of the given class type, false otherwise

Exceptions

IllegalArgumentException:: if the given class does not implement ServletRequest

Since

Servlet 3.0

removeAttribute back to summary

removeAttribute	back to summary
public void removeAttribute(String name) Implements jakarta.servlet.ServletRequest.removeAttribute. The default behavior of this method is to call removeAttribute(String name) on the wrapped request object. Parameters name:String Doc from jakarta.servlet.ServletRequest.removeAttribute. a `String` specifying the name of the attribute to remove Annotations @Override

public void removeAttribute(String name)

Implements jakarta.servlet.ServletRequest.removeAttribute.

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

Parameters

name:String

Doc from jakarta.servlet.ServletRequest.removeAttribute.

a String specifying the name of the attribute to remove

Annotations

@Override

setAttribute back to summary

setAttribute	back to summary
public void setAttribute(String name, Object o) Implements jakarta.servlet.ServletRequest.setAttribute. The default behavior of this method is to return setAttribute(String name, Object o) on the wrapped request object. Parameters name:String Doc from jakarta.servlet.ServletRequest.setAttribute. a `String` specifying the name of the attribute o:Object Doc from jakarta.servlet.ServletRequest.setAttribute. the `Object` to be stored Annotations @Override

public void setAttribute(String name, Object o)

Implements jakarta.servlet.ServletRequest.setAttribute.

The default behavior of this method is to return setAttribute(String name, Object o) on the wrapped request object.

Parameters

name:String

Doc from jakarta.servlet.ServletRequest.setAttribute.

a String specifying the name of the attribute

o:Object

Doc from jakarta.servlet.ServletRequest.setAttribute.

the Object to be stored

Annotations

@Override

setCharacterEncoding back to summary

setCharacterEncoding	back to summary
public void setCharacterEncoding(String enc) throws UnsupportedEncodingException Implements jakarta.servlet.ServletRequest.setCharacterEncoding. The default behavior of this method is to set the character encoding on the wrapped request object. Parameters enc:String Doc from jakarta.servlet.ServletRequest.setCharacterEncoding. `String` containing the name of the character encoding. Annotations @Override Exceptions UnsupportedEncodingException: Doc from jakarta.servlet.ServletRequest.setCharacterEncoding. if this ServletRequest is still in a state where a character encoding may be set, but the specified encoding is invalid

public void setCharacterEncoding(String enc) throws UnsupportedEncodingException

Implements jakarta.servlet.ServletRequest.setCharacterEncoding.

The default behavior of this method is to set the character encoding on the wrapped request object.

Parameters

enc:String

Doc from jakarta.servlet.ServletRequest.setCharacterEncoding.

String containing the name of the character encoding.

Annotations

@Override

Exceptions

UnsupportedEncodingException:

Doc from jakarta.servlet.ServletRequest.setCharacterEncoding.

if this ServletRequest is still in a state where a character encoding may be set, but the specified encoding is invalid

setRequest back to summary

setRequest	back to summary
public void setRequest(ServletRequest request) Sets the request object being wrapped. Parameters request:ServletRequest the `ServletRequest` to be installed Exceptions IllegalArgumentException: if the request is null.

public void setRequest(ServletRequest request)

Sets the request object being wrapped.

Parameters

request:ServletRequest: the ServletRequest to be installed

Exceptions

IllegalArgumentException:: if the request is null.

startAsync back to summary

startAsync	back to summary
public AsyncContext startAsync() throws IllegalStateException Implements jakarta.servlet.ServletRequest.startAsync. The default behavior of this method is to invoke `ServletRequest#startAsync` on the wrapped request object. Returns:AsyncContext the (re)initialized AsyncContext Annotations @Override Exceptions IllegalStateException: if the request is within the scope of a filter or servlet that does not support asynchronous operations (that is, `isAsyncSupported` returns false), or if this method is called again without any asynchronous dispatch (resulting from one of the `AsyncContext#dispatch` methods), is called outside the scope of any such dispatch, or is called again within the scope of the same dispatch, or if the response has already been closed Since Servlet 3.0 See Also `ServletRequest#startAsync`

public AsyncContext startAsync() throws IllegalStateException

Implements jakarta.servlet.ServletRequest.startAsync.

The default behavior of this method is to invoke ServletRequest#startAsync on the wrapped request object.

Returns:AsyncContext

the (re)initialized AsyncContext

Annotations

@Override

Exceptions

IllegalStateException:: if the request is within the scope of a filter or servlet that does not support asynchronous operations (that is, isAsyncSupported returns false), or if this method is called again without any asynchronous dispatch (resulting from one of the AsyncContext#dispatch methods), is called outside the scope of any such dispatch, or is called again within the scope of the same dispatch, or if the response has already been closed

Since

Servlet 3.0

See Also

ServletRequest#startAsync

startAsync back to summary

startAsync	back to summary
public AsyncContext startAsync(ServletRequest servletRequest, ServletResponse servletResponse) throws IllegalStateException Implements jakarta.servlet.ServletRequest.startAsync. The default behavior of this method is to invoke `ServletRequest#startAsync(ServletRequest, ServletResponse)` on the wrapped request object. Parameters servletRequest:ServletRequest the ServletRequest used to initialize the AsyncContext servletResponse:ServletResponse the ServletResponse used to initialize the AsyncContext Returns:AsyncContext the (re)initialized AsyncContext Annotations @Override Exceptions IllegalStateException: if the request is within the scope of a filter or servlet that does not support asynchronous operations (that is, `isAsyncSupported` returns false), or if this method is called again without any asynchronous dispatch (resulting from one of the `AsyncContext#dispatch` methods), is called outside the scope of any such dispatch, or is called again within the scope of the same dispatch, or if the response has already been closed Since Servlet 3.0 See Also `ServletRequest#startAsync(ServletRequest, ServletResponse)`

public AsyncContext startAsync(ServletRequest servletRequest, ServletResponse servletResponse) throws IllegalStateException

Implements jakarta.servlet.ServletRequest.startAsync.

The default behavior of this method is to invoke ServletRequest#startAsync(ServletRequest, ServletResponse) on the wrapped request object.

Parameters

servletRequest:ServletRequest: the ServletRequest used to initialize the AsyncContext
servletResponse:ServletResponse: the ServletResponse used to initialize the AsyncContext

Returns:AsyncContext

the (re)initialized AsyncContext

Annotations

@Override

Exceptions

IllegalStateException:: if the request is within the scope of a filter or servlet that does not support asynchronous operations (that is, isAsyncSupported returns false), or if this method is called again without any asynchronous dispatch (resulting from one of the AsyncContext#dispatch methods), is called outside the scope of any such dispatch, or is called again within the scope of the same dispatch, or if the response has already been closed

Since

Servlet 3.0

public Class ServletRequestWrapper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail