jakarta.servlet.ServletRequest
| Modifier and Type | Field and Description |
|---|---|
| private ServletRequest |
| Access | Constructor and Description |
|---|---|
| public | ServletRequestWrapper(ServletRequest
the request)ServletRequest to be wrappedCreates a ServletRequest adaptor wrapping the given request object. |
| Modifier and Type | Method and Description |
|---|---|
| public AsyncContext | Returns: the AsyncContext that was created or reinitialized by the most recent invocation ofstartAsync or
startAsync(ServletRequest, ServletResponse) on the wrapped requestImplements jakarta. Gets the AsyncContext that was created or reinitialized by the most recent invocation of |
| public Object | getAttribute(String
a name)String specifying the name of the attributeImplements jakarta. The default behavior of this method is to call getAttribute(String name) on the wrapped request object. |
| public Enumeration | getAttributeNames()
Implements jakarta. The default behavior of this method is to return getAttributeNames() on the wrapped request object. |
| public String | getCharacterEncoding()
Implements jakarta. The default behavior of this method is to return getCharacterEncoding() on the wrapped request object. |
| public int | getContentLength()
Implements jakarta. The default behavior of this method is to return getContentLength() on the wrapped request object. |
| public long | getContentLengthLong()
Implements jakarta. The default behavior of this method is to return getContentLengthLong() on the wrapped request object. |
| public String | getContentType()
Implements jakarta. The default behavior of this method is to return getContentType() on the wrapped request object. |
| public DispatcherType | Returns: the dispatcher type of the wrapped requestImplements jakarta. Gets the dispatcher type of the wrapped request. |
| public ServletInputStream | getInputStream()
Implements jakarta. The default behavior of this method is to return getInputStream() on the wrapped request object. |
| public String | getLocalAddr()
Implements jakarta. The default behavior of this method is to return getLocalAddr() on the wrapped request object. |
| public Locale | getLocale()
Implements jakarta. The default behavior of this method is to return getLocale() on the wrapped request object. |
| public Enumeration | getLocales()
Implements jakarta. The default behavior of this method is to return getLocales() on the wrapped request object. |
| public String | getLocalName()
Implements jakarta. The default behavior of this method is to return getLocalName() on the wrapped request object. |
| public int | getLocalPort()
Implements jakarta. The default behavior of this method is to return getLocalPort() on the wrapped request object. |
| public String | getParameter(String
a name)String specifying the name of the parameterImplements jakarta. The default behavior of this method is to return getParameter(String name) on the wrapped request object. |
| public Map | getParameterMap()
Implements jakarta. The default behavior of this method is to return getParameterMap() on the wrapped request object. |
| public Enumeration | getParameterNames()
Implements jakarta. The default behavior of this method is to return getParameterNames() on the wrapped request object. |
| public String[] | getParameterValues(String
a name)String containing the name of the parameter whose value is requestedImplements jakarta. The default behavior of this method is to return getParameterValues(String name) on the wrapped request object. |
| public String | getProtocol()
Implements jakarta. 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 requestImplements jakarta. Gets the protocol defined request ID, if any, for the wrapped request. |
| public BufferedReader | getReader()
Implements jakarta. The default behavior of this method is to return getReader() on the wrapped request object. |
| public String | getRemoteAddr()
Implements jakarta. The default behavior of this method is to return getRemoteAddr() on the wrapped request object. |
| public String | getRemoteHost()
Implements jakarta. The default behavior of this method is to return getRemoteHost() on the wrapped request object. |
| public int | getRemotePort()
Implements jakarta. The default behavior of this method is to return getRemotePort() on the wrapped request object. |
| public ServletRequest | |
| public RequestDispatcher | getRequestDispatcher(String
a path)String specifying the pathname to the resource. If it is relative, it must be relative
against the current servlet.Implements jakarta. 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 requestImplements jakarta. Gets the request ID for the wrapped request. |
| public String | getScheme()
Implements jakarta. The default behavior of this method is to return getScheme() on the wrapped request object. |
| public String | getServerName()
Implements jakarta. The default behavior of this method is to return getServerName() on the wrapped request object. |
| public int | getServerPort()
Implements jakarta. The default behavior of this method is to return getServerPort() on the wrapped request object. |
| public ServletConnection | Returns: the connection information for the wrapped requestImplements jakarta. Gets the connection information for the wrapped request. |
| public ServletContext | Returns: the servlet context to which the wrapped servlet request was last dispatchedImplements jakarta. 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 otherwiseImplements jakarta. Checks if the wrapped request has been put into asynchronous mode. |
| public boolean | Returns: true if this request supports asynchronous operation, false otherwiseImplements jakarta. Checks if the wrapped request supports asynchronous operation. |
| public boolean | isSecure()
Implements jakarta. 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 otherwisethe ServletRequest instance to search for wrapped)Checks (recursively) if this ServletRequestWrapper wraps the given |
| public boolean | Returns: true if this ServletRequestWrapper wraps a ServletRequest of the given class type, false otherwisethe ServletRequest class type to search for wrappedType)Checks (recursively) if this ServletRequestWrapper wraps a |
| public void | removeAttribute(String
a name)String specifying the name of the attribute to removeImplements jakarta. The default behavior of this method is to call removeAttribute(String name) on the wrapped request object. |
| public void | setAttribute(String
a name, Object String specifying the name of the attributethe o)Object to be storedImplements jakarta. 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.Implements jakarta. The default behavior of this method is to set the character encoding on the wrapped request object. |
| public void | setCharacterEncoding(Charset
Charset representing the character encoding.Overrides default jakarta. The default behavior of this method is to set the character encoding on the wrapped request object. |
| public void | setRequest(ServletRequest
the request)ServletRequest to be installedSets the request object being wrapped. |
| public AsyncContext | Returns: the (re)initialized AsyncContextImplements jakarta. The default behavior of this method is to invoke |
| public AsyncContext | Returns: the (re)initialized AsyncContextthe ServletRequest used to initialize the AsyncContext servletRequest, ServletResponse the ServletResponse used to initialize the AsyncContext servletResponse)Implements jakarta. The default behavior of this method is to invoke |
| request | back to summary |
|---|---|
| private ServletRequest request | |
| ServletRequestWrapper | back to summary |
|---|---|
| public ServletRequestWrapper(ServletRequest request) Creates a ServletRequest adaptor wrapping the given request object.
| |
| getAsyncContext | back to summary |
|---|---|
| public AsyncContext getAsyncContext() Implements jakarta. Gets the AsyncContext that was created or reinitialized by the most recent invocation of
| |
| getAttribute | back to summary |
|---|---|
| public Object getAttribute(String name) Implements jakarta. The default behavior of this method is to call getAttribute(String name) on the wrapped request object.
| |
| getAttributeNames | back to summary |
|---|---|
| public Enumeration Implements jakarta. The default behavior of this method is to return getAttributeNames() on the wrapped request object.
| |
| getCharacterEncoding | back to summary |
|---|---|
| public String getCharacterEncoding() Implements jakarta. The default behavior of this method is to return getCharacterEncoding() on the wrapped request object.
| |
| getContentLength | back to summary |
|---|---|
| public int getContentLength() Implements jakarta. The default behavior of this method is to return getContentLength() on the wrapped request object.
| |
| getContentLengthLong | back to summary |
|---|---|
| public long getContentLengthLong() Implements jakarta. The default behavior of this method is to return getContentLengthLong() on the wrapped request object.
| |
| getContentType | back to summary |
|---|---|
| public String getContentType() Implements jakarta. The default behavior of this method is to return getContentType() on the wrapped request object.
| |
| getDispatcherType | back to summary |
|---|---|
| public DispatcherType getDispatcherType() Implements jakarta. Gets the dispatcher type of the wrapped request.
| |
| getInputStream | back to summary |
|---|---|
| public ServletInputStream getInputStream() throws IOException Implements jakarta. The default behavior of this method is to return getInputStream() on the wrapped request object.
| |
| getLocalAddr | back to summary |
|---|---|
| public String getLocalAddr() Implements jakarta. The default behavior of this method is to return getLocalAddr() on the wrapped request object.
| |
| getLocale | back to summary |
|---|---|
| public Locale getLocale() Implements jakarta. The default behavior of this method is to return getLocale() on the wrapped request object.
| |
| getLocales | back to summary |
|---|---|
| public Enumeration Implements jakarta. The default behavior of this method is to return getLocales() on the wrapped request object.
| |
| getLocalName | back to summary |
|---|---|
| public String getLocalName() Implements jakarta. The default behavior of this method is to return getLocalName() on the wrapped request object.
| |
| getLocalPort | back to summary |
|---|---|
| public int getLocalPort() Implements jakarta. The default behavior of this method is to return getLocalPort() on the wrapped request object.
| |
| getParameter | back to summary |
|---|---|
| public String getParameter(String name) Implements jakarta. The default behavior of this method is to return getParameter(String name) on the wrapped request object.
| |
| getParameterMap | back to summary |
|---|---|
| public Map Implements jakarta. The default behavior of this method is to return getParameterMap() on the wrapped request object.
| |
| getParameterNames | back to summary |
|---|---|
| public Enumeration Implements jakarta. The default behavior of this method is to return getParameterNames() on the wrapped request object.
| |
| getParameterValues | back to summary |
|---|---|
| public String[] getParameterValues(String name) Implements jakarta. The default behavior of this method is to return getParameterValues(String name) on the wrapped request object.
| |
| getProtocol | back to summary |
|---|---|
| public String getProtocol() Implements jakarta. The default behavior of this method is to return getProtocol() on the wrapped request object.
| |
| getProtocolRequestId | back to summary |
|---|---|
| public String getProtocolRequestId() Implements jakarta. Gets the protocol defined request ID, if any, for the wrapped request. | |
| getReader | back to summary |
|---|---|
| public BufferedReader getReader() throws IOException Implements jakarta. The default behavior of this method is to return getReader() on the wrapped request object.
| |
| getRemoteAddr | back to summary |
|---|---|
| public String getRemoteAddr() Implements jakarta. The default behavior of this method is to return getRemoteAddr() on the wrapped request object.
| |
| getRemoteHost | back to summary |
|---|---|
| public String getRemoteHost() Implements jakarta. The default behavior of this method is to return getRemoteHost() on the wrapped request object.
| |
| getRemotePort | back to summary |
|---|---|
| public int getRemotePort() Implements jakarta. The default behavior of this method is to return getRemotePort() on the wrapped request object.
| |
| getRequest | back to summary |
|---|---|
| public ServletRequest getRequest() Return the wrapped request object.
| |
| getRequestDispatcher | back to summary |
|---|---|
| public RequestDispatcher getRequestDispatcher(String path) Implements jakarta. The default behavior of this method is to return getRequestDispatcher(String path) on the wrapped request object.
| |
| getRequestId | back to summary |
|---|---|
| public String getRequestId() Implements jakarta. Gets the request ID for the wrapped request. | |
| getScheme | back to summary |
|---|---|
| public String getScheme() Implements jakarta. The default behavior of this method is to return getScheme() on the wrapped request object.
| |
| getServerName | back to summary |
|---|---|
| public String getServerName() Implements jakarta. The default behavior of this method is to return getServerName() on the wrapped request object.
| |
| getServerPort | back to summary |
|---|---|
| public int getServerPort() Implements jakarta. The default behavior of this method is to return getServerPort() on the wrapped request object.
| |
| getServletConnection | back to summary |
|---|---|
| public ServletConnection getServletConnection() Implements jakarta. Gets the connection information for the wrapped request.
| |
| getServletContext | back to summary |
|---|---|
| public ServletContext getServletContext() Implements jakarta. Gets the servlet context to which the wrapped servlet request was last dispatched.
| |
| isAsyncStarted | back to summary |
|---|---|
| public boolean isAsyncStarted() Implements jakarta. Checks if the wrapped request has been put into asynchronous mode.
| |
| isAsyncSupported | back to summary |
|---|---|
| public boolean isAsyncSupported() Implements jakarta. Checks if the wrapped request supports asynchronous operation.
| |
| isSecure | back to summary |
|---|---|
| public boolean isSecure() Implements jakarta. The default behavior of this method is to return isSecure() on the wrapped request object.
| |
| isWrapperFor | back to summary |
|---|---|
| public boolean isWrapperFor(ServletRequest wrapped) Checks (recursively) if this ServletRequestWrapper wraps the given
| |
| isWrapperFor | back to summary |
|---|---|
| public boolean isWrapperFor(Class<?> wrappedType) Checks (recursively) if this ServletRequestWrapper wraps a
| |
| removeAttribute | back to summary |
|---|---|
| public void removeAttribute(String name) Implements jakarta. The default behavior of this method is to call removeAttribute(String name) on the wrapped request object.
| |
| setAttribute | back to summary |
|---|---|
| public void setAttribute(String name, Object o) Implements jakarta. The default behavior of this method is to return setAttribute(String name, Object o) on the wrapped request object.
| |
| setCharacterEncoding | back to summary |
|---|---|
| public void setCharacterEncoding(String encoding) throws UnsupportedEncodingException Implements jakarta. The default behavior of this method is to set the character encoding on the wrapped request object.
| |
| setCharacterEncoding | back to summary |
|---|---|
| public void setCharacterEncoding(Charset encoding) Overrides default jakarta. The default behavior of this method is to set the character encoding on the wrapped request object.
| |
| setRequest | back to summary |
|---|---|
| public void setRequest(ServletRequest request) Sets the request object being wrapped.
| |
| startAsync | back to summary |
|---|---|
| public AsyncContext startAsync() throws IllegalStateException Implements jakarta. The default behavior of this method is to invoke
| |
| startAsync | back to summary |
|---|---|
| public AsyncContext startAsync(ServletRequest servletRequest, ServletResponse servletResponse) throws IllegalStateException Implements jakarta. The default behavior of this method is to invoke
| |