| ID | Return | Method/Field | Description | Required | Deprecated | Testable |
| Servlet:JAVADOC:1 | UnavailableException | jakarta.servlet.UnavailableException.UnavailableException
(
Servlet
,
String
)
|
| true | true | true |
| Servlet:JAVADOC:2 | UnavailableException | jakarta.servlet.UnavailableException.UnavailableException
(
int
,
Servlet
,
String
)
|
| true | true | true |
| Servlet:JAVADOC:3 | UnavailableException | jakarta.servlet.UnavailableException.UnavailableException
(
String
)
| Constructs a new exception with a descriptive message indicating that the servlet is permanently unavailable.
| true |
| true |
| Servlet:JAVADOC:4 | UnavailableException | jakarta.servlet.UnavailableException.UnavailableException
(
String
,
int
)
| Constructs a new exception with a descriptive message indicating that the servlet is temporarily unavailable and giving an estimate of how long it will be unavailable.
In some cases, the servlet cannot make an estimate. For example, the servlet might know that a server it needs is not running, but not be able to report how long it will take to be restored to functionality. This can be indicated with a negative or zero value for the seconds argument.
| true |
| true |
| Servlet:JAVADOC:5 | boolean | jakarta.servlet.UnavailableException.isPermanent
| Returns a boolean indicating whether the servlet is permanently unavailable. | true |
| true |
| Servlet:JAVADOC:6 | Servlet | jakarta.servlet.UnavailableException.getServlet
|
| true | true | true |
| Servlet:JAVADOC:7 | int | jakarta.servlet.UnavailableException.getUnavailableSeconds
| Returns the number of seconds the servlet expects to be temporarily unavailable.
If this method returns a negative number, the servlet is permanently unavailable or cannot provide an estimate of how long it will be unavailable. No effort is made to correct for the time elapsed since the exception was first reported.
| true |
| true |
| Servlet:JAVADOC:8 | Throwable | jakarta.servlet.UnavailableException.{jakarta.servlet.ServletException}.getRootCause
| Returns the exception that caused this servlet exception. | true |
| true |
| Servlet:JAVADOC:9 | ServletResponseWrapper | jakarta.servlet.ServletResponseWrapper.ServletResponseWrapper
(
ServletResponse
)
| Creates a ServletResponse adaptor wrapping the given response object.
| true |
| true |
| Servlet:JAVADOC:10 | ServletResponse | jakarta.servlet.ServletResponseWrapper.getResponse
| Return the wrapped ServletResponse object. | true |
| true |
| Servlet:JAVADOC:11 | void | jakarta.servlet.ServletResponseWrapper.setResponse
(
ServletResponse
)
| Sets the response being wrapped. | true |
| true |
| Servlet:JAVADOC:12 | void | jakarta.servlet.ServletResponseWrapper.setResponse
(
ServletResponse
)
throws
IllegalArgumentException
| if the response is null. | true |
| true |
| Servlet:JAVADOC:13 | void | jakarta.servlet.ServletResponseWrapper.setCharacterEncoding
(
String
)
| The default behavior of this method is to call setCharacterEncoding(String charset) on the wrapped response object.
| true |
| true |
| Servlet:JAVADOC:14 | String | jakarta.servlet.ServletResponseWrapper.getCharacterEncoding
| The default behavior of this method is to return getCharacterEncoding() on the wrapped response object.
| true |
| true |
| Servlet:JAVADOC:15 | ServletOutputStream | jakarta.servlet.ServletResponseWrapper.getOutputStream
| The default behavior of this method is to return getOutputStream() on the wrapped response object. | true |
| true |
| Servlet:JAVADOC:16 | ServletOutputStream | jakarta.servlet.ServletResponseWrapper.getOutputStream
throws
IOException
| if an input or output exception occurred | true |
| false |
| Servlet:JAVADOC:17 | PrintWriter | jakarta.servlet.ServletResponseWrapper.getWriter
| The default behavior of this method is to return getWriter() on the wrapped response object.
| true |
| true |
| Servlet:JAVADOC:18 | PrintWriter | jakarta.servlet.ServletResponseWrapper.getWriter
throws
IOException
|
| true |
| false |
| Servlet:JAVADOC:19 | void | jakarta.servlet.ServletResponseWrapper.setContentLength
(
int
)
| The default behavior of this method is to call setContentLength(int len) on the wrapped response object.
| true |
| true |
| Servlet:JAVADOC:20 | void | jakarta.servlet.ServletResponseWrapper.setContentType
(
String
)
| The default behavior of this method is to call setContentType(String type) on the wrapped response object.
| true |
| true |
| Servlet:JAVADOC:21 | String | jakarta.servlet.ServletResponseWrapper.getContentType
| The default behavior of this method is to return getContentType() on the wrapped response object.
| true |
| true |
| Servlet:JAVADOC:22 | void | jakarta.servlet.ServletResponseWrapper.setBufferSize
(
int
)
| The default behavior of this method is to call setBufferSize(int size) on the wrapped response object.
| true |
| true |
| Servlet:JAVADOC:23 | int | jakarta.servlet.ServletResponseWrapper.getBufferSize
| The default behavior of this method is to return getBufferSize() on the wrapped response object.
| true |
| true |
| Servlet:JAVADOC:24 | void | jakarta.servlet.ServletResponseWrapper.flushBuffer
| The default behavior of this method is to call flushBuffer() on the wrapped response object.
| true |
| true |
| Servlet:JAVADOC:25 | void | jakarta.servlet.ServletResponseWrapper.flushBuffer
throws
IOException
|
| true |
| false |
| Servlet:JAVADOC:26 | boolean | jakarta.servlet.ServletResponseWrapper.isCommitted
| The default behavior of this method is to return isCommitted() on the wrapped response object.
| true |
| true |
| Servlet:JAVADOC:27 | void | jakarta.servlet.ServletResponseWrapper.reset
| The default behavior of this method is to call reset() on the wrapped response object.
| true |
| true |
| Servlet:JAVADOC:28 | void | jakarta.servlet.ServletResponseWrapper.resetBuffer
| The default behavior of this method is to call resetBuffer() on the wrapped response object.
| true |
| true |
| Servlet:JAVADOC:29 | void | jakarta.servlet.ServletResponseWrapper.setLocale
(
Locale
)
| The default behavior of this method is to call setLocale(Locale loc) on the wrapped response object.
| true |
| true |
| Servlet:JAVADOC:30 | Locale | jakarta.servlet.ServletResponseWrapper.getLocale
| The default behavior of this method is to return getLocale() on the wrapped response object.
| true |
| true |
| Servlet:JAVADOC:31 | ServletRequestWrapper | jakarta.servlet.ServletRequestWrapper.ServletRequestWrapper
(
ServletRequest
)
| Creates a ServletRequest adaptor wrapping the given request object.
| true |
| true |
| Servlet:JAVADOC:32 | ServletRequest | jakarta.servlet.ServletRequestWrapper.getRequest
| Return the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:33 | void | jakarta.servlet.ServletRequestWrapper.setRequest
(
ServletRequest
)
| Sets the request object being wrapped. | true |
| true |
| Servlet:JAVADOC:34 | void | jakarta.servlet.ServletRequestWrapper.setRequest
(
ServletRequest
)
throws
IllegalArgumentException
| if the request is null. | true |
| true |
| Servlet:JAVADOC:35 | Object | jakarta.servlet.ServletRequestWrapper.getAttribute
(
String
)
| The default behavior of this method is to call getAttribute(String name) on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:36 | Enumeration | jakarta.servlet.ServletRequestWrapper.getAttributeNames
| The default behavior of this method is to return getAttributeNames() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:37 | String | jakarta.servlet.ServletRequestWrapper.getCharacterEncoding
| The default behavior of this method is to return getCharacterEncoding() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:38 | void | jakarta.servlet.ServletRequestWrapper.setCharacterEncoding
(
String
)
| Overrides the name of the character encoding used in the body of this wrapped request. This method must be called prior to reading request parameters or reading input using getReader(). Otherwise, it has no effect.
| true |
| true |
| Servlet:JAVADOC:39 | void | jakarta.servlet.ServletRequestWrapper.setCharacterEncoding
(
String
)
throws
UnsupportedEncodingException
| if this ServletRequest is still in a state where a character encoding may be set, but the specified encoding is invalid | true |
| true |
| Servlet:JAVADOC:40 | int | jakarta.servlet.ServletRequestWrapper.getContentLength
| The default behavior of this method is to return getContentLength() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:41 | String | jakarta.servlet.ServletRequestWrapper.getContentType
| The default behavior of this method is to return getContentType() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:42 | ServletInputStream | jakarta.servlet.ServletRequestWrapper.getInputStream
| The default behavior of this method is to return getInputStream() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:43 | ServletInputStream | jakarta.servlet.ServletRequestWrapper.getInputStream
throws
IOException
|
| true |
| false |
| Servlet:JAVADOC:44 | String | jakarta.servlet.ServletRequestWrapper.getParameter
(
String
)
| The default behavior of this method is to return getParameter(String name) on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:45 | Map | jakarta.servlet.ServletRequestWrapper.getParameterMap
| The default behavior of this method is to return getParameterMap() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:46 | Enumeration | jakarta.servlet.ServletRequestWrapper.getParameterNames
| The default behavior of this method is to return getParameterNames() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:47 | String[] | jakarta.servlet.ServletRequestWrapper.getParameterValues
(
String
)
| The default behavior of this method is to return getParameterValues(String name) on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:48 | String | jakarta.servlet.ServletRequestWrapper.getProtocol
| The default behavior of this method is to return getProtocol() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:49 | String | jakarta.servlet.ServletRequestWrapper.getScheme
| The default behavior of this method is to return getScheme() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:50 | String | jakarta.servlet.ServletRequestWrapper.getServerName
| The default behavior of this method is to return getServerName() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:51 | int | jakarta.servlet.ServletRequestWrapper.getServerPort
| The default behavior of this method is to return getServerPort() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:52 | BufferedReader | jakarta.servlet.ServletRequestWrapper.getReader
| The default behavior of this method is to return getReader() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:53 | BufferedReader | jakarta.servlet.ServletRequestWrapper.getReader
throws
IOException
|
| true |
| false |
| Servlet:JAVADOC:54 | String | jakarta.servlet.ServletRequestWrapper.getRemoteAddr
| The default behavior of this method is to return getRemoteAddr() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:55 | String | jakarta.servlet.ServletRequestWrapper.getRemoteHost
| The default behavior of this method is to return getRemoteHost() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:56 | void | jakarta.servlet.ServletRequestWrapper.setAttribute
(
String
,
Object
)
| The default behavior of this method is to return setAttribute(String name, Object o) on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:57 | void | jakarta.servlet.ServletRequestWrapper.removeAttribute
(
String
)
| The default behavior of this method is to call removeAttribute(String name) on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:58 | Locale | jakarta.servlet.ServletRequestWrapper.getLocale
| The default behavior of this method is to return getLocale() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:59 | Enumeration | jakarta.servlet.ServletRequestWrapper.getLocales
| The default behavior of this method is to return getLocales() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:60 | boolean | jakarta.servlet.ServletRequestWrapper.isSecure
| The default behavior of this method is to return isSecure() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:61 | RequestDispatcher | jakarta.servlet.ServletRequestWrapper.getRequestDispatcher
(
String
)
| The default behavior of this method is to return getRequestDispatcher(String path) on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:62 | String | jakarta.servlet.ServletRequestWrapper.getRealPath
(
String
)
| The default behavior of this method is to return getRealPath(String path) on the wrapped request object.
| true | true | true |
| Servlet:JAVADOC:63 | ServletRequestEvent | jakarta.servlet.ServletRequestEvent.ServletRequestEvent
(
ServletContext
,
ServletRequest
)
| Construct a ServletRequestEvent from the given context.
| true |
| true |
| Servlet:JAVADOC:64 | ServletRequest | jakarta.servlet.ServletRequestEvent.getServletRequest
| Return the ServletRequest that changed.
| true |
| true |
| Servlet:JAVADOC:65 | ServletContext | jakarta.servlet.ServletRequestEvent.getServletContext
| Return the ServletContext that changed.
| true |
| true |
| Servlet:JAVADOC:66 | ServletRequestAttributeEvent | jakarta.servlet.ServletRequestAttributeEvent.ServletRequestAttributeEvent
(
ServletContext
,
ServletRequest
,
String
,
Object
)
| Construct a ServletRequestAttributeEvent from the given context for the given attribute name and attribute value.
| true |
| true |
| Servlet:JAVADOC:67 | String | jakarta.servlet.ServletRequestAttributeEvent.getName
| Return the name of the attribute that changed on the ServletRequest. | true |
| true |
| Servlet:JAVADOC:68 | Object | jakarta.servlet.ServletRequestAttributeEvent.getValue
| Returns the value of the attribute that has been added removed or replaced.
If the attribute was added, this is the value of the attribute. | true |
| true |
| Servlet:JAVADOC:69 | Object | jakarta.servlet.ServletRequestAttributeEvent.getValue
| Returns the value of the attribute that has been added removed or replaced.
If the attribute was removed, this is the value of the removed attribute. | true |
| true |
| Servlet:JAVADOC:70 | Object | jakarta.servlet.ServletRequestAttributeEvent.getValue
| Returns the value of the attribute that has been added removed or replaced.
If the attribute was replaced, this is the old value of the attribute. | true |
| true |
| Servlet:JAVADOC:71 | ServletRequest | jakarta.servlet.ServletRequestAttributeEvent.{jakarta.servlet.ServletRequestEvent}.getServletRequest
| Return the ServletRequest that changed. | true |
| true |
| Servlet:JAVADOC:72 | ServletContext | jakarta.servlet.ServletRequestAttributeEvent.{jakarta.servlet.ServletRequestEvent}.getServletContext
| Return the ServletContext that changed. | true |
| true |
| Servlet:JAVADOC:73 | void | jakarta.servlet.ServletOutputStream.print
(
String
)
| Writes a String to the client, without a carriage return-line feed (CRLF) character at the end.
| true |
| true |
| Servlet:JAVADOC:74 | void | jakarta.servlet.ServletOutputStream.print
(
String
)
throws
IOException
| if an input or output exception occurred | true |
| false |
| Servlet:JAVADOC:75 | void | jakarta.servlet.ServletOutputStream.print
(
boolean
)
| Writes a boolean value to the client, with no carriage return-line feed (CRLF) character at the end.
| true |
| true |
| Servlet:JAVADOC:76 | void | jakarta.servlet.ServletOutputStream.print
(
boolean
)
throws
IOException
| if an input or output exception occurred | true |
| false |
| Servlet:JAVADOC:77 | void | jakarta.servlet.ServletOutputStream.print
(
char
)
| Writes a character to the client, with no carriage return-line feed (CRLF) at the end.
| true |
| true |
| Servlet:JAVADOC:78 | void | jakarta.servlet.ServletOutputStream.print
(
char
)
throws
IOException
| if an input or output exception occurred | true |
| false |
| Servlet:JAVADOC:79 | void | jakarta.servlet.ServletOutputStream.print
(
int
)
| Writes an int to the client, with no carriage return-line feed (CRLF) at the end.
| true |
| true |
| Servlet:JAVADOC:80 | void | jakarta.servlet.ServletOutputStream.print
(
int
)
throws
IOException
| if an input or output exception occurred | true |
| false |
| Servlet:JAVADOC:81 | void | jakarta.servlet.ServletOutputStream.print
(
long
)
| Writes a long value to the client, with no carriage return-line feed (CRLF) at the end.
| true |
| true |
| Servlet:JAVADOC:82 | void | jakarta.servlet.ServletOutputStream.print
(
long
)
throws
IOException
| if an input or output exception occurred | true |
| false |
| Servlet:JAVADOC:83 | void | jakarta.servlet.ServletOutputStream.print
(
float
)
| Writes a float value to the client, with no carriage return-line feed (CRLF) at the end.
| true |
| true |
| Servlet:JAVADOC:84 | void | jakarta.servlet.ServletOutputStream.print
(
float
)
throws
IOException
| if an input or output exception occurred | true |
| false |
| Servlet:JAVADOC:85 | void | jakarta.servlet.ServletOutputStream.print
(
double
)
| Writes a double value to the client, with no carriage return-line feed (CRLF) at the end.
| true |
| true |
| Servlet:JAVADOC:86 | void | jakarta.servlet.ServletOutputStream.print
(
double
)
throws
IOException
| if an input or output exception occurred | true |
| false |
| Servlet:JAVADOC:87 | void | jakarta.servlet.ServletOutputStream.println
| Writes a carriage return-line feed (CRLF) to the client.
| true |
| true |
| Servlet:JAVADOC:88 | void | jakarta.servlet.ServletOutputStream.println
throws
IOException
| if an input or output exception occurred | true |
| false |
| Servlet:JAVADOC:89 | void | jakarta.servlet.ServletOutputStream.println
(
String
)
| Writes a String to the client, followed by a carriage return-line feed (CRLF).
| true |
| true |
| Servlet:JAVADOC:90 | void | jakarta.servlet.ServletOutputStream.println
(
String
)
throws
IOException
| if an input or output exception occurred | true |
| false |
| Servlet:JAVADOC:91 | void | jakarta.servlet.ServletOutputStream.println
(
boolean
)
| Writes a boolean value to the client, followed by a carriage return-line feed (CRLF).
| true |
| true |
| Servlet:JAVADOC:92 | void | jakarta.servlet.ServletOutputStream.println
(
boolean
)
throws
IOException
| if an input or output exception occurred | true |
| false |
| Servlet:JAVADOC:93 | void | jakarta.servlet.ServletOutputStream.println
(
char
)
| Writes a character to the client, followed by a carriage return-line feed (CRLF).
| true |
| true |
| Servlet:JAVADOC:94 | void | jakarta.servlet.ServletOutputStream.println
(
char
)
throws
IOException
| if an input or output exception occurred | true |
| false |
| Servlet:JAVADOC:95 | void | jakarta.servlet.ServletOutputStream.println
(
int
)
| Writes an int to the client, followed by a carriage return-line feed (CRLF) character.
| true |
| true |
| Servlet:JAVADOC:96 | void | jakarta.servlet.ServletOutputStream.println
(
int
)
throws
IOException
| if an input or output exception occurred | true |
| false |
| Servlet:JAVADOC:97 | void | jakarta.servlet.ServletOutputStream.println
(
long
)
| Writes a long value to the client, followed by a carriage return-line feed (CRLF).
| true |
| true |
| Servlet:JAVADOC:98 | void | jakarta.servlet.ServletOutputStream.println
(
long
)
throws
IOException
| if an input or output exception occurred | true |
| false |
| Servlet:JAVADOC:99 | void | jakarta.servlet.ServletOutputStream.println
(
float
)
| Writes a float value to the client, followed by a carriage return-line feed (CRLF).
| true |
| true |
| Servlet:JAVADOC:100 | void | jakarta.servlet.ServletOutputStream.println
(
float
)
throws
IOException
| if an input or output exception occurred | true |
| false |
| Servlet:JAVADOC:101 | void | jakarta.servlet.ServletOutputStream.println
(
double
)
| Writes a double value to the client, followed by a carriage return-line feed (CRLF).
| true |
| true |
| Servlet:JAVADOC:102 | void | jakarta.servlet.ServletOutputStream.println
(
double
)
throws
IOException
| if an input or output exception occurred | true |
| false |
| Servlet:JAVADOC:103 | int | jakarta.servlet.ServletInputStream.readLine
(
byte[]
,
int
,
int
)
| Reads the input stream, one line at a time. Starting at an offset, reads bytes into an array, until it reads a certain number of bytes or reaches a newline character, which it reads into the array as well.
| true |
| true |
| Servlet:JAVADOC:104 | int | jakarta.servlet.ServletInputStream.readLine
(
byte[]
,
int
,
int
)
throws
IOException
| if an input or output exception has occurred | true |
| false |
| Servlet:JAVADOC:105 | ServletException | jakarta.servlet.ServletException.ServletException
| Constructs a new servlet exception.
| true |
| true |
| Servlet:JAVADOC:106 | ServletException | jakarta.servlet.ServletException.ServletException
(
String
)
| Constructs a new servlet exception with the specified message.
| true |
| true |
| Servlet:JAVADOC:107 | ServletException | jakarta.servlet.ServletException.ServletException
(
String
,
Throwable
)
| Constructs a new servlet exception when the servlet needs to throw an exception and include a message about the "root cause" exception that interfered with its normal operation, including a description message.
| true |
| true |
| Servlet:JAVADOC:108 | ServletException | jakarta.servlet.ServletException.ServletException
(
Throwable
)
| Constructs a new servlet exception when the servlet needs to throw an exception and include a message about the "root cause" exception that interfered with its normal operation.
The exception's message is based on the localized message of the underlying exception. This method calls the getLocalizedMessage method on the Throwable exception to get a localized exception message. When subclassing ServletException, this method can be overridden to create an exception message designed for a specific locale.
| true |
| true |
| Servlet:JAVADOC:109 | Throwable | jakarta.servlet.ServletException.getRootCause
| Returns the exception that caused this servlet exception.
| true |
| true |
| Servlet:JAVADOC:110 | ServletContextEvent | jakarta.servlet.ServletContextEvent.ServletContextEvent
(
ServletContext
)
| Construct a ServletContextEvent from the given context.
| true |
| true |
| Servlet:JAVADOC:111 | ServletContext | jakarta.servlet.ServletContextEvent.getServletContext
| Return the ServletContext that changed.
| true |
| true |
| Servlet:JAVADOC:112 | ServletContextAttributeEvent | jakarta.servlet.ServletContextAttributeEvent.ServletContextAttributeEvent
(
ServletContext
,
String
,
Object
)
| Construct a ServletContextAttributeEvent from the given context for the given attribute name and attribute value.
| true |
| true |
| Servlet:JAVADOC:113 | String | jakarta.servlet.ServletContextAttributeEvent.getName
| Return the name of the attribute that changed on the ServletContext.
| true |
| true |
| Servlet:JAVADOC:114 | Object | jakarta.servlet.ServletContextAttributeEvent.getValue
| Returns the value of the attribute that has been added removed or replaced.
If the attribute was added, this is the value of the attribute.
| true |
| true |
| Servlet:JAVADOC:115 | Object | jakarta.servlet.ServletContextAttributeEvent.getValue
| Returns the value of the attribute that has been added removed or replaced.
If the attrubute was removed, this is the value of the removed attribute.
| true |
| true |
| Servlet:JAVADOC:116 | Object | jakarta.servlet.ServletContextAttributeEvent.getValue
| Returns the value of the attribute that has been added removed or replaced.
If the attribute was replaced, this is the old value of the attribute.
| true |
| true |
| Servlet:JAVADOC:117 | ServletContext | jakarta.servlet.ServletContextAttributeEvent.{jakarta.servlet.ServletContextEvent}.getServletContext
| Return the ServletContext that changed. | true |
| true |
| Servlet:JAVADOC:118 | GenericServlet | jakarta.servlet.GenericServlet.GenericServlet
| Does nothing.
All of the servlet initialization is done by one of the init methods.
| true |
| false |
| Servlet:JAVADOC:119 | void | jakarta.servlet.GenericServlet.destroy
| Called by the servlet container to indicate to a servlet that the servlet is being taken out of service.
| true |
| true |
| Servlet:JAVADOC:120 | String | jakarta.servlet.GenericServlet.getInitParameter
(
String
)
| Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.
This method is supplied for convenience. It gets the value of the named parameter from the servlet's ServletConfig object.
| true |
| true |
| Servlet:JAVADOC:121 | String | jakarta.servlet.GenericServlet.getInitParameter
(
String
)
| Returns null if the parameter does not exist.
This method is supplied for convenience. It gets the value of the named parameter from the servlet's ServletConfig object.
| true |
| false |
| Servlet:JAVADOC:122 | Enumeration | jakarta.servlet.GenericServlet.getInitParameterNames
| Returns the names of the servlet's initialization parameters as an Enumeration of String objects, or an empty Enumeration if the servlet has no initialization parameters.
This method is supplied for convenience. It gets the parameter names from the servlet's ServletConfig object.
| true |
| true |
| Servlet:JAVADOC:123 | Enumeration | jakarta.servlet.GenericServlet.getInitParameterNames
| Returns an empty Enumeration if the servlet has no initialization parameters.
This method is supplied for convenience. It gets the parameter names from the servlet's ServletConfig object.
| true |
| false |
| Servlet:JAVADOC:124 | ServletConfig | jakarta.servlet.GenericServlet.getServletConfig
|
Returns this servlet's object.
| true |
| true |
| Servlet:JAVADOC:125 | ServletContext | jakarta.servlet.GenericServlet.getServletContext
|
Returns a reference to the context in which this servlet is running.
This method is supplied for convenience. It gets the servlet context from the servlet's ServletConfig object.
| true |
| true |
| Servlet:JAVADOC:126 | String | jakarta.servlet.GenericServlet.getServletInfo
| Returns information about the servlet, such as author, version, and copyright.
By default, this method returns an empty string. Override this method to have it return a meaningful value.
| true |
| true |
| Servlet:JAVADOC:127 | void | jakarta.servlet.GenericServlet.init
(
ServletConfig
)
| Called by the servlet container to indicate to a servlet that the servlet is being placed into service.
This implementation stores the object it receives from the servlet container for later use. When overriding this form of the method, call super.init(config).
| true |
| true |
| Servlet:JAVADOC:128 | void | jakarta.servlet.GenericServlet.init
(
ServletConfig
)
throws
ServletException
| if an exception occurs that interrupts the servlet's normal operation | true |
| true |
| Servlet:JAVADOC:129 | void | jakarta.servlet.GenericServlet.init
| A convenience method which can be overridden so that there's no need to call super.init(config).
Instead of overriding #init(ServletConfig), simply override this method and it will be called by GenericServlet.init(ServletConfig config). The ServletConfig object can still be retrieved via .
| true |
| true |
| Servlet:JAVADOC:130 | void | jakarta.servlet.GenericServlet.init
throws
ServletException
| if an exception occurs that interrupts the servlet's normal operation | true |
| true |
| Servlet:JAVADOC:131 | void | jakarta.servlet.GenericServlet.log
(
String
)
| Writes the specified message to a servlet log file, prepended by the servlet's name.
| true |
| false |
| Servlet:JAVADOC:132 | void | jakarta.servlet.GenericServlet.log
(
String
,
Throwable
)
| Writes an explanatory message and a stack trace for a given Throwable exception to the servlet log file, prepended by the servlet's name.
| true |
| false |
| Servlet:JAVADOC:133 | void | jakarta.servlet.GenericServlet.service
(
ServletRequest
,
ServletResponse
)
| Called by the servlet container to allow the servlet to respond to a request.
This method is declared abstract so subclasses, such as HttpServlet, must override it.
| true |
| true |
| Servlet:JAVADOC:134 | void | jakarta.servlet.GenericServlet.service
(
ServletRequest
,
ServletResponse
)
throws
ServletException
| if an exception occurs that interferes with the servlet's normal operation occurred | true |
| false |
| Servlet:JAVADOC:135 | void | jakarta.servlet.GenericServlet.service
(
ServletRequest
,
ServletResponse
)
throws
IOException
| if an input or output exception occurs | true |
| false |
| Servlet:JAVADOC:136 | String | jakarta.servlet.GenericServlet.getServletName
| Returns the name of this servlet instance.
| true |
| true |
| Servlet:JAVADOC:137 | String | jakarta.servlet.ServletResponse.getCharacterEncoding
| Returns the name of the charset used for the MIME body sent in this response.
See RFC 2047 (http://ds.internic.net/rfc/rfc2045.txt) for more information about character encoding and MIME.
| true |
| true |
| Servlet:JAVADOC:138 | String | jakarta.servlet.ServletResponse.getCharacterEncoding
| Returns the name of the charset used for the MIME body sent in this response.
If no charset has been assigned, it is implicitly set to ISO-8859-1 (Latin-1). See RFC 2047 (http://ds.internic.net/rfc/rfc2045.txt) for more information about character encoding and MIME.
| true |
| true |
| Servlet:JAVADOC:139 | void | jakarta.servlet.ServletResponse.setCharacterEncoding
(
String
)
| Overrides the name of the character encoding used in the body of the request.
| true |
| true |
| Servlet:JAVADOC:140 | ServletOutputStream | jakarta.servlet.ServletResponse.getOutputStream
|
Returns a ServletOutputStream suitable output steam for writing binary data in the response.
Calling flush() on the ServletOutputStream commits the response.
| true |
| true |
| Servlet:JAVADOC:141 | ServletOutputStream | jakarta.servlet.ServletResponse.getOutputStream
|
Returns a ServletOutputStream suitable output steam for writing binary data in the response.
The servlet container does not encode the binary data.
| true |
| true |
| Servlet:JAVADOC:142 | ServletOutputStream | jakarta.servlet.ServletResponse.getOutputStream
throws
IOException
| if an input or output exception occurred | true |
| false |
| Servlet:JAVADOC:143 | ServletOutputStream | jakarta.servlet.ServletResponse.getOutputStream
throws
IllegalStateException
| if the getWriter method has been called on this response | true |
| true |
| Servlet:JAVADOC:144 | PrintWriter | jakarta.servlet.ServletResponse.getWriter
| Returns a PrintWriter object that can send character text to the client.
The character encoding used is the one specified in the charset= property of the setContentType(String) method.
| true |
| true |
| Servlet:JAVADOC:145 | PrintWriter | jakarta.servlet.ServletResponse.getWriter
| Returns a PrintWriter object that can send character text to the client.
getWriter()must be called before calling the setContentType(String) methodfor the charset to take effect.
| true |
| true |
| Servlet:JAVADOC:146 | PrintWriter | jakarta.servlet.ServletResponse.getWriter
| Returns a PrintWriter object that can send character text to the client.
Calling flush() on the PrintWriter commits the response.
| true |
| true |
| Servlet:JAVADOC:147 | PrintWriter | jakarta.servlet.ServletResponse.getWriter
throws
IOException
| if an input or output exception occurred | true |
| false |
| Servlet:JAVADOC:148 | PrintWriter | jakarta.servlet.ServletResponse.getWriter
throws
UnsupportedEncodingException
| if the character encoding returned by getCharacterEncoding cannot be used | true |
| false |
| Servlet:JAVADOC:149 | PrintWriter | jakarta.servlet.ServletResponse.getWriter
throws
IllegalStateException
| if the getOutputStream method has already been called for this response object | true |
| true |
| Servlet:JAVADOC:150 | void | jakarta.servlet.ServletResponse.setContentLength
(
int
)
| Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.
| true |
| true |
| Servlet:JAVADOC:151 | void | jakarta.servlet.ServletResponse.setContentType
(
String
)
| Sets the content type of the response being sent to the client, if the response has not been committed yet. The given content type may include a character encoding specification, for example, text/html;charset=UTF-8. The response s character encoding is only set from the given content type if this method is called before getWriter is called.
| true |
| true |
| Servlet:JAVADOC:151.1 | void | jakarta.servlet.ServletResponse.setContentType
(
String
)
| This method may be called repeatedly to change content type and character encoding.
| true |
| true |
| Servlet:JAVADOC:151.2 | void | jakarta.servlet.ServletResponse.setContentType
(
String
)
| This method has no effect if called after the response has been committed. It does not set the response s character encoding if it is called after getWriter has been called or after the response has been committed.
| true |
| true |
| Servlet:JAVADOC:151.3 | void | jakarta.servlet.ServletResponse.setContentType
(
String
)
| Containers must communicate the content type and the character encoding used for the servlet response's writer to the client if the protocol provides a way for doing so. In the case of HTTP, the Content-Type header is used.
| true |
| true |
| Servlet:JAVADOC:152 | String | jakarta.servlet.ServletResponse.getContentType
| Returns the content type used for the MIME body sent in this response. The content type proper must have been specified using setContentType(java.lang.String) before the response is committed.
| true |
| true |
| Servlet:JAVADOC:153 | String | jakarta.servlet.ServletResponse.getContentType
| If no content type has been specified, this method returns null.
| true |
| true |
| Servlet:JAVADOC:153.1 | String | jakarta.servlet.ServletResponse.getContentType
| If a content type has been specified, and a character encoding has been explicitly or implicitly specified as described in getCharacterEncoding() or getWriter() has been called, the charset parameter is included in the string returned. If no character encoding has been specified, the charset parameter is omitted.
| true |
| true |
| Servlet:JAVADOC:154 | void | jakarta.servlet.ServletResponse.setBufferSize
(
int
)
| Sets the preferred buffer size for the body of the response.
The servlet container will use a buffer at least as large as the size requested.
| true |
| true |
| Servlet:JAVADOC:155 | void | jakarta.servlet.ServletResponse.setBufferSize
(
int
)
throws
IllegalStateException
| If this method is called after content has been written | true |
| true |
| Servlet:JAVADOC:156 | int | jakarta.servlet.ServletResponse.getBufferSize
| Returns the actual buffer size used for the response.
| true |
| true |
| Servlet:JAVADOC:157 | int | jakarta.servlet.ServletResponse.getBufferSize
|
If no buffering is used, this method returns 0.
| true |
| true |
| Servlet:JAVADOC:158 | void | jakarta.servlet.ServletResponse.flushBuffer
| Forces any content in the buffer to be written to the client.
A call to this method automatically commits the response, meaning the status code and headers will be written.
| true |
| true |
| Servlet:JAVADOC:159 | void | jakarta.servlet.ServletResponse.flushBuffer
throws
IOException
|
| true |
| false |
| Servlet:JAVADOC:160 | void | jakarta.servlet.ServletResponse.resetBuffer
| Clears the content of the underlying buffer in the response without clearing headers or status code. | true |
| true |
| Servlet:JAVADOC:161 | boolean | jakarta.servlet.ServletResponse.isCommitted
| Returns a boolean indicating if the response has been committed. | true |
| true |
| Servlet:JAVADOC:162 | void | jakarta.servlet.ServletResponse.reset
| Clears any data that exists in the buffer as well as the status code and headers. | true |
| true |
| Servlet:JAVADOC:163 | void | jakarta.servlet.ServletResponse.reset
throws
IllegalStateException
| if the response has already been committed | true |
| true |
| Servlet:JAVADOC:164 | void | jakarta.servlet.ServletResponse.setLocale
(
Locale
)
| Sets the locale of the response, if the response has not been
committed yet.
| true |
| true |
| Servlet:JAVADOC:164.1 | void | jakarta.servlet.ServletResponse.setLocale
(
Locale
)
| It also sets the response's character encoding
appropriately for the locale, if the character encoding has not
been explicitly set using setContentType
| true |
| true |
| Servlet:JAVADOC:164.2 | void | jakarta.servlet.ServletResponse.setLocale
(
Locale
)
| It also sets the response's character encoding
appropriately for the locale, if the character encoding has not
been explicitly set using
setCharacterEncoding,
| true |
| true |
| Servlet:JAVADOC:164.3 | void | jakarta.servlet.ServletResponse.setLocale
(
Locale
)
| It also sets the response's character encoding
appropriately for the locale, if the character encoding has not
been explicitly set using setContentType or
setCharacterEncoding, getWriter hasn't
been called yet
| true |
| true |
| Servlet:JAVADOC:164.4 | void | jakarta.servlet.ServletResponse.setLocale
(
Locale
)
| It also sets the response's character encoding
appropriately for the locale, if the character encoding has not
been explicitly set using setContentType or
setCharacterEncoding,
and the response hasn't been committed yet.
| true |
| true |
| Servlet:JAVADOC:164.5 | void | jakarta.servlet.ServletResponse.setLocale
(
Locale
)
| If the deployment descriptor contains a
locale-encoding-mapping-list element, and that
element provides a mapping for the given locale, that mapping
is used.
| true |
| true |
| Servlet:JAVADOC:164.6 | void | jakarta.servlet.ServletResponse.setLocale
(
Locale
)
| Otherwise, the mapping from locale to character
encoding is container dependent.
| true |
| true |
| Servlet:JAVADOC:164.7 | void | jakarta.servlet.ServletResponse.setLocale
(
Locale
)
| This method may be called repeatedly to change locale and
character encoding.
| true |
| true |
| Servlet:JAVADOC:164.8 | void | jakarta.servlet.ServletResponse.setLocale
(
Locale
)
| The method has no effect if called after the
response has been committed.
| true |
| true |
| Servlet:JAVADOC:164.9 | void | jakarta.servlet.ServletResponse.setLocale
(
Locale
)
| It does not set the response's
character encoding if it is called after setContentType
has been called with a charset specification, | true |
| true |
| Servlet:JAVADOC:164.10 | void | jakarta.servlet.ServletResponse.setLocale
(
Locale
)
| It does not set the response's
character encoding if it is called after
setCharacterEncoding has been called
| true |
| true |
| Servlet:JAVADOC:164.11 | void | jakarta.servlet.ServletResponse.setLocale
(
Locale
)
| It does not set the response's
character encoding if it is called after
getWriter has been called,
| true |
| true |
| Servlet:JAVADOC:164.12 | void | jakarta.servlet.ServletResponse.setLocale
(
Locale
)
| It does not set the response's
character encoding if it is called after
the response has been committed.
| true |
| true |
| Servlet:JAVADOC:165 | void | jakarta.servlet.ServletResponse.setLocale
(
Locale
)
| Containers must communicate the locale and the character encoding
used for the servlet response's writer to the client if the protocol
provides a way for doing so. In the case of HTTP, the locale is
communicated via the Content-Language header,
the character encoding as part of the Content-Type
header for text media types. Note that the character encoding
cannot be communicated via HTTP headers if the servlet does not
specify a content type; however, it is still used to encode text
written via the servlet response's writer.Sets the locale of the response,
setting the headers (including the Content-Type's charset) as appropriate.
| true |
| true |
| Servlet:JAVADOC:166 | Locale | jakarta.servlet.ServletResponse.getLocale
| Returns the locale specified for this response
using the setLocale method.
If no locale has been specified,
the container's default locale is returned.
| true |
| true |
| Servlet:JAVADOC:167 | void | jakarta.servlet.ServletRequestListener.requestDestroyed
(
ServletRequestEvent
)
| Notification that the servlet request is about to go out of scope.
| true |
| true |
| Servlet:JAVADOC:168 | void | jakarta.servlet.ServletRequestListener.requestInitialized
(
ServletRequestEvent
)
| Notification that the servlet request is about to go into scope.
| true |
| true |
| Servlet:JAVADOC:169 | void | jakarta.servlet.ServletRequestAttributeListener.attributeAdded
(
ServletRequestAttributeEvent
)
| Notification that a new attribute was added to the servlet request.
Called after the attribute is added.
| true |
| true |
| Servlet:JAVADOC:170 | void | jakarta.servlet.ServletRequestAttributeListener.attributeRemoved
(
ServletRequestAttributeEvent
)
| Notification that an existing attribute has been removed from the servlet request.
Called after the attribute is removed.
| true |
| true |
| Servlet:JAVADOC:171 | void | jakarta.servlet.ServletRequestAttributeListener.attributeReplaced
(
ServletRequestAttributeEvent
)
| Notification that an attribute on the servlet request has been replaced.
Called after the attribute is replaced.
| true |
| true |
| Servlet:JAVADOC:172 | Object | jakarta.servlet.ServletRequest.getAttribute
(
String
)
| Returns the value of the named attribute as an Object.
| true |
| true |
| Servlet:JAVADOC:173 | Object | jakarta.servlet.ServletRequest.getAttribute
(
String
)
| Returns null if no attribute of the given name exists.
| true |
| true |
| Servlet:JAVADOC:174 | Enumeration | jakarta.servlet.ServletRequest.getAttributeNames
| Returns an Enumeration containing the names of the attributes available to this request.
| true |
| true |
| Servlet:JAVADOC:175 | Enumeration | jakarta.servlet.ServletRequest.getAttributeNames
| Returns an empty Enumeration if the request has no attributes available to it.
| true |
| true |
| Servlet:JAVADOC:176 | String | jakarta.servlet.ServletRequest.getCharacterEncoding
| Returns the name of the character encoding used in the body of this request.
| true |
| true |
| Servlet:JAVADOC:177 | String | jakarta.servlet.ServletRequest.getCharacterEncoding
| Returns null if the request does not specify a character encoding
| true |
| true |
| Servlet:JAVADOC:178 | void | jakarta.servlet.ServletRequest.setCharacterEncoding
(
String
)
| Overrides the name of the character encoding used in the body of this
request. This method must be called prior to reading request parameters or
reading input using getReader(). Otherwise, it has no effect.
| true |
| true |
| Servlet:JAVADOC:179 | void | jakarta.servlet.ServletRequest.setCharacterEncoding
(
String
)
throws
UnsupportedEncodingException
| if this ServletRequest is still in a state where a character encoding may be set, but the specified encoding is invalid | true |
| true |
| Servlet:JAVADOC:180 | int | jakarta.servlet.ServletRequest.getContentLength
| Returns the length, in bytes, of the request body and made available by the input stream.
For HTTP servlets, same as the value of the CGI variable CONTENT_LENGTH.
| true |
| true |
| Servlet:JAVADOC:181 | int | jakarta.servlet.ServletRequest.getContentLength
| Returns -1 if the length is not known.
For HTTP servlets, same as the value of the CGI variable CONTENT_LENGTH.
| true |
| false |
| Servlet:JAVADOC:182 | String | jakarta.servlet.ServletRequest.getContentType
| Returns the MIME type of the body of the request.
For HTTP servlets, same as the value of the CGI variable CONTENT_TYPE.
| true |
| true |
| Servlet:JAVADOC:183 | String | jakarta.servlet.ServletRequest.getContentType
| Returns null if the MIME type is not known.
For HTTP servlets, same as the value of the CGI variable CONTENT_TYPE.
| true |
| true |
| Servlet:JAVADOC:184 | ServletInputStream | jakarta.servlet.ServletRequest.getInputStream
|
Retrieves the body of the request as binary data using a ServletInputStream.
| true |
| true |
| Servlet:JAVADOC:185 | ServletInputStream | jakarta.servlet.ServletRequest.getInputStream
throws
IOException
| if an input or output exception occurred | true |
| false |
| Servlet:JAVADOC:186 | ServletInputStream | jakarta.servlet.ServletRequest.getInputStream
throws
IllegalStateException
| if the getReader() method has already been called for this request | true |
| true |
| Servlet:JAVADOC:187 | String | jakarta.servlet.ServletRequest.getParameter
(
String
)
| Returns the value of a request parameter as a String.
Request parameters are extra information sent with the request. For HTTP servlets, parameters are contained in the query string or posted form data. You should only use this method when you are sure the parameter has only one value. If the parameter might have more than one value, use . If you use this method with a multivalued parameter, the value returned is equal to the first value in the array returned by getParameterValues. If the parameter data was sent in the request body, such as occurs with an HTTP POST request, then reading the body directly via or can interfere with the execution of this method.
| true |
| true |
| Servlet:JAVADOC:188 | String | jakarta.servlet.ServletRequest.getParameter
(
String
)
| Returns null if the parameter does not exist.
| true |
| true |
| Servlet:JAVADOC:189 | Enumeration | jakarta.servlet.ServletRequest.getParameterNames
| Returns an Enumeration of String objects containing the names of the parameters contained in this request.
| true |
| true |
| Servlet:JAVADOC:190 | Enumeration | jakarta.servlet.ServletRequest.getParameterNames
| If the request has no parameters, the method returns an empty Enumeration.
| true |
| true |
| Servlet:JAVADOC:191 | String[] | jakarta.servlet.ServletRequest.getParameterValues
(
String
)
| Returns an array of String objects containing all of the values the given request parameter has.
| true |
| true |
| Servlet:JAVADOC:192 | String[] | jakarta.servlet.ServletRequest.getParameterValues
(
String
)
| Returns null if the parameter does not exist.
| true |
| true |
| Servlet:JAVADOC:193 | Map | jakarta.servlet.ServletRequest.getParameterMap
| Returns a java.util.Map of the parameters of this request.
Request parameters are extra information sent with the request. For HTTP servlets, parameters are contained in the query string or posted form data.
| true |
| true |
| Servlet:JAVADOC:194 | String | jakarta.servlet.ServletRequest.getProtocol
| Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1.
For HTTP servlets, the value returned is the same as the value of the CGI variable SERVER_PROTOCOL.
| true |
| true |
| Servlet:JAVADOC:195 | String | jakarta.servlet.ServletRequest.getScheme
| Returns the name of the scheme used to make this request, for example, http, https, or ftp.
| true |
| true |
| Servlet:JAVADOC:196 | String | jakarta.servlet.ServletRequest.getServerName
| Returns the host name of the server that received the request.
For HTTP servlets, same as the value of the CGI variable SERVER_NAME.
| true |
| true |
| Servlet:JAVADOC:197 | int | jakarta.servlet.ServletRequest.getServerPort
| Returns the port number on which this request was received.
For HTTP servlets, same as the value of the CGI variable SERVER_PORT.
| true |
| true |
| Servlet:JAVADOC:198 | BufferedReader | jakarta.servlet.ServletRequest.getReader
| Retrieves the body of the request as character data using a BufferedReader.
| true |
| true |
| Servlet:JAVADOC:199 | BufferedReader | jakarta.servlet.ServletRequest.getReader
throws
IOException
| if an input or output exception occurred | true |
| false |
| Servlet:JAVADOC:200 | BufferedReader | jakarta.servlet.ServletRequest.getReader
throws
UnsupportedEncodingException
| if the character set encoding used is not supported and the text cannot be decoded | true |
| true |
| Servlet:JAVADOC:201 | BufferedReader | jakarta.servlet.ServletRequest.getReader
throws
IllegalStateException
| if getInputStream method has been called on this request | true |
| true |
| Servlet:JAVADOC:202 | String | jakarta.servlet.ServletRequest.getRemoteAddr
| Returns the Internet Protocol (IP) address of the client that sent the request.
For HTTP servlets, same as the value of the CGI variable REMOTE_ADDR.
| true |
| true |
| Servlet:JAVADOC:203 | String | jakarta.servlet.ServletRequest.getRemoteHost
| Returns the fully qualified name of the client that sent the request.
If the engine cannot or chooses not to resolve the hostname (to improve performance), this method returns the dotted-string form of the IP address. For HTTP servlets, same as the value of the CGI variable REMOTE_HOST.
| true |
| true |
| Servlet:JAVADOC:204 | void | jakarta.servlet.ServletRequest.setAttribute
(
String
,
Object
)
| Stores an attribute in this request.
Attributes are reset between requests. This method is most often used in conjunction with . Attribute names should follow the same conventions as package names. Names beginning with java.*, jakarta.*, and com.sun.*, are reserved for use by the Eclipse Foundation. If the value passed in is null, the effect is the same as calling .
| true |
| true |
| Servlet:JAVADOC:205 | void | jakarta.servlet.ServletRequest.removeAttribute
(
String
)
| Removes an attribute from this request.
This method is not generally needed as attributes only persist as long as the request is being handled. Attribute names should follow the same conventions as package names. Names beginning with java.*, jakarta.*, and com.sun.*, are reserved for use by the Eclipse Foundation.
| true |
| true |
| Servlet:JAVADOC:206 | Locale | jakarta.servlet.ServletRequest.getLocale
| Returns the preferred Locale that the client will accept content in, based on the Accept-Language header.
If the client request doesn't provide an Accept-Language header, this method returns the default locale for the server.
| true |
| true |
| Servlet:JAVADOC:207 | Locale | jakarta.servlet.ServletRequest.getLocale
| If the client request doesn't provide an Accept-Language header, this method returns the default locale for the server.
| true |
| true |
| Servlet:JAVADOC:208 | Enumeration | jakarta.servlet.ServletRequest.getLocales
| Returns an Enumeration of Locale objects indicating, in decreasing order starting with the preferred locale, the locales that are acceptable to the client based on the Accept-Language header.
| true |
| true |
| Servlet:JAVADOC:209 | Enumeration | jakarta.servlet.ServletRequest.getLocales
|
If the client request doesn't provide an Accept-Language header, this method returns an Enumeration containing one Locale, the default locale for the server.
| true |
| true |
| Servlet:JAVADOC:210 | boolean | jakarta.servlet.ServletRequest.isSecure
| Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
| true |
| true |
| Servlet:JAVADOC:211 | RequestDispatcher | jakarta.servlet.ServletRequest.getRequestDispatcher
(
String
)
|
Returns a object that acts as a wrapper for the resource located at the given path.
A RequestDispatcher object can be used to forward a request to the resource or to include the resource in a response. The resource can be dynamic or static. The pathname specified may be relative, although it cannot extend outside the current servlet context. If the path begins with a "/" it is interpreted as relative to the current context root.
| true |
| true |
| Servlet:JAVADOC:212 | RequestDispatcher | jakarta.servlet.ServletRequest.getRequestDispatcher
(
String
)
|
This method returns null if the servlet container cannot return a RequestDispatcher.
| true |
| false |
| Servlet:JAVADOC:213 | String | jakarta.servlet.ServletRequest.getRealPath
(
String
)
|
| true | true | true |
| Servlet:JAVADOC:214 | void | jakarta.servlet.ServletContextListener.contextInitialized
(
ServletContextEvent
)
| Notification that the web application is ready to process requests.
| true |
| true |
| Servlet:JAVADOC:215 | void | jakarta.servlet.ServletContextListener.contextDestroyed
(
ServletContextEvent
)
| Notification that the servlet context is about to be shut down.
| true |
| false |
| Servlet:JAVADOC:216 | void | jakarta.servlet.ServletContextAttributeListener.attributeAdded
(
ServletContextAttributeEvent
)
| Notification that a new attribute was added to the servlet context.
Called after the attribute is added.
| true |
| true |
| Servlet:JAVADOC:217 | void | jakarta.servlet.ServletContextAttributeListener.attributeRemoved
(
ServletContextAttributeEvent
)
| Notification that an existing attribute has been remved from the servlet context.
Called after the attribute is removed.
| true |
| true |
| Servlet:JAVADOC:218 | void | jakarta.servlet.ServletContextAttributeListener.attributeReplaced
(
ServletContextAttributeEvent
)
| Notification that an attribute on the servlet context has been replaced.
Called after the attribute is replaced.
| true |
| true |
| Servlet:JAVADOC:219 | ServletContext | jakarta.servlet.ServletContext.getContext
(
String
)
| Returns a ServletContext object that corresponds to a specified URL on the server. | true |
| true |
| Servlet:JAVADOC:219.1 | ServletContext | jakarta.servlet.ServletContext.getContext
(
String
)
| This method allows servlets to gain access to the context for various parts of the server, and as needed obtain RequestDispatcher objects from the context. The given path must be begin with "/", is interpreted relative to the server's document root and is matched against the context roots of other web applications hosted on this container. | true |
| true |
| Servlet:JAVADOC:219.2 | ServletContext | jakarta.servlet.ServletContext.getContext
(
String
)
| In a security conscious environment, the servlet container may return null for a given URL. | true |
| true |
| Servlet:JAVADOC:220 | int | jakarta.servlet.ServletContext.getMajorVersion
| Returns the major version of the Java Servlet API that this servlet container supports.
All implementations that comply with Version 3.0 must have this method return the integer 3.
| true |
| true |
| Servlet:JAVADOC:221 | int | jakarta.servlet.ServletContext.getMinorVersion
| Returns the minor version of the Servlet API that this servlet container supports.
All implementations that comply with Version 3.0 must have this method return the integer 0.
| true |
| true |
| Servlet:JAVADOC:222 | String | jakarta.servlet.ServletContext.getMimeType
(
String
)
| Returns the MIME type of the specified file, or null if the MIME type is not known.
The MIME type is determined by the configuration of the servlet container, and may be specified in a web application deployment descriptor. Common MIME types are "text/html" and "image/gif".
| true |
| true |
| Servlet:JAVADOC:223 | String | jakarta.servlet.ServletContext.getMimeType
(
String
)
| Returns null if the MIME type is not known.
The MIME type is determined by the configuration of the servlet container, and may be specified in a web application deployment descriptor. Common MIME types are "text/html" and "image/gif".
| true |
| true |
| Servlet:JAVADOC:224 | Set | jakarta.servlet.ServletContext.getResourcePaths
(
String
)
| Returns a directory-like listing of all the paths to resources within the web application whose longest sub-path matches the supplied path argument.
Paths indicating subdirectory paths end with a '/'. The returned paths are all relative to the root of the web application and have a leading '/'. For example, for a web application containing /welcome.html /catalog/index.html /catalog/products.html /catalog/offers/books.html /catalog/offers/music.html /customer/login.jsp /WEB-INF/web.xml /WEB-INF/classes/com.acme.OrderServlet.class, getResourcePaths("/") returns {"/welcome.html", "/catalog/", "/customer/", "/WEB-INF/"} getResourcePaths("/catalog/") returns {"/catalog/index.html", "/catalog/products.html", "/catalog/offers/"}.
| true |
| true |
| Servlet:JAVADOC:225 | URL | jakarta.servlet.ServletContext.getResource
(
String
)
|
This method returns null if no resource is mapped to the pathname.
| true |
| true |
| Servlet:JAVADOC:226 | URL | jakarta.servlet.ServletContext.getResource
(
String
)
| Returns a URL to the resource that is mapped to the given path.
The path must begin with a "/" and is interpreted as relative to the current context root. This method allows the servlet container to make a resource available to servlets from any source. Resources can be located on a local or remote file system, in a database, or in a .war file. The servlet container must implement the URL handlers and URLConnection objects that are necessary to access the resource.
| true |
| true |
| Servlet:JAVADOC:227 | URL | jakarta.servlet.ServletContext.getResource
(
String
)
throws
MalformedURLException
| if the pathname is not given in the correct form | true |
| true |
| Servlet:JAVADOC:228 | InputStream | jakarta.servlet.ServletContext.getResourceAsStream
(
String
)
| Returns the resource located at the named path as an InputStream object.
The data in the InputStream can be of any type or length. The path must be specified according to the rules given in getResource. Meta-information such as content length and content type that is available via getResource method is lost when using this method. The servlet container must implement the URL handlers and URLConnection objects necessary to access the resource.
| true |
| true |
| Servlet:JAVADOC:229 | InputStream | jakarta.servlet.ServletContext.getResourceAsStream
(
String
)
| This method returns null if no resource exists at the specified path.
| true |
| true |
| Servlet:JAVADOC:230 | RequestDispatcher | jakarta.servlet.ServletContext.getRequestDispatcher
(
String
)
| Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path.
A RequestDispatcher object can be used to forward a request to the resource or to include the resource in a response.
The resource can be dynamic or static. The pathname must begin with a / and is interpreted as relative to the current context root.
Use getContext to obtain a RequestDispatcher for resources in foreign contexts. | true |
| true |
| Servlet:JAVADOC:231 | RequestDispatcher | jakarta.servlet.ServletContext.getRequestDispatcher
(
String
)
|
This method returns null if the ServletContext cannot return a RequestDispatcher.
| true |
| false |
| Servlet:JAVADOC:232 | RequestDispatcher | jakarta.servlet.ServletContext.getNamedDispatcher
(
String
)
| Returns a RequestDispatcher object that acts as a wrapper for the named servlet. Servlets (and JSP pages also) may be given names via server administration or via a web application deployment descriptor. A servlet instance can determine its name using ServletConfig#getServletName. | true |
| true |
| Servlet:JAVADOC:233 | RequestDispatcher | jakarta.servlet.ServletContext.getNamedDispatcher
(
String
)
|
This method returns null if the ServletContext cannot return a RequestDispatcher for any reason.
| true |
| true |
| Servlet:JAVADOC:234 | Servlet | jakarta.servlet.ServletContext.getServlet
(
String
)
|
| true | true | true |
| Servlet:JAVADOC:235 | Servlet | jakarta.servlet.ServletContext.getServlet
(
String
)
throws
ServletException
|
| true | true | true |
| Servlet:JAVADOC:236 | Enumeration | jakarta.servlet.ServletContext.getServlets
|
| true | true | true |
| Servlet:JAVADOC:237 | Enumeration | jakarta.servlet.ServletContext.getServletNames
|
| true | true | true |
| Servlet:JAVADOC:954 | String | jakarta.servlet.ServletContext.getVirtualServerName
| Returns the configuration name of the logical host on which the ServletContext is deployed. Servlet containers may support multiple logical hosts. This method must return the same name for all the servlet contexts deployed on a logical host, and the name returned by this method must be distinct, stable per logical host, and suitable for use in associating server configuration information with the logical host. The returned value is NOT expected or required to be equivalent to a network address or hostname of the logical host. | true |
| true |
| Servlet:JAVADOC:238 | void | jakarta.servlet.ServletContext.log
(
String
)
| Writes the specified message to a servlet log file, usually an event log.
The name and type of the servlet log file is specific to the servlet container.
| true |
| false |
| Servlet:JAVADOC:239 | void | jakarta.servlet.ServletContext.log
(
Exception
,
String
)
|
| true | true | false |
| Servlet:JAVADOC:240 | void | jakarta.servlet.ServletContext.log
(
String
,
Throwable
)
| Writes an explanatory message and a stack trace for a given Throwable exception to the servlet log file.
The name and type of the servlet log file is specific to the servlet container, usually an event log.
| true |
| false |
| Servlet:JAVADOC:241 | String | jakarta.servlet.ServletContext.getRealPath
(
String
)
| Gets the real path corresponding to the given virtual path. For example, if path is equal to /index.html, this method will return the absolute file path on the server's filesystem to which a request of the form http://://index.html would be mapped, where corresponds to the context path of this ServletContext. The real path returned will be in a form appropriate to the computer and operating system on which the servlet container is running, including the proper path separators. Resources inside the /META-INF/resources directories of JAR files bundled in the application's /WEB-INF/lib directory must be considered only if the container has unpacked them from their containing JAR file, in which case the path to the unpacked location must be returned. This method returns null if the servlet container is unable to translate the given virtual path to a real path. | true |
| true |
| Servlet:JAVADOC:242 | String | jakarta.servlet.ServletContext.getServerInfo
| Returns the name and version of the servlet container on which the servlet is running.
The form of the returned string is servername/versionnumber. For example, the JavaServer Web Development Kit may return the string JavaServer Web Dev Kit/1.0. The servlet container may return other optional information after the primary string in parentheses, for example, JavaServer Web Dev Kit/1.0 (JDK 1.1.6; Windows NT 4.0 x86).
| true |
| true |
| Servlet:JAVADOC:243 | String | jakarta.servlet.ServletContext.getInitParameter
(
String
)
| Returns a String containing the value of the named context-wide initialization parameter.
| true |
| true |
| Servlet:JAVADOC:244 | String | jakarta.servlet.ServletContext.getInitParameter
(
String
)
| Returns null if the parameter does not exist.
| true |
| true |
| Servlet:JAVADOC:245 | Enumeration | jakarta.servlet.ServletContext.getInitParameterNames
| Returns the names of the context's initialization parameters as an Enumeration of String objects.
| true |
| true |
| Servlet:JAVADOC:246 | Enumeration | jakarta.servlet.ServletContext.getInitParameterNames
| Returns an empty Enumeration if the context has no initialization parameters.
| true |
| false |
| Servlet:JAVADOC:247 | Object | jakarta.servlet.ServletContext.getAttribute
(
String
)
| Returns the servlet container attribute with the given name. | true |
| true |
| Servlet:JAVADOC:248 | Object | jakarta.servlet.ServletContext.getAttribute
(
String
)
| Returns null if there is no attribute by that name. | true |
| true |
| Servlet:JAVADOC:249 | Enumeration | jakarta.servlet.ServletContext.getAttributeNames
| Returns an Enumeration containing the attribute names available within this ServletContext. Use the #getAttribute method with an attribute name to get the value of an attribute. | true |
| true |
| Servlet:JAVADOC:250 | void | jakarta.servlet.ServletContext.setAttribute
(
String
,
Object
)
| Binds an object to a given attribute name in this servlet context.
| true |
| true |
| Servlet:JAVADOC:251 | void | jakarta.servlet.ServletContext.setAttribute
(
String
,
Object
)
|
If the name specified is already used for an attribute, this method will replace the attribute with the new to the new attribute.
| true |
| true |
| Servlet:JAVADOC:252 | void | jakarta.servlet.ServletContext.setAttribute
(
String
,
Object
)
|
If listeners are configured on the ServletContext the container notifies them accordingly.
| true |
| true |
| Servlet:JAVADOC:253 | void | jakarta.servlet.ServletContext.setAttribute
(
String
,
Object
)
|
If a null value is passed, the effect is the same as calling removeAttribute().
| true |
| true |
| Servlet:JAVADOC:254 | void | jakarta.servlet.ServletContext.removeAttribute
(
String
)
| Removes the attribute with the given name from the servlet context.
After removal, subsequent calls to to retrieve the attribute's value will return null.
| true |
| true |
| Servlet:JAVADOC:255 | void | jakarta.servlet.ServletContext.removeAttribute
(
String
)
|
If listeners are configured on the ServletContext the container notifies them accordingly.
| true |
| true |
| Servlet:JAVADOC:256 | String | jakarta.servlet.ServletContext.getServletContextName
| Returns the name of this web application correponding to this ServletContext as specified in the deployment descriptor for this web application by the display-name element.
| true |
| true |
| Servlet:JAVADOC:257 | String | jakarta.servlet.ServletConfig.getServletName
| Returns the name of this servlet instance.
The name may be provided via server administration, assigned in the web application deployment descriptor, or for an unregistered (and thus unnamed) servlet instance it will be the servlet's class name.
| true |
| true |
| Servlet:JAVADOC:258 | ServletContext | jakarta.servlet.ServletConfig.getServletContext
|
Returns a reference to the ServletContext in which the caller is executing.
| true |
| true |
| Servlet:JAVADOC:259 | String | jakarta.servlet.ServletConfig.getInitParameter
(
String
)
| Returns a String containing the value of the named initialization parameter.
| true |
| true |
| Servlet:JAVADOC:260 | String | jakarta.servlet.ServletConfig.getInitParameter
(
String
)
| Returns null if the parameter does not exist.
| true |
| true |
| Servlet:JAVADOC:261 | Enumeration | jakarta.servlet.ServletConfig.getInitParameterNames
| Returns the names of the servlet's initialization parameters as an Enumeration of String objects.
| true |
| true |
| Servlet:JAVADOC:262 | Enumeration | jakarta.servlet.ServletConfig.getInitParameterNames
| Returns an empty Enumeration if the servlet has no initialization parameters.
| true |
| false |
| Servlet:JAVADOC:263 | void | jakarta.servlet.Servlet.init
(
ServletConfig
)
| Called by the servlet container to indicate to a servlet that the servlet is being placed into service.
The servlet container calls the init method exactly once after instantiating the servlet. The init method must complete successfully before the servlet can receive any requests.
| true |
| true |
| Servlet:JAVADOC:265 | void | jakarta.servlet.Servlet.init
(
ServletConfig
)
throws
ServletException
| Called by the servlet container to indicate to a servlet that the servlet is being placed into service.
The servlet container cannot place the servlet into service if the init method Throws a ServletException or does not return within a time period defined by the Web server.
if an exception has occurred that interferes with the servlet's normal operation | true |
| true |
| Servlet:JAVADOC:266 | ServletConfig | jakarta.servlet.Servlet.getServletConfig
|
Returns a ServletConfig object, which contains initialization and startup parameters for this servlet.
The ServletConfig object returned is the one passed to the init method. Implementations of this interface are responsible for storing the ServletConfig object so that this method can return it. The GenericServlet class, which implements this interface, already does this.
| true |
| true |
| Servlet:JAVADOC:267 | void | jakarta.servlet.Servlet.service
(
ServletRequest
,
ServletResponse
)
| Called by the servlet container to allow the servlet to respond to a request.
| true |
| true |
| Servlet:JAVADOC:268 | void | jakarta.servlet.Servlet.service
(
ServletRequest
,
ServletResponse
)
throws
ServletException
| if an exception occurs that interferes with the servlet's normal operation | true |
| true |
| Servlet:JAVADOC:269 | void | jakarta.servlet.Servlet.service
(
ServletRequest
,
ServletResponse
)
throws
IOException
| if an input or output exception occurs | true |
| false |
| Servlet:JAVADOC:270 | String | jakarta.servlet.Servlet.getServletInfo
| Returns information about the servlet, such as author, version, and copyright.
The string that this method returns should be plain text and not markup of any kind (such as HTML, XML, etc.).
| true |
| true |
| Servlet:JAVADOC:271 | void | jakarta.servlet.Servlet.destroy
| Called by the servlet container to indicate to a servlet that the servlet is being taken out of service. This method is only called once all threads within the servlet's service method have exited or after a timeout period has passed. After the servlet container calls this method, it will not call the service method again on this servlet. This method gives the servlet an opportunity to clean up any resources that are being held (for example, memory, file handles, threads) and make sure that any persistent state is synchronized with the servlet's current state in memory. | true |
| false |
| Servlet:JAVADOC:272 | void | jakarta.servlet.RequestDispatcher.forward
(
ServletRequest
,
ServletResponse
)
| Forwards a request from a servlet to another resource (servlet, JSP file, or HTML file) on the server.
For a RequestDispatcher obtained via getRequestDispatcher(), the ServletRequest object has its path elements and parameters adjusted to match the path of the target resource.
| true |
| true |
| Servlet:JAVADOC:273 | void | jakarta.servlet.RequestDispatcher.forward
(
ServletRequest
,
ServletResponse
)
| Forwards a request from a servlet to another resource (servlet, JSP file, or HTML file) on the server.
Uncommitted output in the response buffer is automatically cleared before the forward.
| true |
| true |
| Servlet:JAVADOC:274 | void | jakarta.servlet.RequestDispatcher.forward
(
ServletRequest
,
ServletResponse
)
| Forwards a request from a servlet to another resource (servlet, JSP file, or HTML file) on the server.
The request and response parameters must be either the same objects as were passed to the calling servlet's service method or be subclasses of the ServletRequestWrapper or ServletResponseWrapper classes that wrap them.
| true |
| true |
| Servlet:JAVADOC:275 | void | jakarta.servlet.RequestDispatcher.forward
(
ServletRequest
,
ServletResponse
)
throws
ServletException
| if the target resource throws this exception | true |
| true |
| Servlet:JAVADOC:276 | void | jakarta.servlet.RequestDispatcher.forward
(
ServletRequest
,
ServletResponse
)
throws
IOException
| if the target resource throws this exception | true |
| true |
| Servlet:JAVADOC:277 | void | jakarta.servlet.RequestDispatcher.forward
(
ServletRequest
,
ServletResponse
)
throws
IllegalStateException
| if the response was already committed | true |
| true |
| Servlet:JAVADOC:278 | void | jakarta.servlet.RequestDispatcher.include
(
ServletRequest
,
ServletResponse
)
| Includes the content of a resource (servlet, JSP page, HTML file) in the response.
In essence, this method enables programmatic server-side includes. The ServletResponse object has its path elements and parameters remain unchanged from the caller's.
The included servlet cannot change the response status code or set headers; any attempt to make a change is ignored.
The request and response parameters must be either the same objects as were passed to the calling servlet's service method or be subclasses of the ServletRequestWrapper or ServletResponseWrapper classes that wrap them.
This method sets the dispatcher type of the given request to DispatcherType.INCLUDE.
| true |
| true |
| Servlet:JAVADOC:279 | void | jakarta.servlet.RequestDispatcher.include
(
ServletRequest
,
ServletResponse
)
throws
ServletException
| if the included resource throws this exception | true |
| true |
| Servlet:JAVADOC:280 | void | jakarta.servlet.RequestDispatcher.include
(
ServletRequest
,
ServletResponse
)
throws
IOException
| if the included resource throws this exception | true |
| true |
| Servlet:JAVADOC:281 | String | jakarta.servlet.FilterConfig.getFilterName
| Returns the filter-name of this filter as defined in the deployment descriptor.
| true |
| true |
| Servlet:JAVADOC:282 | ServletContext | jakarta.servlet.FilterConfig.getServletContext
|
Returns a reference to the ServletContext in which the caller is executing.
| true |
| true |
| Servlet:JAVADOC:283 | String | jakarta.servlet.FilterConfig.getInitParameter
(
String
)
| Returns a String containing the value of the named initialization parameter.
| true |
| true |
| Servlet:JAVADOC:284 | String | jakarta.servlet.FilterConfig.getInitParameter
(
String
)
| Returns null if the parameter does not exist.
| true |
| true |
| Servlet:JAVADOC:285 | Enumeration | jakarta.servlet.FilterConfig.getInitParameterNames
| Returns the names of the servlet's initialization parameters as an Enumeration of String objects.
| true |
| true |
| Servlet:JAVADOC:286 | Enumeration | jakarta.servlet.FilterConfig.getInitParameterNames
| Returns an empty Enumeration if the servlet has no initialization parameters.
| true |
| true |
| Servlet:JAVADOC:287 | void | jakarta.servlet.FilterChain.doFilter
(
ServletRequest
,
ServletResponse
)
| Causes the next filter in the chain to be invoked, or if the calling filter is the last filter in the chain, causes the resource at the end of the chain to be invoked.
| true |
| true |
| Servlet:JAVADOC:288 | void | jakarta.servlet.FilterChain.doFilter
(
ServletRequest
,
ServletResponse
)
throws
IOException
|
| true |
| false |
| Servlet:JAVADOC:289 | void | jakarta.servlet.FilterChain.doFilter
(
ServletRequest
,
ServletResponse
)
throws
ServletException
|
| true |
| false |
| Servlet:JAVADOC:290 | void | jakarta.servlet.Filter.init
(
FilterConfig
)
| Called by the web container to indicate to a filter that it is being placed into service.
The servlet container calls the init method exactly once after instantiating the filter.
The init method must complete successfully before the filter is asked to do any filtering work.
The web container cannot place the filter into service if the init method either
1.Throws a ServletException
2.Does not return within a time period defined by the web container
| true |
| true |
| Servlet:JAVADOC:292 | void | jakarta.servlet.Filter.init
(
FilterConfig
)
throws
ServletException
|
Called by the web container to indicate to a filter that it is being placed into service.1
The web container cannot place the filter into service if the init method throws a ServletException.
| true |
| false |
| Servlet:JAVADOC:293 | void | jakarta.servlet.Filter.doFilter
(
ServletRequest
,
ServletResponse
,
FilterChain
)
| The doFilter method of the Filter is called by the container each time a request/response pair is passed through the chain due to a client request for a resource at the end of the chain.
The FilterChain passed in to this method allows the Filter to pass on the request and response to the next entity in the chain. A typical implementation of this method would follow the following pattern: Examine the request Optionally wrap the request object with a custom implementation to filter content or headers for input filtering Optionally wrap the response object with a custom implementation to filter content or headers for output filtering Either invoke the next entity in the chain using the FilterChain object (chain.doFilter()), or not pass on the request/response pair to the next entity in the filter chain to block the request processing Directly set headers on the response after invocation of the next entity in the filter chain.
| true |
| true |
| Servlet:JAVADOC:294 | void | jakarta.servlet.Filter.doFilter
(
ServletRequest
,
ServletResponse
,
FilterChain
)
throws
IOException
|
| true |
| false |
| Servlet:JAVADOC:295 | void | jakarta.servlet.Filter.doFilter
(
ServletRequest
,
ServletResponse
,
FilterChain
)
throws
ServletException
|
| true |
| false |
| Servlet:JAVADOC:296 | void | jakarta.servlet.Filter.destroy
| Called by the web container to indicate to a filter that it is being taken out of service.
This method is only called once all threads within the filter's doFilter method have exited or after a timeout period has passed. After the web container calls this method, it will not call the doFilter method again on this instance of the filter. This method gives the filter an opportunity to clean up any resources that are being held (for example, memory, file handles, threads) and make sure that any persistent state is synchronized with the filter's current state in memory.
| true |
| false |
| Servlet:JAVADOC:297 | HttpUtils | jakarta.servlet.http.HttpUtils.HttpUtils
| Constructs an empty HttpUtils object.
| true | true | true |
| Servlet:JAVADOC:298 | Hashtable | jakarta.servlet.http.HttpUtils.parseQueryString
(
String
)
| Parses a query string passed from the client to the server and builds a HashTable object with key-value pairs.
The query string should be in the form of a string packaged by the GET or POST method, that is, it should have key-value pairs in the form key=value, with each pair separated from the next by a & character. A key can appear more than once in the query string with different values. However, the key appears only once in the hashtable, with its value being an array of strings containing the multiple values sent by the query string. The keys and values in the hashtable are stored in their decoded form, so any + characters are converted to spaces, and characters sent in hexadecimal notation (like %xx) are converted to ASCII characters.
| true | true | true |
| Servlet:JAVADOC:299 | Hashtable | jakarta.servlet.http.HttpUtils.parseQueryString
(
String
)
throws
IllegalArgumentException
| if the query string is invalid | true | true | true |
| Servlet:JAVADOC:300 | Hashtable | jakarta.servlet.http.HttpUtils.parsePostData
(
int
,
ServletInputStream
)
| Parses data from an HTML form that the client sends to the server using the HTTP POST method and the application/x-www-form-urlencoded MIME type.
The data sent by the POST method contains key-value pairs. A key can appear more than once in the POST data with different values. However, the key appears only once in the hashtable, with its value being an array of strings containing the multiple values sent by the POST method. The keys and values in the hashtable are stored in their decoded form, so any + characters are converted to spaces, and characters sent in hexadecimal notation (like %xx) are converted to ASCII characters.
| true | true | true |
| Servlet:JAVADOC:301 | Hashtable | jakarta.servlet.http.HttpUtils.parsePostData
(
int
,
ServletInputStream
)
throws
IllegalArgumentException
| if the data sent by the POST method is invalid | true | true | true |
| Servlet:JAVADOC:302 | StringBuffer | jakarta.servlet.http.HttpUtils.getRequestURL
(
HttpServletRequest
)
| Reconstructs the URL the client used to make the request, using information in the HttpServletRequest object.
The returned URL contains a protocol, server name, port number, and server path, but it does not include query string parameters.
| true | true | true |
| Servlet:JAVADOC:303 | HttpSessionEvent | jakarta.servlet.http.HttpSessionEvent.HttpSessionEvent
(
HttpSession
)
| Construct a session event from the given source.
| true |
| true |
| Servlet:JAVADOC:304 | HttpSession | jakarta.servlet.http.HttpSessionEvent.getSession
| Return the session that changed. | true |
| true |
| Servlet:JAVADOC:305 | HttpSessionBindingEvent | jakarta.servlet.http.HttpSessionBindingEvent.HttpSessionBindingEvent
(
HttpSession
,
String
)
| Constructs an event that notifies an object that it has been bound to or unbound from a session.
To receive the event, the object must implement HttpSessionBindingListener .
| true |
| true |
| Servlet:JAVADOC:306 | HttpSessionBindingEvent | jakarta.servlet.http.HttpSessionBindingEvent.HttpSessionBindingEvent
(
HttpSession
,
String
,
Object
)
| Constructs an event that notifies an object that it has been bound to or unbound from a session.
To receive the event, the object must implement HttpSessionBindingListener.
| true |
| true |
| Servlet:JAVADOC:307 | HttpSession | jakarta.servlet.http.HttpSessionBindingEvent.getSession
| Return the session that changed. | true |
| true |
| Servlet:JAVADOC:308 | String | jakarta.servlet.http.HttpSessionBindingEvent.getName
| Returns the name with which the attribute is bound to or unbound from the session.
| true |
| true |
| Servlet:JAVADOC:309 | Object | jakarta.servlet.http.HttpSessionBindingEvent.getValue
| Returns the value of the attribute that has been added, removed or replaced.
If the attribute was added (or bound), this is the value of the attribute.
| true |
| true |
| Servlet:JAVADOC:310 | Object | jakarta.servlet.http.HttpSessionBindingEvent.getValue
| Returns the value of the attribute that has been added, removed or replaced.
If the attrubute was removed (or unbound), this is the value of the removed attribute.
| true |
| true |
| Servlet:JAVADOC:311 | Object | jakarta.servlet.http.HttpSessionBindingEvent.getValue
| Returns the value of the attribute that has been added, removed or replaced.
If the attribute was replaced, this is the old value of the attribute.
| true |
| true |
| Servlet:JAVADOC:313 | HttpServletResponseWrapper | jakarta.servlet.http.HttpServletResponseWrapper.HttpServletResponseWrapper
(
HttpServletResponse
)
| Constructs a response adaptor wrapping the given response.
| true |
| true |
| Servlet:JAVADOC:314 | void | jakarta.servlet.http.HttpServletResponseWrapper.addCookie
(
Cookie
)
| The default behavior of this method is to call addCookie(Cookie cookie) on the wrapped response object.
| true |
| true |
| Servlet:JAVADOC:315 | boolean | jakarta.servlet.http.HttpServletResponseWrapper.containsHeader
(
String
)
| The default behavior of this method is to call containsHeader(String name) on the wrapped response object.
| true |
| true |
| Servlet:JAVADOC:316 | String | jakarta.servlet.http.HttpServletResponseWrapper.encodeURL
(
String
)
| The default behavior of this method is to call encodeURL(String url) on the wrapped response object.
| true |
| true |
| Servlet:JAVADOC:317 | String | jakarta.servlet.http.HttpServletResponseWrapper.encodeRedirectURL
(
String
)
| The default behavior of this method is to return encodeRedirectURL(String url) on the wrapped response object.
| true |
| true |
| Servlet:JAVADOC:318 | String | jakarta.servlet.http.HttpServletResponseWrapper.encodeUrl
(
String
)
| The default behavior of this method is to call encodeUrl(String url) on the wrapped response object.
| true | true | true |
| Servlet:JAVADOC:319 | String | jakarta.servlet.http.HttpServletResponseWrapper.encodeRedirectUrl
(
String
)
| The default behavior of this method is to return encodeRedirectUrl(String url) on the wrapped response object.
| true | true | true |
| Servlet:JAVADOC:320 | void | jakarta.servlet.http.HttpServletResponseWrapper.sendError
(
int
,
String
)
| The default behavior of this method is to call sendError(int sc, String msg) on the wrapped response object.
| true |
| true |
| Servlet:JAVADOC:321 | void | jakarta.servlet.http.HttpServletResponseWrapper.sendError
(
int
,
String
)
throws
IOException
|
| true |
| false |
| Servlet:JAVADOC:322 | void | jakarta.servlet.http.HttpServletResponseWrapper.sendError
(
int
)
| The default behavior of this method is to call sendError(int sc) on the wrapped response object.
| true |
| true |
| Servlet:JAVADOC:323 | void | jakarta.servlet.http.HttpServletResponseWrapper.sendError
(
int
)
throws
IOException
|
| true |
| false |
| Servlet:JAVADOC:324 | void | jakarta.servlet.http.HttpServletResponseWrapper.sendRedirect
(
String
)
| The default behavior of this method is to return sendRedirect(String location) on the wrapped response object.
| true |
| true |
| Servlet:JAVADOC:325 | void | jakarta.servlet.http.HttpServletResponseWrapper.sendRedirect
(
String
)
throws
IOException
|
| true |
| false |
| Servlet:JAVADOC:326 | void | jakarta.servlet.http.HttpServletResponseWrapper.setDateHeader
(
String
,
long
)
| The default behavior of this method is to call setDateHeader(String name, long date) on the wrapped response object.
| true |
| true |
| Servlet:JAVADOC:327 | void | jakarta.servlet.http.HttpServletResponseWrapper.addDateHeader
(
String
,
long
)
| The default behavior of this method is to call addDateHeader(String name, long date) on the wrapped response object.
| true |
| true |
| Servlet:JAVADOC:328 | void | jakarta.servlet.http.HttpServletResponseWrapper.setHeader
(
String
,
String
)
| The default behavior of this method is to return setHeader(String name, String value) on the wrapped response object.
| true |
| true |
| Servlet:JAVADOC:329 | void | jakarta.servlet.http.HttpServletResponseWrapper.addHeader
(
String
,
String
)
| The default behavior of this method is to return addHeader(String name, String value) on the wrapped response object.
| true |
| true |
| Servlet:JAVADOC:330 | void | jakarta.servlet.http.HttpServletResponseWrapper.setIntHeader
(
String
,
int
)
| The default behavior of this method is to call setIntHeader(String name, int value) on the wrapped response object.
| true |
| true |
| Servlet:JAVADOC:331 | void | jakarta.servlet.http.HttpServletResponseWrapper.addIntHeader
(
String
,
int
)
| The default behavior of this method is to call addIntHeader(String name, int value) on the wrapped response object.
| true |
| true |
| Servlet:JAVADOC:332 | void | jakarta.servlet.http.HttpServletResponseWrapper.setStatus
(
int
)
| The default behavior of this method is to call setStatus(int sc) on the wrapped response object.
| true |
| true |
| Servlet:JAVADOC:333 | void | jakarta.servlet.http.HttpServletResponseWrapper.setStatus
(
int
,
String
)
| The default behavior of this method is to call setStatus(int sc, String sm) on the wrapped response object.
| true | true | true |
| Servlet:JAVADOC:334 | ServletResponse | jakarta.servlet.http.HttpServletResponseWrapper.{jakarta.servlet.ServletResponseWrapper}.getResponse
| Return the wrapped ServletResponse object. | true |
| true |
| Servlet:JAVADOC:335 | void | jakarta.servlet.http.HttpServletResponseWrapper.{jakarta.servlet.ServletResponseWrapper}.setResponse
(
ServletResponse
)
| Sets the response being wrapped. | true |
| true |
| Servlet:JAVADOC:336 | void | jakarta.servlet.http.HttpServletResponseWrapper.setResponse
(
ServletResponse
)
throws
IllegalArgumentException
| if the response is null. | true |
| true |
| Servlet:JAVADOC:337 | void | jakarta.servlet.http.HttpServletResponseWrapper.{jakarta.servlet.ServletResponseWrapper}.setCharacterEncoding
(
String
)
| The default behavior of this method is to call setCharacterEncoding(String charset) on the wrapped response object. | true |
| true |
| Servlet:JAVADOC:338 | String | jakarta.servlet.http.HttpServletResponseWrapper.{jakarta.servlet.ServletResponseWrapper}.getCharacterEncoding
| The default behavior of this method is to return getCharacterEncoding() on the wrapped response object. | true |
| true |
| Servlet:JAVADOC:339 | ServletOutputStream | jakarta.servlet.http.HttpServletResponseWrapper.{jakarta.servlet.ServletResponseWrapper}.getOutputStream
| The default behavior of this method is to return getOutputStream() on the wrapped response object. | true |
| true |
| Servlet:JAVADOC:340 | ServletOutputStream | jakarta.servlet.http.HttpServletResponseWrapper.{jakarta.servlet.ServletResponseWrapper}.getOutputStream
throws
IOException
| if an input or output exception occurred. | true |
| false |
| Servlet:JAVADOC:341 | PrintWriter | jakarta.servlet.http.HttpServletResponseWrapper.{jakarta.servlet.ServletResponseWrapper}.getWriter
| The default behavior of this method is to return getWriter() on the wrapped response object. | true |
| true |
| Servlet:JAVADOC:342 | PrintWriter | jakarta.servlet.http.HttpServletResponseWrapper.getWriter
throws
IOException
| if an input or output exception occurred | true |
| false |
| Servlet:JAVADOC:343 | void | jakarta.servlet.http.HttpServletResponseWrapper.{jakarta.servlet.ServletResponseWrapper}.setContentLength
(
int
)
| The default behavior of this method is to call setContentLength(int len) on the wrapped response object. | true |
| true |
| Servlet:JAVADOC:344 | void | jakarta.servlet.http.HttpServletResponseWrapper.{jakarta.servlet.ServletResponseWrapper}.setContentType
(
String
)
| The default behavior of this method is to call setContentType(String type) on the wrapped response object. | true |
| true |
| Servlet:JAVADOC:345 | String | jakarta.servlet.http.HttpServletResponseWrapper.{jakarta.servlet.ServletResponseWrapper}.getContentType
| The default behavior of this method is to return getContentType() on the wrapped response object. | true |
| true |
| Servlet:JAVADOC:346 | void | jakarta.servlet.http.HttpServletResponseWrapper.{jakarta.servlet.ServletResponseWrapper}.setBufferSize
(
int
)
| The default behavior of this method is to call setBufferSize(int size) on the wrapped response object. | true |
| true |
| Servlet:JAVADOC:347 | int | jakarta.servlet.http.HttpServletResponseWrapper.{jakarta.servlet.ServletResponseWrapper}.getBufferSize
| The default behavior of this method is to return getBufferSize() on the wrapped response object. | true |
| true |
| Servlet:JAVADOC:348 | void | jakarta.servlet.http.HttpServletResponseWrapper.{jakarta.servlet.ServletResponseWrapper}.flushBuffer
| The default behavior of this method is to call flushBuffer() on the wrapped response object. | true |
| true |
| Servlet:JAVADOC:349 | void | jakarta.servlet.http.HttpServletResponseWrapper.flushBuffer
throws
IOException
|
| true |
| false |
| Servlet:JAVADOC:350 | boolean | jakarta.servlet.http.HttpServletResponseWrapper.{jakarta.servlet.ServletResponseWrapper}.isCommitted
| The default behavior of this method is to return isCommitted() on the wrapped response object. | true |
| true |
| Servlet:JAVADOC:351 | void | jakarta.servlet.http.HttpServletResponseWrapper.{jakarta.servlet.ServletResponseWrapper}.reset
| The default behavior of this method is to call reset() on the wrapped response object. | true |
| true |
| Servlet:JAVADOC:352 | void | jakarta.servlet.http.HttpServletResponseWrapper.{jakarta.servlet.ServletResponseWrapper}.resetBuffer
| The default behavior of this method is to call resetBuffer() on the wrapped response object. | true |
| true |
| Servlet:JAVADOC:353 | void | jakarta.servlet.http.HttpServletResponseWrapper.{jakarta.servlet.ServletResponseWrapper}.setLocale
(
Locale
)
| The default behavior of this method is to call setLocale(Locale loc) on the wrapped response object. | true |
| true |
| Servlet:JAVADOC:354 | Locale | jakarta.servlet.http.HttpServletResponseWrapper.{jakarta.servlet.ServletResponseWrapper}.getLocale
| The default behavior of this method is to return getLocale() on the wrapped response object. | true |
| true |
| Servlet:JAVADOC:355 | HttpServletRequestWrapper | jakarta.servlet.http.HttpServletRequestWrapper.HttpServletRequestWrapper
(
HttpServletRequest
)
| Constructs a request object wrapping the given request.
| true |
| true |
| Servlet:JAVADOC:356 | String | jakarta.servlet.http.HttpServletRequestWrapper.getAuthType
| The default behavior of this method is to return getAuthType() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:357 | Cookie[] | jakarta.servlet.http.HttpServletRequestWrapper.getCookies
| The default behavior of this method is to return getCookies() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:358 | long | jakarta.servlet.http.HttpServletRequestWrapper.getDateHeader
(
String
)
| The default behavior of this method is to return getDateHeader(String name) on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:359 | String | jakarta.servlet.http.HttpServletRequestWrapper.getHeader
(
String
)
| The default behavior of this method is to return getHeader(String name) on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:360 | Enumeration | jakarta.servlet.http.HttpServletRequestWrapper.getHeaders
(
String
)
| The default behavior of this method is to return getHeaders(String name) on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:361 | Enumeration | jakarta.servlet.http.HttpServletRequestWrapper.getHeaderNames
| The default behavior of this method is to return getHeaderNames() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:362 | int | jakarta.servlet.http.HttpServletRequestWrapper.getIntHeader
(
String
)
| The default behavior of this method is to return getIntHeader(String name) on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:363 | String | jakarta.servlet.http.HttpServletRequestWrapper.getMethod
| The default behavior of this method is to return getMethod() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:364 | String | jakarta.servlet.http.HttpServletRequestWrapper.getPathInfo
| The default behavior of this method is to return getPathInfo() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:365 | String | jakarta.servlet.http.HttpServletRequestWrapper.getPathTranslated
| The default behavior of this method is to return getPathTranslated() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:366 | String | jakarta.servlet.http.HttpServletRequestWrapper.getContextPath
| The default behavior of this method is to return getContextPath() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:367 | String | jakarta.servlet.http.HttpServletRequestWrapper.getQueryString
| The default behavior of this method is to return getQueryString() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:368 | String | jakarta.servlet.http.HttpServletRequestWrapper.getRemoteUser
| The default behavior of this method is to return getRemoteUser() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:369 | boolean | jakarta.servlet.http.HttpServletRequestWrapper.isUserInRole
(
String
)
| The default behavior of this method is to return isUserInRole(String role) on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:370 | Principal | jakarta.servlet.http.HttpServletRequestWrapper.getUserPrincipal
| The default behavior of this method is to return getUserPrincipal() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:371 | String | jakarta.servlet.http.HttpServletRequestWrapper.getRequestedSessionId
| The default behavior of this method is to return getRequestedSessionId() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:372 | String | jakarta.servlet.http.HttpServletRequestWrapper.getRequestURI
| The default behavior of this method is to return getRequestURI() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:373 | StringBuffer | jakarta.servlet.http.HttpServletRequestWrapper.getRequestURL
| The default behavior of this method is to return getRequestURL() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:374 | String | jakarta.servlet.http.HttpServletRequestWrapper.getServletPath
| The default behavior of this method is to return getServletPath() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:375 | HttpSession | jakarta.servlet.http.HttpServletRequestWrapper.getSession
(
boolean
)
| The default behavior of this method is to return getSession(boolean create) on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:376 | HttpSession | jakarta.servlet.http.HttpServletRequestWrapper.getSession
| The default behavior of this method is to return getSession() on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:377 | boolean | jakarta.servlet.http.HttpServletRequestWrapper.isRequestedSessionIdValid
| The default behavior of this method is to return isRequestedSessionIdValid() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:378 | boolean | jakarta.servlet.http.HttpServletRequestWrapper.isRequestedSessionIdFromCookie
| The default behavior of this method is to return isRequestedSessionIdFromCookie() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:379 | boolean | jakarta.servlet.http.HttpServletRequestWrapper.isRequestedSessionIdFromURL
| The default behavior of this method is to return isRequestedSessionIdFromURL() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:380 | boolean | jakarta.servlet.http.HttpServletRequestWrapper.isRequestedSessionIdFromUrl
| The default behavior of this method is to return isRequestedSessionIdFromUrl() on the wrapped request object.
| true | true | true |
| Servlet:JAVADOC:381 | ServletRequest | jakarta.servlet.http.HttpServletRequestWrapper.{jakarta.servlet.ServletRequestWrapper}.getRequest
| Return the wrapped request object. | true |
| true |
| Servlet:JAVADOC:382 | void | jakarta.servlet.http.HttpServletRequestWrapper.{jakarta.servlet.ServletRequestWrapper}.setRequest
(
ServletRequest
)
| Sets the request object being wrapped. | true |
| true |
| Servlet:JAVADOC:383 | void | jakarta.servlet.http.HttpServletRequestWrapper.setRequest
(
ServletRequest
)
throws
IllegalArgumentException
| if the request is null. | true |
| true |
| Servlet:JAVADOC:384 | Object | jakarta.servlet.http.HttpServletRequestWrapper.{jakarta.servlet.ServletRequestWrapper}.getAttribute
(
String
)
| The default behavior of this method is to call getAttribute(String name) on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:385 | Enumeration | jakarta.servlet.http.HttpServletRequestWrapper.{jakarta.servlet.ServletRequestWrapper}.getAttributeNames
| The default behavior of this method is to return getAttributeNames() on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:386 | String | jakarta.servlet.http.HttpServletRequestWrapper.{jakarta.servlet.ServletRequestWrapper}.getCharacterEncoding
| The default behavior of this method is to return getCharacterEncoding() on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:387 | void | jakarta.servlet.http.HttpServletRequestWrapper.{jakarta.servlet.ServletRequestWrapper}.setCharacterEncoding
(
String
)
| Overrides the name of the character encoding used in the body of the wrapped
request. This method must be called prior to reading request parameters or
reading input using getReader(). Otherwise, it has no effect.
| true |
| true |
| Servlet:JAVADOC:388 | void | jakarta.servlet.http.HttpServletRequestWrapper.setCharacterEncoding
(
String
)
throws
UnsupportedEncodingException
| if this ServletRequest is still in a state where a character encoding may be set, but the specified encoding is invalid | true |
| true |
| Servlet:JAVADOC:389 | int | jakarta.servlet.http.HttpServletRequestWrapper.{jakarta.servlet.ServletRequestWrapper}.getContentLength
| The default behavior of this method is to return getContentLength() on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:390 | String | jakarta.servlet.http.HttpServletRequestWrapper.{jakarta.servlet.ServletRequestWrapper}.getContentType
| The default behavior of this method is to return getContentType() on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:391 | ServletInputStream | jakarta.servlet.http.HttpServletRequestWrapper.{jakarta.servlet.ServletRequestWrapper}.getInputStream
| The default behavior of this method is to return getInputStream() on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:392 | ServletInputStream | jakarta.servlet.http.HttpServletRequestWrapper.getInputStream
throws
IOException
|
| true |
| false |
| Servlet:JAVADOC:393 | String | jakarta.servlet.http.HttpServletRequestWrapper.{jakarta.servlet.ServletRequestWrapper}.getParameter
(
String
)
| The default behavior of this method is to return getParameter(String name) on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:394 | Map | jakarta.servlet.http.HttpServletRequestWrapper.{jakarta.servlet.ServletRequestWrapper}.getParameterMap
| The default behavior of this method is to return getParameterMap() on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:395 | Enumeration | jakarta.servlet.http.HttpServletRequestWrapper.{jakarta.servlet.ServletRequestWrapper}.getParameterNames
| The default behavior of this method is to return getParameterNames() on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:396 | String[] | jakarta.servlet.http.HttpServletRequestWrapper.{jakarta.servlet.ServletRequestWrapper}.getParameterValues
(
String
)
| The default behavior of this method is to return getParameterValues(String name) on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:397 | String | jakarta.servlet.http.HttpServletRequestWrapper.{jakarta.servlet.ServletRequestWrapper}.getProtocol
| The default behavior of this method is to return getProtocol() on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:398 | String | jakarta.servlet.http.HttpServletRequestWrapper.{jakarta.servlet.ServletRequestWrapper}.getScheme
| The default behavior of this method is to return getScheme() on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:399 | String | jakarta.servlet.http.HttpServletRequestWrapper.{jakarta.servlet.ServletRequestWrapper}.getServerName
| The default behavior of this method is to return getServerName() on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:400 | int | jakarta.servlet.http.HttpServletRequestWrapper.{jakarta.servlet.ServletRequestWrapper}.getServerPort
| The default behavior of this method is to return getServerPort() on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:401 | BufferedReader | jakarta.servlet.http.HttpServletRequestWrapper.{jakarta.servlet.ServletRequestWrapper}.getReader
| The default behavior of this method is to return getReader() on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:402 | BufferedReader | jakarta.servlet.http.HttpServletRequestWrapper.getReader
throws
IOException
| if an input or output exception occurred | true |
| false |
| Servlet:JAVADOC:403 | String | jakarta.servlet.http.HttpServletRequestWrapper.{jakarta.servlet.ServletRequestWrapper}.getRemoteAddr
| The default behavior of this method is to return getRemoteAddr() on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:404 | String | jakarta.servlet.http.HttpServletRequestWrapper.{jakarta.servlet.ServletRequestWrapper}.getRemoteHost
| The default behavior of this method is to return getRemoteHost() on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:405 | void | jakarta.servlet.http.HttpServletRequestWrapper.{jakarta.servlet.ServletRequestWrapper}.setAttribute
(
String
,
Object
)
| The default behavior of this method is to return setAttribute(String name, Object o) on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:406 | void | jakarta.servlet.http.HttpServletRequestWrapper.{jakarta.servlet.ServletRequestWrapper}.removeAttribute
(
String
)
| The default behavior of this method is to call removeAttribute(String name) on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:407 | Locale | jakarta.servlet.http.HttpServletRequestWrapper.{jakarta.servlet.ServletRequestWrapper}.getLocale
| The default behavior of this method is to return getLocale() on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:408 | Enumeration | jakarta.servlet.http.HttpServletRequestWrapper.{jakarta.servlet.ServletRequestWrapper}.getLocales
| The default behavior of this method is to return getLocales() on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:409 | boolean | jakarta.servlet.http.HttpServletRequestWrapper.{jakarta.servlet.ServletRequestWrapper}.isSecure
| The default behavior of this method is to return isSecure() on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:410 | RequestDispatcher | jakarta.servlet.http.HttpServletRequestWrapper.{jakarta.servlet.ServletRequestWrapper}.getRequestDispatcher
(
String
)
| The default behavior of this method is to return getRequestDispatcher(String path) on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:411 | String | jakarta.servlet.http.HttpServletRequestWrapper.{jakarta.servlet.ServletRequestWrapper}.getRealPath
(
String
)
| The default behavior of this method is to return getRealPath(String path) on the wrapped request object. | true | true | true |
| Servlet:JAVADOC:412 | HttpServlet | jakarta.servlet.http.HttpServlet.HttpServlet
| Does nothing, because this is an abstract class.
| true |
| false |
| Servlet:JAVADOC:413 | void | jakarta.servlet.http.HttpServlet.service
(
ServletRequest
,
ServletResponse
)
| Dispatches client requests to the protected service method.
There's no need to override this method.
| true |
| false |
| Servlet:JAVADOC:414 | void | jakarta.servlet.http.HttpServlet.service
(
ServletRequest
,
ServletResponse
)
throws
ServletException
| if the request for the TRACE cannot be handled | true |
| false |
| Servlet:JAVADOC:415 | void | jakarta.servlet.http.HttpServlet.service
(
ServletRequest
,
ServletResponse
)
throws
IOException
| if an input or output error occurs while the servlet is handling the TRACE request | true |
| false |
| Servlet:JAVADOC:416 | void | jakarta.servlet.http.HttpServlet.{jakarta.servlet.GenericServlet}.destroy
| Called by the servlet container to indicate to a servlet that the servlet is being taken out of service. | true |
| false |
| Servlet:JAVADOC:417 | String | jakarta.servlet.http.HttpServlet.{jakarta.servlet.GenericServlet}.getInitParameter
(
String
)
| Returns a String containing the value of the named initialization parameter. | true |
| true |
| Servlet:JAVADOC:418 | String | jakarta.servlet.http.HttpServlet.{jakarta.servlet.GenericServlet}.getInitParameter
(
String
)
| Returns null if the parameter does not exist. | true |
| true |
| Servlet:JAVADOC:419 | Enumeration | jakarta.servlet.http.HttpServlet.{jakarta.servlet.GenericServlet}.getInitParameterNames
| Returns the names of the servlet's initialization parameters as an Enumeration of String objects. | true |
| true |
| Servlet:JAVADOC:420 | Enumeration | jakarta.servlet.http.HttpServlet.{jakarta.servlet.GenericServlet}.getInitParameterNames
| Returns an empty Enumeration if the servlet has no initialization parameters. | true |
| false |
| Servlet:JAVADOC:421 | ServletConfig | jakarta.servlet.http.HttpServlet.{jakarta.servlet.GenericServlet}.getServletConfig
| Returns this servlet's ServletConfig object. | true |
| true |
| Servlet:JAVADOC:422 | ServletContext | jakarta.servlet.http.HttpServlet.{jakarta.servlet.GenericServlet}.getServletContext
| Returns a reference to the ServletContext in which this servlet is running. | true |
| true |
| Servlet:JAVADOC:423 | String | jakarta.servlet.http.HttpServlet.{jakarta.servlet.GenericServlet}.getServletInfo
| Returns information about the servlet, such as author, version, and copyright. By default, this method returns an empty string. | true |
| true |
| Servlet:JAVADOC:424 | void | jakarta.servlet.http.HttpServlet.{jakarta.servlet.GenericServlet}.init
(
ServletConfig
)
| Called by the servlet container to indicate to a servlet that the servlet is being placed into service. | true |
| true |
| Servlet:JAVADOC:425 | void | jakarta.servlet.http.HttpServlet.init
(
ServletConfig
)
throws
ServletException
| if an exception occurs that interrupts the servlet's normal operation | true |
| false |
| Servlet:JAVADOC:426 | void | jakarta.servlet.http.HttpServlet.{jakarta.servlet.GenericServlet}.init
| A convenience method which can be overridden so that there's no need to call super.init(config). Instead of overriding init(ServletConfig(, simply override this method and it will be called by GenericServlet.init(ServletConfig config). The ServletConfig object can still be retrieved via getServletConfig. | true |
| true |
| Servlet:JAVADOC:427 | void | jakarta.servlet.http.HttpServlet.init
throws
ServletException
| if an exception occurs that interrupts the servlet's normal operation | true |
| false |
| Servlet:JAVADOC:428 | void | jakarta.servlet.http.HttpServlet.{jakarta.servlet.GenericServlet}.log
(
String
)
| Writes the specified message to a servlet log file, prepended by the servlet's name. See ServletContext.log(String). | true |
| false |
| Servlet:JAVADOC:429 | void | jakarta.servlet.http.HttpServlet.{jakarta.servlet.GenericServlet}.log
(
String
,
Throwable
)
| Writes an explanatory message and a stack trace for a given Throwable exception to the servlet log file, prepended by the servlet's name.
See ServletContext.log(String, Throwable).
| true |
| false |
| Servlet:JAVADOC:430 | void | jakarta.servlet.http.HttpServlet.{jakarta.servlet.GenericServlet}.service
(
ServletRequest
,
ServletResponse
)
| Called by the servlet container to allow the servlet to respond to a request. | true |
| true |
| Servlet:JAVADOC:431 | void | jakarta.servlet.http.HttpServlet.service
(
ServletRequest
,
ServletResponse
)
throws
ServletException
| if an exception occurs that interferes with the servlet's normal operation occurred | true |
| false |
| Servlet:JAVADOC:432 | void | jakarta.servlet.http.HttpServlet.service
(
ServletRequest
,
ServletResponse
)
throws
IOException
| if an input or output exception occurs | true |
| false |
| Servlet:JAVADOC:433 | String | jakarta.servlet.http.HttpServlet.{jakarta.servlet.GenericServlet}.getServletName
| Returns the name of this servlet instance. | true |
| true |
| Servlet:JAVADOC:434 | Cookie | jakarta.servlet.http.Cookie.Cookie
(
String
,
String
)
| Constructs a cookie with a specified name and value.
The name must conform to RFC 2109. That means it can contain only ASCII alphanumeric characters and cannot contain commas, semicolons, or white space or begin with a $ character. The cookie's name cannot be changed after creation. The value can be anything the server chooses to send. Its value is probably of interest only to the server. The cookie's value can be changed after creation with the setValue method. By default, cookies are created according to the Netscape cookie specification. The version can be changed with the setVersion method.
| true |
| true |
| Servlet:JAVADOC:435 | void | jakarta.servlet.http.Cookie.setComment
(
String
)
| Specifies a comment that describes a cookie's purpose.
The comment is useful if the browser presents the cookie to the user. Comments are not supported by Netscape Version 0 cookies.
| true |
| true |
| Servlet:JAVADOC:436 | String | jakarta.servlet.http.Cookie.getComment
| Returns the comment describing the purpose of this cookie.
| true |
| true |
| Servlet:JAVADOC:437 | String | jakarta.servlet.http.Cookie.getComment
| Returns null if the cookie has no comment.
| true |
| true |
| Servlet:JAVADOC:438 | void | jakarta.servlet.http.Cookie.setDomain
(
String
)
| Specifies the domain within which this cookie should be presented.
The form of the domain name is specified by RFC 2109. A domain name begins with a dot (.foo.com) and means that the cookie is visible to servers in a specified Domain Name System (DNS) zone (for example, www.foo.com, but not a.b.foo.com). By default, cookies are only returned to the server that sent them.
| true |
| true |
| Servlet:JAVADOC:439 | String | jakarta.servlet.http.Cookie.getDomain
| Returns the domain name set for this cookie.
The form of the domain name is set by RFC 2109.
| true |
| true |
| Servlet:JAVADOC:440 | void | jakarta.servlet.http.Cookie.setMaxAge
(
int
)
| Sets the maximum age of the cookie in seconds.
A positive value indicates that the cookie will expire after that many seconds have passed. Note that the value is the maximum age when the cookie will expire, not the cookie's current age.
| true |
| true |
| Servlet:JAVADOC:441 | void | jakarta.servlet.http.Cookie.setMaxAge
(
int
)
| Sets the maximum age of the cookie in seconds.
A negative value means that the cookie is not stored persistently and will be deleted when the Web browser exits.
| true |
| true |
| Servlet:JAVADOC:442 | void | jakarta.servlet.http.Cookie.setMaxAge
(
int
)
| Sets the maximum age of the cookie in seconds.
A zero value causes the cookie to be deleted.
| true |
| true |
| Servlet:JAVADOC:443 | int | jakarta.servlet.http.Cookie.getMaxAge
| Returns the maximum age of the cookie, specified in seconds, By default, -1 indicating the cookie will persist until browser shutdown.
| true |
| true |
| Servlet:JAVADOC:444 | void | jakarta.servlet.http.Cookie.setPath
(
String
)
| Specifies a path for the cookie to which the client should return the cookie.
The cookie is visible to all the pages in the directory you specify, and all the pages in that directory's subdirectories. A cookie's path must include the servlet that set the cookie, for example, /catalog, which makes the cookie visible to all directories on the server under /catalog. Consult RFC 2109 (available on the Internet) for more information on setting path names for cookies.
| true |
| true |
| Servlet:JAVADOC:445 | String | jakarta.servlet.http.Cookie.getPath
| Returns the path on the server to which the browser returns this cookie.
The cookie is visible to all subpaths on the server.
| true |
| true |
| Servlet:JAVADOC:446 | void | jakarta.servlet.http.Cookie.setSecure
(
boolean
)
| Indicates to the browser whether the cookie should only be sent using a secure protocol, such as HTTPS or SSL.
The default value is false.
| true |
| true |
| Servlet:JAVADOC:447 | boolean | jakarta.servlet.http.Cookie.getSecure
| Returns true if the browser is sending cookies only over a secure protocol, or false if the browser can send cookies using any protocol.
| true |
| true |
| Servlet:JAVADOC:448 | String | jakarta.servlet.http.Cookie.getName
| Returns the name of the cookie.
The name cannot be changed after creation.
| true |
| true |
| Servlet:JAVADOC:449 | void | jakarta.servlet.http.Cookie.setValue
(
String
)
| Assigns a new value to a cookie after the cookie is created.
If you use a binary value, you may want to use BASE64 encoding. With Version 0 cookies, values should not contain white space, brackets, parentheses, equals signs, commas, double quotes, slashes, question marks, at signs, colons, and semicolons. Empty values may not behave the same way on all browsers.
| true |
| true |
| Servlet:JAVADOC:450 | String | jakarta.servlet.http.Cookie.getValue
| Returns the value of the cookie.
| true |
| true |
| Servlet:JAVADOC:451 | int | jakarta.servlet.http.Cookie.getVersion
| Returns the version of the protocol this cookie complies with.
Version 1 complies with RFC 2109, and version 0 complies with the original cookie specification drafted by Netscape. Cookies provided by a browser use and identify the browser's cookie version.
| true |
| true |
| Servlet:JAVADOC:452 | void | jakarta.servlet.http.Cookie.setVersion
(
int
)
| Sets the version of the cookie protocol this cookie complies with.
Version 0 complies with the original Netscape cookie specification. Version 1 complies with RFC 2109. Since RFC 2109 is still somewhat new, consider version 1 as experimental; do not use it yet on production sites.
| true |
| true |
| Servlet:JAVADOC:453 | Object | jakarta.servlet.http.Cookie.clone
| Overrides the standard java.lang.Object.clone method to return a copy of this cookie.
| true |
| true |
| Servlet:JAVADOC:454 | void | jakarta.servlet.http.HttpSessionListener.sessionCreated
(
HttpSessionEvent
)
| Notification that a session was created.
| true |
| true |
| Servlet:JAVADOC:455 | void | jakarta.servlet.http.HttpSessionListener.sessionDestroyed
(
HttpSessionEvent
)
| Notification that a session was invalidated.
| true |
| true |
| Servlet:JAVADOC:456 | HttpSession | jakarta.servlet.http.HttpSessionContext.getSession
(
String
)
|
| true | true | true |
| Servlet:JAVADOC:457 | Enumeration | jakarta.servlet.http.HttpSessionContext.getIds
|
| true | true | true |
| Servlet:JAVADOC:458 | void | jakarta.servlet.http.HttpSessionBindingListener.valueBound
(
HttpSessionBindingEvent
)
| Notifies the object that it is being bound to a session and identifies the session.
| true |
| true |
| Servlet:JAVADOC:459 | void | jakarta.servlet.http.HttpSessionBindingListener.valueUnbound
(
HttpSessionBindingEvent
)
| Notifies the object that it is being unbound from a session and identifies the session.
| true |
| true |
| Servlet:JAVADOC:460 | void | jakarta.servlet.http.HttpSessionAttributeListener.attributeAdded
(
HttpSessionBindingEvent
)
| Notification that an attribute has been added to a session.
Called after the attribute is added.
| true |
| true |
| Servlet:JAVADOC:461 | void | jakarta.servlet.http.HttpSessionAttributeListener.attributeRemoved
(
HttpSessionBindingEvent
)
| Notification that an attribute has been removed from a session.
Called after the attribute is removed.
| true |
| true |
| Servlet:JAVADOC:462 | void | jakarta.servlet.http.HttpSessionAttributeListener.attributeReplaced
(
HttpSessionBindingEvent
)
| Notification that an attribute has been replaced in a session.
Called after the attribute is replaced.
| true |
| true |
| Servlet:JAVADOC:463 | void | jakarta.servlet.http.HttpSessionActivationListener.sessionWillPassivate
(
HttpSessionEvent
)
| Notification that the session is about to be passivated.
| true |
| false |
| Servlet:JAVADOC:464 | void | jakarta.servlet.http.HttpSessionActivationListener.sessionDidActivate
(
HttpSessionEvent
)
| Notification that the session has just been activated.
| true |
| false |
| Servlet:JAVADOC:465 | long | jakarta.servlet.http.HttpSession.getCreationTime
| Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.
| true |
| true |
| Servlet:JAVADOC:466 | long | jakarta.servlet.http.HttpSession.getCreationTime
throws
IllegalStateException
| if this method is called on an invalidated session | true |
| true |
| Servlet:JAVADOC:467 | String | jakarta.servlet.http.HttpSession.getId
| Returns a string containing the unique identifier assigned to this session.
The identifier is assigned by the servlet container and is implementation dependent.
| true |
| true |
| Servlet:JAVADOC:469 | long | jakarta.servlet.http.HttpSession.getLastAccessedTime
| Returns the last time the client sent a request associated with this session, as the number of milliseconds since midnight January 1, 1970 GMT, and marked by the time the container recieved the request.
| true |
| true |
| Servlet:JAVADOC:470 | long | jakarta.servlet.http.HttpSession.getLastAccessedTime
|
Actions such as getting or setting a value associated with the session, do not affect the access time.
| true |
| true |
| Servlet:JAVADOC:471 | long | jakarta.servlet.http.HttpSession.getLastAccessedTime
throws
IllegalStateException
| if this method is called on an invalidated session | true |
| true |
| Servlet:JAVADOC:472 | ServletContext | jakarta.servlet.http.HttpSession.getServletContext
| Returns the ServletContext to which this session belongs.
| true |
| true |
| Servlet:JAVADOC:473 | void | jakarta.servlet.http.HttpSession.setMaxInactiveInterval
(
int
)
| Specifies the time, in seconds, between client requests before the servlet container will invalidate this session.
A negative time indicates the session should never timeout.
| true |
| true |
| Servlet:JAVADOC:474 | int | jakarta.servlet.http.HttpSession.getMaxInactiveInterval
| Returns the maximum time interval, in seconds, that the servlet container will keep this session open between client accesses.
After this interval, the servlet container will invalidate the session. The maximum time interval can be set with the setMaxInactiveInterval method. A negative time indicates the session should never timeout.
| true |
| true |
| Servlet:JAVADOC:475 | HttpSessionContext | jakarta.servlet.http.HttpSession.getSessionContext
|
| true | true | true |
| Servlet:JAVADOC:476 | Object | jakarta.servlet.http.HttpSession.getAttribute
(
String
)
| Returns the object bound with the specified name in this session, or null if no object is bound under the name.
| true |
| true |
| Servlet:JAVADOC:477 | Object | jakarta.servlet.http.HttpSession.getAttribute
(
String
)
throws
IllegalStateException
| if this method is called on an invalidated session | true |
| true |
| Servlet:JAVADOC:478 | Object | jakarta.servlet.http.HttpSession.getValue
(
String
)
|
| true | true | true |
| Servlet:JAVADOC:479 | Object | jakarta.servlet.http.HttpSession.getValue
(
String
)
throws
IllegalStateException
| if this method is called on an invalidated session | true | true | true |
| Servlet:JAVADOC:480 | Enumeration | jakarta.servlet.http.HttpSession.getAttributeNames
| Returns an Enumeration of String objects containing the names of all the objects bound to this session.
| true |
| true |
| Servlet:JAVADOC:481 | Enumeration | jakarta.servlet.http.HttpSession.getAttributeNames
throws
IllegalStateException
| if this method is called on an invalidated session | true |
| true |
| Servlet:JAVADOC:482 | String[] | jakarta.servlet.http.HttpSession.getValueNames
|
| true | true | true |
| Servlet:JAVADOC:483 | String[] | jakarta.servlet.http.HttpSession.getValueNames
throws
IllegalStateException
| if this method is called on an invalidated session | true | true | true |
| Servlet:JAVADOC:484 | void | jakarta.servlet.http.HttpSession.setAttribute
(
String
,
Object
)
| Binds an object to this session, using the name specified.
If an object of the same name is already bound to the session, the object is replaced.
| true |
| true |
| Servlet:JAVADOC:485 | void | jakarta.servlet.http.HttpSession.setAttribute
(
String
,
Object
)
| Binds an object to this session, using the name specified.
After this method executes, and if the new object implements HttpSessionBindingListener, the container calls HttpSessionBindingListener.valueBound. The container then notifies any HttpSessionAttributeListeners in the web application.
| true |
| true |
| Servlet:JAVADOC:486 | void | jakarta.servlet.http.HttpSession.setAttribute
(
String
,
Object
)
| Binds an object to this session, using the name specified.
If an object was already bound to this session of this name that implements HttpSessionBindingListener, its HttpSessionBindingListener.valueUnbound method is called.
| true |
| true |
| Servlet:JAVADOC:487 | void | jakarta.servlet.http.HttpSession.setAttribute
(
String
,
Object
)
| Binds an object to this session, using the name specified.
If the value passed in is null, this has the same effect as calling removeAttribute().
| true |
| true |
| Servlet:JAVADOC:488 | void | jakarta.servlet.http.HttpSession.setAttribute
(
String
,
Object
)
throws
IllegalStateException
| if this method is called on an invalidated session | true |
| true |
| Servlet:JAVADOC:489 | void | jakarta.servlet.http.HttpSession.putValue
(
String
,
Object
)
|
| true | true | true |
| Servlet:JAVADOC:490 | void | jakarta.servlet.http.HttpSession.putValue
(
String
,
Object
)
throws
IllegalStateException
| if this method is called on an invalidated session | true | true | true |
| Servlet:JAVADOC:491 | void | jakarta.servlet.http.HttpSession.removeAttribute
(
String
)
| Removes the object bound with the specified name from this session.
After this method executes, and if the object implements HttpSessionBindingListener, the container calls HttpSessionBindingListener.valueUnbound. The container then notifies any HttpSessionAttributeListeners in the web application.
| true |
| true |
| Servlet:JAVADOC:492 | void | jakarta.servlet.http.HttpSession.removeAttribute
(
String
)
|
If the session does not have an object bound with the specified name, this method does nothing.
| true |
| true |
| Servlet:JAVADOC:493 | void | jakarta.servlet.http.HttpSession.removeAttribute
(
String
)
throws
IllegalStateException
| if this method is called on an invalidated session | true |
| true |
| Servlet:JAVADOC:494 | void | jakarta.servlet.http.HttpSession.removeValue
(
String
)
|
| true | true | true |
| Servlet:JAVADOC:495 | void | jakarta.servlet.http.HttpSession.removeValue
(
String
)
throws
IllegalStateException
| if this method is called on an invalidated session | true | true | true |
| Servlet:JAVADOC:496 | void | jakarta.servlet.http.HttpSession.invalidate
| Invalidates this session then unbinds any objects bound to it.
| true |
| true |
| Servlet:JAVADOC:497 | void | jakarta.servlet.http.HttpSession.invalidate
throws
IllegalStateException
| if this method is called on an already invalidated session | true |
| true |
| Servlet:JAVADOC:498 | boolean | jakarta.servlet.http.HttpSession.isNew
| Returns true if the client does not yet know about the session or if the client chooses not to join the session.
For example, if the server used only cookie-based sessions, and the client had disabled the use of cookies, then a session would be new on each request.
| true |
| true |
| Servlet:JAVADOC:499 | boolean | jakarta.servlet.http.HttpSession.isNew
throws
IllegalStateException
| if this method is called on an already invalidated session | true |
| true |
| Servlet:JAVADOC:502 | void | jakarta.servlet.http.HttpServletResponse.addCookie
(
Cookie
)
| Adds the specified cookie to the response.
This method can be called multiple times to set more than one cookie.
| true |
| true |
| Servlet:JAVADOC:503 | boolean | jakarta.servlet.http.HttpServletResponse.containsHeader
(
String
)
| Returns a boolean indicating whether the named response header has already been set.
| true |
| true |
| Servlet:JAVADOC:504 | String | jakarta.servlet.http.HttpServletResponse.encodeURL
(
String
)
| Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged.
The implementation of this method includes the logic to determine whether the session ID needs to be encoded in the URL. For example, if the browser supports cookies, or session tracking is turned off, URL encoding is unnecessary. For robust session tracking, all URLs emitted by a servlet should be run through this method. Otherwise, URL rewriting cannot be used with browsers which do not support cookies.
| true |
| true |
| Servlet:JAVADOC:505 | String | jakarta.servlet.http.HttpServletResponse.encodeRedirectURL
(
String
)
| Encodes the specified URL for use in the sendRedirect method or, if encoding is not needed, returns the URL unchanged.
The implementation of this method includes the logic to determine whether the session ID needs to be encoded in the URL. Because the rules for making this determination can differ from those used to decide whether to encode a normal link, this method is seperate from the encodeURL method. All URLs sent to the HttpServletResponse.sendRedirect method should be run through this method. Otherwise, URL rewriting cannot be used with browsers which do not support cookies.
| true |
| true |
| Servlet:JAVADOC:506 | String | jakarta.servlet.http.HttpServletResponse.encodeUrl
(
String
)
|
| true | true | true |
| Servlet:JAVADOC:507 | String | jakarta.servlet.http.HttpServletResponse.encodeRedirectUrl
(
String
)
|
| true | true | true |
| Servlet:JAVADOC:508 | void | jakarta.servlet.http.HttpServletResponse.sendError
(
int
,
String
)
| Sends an error response to the client using the specified status clearing the buffer.
The server defaults to creating the response to look like an HTML-formatted server error page containing the specified message, setting the content type to "text/html", leaving cookies and other headers unmodified.
| true |
| true |
| Servlet:JAVADOC:509 | void | jakarta.servlet.http.HttpServletResponse.sendError
(
int
,
String
)
| Sends an error response to the client using the specified status clearing the buffer.
If an error-page declaration has been made for the web application corresponding to the status code passed in, it will be served back in preference to the suggested msg parameter. If the response has already been committed, this method throws an IllegalStateException. After using this method, the response should be considered to be committed and should not be written to.
| true |
| true |
| Servlet:JAVADOC:510 | void | jakarta.servlet.http.HttpServletResponse.sendError
(
int
,
String
)
throws
IOException
| If an input or output exception occurs | true |
| false |
| Servlet:JAVADOC:511 | void | jakarta.servlet.http.HttpServletResponse.sendError
(
int
,
String
)
throws
IllegalStateException
| If the response was committed | true |
| true |
| Servlet:JAVADOC:512 | void | jakarta.servlet.http.HttpServletResponse.sendError
(
int
)
| Sends an error response to the client using the specified status code and clearing the buffer.
| true |
| true |
| Servlet:JAVADOC:513 | void | jakarta.servlet.http.HttpServletResponse.sendError
(
int
)
throws
IOException
| If an input or output exception occurs | true |
| false |
| Servlet:JAVADOC:514 | void | jakarta.servlet.http.HttpServletResponse.sendError
(
int
)
throws
IllegalStateException
| If the response was committed before this method call | true |
| true |
| Servlet:JAVADOC:515 | void | jakarta.servlet.http.HttpServletResponse.sendRedirect
(
String
)
| Sends a temporary redirect response to the client using the specified redirect location URL.
This method can accept relative URLs; the servlet container must convert the relative URL to an absolute URL before sending the response to the client. If the location is relative without a leading '/' the container interprets it as relative to the current request URI.
| true |
| true |
| Servlet:JAVADOC:516 | void | jakarta.servlet.http.HttpServletResponse.sendRedirect
(
String
)
| Sends a temporary redirect response to the client using the specified redirect location URL.
If the location is relative with a leading '/' the container interprets it as relative to the servlet container root.
| true |
| true |
| Servlet:JAVADOC:518 | void | jakarta.servlet.http.HttpServletResponse.sendRedirect
(
String
)
throws
IOException
| If an input or output exception occurs | true |
| false |
| Servlet:JAVADOC:519 | void | jakarta.servlet.http.HttpServletResponse.sendRedirect
(
String
)
throws
IllegalStateException
| If the response was committed or if a partial URL is given and cannot be converted into a valid URL | true |
| true |
| Servlet:JAVADOC:520 | void | jakarta.servlet.http.HttpServletResponse.setDateHeader
(
String
,
long
)
| Sets a response header with the given name and date-value.
The date is specified in terms of milliseconds since the epoch.
| true |
| true |
| Servlet:JAVADOC:521 | void | jakarta.servlet.http.HttpServletResponse.setDateHeader
(
String
,
long
)
| Sets a response header with the given name and date-value.
If the header had already been set, the new value overwrites the previous one.
| true |
| true |
| Servlet:JAVADOC:522 | void | jakarta.servlet.http.HttpServletResponse.addDateHeader
(
String
,
long
)
| Adds a response header with the given name and date-value.
The date is specified in terms of milliseconds since the epoch. This method allows response headers to have multiple values.
| true |
| true |
| Servlet:JAVADOC:523 | void | jakarta.servlet.http.HttpServletResponse.setHeader
(
String
,
String
)
| Sets a response header with the given name and value. | true |
| true |
| Servlet:JAVADOC:524 | void | jakarta.servlet.http.HttpServletResponse.setHeader
(
String
,
String
)
| Sets a response header with the given name and value.
If the header had already been set, the new value overwrites the previous one.
| true |
| true |
| Servlet:JAVADOC:525 | void | jakarta.servlet.http.HttpServletResponse.addHeader
(
String
,
String
)
| Adds a response header with the given name and value.
This method allows response headers to have multiple values.
| true |
| true |
| Servlet:JAVADOC:526 | void | jakarta.servlet.http.HttpServletResponse.setIntHeader
(
String
,
int
)
| Sets a response header with the given name and integer value.
If the header had already been set, the new value overwrites the previous one. The containsHeader method can be used to test for the presence of a header before setting its value.
| true |
| true |
| Servlet:JAVADOC:527 | void | jakarta.servlet.http.HttpServletResponse.addIntHeader
(
String
,
int
)
| Adds a response header with the given name and integer value.
This method allows response headers to have multiple values.
| true |
| true |
| Servlet:JAVADOC:528 | void | jakarta.servlet.http.HttpServletResponse.setStatus
(
int
)
| Sets the status code for this response.
This method is used to set the return status code when there is no error (for example, for the status codes SC_OK or SC_MOVED_TEMPORARILY). The container clears the buffer and sets the Location header, preserving cookies and other headers.
| true |
| true |
| Servlet:JAVADOC:529 | void | jakarta.servlet.http.HttpServletResponse.setStatus
(
int
,
String
)
|
| true | true | true |
| Servlet:JAVADOC:530 | String | 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. Same as the value of the CGI variable AUTH_TYPE.
XXX
| true |
| true |
| Servlet:JAVADOC:531 | Cookie[] | jakarta.servlet.http.HttpServletRequest.getCookies
| Returns an array containing all of the Cookie objects the client sent with this request.
| true |
| true |
| Servlet:JAVADOC:532 | Cookie[] | jakarta.servlet.http.HttpServletRequest.getCookies
|
This method returns null if no cookies were sent.
| true |
| true |
| Servlet:JAVADOC:533 | long | jakarta.servlet.http.HttpServletRequest.getDateHeader
(
String
)
| Returns the value of the specified request header as a long value that represents a Date object.
The date is returned as the number of milliseconds since January 1, 1970 GMT. The header name is case insensitive.
| true |
| true |
| Servlet:JAVADOC:534 | long | jakarta.servlet.http.HttpServletRequest.getDateHeader
(
String
)
| Returns the value of the specified request header as a long value that represents a Date object.
if the request did not have a header of the specified name, this method returns -1.
| true |
| true |
| Servlet:JAVADOC:535 | long | jakarta.servlet.http.HttpServletRequest.getDateHeader
(
String
)
throws
IllegalArgumentException
| If the header value can't be converted to a date | true |
| true |
| Servlet:JAVADOC:536 | String | jakarta.servlet.http.HttpServletRequest.getHeader
(
String
)
| Returns the value of the specified request header as a String.
The header name is case insensitive.
| true |
| true |
| Servlet:JAVADOC:537 | String | jakarta.servlet.http.HttpServletRequest.getHeader
(
String
)
|
If the request does not include a header of the specified name, this method returns null.
| true |
| true |
| Servlet:JAVADOC:538 | Enumeration | jakarta.servlet.http.HttpServletRequest.getHeaders
(
String
)
| 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. The header name is case insensitive.
| true |
| true |
| Servlet:JAVADOC:539 | Enumeration | jakarta.servlet.http.HttpServletRequest.getHeaders
(
String
)
| If the request did not include any headers of the specified name, this method returns an empty Enumeration.
| true |
| true |
| Servlet:JAVADOC:540 | Enumeration | jakarta.servlet.http.HttpServletRequest.getHeaderNames
| Returns an enumeration of all the header names this request contains.
Some servlet containers do not allow do not allow servlets to access headers using this method, in which case this method returns null
| true |
| true |
| Servlet:JAVADOC:541 | Enumeration | jakarta.servlet.http.HttpServletRequest.getHeaderNames
|
If the request has no headers, this method returns an empty enumeration. Some servlet containers do not allow do not allow servlets to access headers using this method, in which case this method returns null
| true |
| false |
| Servlet:JAVADOC:542 | int | jakarta.servlet.http.HttpServletRequest.getIntHeader
(
String
)
| Returns the value of the specified request header as an int.
The header name is case insensitive.
| true |
| true |
| Servlet:JAVADOC:543 | int | jakarta.servlet.http.HttpServletRequest.getIntHeader
(
String
)
|
If the request does not have a header of the specified name, this method returns -1.
| true |
| true |
| Servlet:JAVADOC:544 | int | jakarta.servlet.http.HttpServletRequest.getIntHeader
(
String
)
throws
NumberFormatException
| If the header value can't be converted to an int | true |
| true |
| Servlet:JAVADOC:545 | String | jakarta.servlet.http.HttpServletRequest.getMethod
| Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
Same as the value of the CGI variable REQUEST_METHOD.
| true |
| true |
| Servlet:JAVADOC:546 | String | 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. Same as the value of the CGI variable PATH_INFO.
| true |
| true |
| Servlet:JAVADOC:547 | String | jakarta.servlet.http.HttpServletRequest.getPathInfo
| This method returns null if there was no extra path information.
| true |
| true |
| Servlet:JAVADOC:548 | String | 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.
Same as the value of the CGI variable PATH_TRANSLATED. The web container does not decode this string.
| true |
| true |
| Servlet:JAVADOC:549 | String | jakarta.servlet.http.HttpServletRequest.getPathTranslated
|
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).
| true |
| true |
| Servlet:JAVADOC:550 | String | 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.
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 ServletContext.getContextPath() method. The context path returned by ServletContext.getContextPath() should be considered as the prime or preferred context path of the application.
| true |
| true |
| Servlet:JAVADOC:551 | String | jakarta.servlet.http.HttpServletRequest.getContextPath
|
For servlets in the default (root) context, this method returns "". The container does not decode this string.
| true |
| false |
| Servlet:JAVADOC:552 | String | jakarta.servlet.http.HttpServletRequest.getQueryString
| Returns the query string that is contained in the request URL after the path.
Same as the value of the CGI variable QUERY_STRING.
| true |
| true |
| Servlet:JAVADOC:553 | String | jakarta.servlet.http.HttpServletRequest.getQueryString
| This method returns null if the URL does not have a query string.
| true |
| true |
| Servlet:JAVADOC:554 | String | 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. Same as the value of the CGI variable REMOTE_USER.
| true |
| true |
| Servlet:JAVADOC:555 | boolean | jakarta.servlet.http.HttpServletRequest.isUserInRole
(
String
)
| 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.
| true |
| true |
| Servlet:JAVADOC:556 | boolean | jakarta.servlet.http.HttpServletRequest.isUserInRole
(
String
)
|
If the user has not been authenticated, the method returns false.
| true |
| true |
| Servlet:JAVADOC:947 | boolean | jakarta.servlet.http.HttpServletRequest.isUserInRole
(
String
)
| 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.
| true |
| true |
| Servlet:JAVADOC:557 | Principal | jakarta.servlet.http.HttpServletRequest.getUserPrincipal
| Returns a java.security.Principal object containing the name of the current authenticated user.
| true |
| true |
| Servlet:JAVADOC:558 | Principal | jakarta.servlet.http.HttpServletRequest.getUserPrincipal
|
If the user has not been authenticated, the method returns null.
| true |
| true |
| Servlet:JAVADOC:559 | String | jakarta.servlet.http.HttpServletRequest.getRequestedSessionId
| Returns the session ID specified by the client.
This may not be the same as the ID of the actual session in use. For example, if the request specified an old (expired) session ID and the server has started a new session, this method gets a new session with a new ID. If the request did not specify a session ID, this method returns null.
| true |
| true |
| Servlet:JAVADOC:560 | String | jakarta.servlet.http.HttpServletRequest.getRequestedSessionId
|
If the request did not specify a session ID, this method returns null.
| true |
| true |
| Servlet:JAVADOC:561 | String | 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.
| true |
| true |
| Servlet:JAVADOC:562 | StringBuffer | 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 RequestDispatcher.forward(ServletRequest, ServletResponse) , 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.
| true |
| true |
| Servlet:JAVADOC:563 | String | 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 either the servlet name or a path to the servlet, but does not include any extra path information or a query string. Same as the value of the CGI variable SCRIPT_NAME. This method will return an empty string ("") if the servlet used to process this request was matched using the "/*" pattern.
| true |
| true |
| Servlet:JAVADOC:564 | String | jakarta.servlet.http.HttpServletRequest.getServletPath
|
This method will return an empty string ("") if the servlet used to process this request was matched using the "/*" pattern.
| true |
| true |
| Servlet:JAVADOC:565 | HttpSession | jakarta.servlet.http.HttpServletRequest.getSession
(
boolean
)
| Returns the current HttpSession associated with this request or, if if there is no current session and create is true, returns a new session.
| true |
| true |
| Servlet:JAVADOC:566 | HttpSession | jakarta.servlet.http.HttpServletRequest.getSession
(
boolean
)
| If create is false and the request has no valid HttpSession, this method returns null. | true |
| true |
| Servlet:JAVADOC:567 | HttpSession | jakarta.servlet.http.HttpServletRequest.getSession
| Returns the current session associated with this request, or if the request does not have a session, creates one.
| true |
| true |
| Servlet:JAVADOC:568 | boolean | 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: true if this request has an id for a valid session in the current session context; false otherwise
| true |
| true |
| Servlet:JAVADOC:569 | boolean | jakarta.servlet.http.HttpServletRequest.isRequestedSessionIdFromCookie
| Checks whether the requested session ID came in as a cookie.
| true |
| true |
| Servlet:JAVADOC:570 | boolean | jakarta.servlet.http.HttpServletRequest.isRequestedSessionIdFromURL
| Checks whether the requested session ID came in as part of the request URL.
| true |
| true |
| Servlet:JAVADOC:571 | boolean | jakarta.servlet.http.HttpServletRequest.isRequestedSessionIdFromUrl
|
| true | true | true |
| Servlet:JAVADOC:572 | Object | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.getAttribute
(
String
)
| Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
Attributes can be set two ways. The servlet container may set attributes to make available custom information about a request.
For example, for requests made using HTTPS, the attribute jakarta.servlet.request.X509Certificate can be used to retrieve information
on the certificate of the client.
Attributes can also be set programatically using setAttribute(java.lang.String, java.lang.Object).
This allows information to be embedded into a request before a RequestDispatcher call.
Attribute names should follow the same conventions as package names.
This specification reserves names matching java.*, jakarta.*, and sun.*.
| true |
| true |
| Servlet:JAVADOC:573 | Enumeration | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.getAttributeNames
| Returns an Enumeration containing the names of the attributes available to this request.
This method returns an empty Enumeration if the request has no attributes available to it.
| true |
| true |
| Servlet:JAVADOC:574 | String | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.getCharacterEncoding
|
Returns the name of the character encoding used in the body of this request.
This method returns null if the request does not specify a character encoding
| true |
| true |
| Servlet:JAVADOC:575 | int | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.getContentLength
|
Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known.
For HTTP servlets, same as the value of the CGI variable CONTENT_LENGTH.
| true |
| true |
| Servlet:JAVADOC:576 | String | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.getContentType
| Returns the MIME type of the body of the request, or null if the type is not known.
For HTTP servlets, same as the value of the CGI variable CONTENT_TYPE.
| true |
| true |
| Servlet:JAVADOC:577 | ServletInputStream | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.getInputStream
| Retrieves the body of the request as binary data using a ServletInputStream.
Either this method or getReader() may be called to read the body, not both.
| true |
| true |
| Servlet:JAVADOC:578 | ServletInputStream | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.getInputStream
throws
IOException
| if an input or output exception occurred | true |
| false |
| Servlet:JAVADOC:579 | ServletInputStream | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.getInputStream
throws
IllegalStateException
| if the getReader method has already been called for this request | true |
| true |
| Servlet:JAVADOC:580 | Locale | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.getLocale
| Returns the preferred Locale that the client will accept content in, based on the Accept-Language header.
If the client request doesn't provide an Accept-Language header, this method returns the default locale for the server.
| true |
| true |
| Servlet:JAVADOC:581 | Enumeration | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.getLocales
| Returns an Enumeration of Locale objects indicating,
in decreasing order starting with the preferred locale,
the locales that are acceptable to the client based on the Accept-Language header.
If the client request doesn't provide an Accept-Language header,
this method returns an Enumeration containing one Locale, the default locale for the server.
| true |
| true |
| Servlet:JAVADOC:582 | String | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.getParameter
(
String
)
| Returns the value of a request parameter as a String, or null if the parameter does not exist.
Request parameters are extra information sent with the request.
For HTTP servlets, parameters are contained in the query string or posted form data.
You should only use this method when you are sure the parameter has only one value.
If the parameter might have more than one value, use getParameterValues(java.lang.String).
If you use this method with a multivalued parameter, the value returned is equal to the first value in the array returned by getParameterValues.
If the parameter data was sent in the request body, such as occurs with an HTTP POST request,
then reading the body directly via getInputStream() or getReader() can interfere with the execution of this method.
| true |
| true |
| Servlet:JAVADOC:583 | Map | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.getParameterMap
| Returns a java.util.Map of the parameters of this request.
Request parameters are extra information sent with the request.
For HTTP servlets, parameters are contained in the query string or posted form data.
| true |
| true |
| Servlet:JAVADOC:584 | Enumeration | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.getParameterNames
| Returns an Enumeration of String objects containing the names of the parameters contained in this request.
If the request has no parameters, the method returns an empty Enumeration.
| true |
| true |
| Servlet:JAVADOC:585 | String[] | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.getParameterValues
(
String
)
| Returns an array of String objects containing all of the values the given request parameter has,
or null if the parameter does not exist.
If the parameter has a single value, the array has a length of 1.
| true |
| true |
| Servlet:JAVADOC:586 | String | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.getProtocol
| Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion,
for example, HTTP/1.1.
For HTTP servlets, the value returned is the same as the value of the CGI variable SERVER_PROTOCOL.
| true |
| true |
| Servlet:JAVADOC:587 | BufferedReader | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.getReader
| Retrieves the body of the request as character data using a BufferedReader.
The reader translates the character data according to the character encoding used on the body.
Either this method or getInputStream() may be called to read the body, not both.
| true |
| true |
| Servlet:JAVADOC:588 | BufferedReader | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.getReader
throws
IOException
| if an input or output exception occurred | true |
| false |
| Servlet:JAVADOC:589 | BufferedReader | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.getReader
throws
UnsupportedEncodingException
| if the character set encoding used is not supported and the text cannot be decoded | true |
| true |
| Servlet:JAVADOC:590 | BufferedReader | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.getReader
throws
IllegalStateException
| if getInputStream method has been called on this request | true |
| true |
| Servlet:JAVADOC:591 | String | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.getRealPath
(
String
)
|
| true | true | true |
| Servlet:JAVADOC:592 | String | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.getRemoteAddr
| Returns the Internet Protocol (IP) address of the client that sent the request.
For HTTP servlets, same as the value of the CGI variable REMOTE_ADDR.
| true |
| true |
| Servlet:JAVADOC:593 | String | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.getRemoteHost
| Returns the fully qualified name of the client that sent the request.
If the engine cannot or chooses not to resolve the hostname (to improve performance),
this method returns the dotted-string form of the IP address.
For HTTP servlets, same as the value of the CGI variable REMOTE_HOST.
| true |
| true |
| Servlet:JAVADOC:594 | RequestDispatcher | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.getRequestDispatcher
(
String
)
| Returns a object that acts as a wrapper for the resource located at the given path.
A RequestDispatcher object can be used to forward a request to the resource or to include the resource in a response.
The resource can be dynamic or static.
The pathname specified may be relative, although it cannot extend outside the current servlet context.
If the path begins with a "/" it is interpreted as relative to the current context root.
This method returns null if the servlet container cannot return a RequestDispatcher.
The difference between this method and is that this method can take a relative path.
| true |
| true |
| Servlet:JAVADOC:595 | String | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.getScheme
| Returns the name of the scheme used to make this request, for example, http, https, or ftp.
Different schemes have different rules for constructing URLs, as noted in RFC 1738.
| true |
| true |
| Servlet:JAVADOC:596 | String | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.getServerName
| Returns the host name of the server that received the request.
For HTTP servlets, same as the value of the CGI variable SERVER_NAME.
| true |
| true |
| Servlet:JAVADOC:597 | int | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.getServerPort
| Returns the port number on which this request was received.
For HTTP servlets, same as the value of the CGI variable SERVER_PORT.
| true |
| true |
| Servlet:JAVADOC:598 | boolean | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.isSecure
| Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS. | true |
| true |
| Servlet:JAVADOC:599 | void | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.removeAttribute
(
String
)
| Removes an attribute from this request.
This method is not generally needed as attributes only persist as long as the request is being handled.
Attribute names should follow the same conventions as package names.
Names beginning with java.*, jakarta.*, and com.sun.*, are reserved for use by Sun Microsystems.
| true |
| true |
| Servlet:JAVADOC:600 | void | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.setAttribute
(
String
,
Object
)
| Stores an attribute in this request.
Attributes are reset between requests.
This method is most often used in conjunction with RequestDispatcher.
Attribute names should follow the same conventions as package names.
Names beginning with java.*, jakarta.*, and com.sun.*, are reserved for use by the Eclipse Foundation.
If the value passed in is null, the effect is the same as calling removeAttribute(java.lang.String).
It is warned that when the request is dispatched from the servlet resides in a different web application by RequestDispatcher,
the object set by this method may not be correctly retrieved in the caller servlet.
| true |
| true |
| Servlet:JAVADOC:601 | void | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.setCharacterEncoding
(
String
)
| Overrides the name of the character encoding used in the body of this request.
This method must be called prior to reading request parameters or reading input using getReader().
Otherwise, it has no effect.
| true |
| true |
| Servlet:JAVADOC:602 | void | jakarta.servlet.http.HttpServletRequest.{jakarta.servlet.ServletRequest}.setCharacterEncoding
(
String
)
throws
UnsupportedEncodingException
| if this ServletRequest is still in a state where a character encoding may be set, but the specified encoding is invalid | true |
| true |
| Servlet:JAVADOC:603 | void | jakarta.servlet.http.HttpServletResponse.{jakarta.servlet.ServletResponse}.flushBuffer
| Forces any content in the buffer to be written to the client.
A call to this method automatically commits the response, meaning the status code and headers will be written.
| true |
| true |
| Servlet:JAVADOC:604 | void | jakarta.servlet.http.HttpServletResponse.{jakarta.servlet.ServletResponse}.flushBuffer
throws
IOException
|
| true |
| false |
| Servlet:JAVADOC:605 | int | jakarta.servlet.http.HttpServletResponse.{jakarta.servlet.ServletResponse}.getBufferSize
| Returns the actual buffer size used for the response.
If no buffering is used, this method returns 0.
| true |
| true |
| Servlet:JAVADOC:606 | String | jakarta.servlet.http.HttpServletResponse.{jakarta.servlet.ServletResponse}.getCharacterEncoding
| Returns the name of the charset used for the MIME body sent in this response.
If no charset has been assigned, it is implicitly set to ISO-8859-1 (Latin-1).
See RFC 2047 (http://ds.internic.net/rfc/rfc2045.txt) for more information about character encoding and MIME.
| true |
| true |
| Servlet:JAVADOC:607 | String | jakarta.servlet.http.HttpServletResponse.{jakarta.servlet.ServletResponse}.getContentType
| Returns the MIME type of the body of the request, or null if the type is not known.
For HTTP servlets, same as the value of the CGI variable CONTENT_TYPE.
| true |
| true |
| Servlet:JAVADOC:608 | Locale | jakarta.servlet.http.HttpServletResponse.{jakarta.servlet.ServletResponse}.getLocale
| Returns the locale assigned to the response. | true |
| true |
| Servlet:JAVADOC:609 | ServletOutputStream | jakarta.servlet.http.HttpServletResponse.{jakarta.servlet.ServletResponse}.getOutputStream
| Returns a suitable for writing binary data in the response.
The servlet container does not encode the binary data.
Calling flush() on the ServletOutputStream commits the response.
Either this method or getWriter() may be called to write the body, not both.
| true |
| true |
| Servlet:JAVADOC:610 | ServletOutputStream | jakarta.servlet.http.HttpServletResponse.{jakarta.servlet.ServletResponse}.getOutputStream
throws
IOException
| if an input or output exception occurred | true |
| false |
| Servlet:JAVADOC:611 | ServletOutputStream | jakarta.servlet.http.HttpServletResponse.{jakarta.servlet.ServletResponse}.getOutputStream
throws
IllegalStateException
| if the getWriter method has been called on this response | true |
| true |
| Servlet:JAVADOC:612 | PrintWriter | jakarta.servlet.http.HttpServletResponse.{jakarta.servlet.ServletResponse}.getWriter
| Returns a PrintWriter object that can send character text to the client.
The PrintWriter uses the character encoding returned by getCharacterEncoding().
If the response's character encoding has not been specified as described in getCharacterEncoding
(i.e., the method just returns the default value ISO-8859-1), getWriter updates it to ISO-8859-1.
Calling flush() on the PrintWriter commits the response.
Either this method or getOutputStream() may be called to write the body, not both, except when reset() has been called.
| true |
| true |
| Servlet:JAVADOC:613 | PrintWriter | jakarta.servlet.http.HttpServletResponse.{jakarta.servlet.ServletResponse}.getWriter
throws
IOException
| if an input or output exception occurred | true |
| false |
| Servlet:JAVADOC:614 | PrintWriter | jakarta.servlet.http.HttpServletResponse.{jakarta.servlet.ServletResponse}.getWriter
throws
UnsupportedEncodingException
| if the character encoding returned by getCharacterEncoding cannot be used | true |
| false |
| Servlet:JAVADOC:615 | PrintWriter | jakarta.servlet.http.HttpServletResponse.{jakarta.servlet.ServletResponse}.getWriter
throws
IllegalStateException
| if the getOutputStream method has already been called for this response object | true |
| true |
| Servlet:JAVADOC:616 | boolean | jakarta.servlet.http.HttpServletResponse.{jakarta.servlet.ServletResponse}.isCommitted
| Returns a boolean indicating if the response has been committed.
A commited response has already had its status code and headers written.
| true |
| true |
| Servlet:JAVADOC:617 | void | jakarta.servlet.http.HttpServletResponse.{jakarta.servlet.ServletResponse}.reset
| Clears any data that exists in the buffer as well as the status code and headers.
If the response has been committed, this method throws an IllegalStateException.
| true |
| true |
| Servlet:JAVADOC:618 | void | jakarta.servlet.http.HttpServletResponse.{jakarta.servlet.ServletResponse}.reset
throws
IllegalStateException
| if the response has already been committed | true |
| true |
| Servlet:JAVADOC:619 | void | jakarta.servlet.http.HttpServletResponse.{jakarta.servlet.ServletResponse}.resetBuffer
| Clears the content of the underlying buffer in the response without clearing headers or status code.
If the response has been committed, this method throws an IllegalStateException.
| true |
| true |
| Servlet:JAVADOC:620 | void | jakarta.servlet.http.HttpServletResponse.{jakarta.servlet.ServletResponse}.setBufferSize
(
int
)
| Sets the preferred buffer size for the body of the response.
The servlet container will use a buffer at least as large as the size requested.
The actual buffer size used can be found using getBufferSize.
A larger buffer allows more content to be written before anything is actually sent,
thus providing the servlet with more time to set appropriate status codes and headers.
A smaller buffer decreases server memory load and allows the client to start receiving data more quickly.
This method must be called before any response body content is written;
if content has been written, this method throws an IllegalStateException.
| true |
| true |
| Servlet:JAVADOC:621 | void | jakarta.servlet.http.HttpServletResponse.{jakarta.servlet.ServletResponse}.setBufferSize
(
int
)
throws
IllegalStateException
| if this method is called after content has been written | true |
| true |
| Servlet:JAVADOC:622 | void | jakarta.servlet.http.HttpServletResponse.{jakarta.servlet.ServletResponse}.setCharacterEncoding
(
String
)
| Overrides the name of the character encoding used in the body of the request.
This method must be called prior to reading request parameters or reading input using getReader().
| true |
| true |
| Servlet:JAVADOC:623 | void | jakarta.servlet.http.HttpServletResponse.{jakarta.servlet.ServletResponse}.setContentLength
(
int
)
| Sets the length of the content body in the response.
In HTTP servlets, this method sets the HTTP Content-Length header.
| true |
| true |
| Servlet:JAVADOC:624 | void | jakarta.servlet.http.HttpServletResponse.{jakarta.servlet.ServletResponse}.setContentType
(
String
)
| Sets the content type of the response being sent to the client.
The content type may include the type of character encoding used, for example, text/html; charset=ISO-8859-4.
If obtaining a PrintWriter, this method should be called first.
| true |
| true |
| Servlet:JAVADOC:625 | void | jakarta.servlet.http.HttpServletResponse.{jakarta.servlet.ServletResponse}.setLocale
(
Locale
)
| Sets the locale of the response, if the response has not been committed yet.
It also sets the response's character encoding appropriately for the locale,
if the character encoding has not been explicitly set using setContentType(java.lang.String)
or setCharacterEncoding(java.lang.String), getWriter hasn't been called yet, and the response hasn't been committed yet.
If the deployment descriptor contains a locale-encoding-mapping-list element,
and that element provides a mapping for the given locale, that mapping is used.
Otherwise, the mapping from locale to character encoding is container dependent.
This method may be called repeatedly to change locale and character encoding.
The method has no effect if called after the response has been committed.
It does not set the response's character encoding if it is called after
setContentType(java.lang.String) has been called with a charset specification,
after setCharacterEncoding(java.lang.String) has been called, after getWriter has been called,
or after the response has been committed.
Containers must communicate the locale and the character encoding used for the servlet response's writer
to the client if the protocol provides a way for doing so. In the case of HTTP,
the locale is communicated via the Content-Language header,
the character encoding as part of the Content-Type header for text media types.
Note that the character encoding cannot be communicated via HTTP headers if the servlet does not specify a content type;
however, it is still used to encode text written via the servlet response's writer.
| true |
| true |
| Servlet:JAVADOC:626 | HttpServletRequestWrapper | jakarta.servlet.http.HttpServletRequestWrapper.HttpServletRequestWrapper
(
HttpServletRequest
)
throws
IllegalStateException
| If the request is null. | true |
| true |
| Servlet:JAVADOC:627 | int | jakarta.servlet.ServletInputStream.readLine
(
byte[]
,
int
,
int
)
| Reads the input stream, one line at a time.
This method returns -1 if it reaches the end of the input stream before reading the maximum number of bytes.
| true |
| false |
| Servlet:JAVADOC:628 | Cookie | jakarta.servlet.http.Cookie.Cookie
(
String
,
String
)
throws
IllegalArgumentException
| if the cookie name contains illegal characters (for example, a comma, space, or semicolon)
or it is one of the tokens reserved for use by the cookie protocol
| true |
| true |
| Servlet:JAVADOC:629 | String | jakarta.servlet.http.HttpServletRequest.getLocalName
| Returns the host name of the Internet Protocol (IP) interface on which the request was received.
| true |
| true |
| Servlet:JAVADOC:630 | int | jakarta.servlet.http.HttpServletRequest.getLocalPort
| Returns the Internet Protocol (IP) port number of the interface
on which the request was received.
| true |
| true |
| Servlet:JAVADOC:631 | int | jakarta.servlet.http.HttpServletRequestWrapper.getLocalPort
| The default behavior of this method is to return getLocalPort() on the wrapped
request object.
| true |
| true |
| Servlet:JAVADOC:632 | String | jakarta.servlet.ServletRequest.getLocalName
| Returns the host name of the Internet Protocol (IP) interface on which the request was received.
| true |
| true |
| Servlet:JAVADOC:633 | String | jakarta.servlet.ServletRequestWrapper.getLocalName
| The default behavior of this method is to return getLocalName() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:634 | String | jakarta.servlet.http.HttpServletRequestWrapper.getLocalName
| The default behavior of this method is to return getLocalName() on the wrapped request object.
| true |
| true |
| Servlet:JAVADOC:635 | int | jakarta.servlet.ServletRequest.getLocalPort
| Returns the Internet Protocol (IP) port number of the interface
on which the request was received.
| true |
| true |
| Servlet:JAVADOC:636 | int | jakarta.servlet.ServletRequestWrapper.getLocalPort
| The default behavior of this method is to return getLocalPort() on the wrapped
request object.
| true |
| true |
| Servlet:JAVADOC:637 | String | jakarta.servlet.ServletContext.getContextPath
| Returns the context path of the web application.
The context path is the portion of the request URI that is used to select the context of the request.
The context path always comes first in a request URI. If this context is the "default"
context rooted at the base of the Web server's URL name space, this path will be an empty string.
Otherwise, if the context is not rooted at the root of the server's URL name space,
the path starts with a / character but does not end with a / character.
It is possible that a servlet container may match a context by more than one context path.
In such cases the jakarta.servlet.http.HttpServletRequest#getContextPath() will return the actual context path
used by the request and it may differ from the path returned by this method.
The context path returned by this method should be considered as the prime or preferred context path of the application.
| true |
| true |
| Servlet:JAVADOC:638 | void | jakarta.servlet.AsyncContext.complete
| Completes the asynchronous operation that was started on the request
that was used to initialze this AsyncContext, closing the response that was used to initialize this AsyncContext.
Any listeners of type AsyncListener that were added to the request that was used to initialize this AsyncContext
will have their AsyncListener#onComplete(AsyncEvent) method invoked.
It is legal to call this method any time after a call to ServletRequest#startAsync()
or ServletRequest#startAsync(ServletRequest, ServletResponse),
and before a call to one of the dispatch methods of this class.
If this method is called before the container-initiated dispatch that called startAsync has returned to the container,
then the call will not take effect (and any invocations of AsyncListener#onComplete(AsyncEvent) will be delayed)
until after the container-initiated dispatch has returned to the container. | true |
| true |
| Servlet:JAVADOC:638.1 | void | jakarta.servlet.AsyncContext.complete
| Any listeners of type AsyncListener that were added to the request that was used to initialize this AsyncContext will have their AsyncListener#onComplete(AsyncEvent) method invoked. | true |
| true |
| Servlet:JAVADOC:638.2 | void | jakarta.servlet.AsyncContext.complete
| It is legal to call this method any time after a call to ServletRequest#startAsync() or ServletRequest#startAsync(ServletRequest, ServletResponse), and before a call to one of the dispatch methods of this class. If this method is called before the container-initiated dispatch that called startAsync has returned to the container, then the call will not take effect (and any invocations of AsyncListener#onComplete(AsyncEvent) will be delayed) until after the container-initiated dispatch has returned to the container. | true |
| true |
| Servlet:JAVADOC:639 | void | jakarta.servlet.AsyncContext.dispatch
| Dispatches the request and response objects of this AsyncContext to the servlet container. If the asynchronous cycle was started with ServletRequest#startAsync(ServletRequest, ServletResponse) then the dispatch is to the URI of the request passed to startAsync. If the asynchronous cycle was started with ServletRequest#startAsync(), then the dispatch is to the URI of the request when it was last dispatched by the container. The following sequence illustrates how this will work: // REQUEST dispatch to /url/A AsyncContext ac = request.startAsync(); ... ac.dispatch(); // ASYNC dispatch to /url/A // FORWARD dispatch to /url/B getRequestDispatcher("/url/B").forward(request,response); // Start async operation from within the target of the FORWARD // dispatch ac = request.startAsync(); ... ac.dispatch(); // ASYNC dispatch to /url/A // FORWARD dispatch to /url/B getRequestDispatcher("/url/B").forward(request,response); // Start async operation from within the target of the FORWARD // dispatch ac = request.startAsync(request,response); ... ac.dispatch(); // ASYNC dispatch to /url/B This method returns immediately after passing the request and response objects to a container managed thread, on which the dispatch operation will be performed. The dispatcher type of the request is set to DispatcherType.ASYNC. Unlike RequestDispatcher#forward(ServletRequest, ServletResponse) forward dispatches, the response buffer and headers will not be reset, and it is legal to dispatch even if the response has already been committed. Control over the request and response is delegated to the dispatch target, and the response will be closed when the dispatch target has completed execution, unless ServletRequest#startAsync() or ServletRequest#startAsync(ServletRequest, ServletResponse) are called. | true |
| true |
| Servlet:JAVADOC:639.1 | void | jakarta.servlet.AsyncContext.dispatch
| If the asynchronous cycle was started with ServletRequest.startAsync(ServletRequest, ServletResponse), and the request passed is an instance of HttpServletRequest, then the dispatch is to the URI returned by HttpServletRequest.getRequestURI(). | true |
| true |
| Servlet:JAVADOC:639.2 | void | jakarta.servlet.AsyncContext.dispatch
| Otherwise, the dispatch is to the URI of the request when it was last dispatched by the container. | true |
| true |
| Servlet:JAVADOC:639.3 | void | jakarta.servlet.AsyncContext.dispatch
| This method returns immediately after passing the request and response objects to a container managed thread, on which the dispatch operation will be performed. | true |
| true |
| Servlet:JAVADOC:639.4 | void | jakarta.servlet.AsyncContext.dispatch
| The dispatcher type of the request is set to DispatcherType.ASYNC. Unlike forward dispatches, the response buffer and headers will not be reset, and it is legal to dispatch even if the response has already been committed. | true |
| true |
| Servlet:JAVADOC:639.5 | void | jakarta.servlet.AsyncContext.dispatch
| Control over the request and response is delegated to the dispatch target, and the response will be closed when the dispatch target has completed execution, unless ServletRequest.startAsync() or ServletRequest.startAsync(ServletRequest, ServletResponse) are called. | true |
| true |
| Servlet:JAVADOC:639.6 | void | jakarta.servlet.AsyncContext.dispatch
| Any errors or exceptions that may occur during the execution of this method must be caught and handled by the container, as follows: 1. Invoke, at their onError method, all AsyncListener instances registered with the ServletRequest for which this AsyncContext was created, and make the caught Throwable available via AsyncEvent.getThrowable(). | true |
| true |
| Servlet:JAVADOC:639.7 | void | jakarta.servlet.AsyncContext.dispatch
| 2. If none of the listeners called complete() or any of the dispatch() methods, perform an error dispatch with a status code equal to HttpServletResponse.SC_INTERNAL_SERVER_ERROR, and make the above Throwable available as the value of the RequestDispatcher.ERROR_EXCEPTION request attribute. | true |
| true |
| Servlet:JAVADOC:639.8 | void | jakarta.servlet.AsyncContext.dispatch
| 3. If no matching error page was found, or the error page did not call complete() or any of the dispatch() methods, call complete(). | true |
| true |
| Servlet:JAVADOC:639.9 | void | jakarta.servlet.AsyncContext.dispatch
| There can be at most one asynchronous dispatch operation per asynchronous cycle, which is started by a call to one of the ServletRequest.startAsync() methods. Any attempt to perform an additional asynchronous dispatch operation within the same asynchronous cycle will result in an IllegalStateException. | true |
| true |
| Servlet:JAVADOC:639.10 | void | jakarta.servlet.AsyncContext.dispatch
| If startAsync is subsequently called on the dispatched request, then any of the dispatch or complete() methods may be called. | true |
| true |
| Servlet:JAVADOC:639.11 | void | jakarta.servlet.AsyncContext.dispatch
throws
IllegalStateException
| if one of the dispatch methods has been called and the startAsync method has not been called during the resulting dispatch, or if complete() was called | true |
| true |
| Servlet:JAVADOC:639.12 | void | jakarta.servlet.AsyncContext.dispatch
| Unlike forward dispatches, the response buffer and headers will not be reset,
and it is legal to dispatch even if the response has already been committed.
| true |
| true |
| Servlet:JAVADOC:640 | void | jakarta.servlet.AsyncContext.dispatch
(
String
)
| Dispatches the request and response objects of this AsyncContext to the given path. The path parameter is interpreted in the same way as in ServletRequest#getRequestDispatcher(String), within the scope of the ServletContext from which this AsyncContext was initialized. All path related query methods of the request must reflect the dispatch target, while the original request URI, context path, path info, servlet path, and query string may be recovered from the #ASYNC_REQUEST_URI, #ASYNC_CONTEXT_PATH, #ASYNC_PATH_INFO, #ASYNC_SERVLET_PATH, and #ASYNC_QUERY_STRING attributes of the request. These attributes will always reflect the original path elements, even under repeated dispatches. See #dispatch() for additional details. | true |
| true |
| Servlet:JAVADOC:640.1 | void | jakarta.servlet.AsyncContext.dispatch
(
String
)
| The path parameter is interpreted in the same way as in ServletRequest.getRequestDispatcher(String), within the scope of the ServletContext from which this AsyncContext was initialized. | true |
| true |
| Servlet:JAVADOC:640.2 | void | jakarta.servlet.AsyncContext.dispatch
(
String
)
| All path related query methods of the request must reflect the dispatch target, while the original request URI, context path, path info, servlet path, and query string may be recovered from the ASYNC_REQUEST_URI, ASYNC_CONTEXT_PATH, ASYNC_PATH_INFO, ASYNC_SERVLET_PATH, and ASYNC_QUERY_STRING attributes of the request. These attributes will always reflect the original path elements, even under repeated dispatches. | true |
| true |
| Servlet:JAVADOC:640.3 | void | jakarta.servlet.AsyncContext.dispatch
(
String
)
| There can be at most one asynchronous dispatch operation per asynchronous cycle, which is started by a call to one of the ServletRequest.startAsync() methods. Any attempt to perform an additional asynchronous dispatch operation within the same asynchronous cycle will result in an IllegalStateException. | true |
| true |
| Servlet:JAVADOC:640.4 | void | jakarta.servlet.AsyncContext.dispatch
(
String
)
| If startAsync is subsequently called on the dispatched request, then any of the dispatch or complete() methods may be called. | true |
| true |
| Servlet:JAVADOC:640.5 | void | jakarta.servlet.AsyncContext.dispatch
(
String
)
| Any errors or exceptions that may occur during the execution of this method must be caught and handled by the container, as follows: 1. Invoke, at their onError method, all AsyncListener instances registered with the ServletRequest for which this AsyncContext was created, and make the caught Throwable available via AsyncEvent.getThrowable(). | true |
| true |
| Servlet:JAVADOC:640.6 | void | jakarta.servlet.AsyncContext.dispatch
(
String
)
| 2. If none of the listeners called complete() or any of the dispatch() methods, perform an error dispatch with a status code equal to HttpServletResponse.SC_INTERNAL_SERVER_ERROR, and make the above Throwable available as the value of the RequestDispatcher.ERROR_EXCEPTION request attribute. | true |
| true |
| Servlet:JAVADOC:640.7 | void | jakarta.servlet.AsyncContext.dispatch
(
String
)
| 3. If no matching error page was found, or the error page did not call complete() or any of the dispatch() methods, call complete(). | true |
| true |
| Servlet:JAVADOC:640.8 | void | jakarta.servlet.AsyncContext.dispatch
(
String
)
throws
IllegalStateException
| if one of the dispatch methods has been called and the startAsync method has not been called during the resulting dispatch, or if complete() was called | true |
| true |
| Servlet:JAVADOC:641 | void | jakarta.servlet.AsyncContext.dispatch
(
ServletContext
,
String
)
| Dispatches the request and response objects of this AsyncContext to the given path scoped to the given context. The path parameter is interpreted in the same way as in ServletRequest#getRequestDispatcher(String), except that it is scoped to the given context. All path related query methods of the request must reflect the dispatch target, while the original request URI, context path, path info, servlet path, and query string may be recovered from the #ASYNC_REQUEST_URI, #ASYNC_CONTEXT_PATH, #ASYNC_PATH_INFO, #ASYNC_SERVLET_PATH, and #ASYNC_QUERY_STRING attributes of the request. These attributes will always reflect the original path elements, even under repeated dispatches. See #dispatch() for additional details. | true |
| true |
| Servlet:JAVADOC:641.1 | void | jakarta.servlet.AsyncContext.dispatch
(
ServletContext
,
String
)
| The path parameter is interpreted in the same way as in ServletRequest.getRequestDispatcher(String), except that it is scoped to the given context. | true |
| true |
| Servlet:JAVADOC:641.2 | void | jakarta.servlet.AsyncContext.dispatch
(
ServletContext
,
String
)
| All path related query methods of the request must reflect the dispatch target, while the original request URI, context path, path info, servlet path, and query string may be recovered from the ASYNC_REQUEST_URI, ASYNC_CONTEXT_PATH, ASYNC_PATH_INFO, ASYNC_SERVLET_PATH, and ASYNC_QUERY_STRING attributes of the request. These attributes will always reflect the original path elements, even under repeated dispatches. | true |
| true |
| Servlet:JAVADOC:641.3 | void | jakarta.servlet.AsyncContext.dispatch
(
ServletContext
,
String
)
| There can be at most one asynchronous dispatch operation per asynchronous cycle, which is started by a call to one of the ServletRequest.startAsync() methods. Any attempt to perform an additional asynchronous dispatch operation within the same asynchronous cycle will result in an IllegalStateException. | true |
| true |
| Servlet:JAVADOC:641.4 | void | jakarta.servlet.AsyncContext.dispatch
(
ServletContext
,
String
)
| If startAsync is subsequently called on the dispatched request, then any of the dispatch or complete() methods may be called. | true |
| true |
| Servlet:JAVADOC:641.5 | void | jakarta.servlet.AsyncContext.dispatch
(
ServletContext
,
String
)
| Any errors or exceptions that may occur during the execution of this method must be caught and handled by the container, as follows: 1. Invoke, at their onError method, all AsyncListener instances registered with the ServletRequest for which this AsyncContext was created, and make the caught Throwable available via AsyncEvent.getThrowable(). | true |
| true |
| Servlet:JAVADOC:641.6 | void | jakarta.servlet.AsyncContext.dispatch
(
ServletContext
,
String
)
| 2. If none of the listeners called complete() or any of the dispatch() methods, perform an error dispatch with a status code equal to HttpServletResponse.SC_INTERNAL_SERVER_ERROR, and make the above Throwable available as the value of the RequestDispatcher.ERROR_EXCEPTION request attribute. | true |
| true |
| Servlet:JAVADOC:641.7 | void | jakarta.servlet.AsyncContext.dispatch
(
ServletContext
,
String
)
| 3. If no matching error page was found, or the error page did not call complete() or any of the dispatch() methods, call complete(). | true |
| true |
| Servlet:JAVADOC:641.8 | void | jakarta.servlet.AsyncContext.dispatch
(
ServletContext
,
String
)
throws
IllegalStateException
| if one of the dispatch methods has been called and the startAsync method has not been called during the resulting dispatch, or if complete() was called | true |
| true |
| Servlet:JAVADOC:642 | ServletRequest | jakarta.servlet.AsyncContext.getRequest
| Gets the request that was used to initialize this AsyncContext
by calling ServletRequest#startAsync()
or ServletRequest#startAsync(ServletRequest, ServletResponse).
| true |
| true |
| Servlet:JAVADOC:927 | ServletRequest | jakarta.servlet.AsyncContext.getRequest
throws
IllegalStateException
| if complete() or any of the dispatch() methods
has been called in the asynchronous cycle
| true |
| true |
| Servlet:JAVADOC:643 | ServletResponse | jakarta.servlet.AsyncContext.getResponse
| Gets the response that was used to initialize this AsyncContext
by calling ServletRequest#startAsync()
or ServletRequest#startAsync(ServletRequest, ServletResponse).
| true |
| true |
| Servlet:JAVADOC:928 | ServletResponse | jakarta.servlet.AsyncContext.getResponse
throws
IllegalStateException
| if complete() or any of the dispatch() methods
has been called in the asynchronous cycle
| true |
| true |
| Servlet:JAVADOC:644 | boolean | jakarta.servlet.AsyncContext.hasOriginalRequestAndResponse
| Checks if this AsyncContext was initialized with the original request and response objects by calling ServletRequest#startAsync(), or if it was initialized with wrapped request and/or response objects using ServletRequest#startAsync(ServletRequest, ServletResponse). This information may be used by filters invoked in the outbound direction, after a request was put into asynchronous mode, to determine whether any request and/or response wrappers that they added during their inbound invocation need to be preserved for the duration of the asynchronous operation, or may be released. | true |
| true |
| Servlet:JAVADOC:645 | void | jakarta.servlet.AsyncContext.start
(
Runnable
)
| Causes the container to dispatch a thread to run the specified Runnable in the ServletContext that initialized this AsyncContext. | true |
| true |
| Servlet:JAVADOC:649 | void | jakarta.servlet.AsyncListener.onComplete
(
AsyncEvent
)
| Notifies this AsyncListener that an asynchronous operation has been completed. | true |
| true |
| Servlet:JAVADOC:649.1 | void | jakarta.servlet.AsyncListener.onComplete
(
AsyncEvent
)
| The AsyncContext corresponding to the asynchronous operation that has been completed may be obtained by calling AsyncEvent#getAsyncContext getAsyncContext on the given event. | true |
| true |
| Servlet:JAVADOC:649.2 | void | jakarta.servlet.AsyncListener.onComplete
(
AsyncEvent
)
| In addition, if this AsyncListener had been registered via a call to AsyncContext#addListener(AsyncListener, ServletRequest, ServletResponse), the supplied ServletRequest and ServletResponse objects may be retrieved by calling AsyncEvent#getSuppliedRequest getSuppliedRequest and AsyncEvent#getSuppliedResponse getSuppliedResponse, respectively, on the given event. | true |
| true |
| Servlet:JAVADOC:650 | void | jakarta.servlet.AsyncListener.onComplete
(
AsyncEvent
)
throws
IOException
| if an I/O related error has occurred during the processing of the given AsyncEvent | true |
| true |
| Servlet:JAVADOC:651 | void | jakarta.servlet.AsyncListener.onTimeout
(
AsyncEvent
)
| Notifies this AsyncListener that an asynchronous operation has timed out. | true |
| true |
| Servlet:JAVADOC:651.1 | void | jakarta.servlet.AsyncListener.onTimeout
(
AsyncEvent
)
| The AsyncContext corresponding to the asynchronous operation that has timed out may be obtained by calling AsyncEvent#getAsyncContext getAsyncContext on the given event. | true |
| true |
| Servlet:JAVADOC:651.2 | void | jakarta.servlet.AsyncListener.onTimeout
(
AsyncEvent
)
| In addition, if this AsyncListener had been registered via a call to AsyncContext#addListener(AsyncListener, ServletRequest, ServletResponse), the supplied ServletRequest and ServletResponse objects may be retrieved by calling AsyncEvent#getSuppliedRequest getSuppliedRequest and AsyncEvent#getSuppliedResponse getSuppliedResponse, respectively, on the given event. | true |
| true |
| Servlet:JAVADOC:652 | void | jakarta.servlet.AsyncListener.onTimeout
(
AsyncEvent
)
throws
IOException
| if an I/O related error has occurred during the processing of the given AsyncEvent | true |
| true |
| Servlet:JAVADOC:653 | DispatcherType | jakarta.servlet.DispatcherType.valueOf
(
String
)
|
| true |
| true |
| Servlet:JAVADOC:654 | DispatcherType[] | jakarta.servlet.DispatcherType.values
|
| true |
| true |
| Servlet:JAVADOC:655 | void | jakarta.servlet.FilterRegistration.addMappingForServletNames
(
EnumSet
,
boolean
,
String[]
)
| Adds a filter mapping with the given servlet names and dispatcher types for the Filter represented by this FilterRegistration. | true |
| true |
| Servlet:JAVADOC:655.1 | void | jakarta.servlet.FilterRegistration.addMappingForServletNames
(
EnumSet
,
boolean
,
String[]
)
| Filter mappings are matched in the order in which they were added. | true |
| true |
| Servlet:JAVADOC:655.2 | void | jakarta.servlet.FilterRegistration.addMappingForServletNames
(
EnumSet
,
boolean
,
String[]
)
| Depending on the value of the isMatchAfter parameter, the given filter mapping will be considered after or before any declared filter mappings of the ServletContext from which this FilterRegistration was obtained. | true |
| true |
| Servlet:JAVADOC:655.3 | void | jakarta.servlet.FilterRegistration.addMappingForServletNames
(
EnumSet
,
boolean
,
String[]
)
| If this method is called multiple times, each successive call adds to the effects of the former. | true |
| true |
| Servlet:JAVADOC:655.4 | void | jakarta.servlet.FilterRegistration.addMappingForServletNames
(
EnumSet
,
boolean
,
String[]
)
throws
IllegalArgumentException
| if servletNames is null or empty | true |
| true |
| Servlet:JAVADOC:655.4 | void | jakarta.servlet.FilterRegistration.addMappingForServletNames
(
EnumSet
,
boolean
,
String[]
)
throws
IllegalStateException
| if the ServletContext from which this FilterRegistration was obtained has already been initialized | true |
| true |
| Servlet:JAVADOC:656 | void | jakarta.servlet.FilterRegistration.addMappingForUrlPatterns
(
EnumSet
,
boolean
,
String[]
)
| Adds a filter mapping with the given url patterns and dispatcher types for the Filter represented by this FilterRegistration. | true |
| true |
| Servlet:JAVADOC:656.1 | void | jakarta.servlet.FilterRegistration.addMappingForUrlPatterns
(
EnumSet
,
boolean
,
String[]
)
| Filter mappings are matched in the order in which they were added. | true |
| true |
| Servlet:JAVADOC:656.2 | void | jakarta.servlet.FilterRegistration.addMappingForUrlPatterns
(
EnumSet
,
boolean
,
String[]
)
| Depending on the value of the isMatchAfter parameter, the given filter mapping will be considered after or before any declared filter mappings of the ServletContext from which this FilterRegistration was obtained. | true |
| true |
| Servlet:JAVADOC:656.3 | void | jakarta.servlet.FilterRegistration.addMappingForUrlPatterns
(
EnumSet
,
boolean
,
String[]
)
| If this method is called multiple times, each successive call adds to the effects of the former. | true |
| true |
| Servlet:JAVADOC:656.4 | void | jakarta.servlet.FilterRegistration.addMappingForUrlPatterns
(
EnumSet
,
boolean
,
String[]
)
throws
IllegalArgumentException
| if urlPatterns is null or empty | true |
| true |
| Servlet:JAVADOC:656.5 | void | jakarta.servlet.FilterRegistration.addMappingForUrlPatterns
(
EnumSet
,
boolean
,
String[]
)
throws
IllegalStateException
| if the ServletContext from which this FilterRegistration was obtained has already been initialized | true |
| true |
| Servlet:JAVADOC:657 | Collection | jakarta.servlet.FilterRegistration.getServletNameMappings
| Gets the currently available servlet name mappings of the Filter represented by this FilterRegistration. Any changes to the returned Collection must not affect this FilterRegistration. | true |
| true |
| Servlet:JAVADOC:658 | Collection | jakarta.servlet.FilterRegistration.getUrlPatternMappings
| Gets the currently available URL pattern mappings of the Filter represented by this FilterRegistration. Any changes to the returned Collection must not affect this FilterRegistration. | true |
| true |
| Servlet:JAVADOC:659 | String | jakarta.servlet.Registration.getClassName
| Gets the fully qualified class name of the Servlet or Filter that is represented by this Registration. | true |
| true |
| Servlet:JAVADOC:660 | String | jakarta.servlet.Registration.getInitParameter
(
String
)
| Gets the value of the initialization parameter with the given name that will be used to initialize the Servlet or Filter represented by this Registration object. | true |
| true |
| Servlet:JAVADOC:661 | Map | jakarta.servlet.Registration.getInitParameters
| Gets an immutable (and possibly empty) Map containing the currently available initialization parameters that will be used to initialize the Servlet or Filter represented by this Registration object. | true |
| true |
| Servlet:JAVADOC:662 | String | jakarta.servlet.Registration.getName
| Gets the name of the Servlet or Filter that is represented by this Registration. | true |
| true |
| Servlet:JAVADOC:663 | boolean | jakarta.servlet.Registration.setInitParameter
(
String
,
String
)
| Sets the initialization parameter with the given name and value on the Servlet or Filter that is represented by this Registration. | true |
| true |
| Servlet:JAVADOC:663.1 | boolean | jakarta.servlet.Registration.setInitParameter
(
String
,
String
)
throws
IllegalStateException
| if the ServletContext from which this Registration was obtained has already been initialized | true |
| true |
| Servlet:JAVADOC:663.2 | boolean | jakarta.servlet.Registration.setInitParameter
(
String
,
String
)
throws
IllegalArgumentException
| if the given name or value is null | true |
| true |
| Servlet:JAVADOC:664 | Set | jakarta.servlet.Registration.setInitParameters
(
Map
)
| Sets the given initialization parameters on the Servlet or Filter that is represented by this Registration. The given map of initialization parameters is processed by-value, i.e., for each initialization parameter contained in the map, this method calls #setInitParameter(String,String). If that method would return false for any of the initialization parameters in the given map, no updates will be performed, and false will be returned. Likewise, if the map contains an initialization parameter with a null name or value, no updates will be performed, and an IllegalArgumentException will be thrown. | true |
| true |
| Servlet:JAVADOC:664.1 | Set | jakarta.servlet.Registration.setInitParameters
(
Map
)
throws
IllegalStateException
| if the ServletContext from which this Registration was obtained has already been initialized | true |
| true |
| Servlet:JAVADOC:664.2 | Set | jakarta.servlet.Registration.setInitParameters
(
Map
)
throws
IllegalArgumentException
| if the given map contains an initialization parameter with a null name or value | true |
| true |
| Servlet:JAVADOC:665 | void | jakarta.servlet.Registration.Dynamic.setAsyncSupported
(
boolean
)
| Configures the Servlet or Filter represented by this dynamic Registration as supporting asynchronous operations or not. By default, servlet and filters do not support asynchronous operations. A call to this method overrides any previous setting. | true |
| true |
| Servlet:JAVADOC:665.1 | void | jakarta.servlet.Registration.Dynamic.setAsyncSupported
(
boolean
)
throws
IllegalStateException
| if the ServletContext from which this dynamic Registration was obtained has already been initialized | true |
| true |
| Servlet:JAVADOC:666 | void | jakarta.servlet.ServletContainerInitializer.onStartup
(
Set
,
ServletContext
)
| Notifies this ServletContainerInitializer of the startup of the application represented by the given ServletContext. | true |
| true |
| Servlet:JAVADOC:666.1 | void | jakarta.servlet.ServletContainerInitializer.onStartup
(
Set
,
ServletContext
)
| If this ServletContainerInitializer is bundled in a JAR file inside the WEB-INF/lib directory of an application, its onStartup method will be invoked only once during the startup of the bundling application. | true |
| true |
| Servlet:JAVADOC:666.2 | void | jakarta.servlet.ServletContainerInitializer.onStartup
(
Set
,
ServletContext
)
| If this ServletContainerInitializer is bundled inside a JAR file outside of any WEB-INF/lib directory, but still discoverable by the runtime's service provider lookup mechanism, its onStartup method will be invoked every time an application is started. | true |
| true |
| Servlet:JAVADOC:667 | void | jakarta.servlet.ServletContainerInitializer.onStartup
(
Set
,
ServletContext
)
throws
ServletException
| if an error has occurred | true |
| true |
| Servlet:JAVADOC:668 | Dynamic | jakarta.servlet.ServletContext.addFilter
(
String
,
String
)
| Adds the filter with the given name and class name to this servlet context. The registered filter may be further configured via the returned FilterRegistration object. The specified className will be loaded using the classloader associated with the application represented by this ServletContext. | true |
| true |
| Servlet:JAVADOC:668.1 | Dynamic | jakarta.servlet.ServletContext.addFilter
(
String
,
String
)
| If this ServletContext already contains a preliminary FilterRegistration for a filter with the given filterName, it will be completed (by assigning the name of the given filterClass to it) and returned. | true |
| false |
| Servlet:JAVADOC:668.2 | Dynamic | jakarta.servlet.ServletContext.addFilter
(
String
,
String
)
| This method supports resource injection if the given filterClass represents a Managed Bean. See the Jakarta EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection. | true |
| true |
| Servlet:JAVADOC:668.3 | Dynamic | jakarta.servlet.ServletContext.addFilter
(
String
,
String
)
| Returns: a FilterRegistration object that may be used to further configure the registered filter, | true |
| true |
| Servlet:JAVADOC:668.4 | Dynamic | jakarta.servlet.ServletContext.addFilter
(
String
,
String
)
| Returns: or null if this ServletContext already contains a complete FilterRegistration for a filter with the given filterName. | true |
| true |
| Servlet:JAVADOC:668.5 | Dynamic | jakarta.servlet.ServletContext.addFilter
(
String
,
String
)
throws
IllegalStateException
| if this ServletContext has already been initialized. | true |
| true |
| Servlet:JAVADOC:951 | Dynamic | jakarta.servlet.ServletContext.addFilter
(
String
,
String
)
throws
IllegalArgumentException
| if filterName is null or an empty String | true |
| true |
| Servlet:JAVADOC:668.6 | Dynamic | jakarta.servlet.ServletContext.addFilter
(
String
,
String
)
throws
UnsupportedOperationException
| if this ServletContext was passed to the ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener | true |
| true |
| Servlet:JAVADOC:669 | Dynamic | jakarta.servlet.ServletContext.addFilter
(
String
,
Filter
)
| Registers the given filter instance with this ServletContext under the given filterName. The registered filter may be further configured via the returned FilterRegistration object. | true |
| true |
| Servlet:JAVADOC:669.1 | Dynamic | jakarta.servlet.ServletContext.addFilter
(
String
,
Filter
)
| If this ServletContext already contains a preliminary FilterRegistration for a filter with the given filterName, it will be completed (by assigning the name of the given filterClass to it) and returned. | true |
| false |
| Servlet:JAVADOC:669.2 | Dynamic | jakarta.servlet.ServletContext.addFilter
(
String
,
Filter
)
| This method supports resource injection if the given filterClass represents a Managed Bean. See the Jakarta EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection. | true |
| true |
| Servlet:JAVADOC:669.3 | Dynamic | jakarta.servlet.ServletContext.addFilter
(
String
,
Filter
)
| Returns: a FilterRegistration object that may be used to further configure the registered filter. | true |
| true |
| Servlet:JAVADOC:669.4 | Dynamic | jakarta.servlet.ServletContext.addFilter
(
String
,
Filter
)
| Returns: or null if this ServletContext already contains a complete FilterRegistration for a filter with the given filterName | true |
| true |
| Servlet:JAVADOC:669.5 | Dynamic | jakarta.servlet.ServletContext.addFilter
(
String
,
Filter
)
| Returns: null if the same filter instance has already been registered with this or another ServletContext in the same container | true |
| true |
| Servlet:JAVADOC:669.6 | Dynamic | jakarta.servlet.ServletContext.addFilter
(
String
,
Filter
)
throws
IllegalStateException
| if this ServletContext has already been initialized. | true |
| true |
| Servlet:JAVADOC:952 | Dynamic | jakarta.servlet.ServletContext.addFilter
(
String
,
Filter
)
throws
IllegalArgumentException
| if filterName is null or an empty String | true |
| true |
| Servlet:JAVADOC:669.7 | Dynamic | jakarta.servlet.ServletContext.addFilter
(
String
,
Filter
)
throws
UnsupportedOperationException
| if this ServletContext was passed to the ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener | true |
| true |
| Servlet:JAVADOC:670 | Dynamic | jakarta.servlet.ServletContext.addFilter
(
String
,
Class
)
| Adds the filter with the given name and class type to this servlet context. The registered filter may be further configured via the returned FilterRegistration object. | true |
| true |
| Servlet:JAVADOC:670.1 | Dynamic | jakarta.servlet.ServletContext.addFilter
(
String
,
Class
)
| If this ServletContext already contains a preliminary FilterRegistration for a filter with the given filterName, it will be completed (by assigning the name of the given filterClass to it) and returned. | true |
| false |
| Servlet:JAVADOC:670.2 | Dynamic | jakarta.servlet.ServletContext.addFilter
(
String
,
Class
)
| This method supports resource injection if the given filterClass represents a Managed Bean. See the Jakarta EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection. | true |
| true |
| Servlet:JAVADOC:670.3 | Dynamic | jakarta.servlet.ServletContext.addFilter
(
String
,
Class
)
| Returns: a FilterRegistration object that may be used to further configure the registered filter. | true |
| true |
| Servlet:JAVADOC:670.4 | Dynamic | jakarta.servlet.ServletContext.addFilter
(
String
,
Class
)
| Returns: or null if this ServletContext already contains a complete FilterRegistration for a filter with the given filterName | true |
| true |
| Servlet:JAVADOC:670.5 | Dynamic | jakarta.servlet.ServletContext.addFilter
(
String
,
Class
)
throws
IllegalStateException
| if this ServletContext has already been initialized. | true |
| true |
| Servlet:JAVADOC:953 | Dynamic | jakarta.servlet.ServletContext.addFilter
(
String
,
Class
)
throws
IllegalArgumentException
| if filterName is null or an empty String | true |
| true |
| Servlet:JAVADOC:670.6 | Dynamic | jakarta.servlet.ServletContext.addFilter
(
String
,
Class
)
throws
UnsupportedOperationException
| if this ServletContext was passed to the ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener | true |
| true |
| Servlet:JAVADOC:671 | void | jakarta.servlet.ServletContext.addListener
(
String
)
| Adds the listener with the given class name to this ServletContext. The class with the given name will be loaded using the classloader associated with the application represented by this ServletContext, and must implement one or more of the following interfaces: ServletContextAttributeListenerServletRequestListenerServletRequestAttributeListenerjakarta.servlet.http.HttpSessionListenerjakarta.servlet.http.HttpSessionAttributeListener If this ServletContext was passed to ServletContainerInitializer#onStartup, then the class with the given name may also implement ServletContextListener, in addition to the interfaces listed above. As part of this method call, the container must load the class with the specified class name to ensure that it implements one of the required interfaces. If the class with the given name implements a listener interface whose invocation order corresponds to the declaration order (i.e., if it implements ServletRequestListener, ServletContextListener, or jakarta.servlet.http.HttpSessionListener), then the new listener will be added to the end of the ordered list of listeners of that interface. | true | true | true |
| Servlet:JAVADOC:671.1 | void | jakarta.servlet.ServletContext.addListener
(
String
)
| Adds the listener with the given class name to this ServletContext. The class with the given name will be loaded using the classloader associated with the application represented by this ServletContext, and must implement one or more of the following interfaces: ServletContextAttributeListener | true |
| true |
| Servlet:JAVADOC:671.2 | void | jakarta.servlet.ServletContext.addListener
(
String
)
| Adds the listener with the given class name to this ServletContext. The class with the given name will be loaded using the classloader associated with the application represented by this ServletContext, and must implement one or more of the following interfaces: ServletRequestListener | true |
| true |
| Servlet:JAVADOC:671.3 | void | jakarta.servlet.ServletContext.addListener
(
String
)
| Adds the listener with the given class name to this ServletContext. The class with the given name will be loaded using the classloader associated with the application represented by this ServletContext, and must implement one or more of the following interfaces: ServletRequestAttributeListener | true |
| true |
| Servlet:JAVADOC:671.4 | void | jakarta.servlet.ServletContext.addListener
(
String
)
| Adds the listener with the given class name to this ServletContext. The class with the given name will be loaded using the classloader associated with the application represented by this ServletContext, and must implement one or more of the following interfaces: jakarta.servlet.http.HttpSessionListener | true |
| true |
| Servlet:JAVADOC:671.5 | void | jakarta.servlet.ServletContext.addListener
(
String
)
| Adds the listener with the given class name to this ServletContext. The class with the given name will be loaded using the classloader associated with the application represented by this ServletContext, and must implement one or more of the following interfaces: jakarta.servlet.http.HttpSessionAttributeListener | true |
| true |
| Servlet:JAVADOC:671.6 | void | jakarta.servlet.ServletContext.addListener
(
String
)
| Adds the listener with the given class name to this ServletContext. ... If this ServletContext was passed to ServletContainerInitializer#onStartup, then the class with the given name may also implement ServletContextListener, in addition to the interfaces listed above. | true |
| true |
| Servlet:JAVADOC:671.7 | void | jakarta.servlet.ServletContext.addListener
(
String
)
| If the class with the given name implements a listener interface whose invocation order corresponds to the declaration order (i.e., if it is an instance of ServletRequestListener, ServletContextListener, or jakarta.servlet.http.HttpSessionListener), then the listener will be added to the end of the ordered list of listeners of that interface. | true |
| true |
| Servlet:JAVADOC:671.8 | void | jakarta.servlet.ServletContext.addListener
(
String
)
| This method supports resource injection if the class with the given className represents a Managed Bean. See the Jakarta EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection. | true |
| true |
| Servlet:JAVADOC:671.9 | void | jakarta.servlet.ServletContext.addListener
(
String
)
throws
IllegalArgumentException
| if the class with the given name does not implement any of the above interfaces | true |
| true |
| Servlet:JAVADOC:671.10 | void | jakarta.servlet.ServletContext.addListener
(
String
)
throws
IllegalArgumentException
| or if it implements ServletContextListener and this ServletContext was not passed to ServletContainerInitializer.onStartup(java.util.Set>, jakarta.servlet.ServletContext) | true |
| true |
| Servlet:JAVADOC:671.11 | void | jakarta.servlet.ServletContext.addListener
(
String
)
throws
IllegalStateException
| if this ServletContext has already been initialized | true |
| true |
| Servlet:JAVADOC:671.12 | void | jakarta.servlet.ServletContext.addListener
(
String
)
throws
UnsupportedOperationException
| if this ServletContext was passed to the ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener | true |
| true |
| Servlet:JAVADOC:672 | void | jakarta.servlet.ServletContext.addListener
(
EventListener
)
| Adds the given listener to this ServletContext. The given listener must be an instance of one or more of the following interfaces: ServletContextAttributeListenerServletRequestListenerServletRequestAttributeListenerjakarta.servlet.http.HttpSessionListenerjakarta.servlet.http.HttpSessionAttributeListener If this ServletContext was passed to ServletContainerInitializer#onStartup, then the given listener may also be an instance of ServletContextListener, in addition to the interfaces listed above. If the given listener is an instance of a listener interface whose invocation order corresponds to the declaration order (i.e., if it is an instance of ServletRequestListener, ServletContextListener, or jakarta.servlet.http.HttpSessionListener), then the listener will be added to the end of the ordered list of listeners of that interface. | true | true | true |
| Servlet:JAVADOC:672.1 | void | jakarta.servlet.ServletContext.addListener
(
EventListener
)
| Adds the given listener to this ServletContext. The given listener must be an instance of one or more of the following interfaces: ServletContextAttributeListener | true |
| true |
| Servlet:JAVADOC:672.2 | void | jakarta.servlet.ServletContext.addListener
(
EventListener
)
| Adds the given listener to this ServletContext. The given listener must be an instance of one or more of the following interfaces: ServletRequestListener | true |
| true |
| Servlet:JAVADOC:672.3 | void | jakarta.servlet.ServletContext.addListener
(
EventListener
)
| Adds the given listener to this ServletContext. The given listener must be an instance of one or more of the following interfaces: ServletRequestAttributeListener | true |
| true |
| Servlet:JAVADOC:672.4 | void | jakarta.servlet.ServletContext.addListener
(
EventListener
)
| Adds the given listener to this ServletContext. The given listener must be an instance of one or more of the following interfaces: jakarta.servlet.http.HttpSessionListener | true |
| true |
| Servlet:JAVADOC:672.5 | void | jakarta.servlet.ServletContext.addListener
(
EventListener
)
| Adds the given listener to this ServletContext. The given listener must be an instance of one or more of the following interfaces: jakarta.servlet.http.HttpSessionAttributeListener | true |
| true |
| Servlet:JAVADOC:672.6 | void | jakarta.servlet.ServletContext.addListener
(
EventListener
)
| Adds the given listener to this ServletContext. ... If this ServletContext was passed to ServletContainerInitializer#onStartup, then the given listener may also be an instance of ServletContextListener, in addition to the interfaces listed above. | true |
| true |
| Servlet:JAVADOC:672.7 | void | jakarta.servlet.ServletContext.addListener
(
EventListener
)
| If the given listener is an instance of a listener interface whose invocation order corresponds to the declaration order (i.e., if it is an instance of ServletRequestListener, ServletContextListener, or jakarta.servlet.http.HttpSessionListener), then the listener will be added to the end of the ordered list of listeners of that interface. | true |
| true |
| Servlet:JAVADOC:672.8 | void | jakarta.servlet.ServletContext.addListener
(
EventListener
)
| This method supports resource injection if the given listenerClass represents a Managed Bean. See the Jakarta EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection. | true |
| true |
| Servlet:JAVADOC:672.9 | void | jakarta.servlet.ServletContext.addListener
(
EventListener
)
throws
IllegalArgumentException
| if the given listenerClass does not implement any of the above interfaces | true |
| true |
| Servlet:JAVADOC:672.10 | void | jakarta.servlet.ServletContext.addListener
(
EventListener
)
throws
IllegalArgumentException
| or if it implements ServletContextListener and this ServletContext was not passed to ServletContainerInitializer.onStartup(java.util.Set>, jakarta.servlet.ServletContext) | true |
| true |
| Servlet:JAVADOC:672.11 | void | jakarta.servlet.ServletContext.addListener
(
EventListener
)
throws
IllegalStateException
| if this ServletContext has already been initialized | true |
| true |
| Servlet:JAVADOC:672.12 | void | jakarta.servlet.ServletContext.addListener
(
EventListener
)
throws
UnsupportedOperationException
| if this ServletContext was passed to the ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener | true |
| true |
| Servlet:JAVADOC:673 | void | jakarta.servlet.ServletContext.addListener
(
Class
)
| Adds a listener of the given class type to this ServletContext. The given listenerClass must implement one or more of the following interfaces: ServletContextAttributeListenerServletRequestListenerServletRequestAttributeListenerjakarta.servlet.http.HttpSessionListenerjakarta.servlet.http.HttpSessionAttributeListener If this ServletContext was passed to ServletContainerInitializer#onStartup, then the given listenerClass may also implement ServletContextListener, in addition to the interfaces listed above. If the given listenerClass</tt implements a listener interface whose invocation order corresponds to the declaration order (i.e., if it implements ServletRequestListener, ServletContextListener, or jakarta.servlet.http.HttpSessionListener), then the new listener will be added to the end of the ordered list of listeners of that interface. | true | true | true |
| Servlet:JAVADOC:673.1 | void | jakarta.servlet.ServletContext.addListener
(
Class
)
| Adds a listener of the given class type to this ServletContext. The given listenerClass must implement one or more of the following interfaces: ServletContextAttributeListener | true |
| true |
| Servlet:JAVADOC:673.2 | void | jakarta.servlet.ServletContext.addListener
(
Class
)
| Adds a listener of the given class type to this ServletContext. The given listenerClass must implement one or more of the following interfaces: ServletRequestListener | true |
| true |
| Servlet:JAVADOC:673.3 | void | jakarta.servlet.ServletContext.addListener
(
Class
)
| Adds a listener of the given class type to this ServletContext. The given listenerClass must implement one or more of the following interfaces: ServletRequestAttributeListener | true |
| true |
| Servlet:JAVADOC:673.4 | void | jakarta.servlet.ServletContext.addListener
(
Class
)
| Adds a listener of the given class type to this ServletContext. The given listenerClass must implement one or more of the following interfaces: jakarta.servlet.http.HttpSessionListener | true |
| true |
| Servlet:JAVADOC:673.5 | void | jakarta.servlet.ServletContext.addListener
(
Class
)
| Adds a listener of the given class type to this ServletContext. The given listenerClass must implement one or more of the following interfaces: jakarta.servlet.http.HttpSessionAttributeListener | true |
| true |
| Servlet:JAVADOC:673.6 | void | jakarta.servlet.ServletContext.addListener
(
Class
)
| Adds a listener of the given class type to this ServletContext. ... If this ServletContext was passed to ServletContainerInitializer#onStartup, then the given listenerClass may also be implement ServletContextListener, in addition to the interfaces listed above. | true |
| true |
| Servlet:JAVADOC:673.7 | void | jakarta.servlet.ServletContext.addListener
(
Class
)
| If the given listenerClass<> implements a listener interface whose invocation order corresponds to the declaration order (i.e., if it is an instance of ServletRequestListener, ServletContextListener, or jakarta.servlet.http.HttpSessionListener), then the listener will be added to the end of the ordered list of listeners of that interface. | true |
| true |
| Servlet:JAVADOC:673.8 | void | jakarta.servlet.ServletContext.addListener
(
Class
)
| This method supports resource injection if the given listenerClass represents a Managed Bean. See the Jakarta EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection. | true |
| true |
| Servlet:JAVADOC:673.9 | void | jakarta.servlet.ServletContext.addListener
(
Class
)
throws
IllegalArgumentException
| if the given listenerClass does not implement any of the above interfaces | true |
| true |
| Servlet:JAVADOC:673.10 | void | jakarta.servlet.ServletContext.addListener
(
Class
)
throws
IllegalArgumentException
| or if it implements ServletContextListener and this ServletContext was not passed to ServletContainerInitializer.onStartup(java.util.Set>, jakarta.servlet.ServletContext) | true |
| true |
| Servlet:JAVADOC:673.11 | void | jakarta.servlet.ServletContext.addListener
(
Class
)
throws
IllegalStateException
| if this ServletContext has already been initialized | true |
| true |
| Servlet:JAVADOC:673.12 | void | jakarta.servlet.ServletContext.addListener
(
Class
)
throws
UnsupportedOperationException
| if this ServletContext was passed to the ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener | true |
| true |
| Servlet:JAVADOC:674 | Dynamic | jakarta.servlet.ServletContext.addServlet
(
String
,
String
)
| Adds the servlet with the given name and class name to this servlet context. The registered servlet may be further configured via the returned ServletRegistration object. The specified className will be loaded using the classloader associated with the application represented by this ServletContext. | true |
| true |
| Servlet:JAVADOC:674.1 | Dynamic | jakarta.servlet.ServletContext.addServlet
(
String
,
String
)
| If this ServletContext already contains a preliminary ServletRegistration for a servlet with the given servletName, it will be completed (by assigning the given className to it) and returned. | true |
| false |
| Servlet:JAVADOC:674.2 | Dynamic | jakarta.servlet.ServletContext.addServlet
(
String
,
String
)
| This method introspects the class with the given className for the ServletSecurity, MultipartConfig, jakarta.annotation.security.RunAs, and jakarta.annotation.security.DeclareRoles annotations. | true |
| true |
| Servlet:JAVADOC:674.3 | Dynamic | jakarta.servlet.ServletContext.addServlet
(
String
,
String
)
| In addition, this method supports resource injection if the class with the given className represents a Managed Bean. See the Jakarta EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection. | true |
| true |
| Servlet:JAVADOC:674.4 | Dynamic | jakarta.servlet.ServletContext.addServlet
(
String
,
String
)
| Returns: a ServletRegistration object that may be used to further configure the registered servlet, | true |
| true |
| Servlet:JAVADOC:674.5 | Dynamic | jakarta.servlet.ServletContext.addServlet
(
String
,
String
)
| Returns: null if this ServletContext already contains a complete ServletRegistration for a servlet with the given servletName | true |
| true |
| Servlet:JAVADOC:674.6 | Dynamic | jakarta.servlet.ServletContext.addServlet
(
String
,
String
)
throws
IllegalStateException
| if this ServletContext has already been initialized | true |
| true |
| Servlet:JAVADOC:674.7 | Dynamic | jakarta.servlet.ServletContext.addServlet
(
String
,
String
)
throws
UnsupportedOperationException
| if this ServletContext was passed to the ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener | true |
| true |
| Servlet:JAVADOC:675 | Dynamic | jakarta.servlet.ServletContext.addServlet
(
String
,
Servlet
)
| Registers the given servlet instance with this ServletContext under the given servletName. The registered servlet may be further configured via the returned ServletRegistration object. | true |
| true |
| Servlet:JAVADOC:675.1 | Dynamic | jakarta.servlet.ServletContext.addServlet
(
String
,
Servlet
)
| If this ServletContext already contains a preliminary ServletRegistration for a servlet with the given servletName, it will be completed (by assigning the given className to it) and returned. | true |
| false |
| Servlet:JAVADOC:675.2 | Dynamic | jakarta.servlet.ServletContext.addServlet
(
String
,
Servlet
)
| This method introspects the class with the given className for the ServletSecurity, MultipartConfig, jakarta.annotation.security.RunAs, and jakarta.annotation.security.DeclareRoles annotations. | true |
| true |
| Servlet:JAVADOC:675.3 | Dynamic | jakarta.servlet.ServletContext.addServlet
(
String
,
Servlet
)
| In addition, this method supports resource injection if the class with the given className represents a Managed Bean. See the Jakarta EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection. | true |
| true |
| Servlet:JAVADOC:675.4 | Dynamic | jakarta.servlet.ServletContext.addServlet
(
String
,
Servlet
)
| Returns: a ServletRegistration object that may be used to further configure the registered servlet, | true |
| true |
| Servlet:JAVADOC:675.5 | Dynamic | jakarta.servlet.ServletContext.addServlet
(
String
,
Servlet
)
| Returns: null if this ServletContext already contains a complete ServletRegistration for a servlet with the given servletName | true |
| true |
| Servlet:JAVADOC:675.6 | Dynamic | jakarta.servlet.ServletContext.addServlet
(
String
,
Servlet
)
| Returns: null or if the same servlet instance has already been registered with this or another ServletContext in the same container | true |
| true |
| Servlet:JAVADOC:675.7 | Dynamic | jakarta.servlet.ServletContext.addServlet
(
String
,
Servlet
)
throws
IllegalStateException
| if this ServletContext has already been initialized | true |
| true |
| Servlet:JAVADOC:949 | Dynamic | jakarta.servlet.ServletContext.addServlet
(
String
,
Servlet
)
throws
IllegalStateException
| if servletName is null or an empty String | true |
| true |
| Servlet:JAVADOC:675.8 | Dynamic | jakarta.servlet.ServletContext.addServlet
(
String
,
Servlet
)
throws
UnsupportedOperationException
| if this ServletContext was passed to the ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener | true |
| true |
| Servlet:JAVADOC:675.9 | Dynamic | jakarta.servlet.ServletContext.addServlet
(
String
,
Servlet
)
throws
IllegalArgumentException
| if the given servletName is null or an empty String | true |
| true |
| Servlet:JAVADOC:676 | Dynamic | jakarta.servlet.ServletContext.addServlet
(
String
,
Class
)
| Adds the servlet with the given name and class type to this servlet context. The registered servlet may be further configured via the returned ServletRegistration object. | true |
| true |
| Servlet:JAVADOC:676.1 | Dynamic | jakarta.servlet.ServletContext.addServlet
(
String
,
Class
)
| If this ServletContext already contains a preliminary ServletRegistration for a servlet with the given servletName, it will be completed (by assigning the given className to it) and returned. | true |
| false |
| Servlet:JAVADOC:676.2 | Dynamic | jakarta.servlet.ServletContext.addServlet
(
String
,
Class
)
| This method introspects the class with the given className for the ServletSecurity, MultipartConfig, jakarta.annotation.security.RunAs, and jakarta.annotation.security.DeclareRoles annotations. | true |
| true |
| Servlet:JAVADOC:676.3 | Dynamic | jakarta.servlet.ServletContext.addServlet
(
String
,
Class
)
| In addition, this method supports resource injection if the class with the given className represents a Managed Bean. See the Jakarta EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection. | true |
| true |
| Servlet:JAVADOC:676.4 | Dynamic | jakarta.servlet.ServletContext.addServlet
(
String
,
Class
)
| Returns: a ServletRegistration object that may be used to further configure the registered servlet, | true |
| true |
| Servlet:JAVADOC:676.5 | Dynamic | jakarta.servlet.ServletContext.addServlet
(
String
,
Class
)
| Returns: null if this ServletContext already contains a complete ServletRegistration for a servlet with the given servletName | true |
| true |
| Servlet:JAVADOC:676.6 | Dynamic | jakarta.servlet.ServletContext.addServlet
(
String
,
Class
)
throws
IllegalStateException
| if this ServletContext has already been initialized | true |
| true |
| Servlet:JAVADOC:950 | Dynamic | jakarta.servlet.ServletContext.addServlet
(
String
,
Class
)
throws
IllegalArgumentException
| if servletName is null or an empty String | true |
| true |
| Servlet:JAVADOC:676.7 | Dynamic | jakarta.servlet.ServletContext.addServlet
(
String
,
Class
)
throws
UnsupportedOperationException
| if this ServletContext was passed to the ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener | true |
| true |
| Servlet:JAVADOC:677 | Filter | jakarta.servlet.ServletContext.createFilter
(
Class
)
| Instantiates the given Filter class and performs any required resource injection into the new Filter instance before returning it. The returned Filter instance may be further customized before it is registered with this ServletContext via a call to #addFilter(String,Filter). | true |
| true |
| Servlet:JAVADOC:677.1 | Filter | jakarta.servlet.ServletContext.createFilter
(
Class
)
| The given Filter class must define a zero argument constructor, which is used to instantiate it. | true |
| true |
| Servlet:JAVADOC:677.2 | Filter | jakarta.servlet.ServletContext.createFilter
(
Class
)
| This method supports resource injection if the given clazz represents a Managed Bean. See the Jakarta EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection. | true |
| true |
| Servlet:JAVADOC:677.3 | Filter | jakarta.servlet.ServletContext.createFilter
(
Class
)
throws
UnsupportedOperationException
| if this ServletContext was passed to the ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener | true |
| true |
| Servlet:JAVADOC:678 | Filter | jakarta.servlet.ServletContext.createFilter
(
Class
)
throws
ServletException
| if an error occurs during the instantiation of, or resource injection into the new Filter | true |
| true |
| Servlet:JAVADOC:679 | EventListener | jakarta.servlet.ServletContext.createListener
(
Class
)
| Instantiates the given EventListener class and performs any required resource injection into the new EventListener instance before returning it. The specified EventListener class must implement at least one of the ServletContextListener, ServletContextAttributeListener, ServletRequestListener, ServletRequestAttributeListener, jakarta.servlet.http.HttpSessionListener, or jakarta.servlet.http.HttpSessionAttributeListener interfaces. The returned EventListener instance may be further customized before it is registered with this ServletContext via a call to #addListener(EventListener). | true | true | true |
| Servlet:JAVADOC:679.1 | EventListener | jakarta.servlet.ServletContext.createListener
(
Class
)
| The given EventListener class must define a zero argument constructor, which is used to instantiate it. | true |
| true |
| Servlet:JAVADOC:679.2 | EventListener | jakarta.servlet.ServletContext.createListener
(
Class
)
| This method supports resource injection if the given clazz represents a Managed Bean. See the Jakarta EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection. | true |
| true |
| Servlet:JAVADOC:679.3 | EventListener | jakarta.servlet.ServletContext.createListener
(
Class
)
throws
UnsupportedOperationException
| if this ServletContext was passed to the ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener | true |
| true |
| Servlet:JAVADOC:679.4 | EventListener | jakarta.servlet.ServletContext.createListener
(
Class
)
throws
IllegalArgumentException
| if the specified EventListener class does not implement any of the ServletContextListener, ServletContextAttributeListener, ServletRequestListener, ServletRequestAttributeListener, HttpSessionListener, or HttpSessionAttributeListener interfaces. | true |
| true |
| Servlet:JAVADOC:680 | EventListener | jakarta.servlet.ServletContext.createListener
(
Class
)
throws
ServletException
| if the given class fails to be instantiated | true |
| true |
| Servlet:JAVADOC:681 | Servlet | jakarta.servlet.ServletContext.createServlet
(
Class
)
| Instantiates the given Servlet class. The returned Servlet instance may be further customized before it is registered with this ServletContext via a call to #addServlet(String,Servlet). The given Servlet class must define a zero argument constructor, which is used to instantiate it. | true |
| true |
| Servlet:JAVADOC:681.1 | Servlet | jakarta.servlet.ServletContext.createServlet
(
Class
)
| This method introspects the given clazz for the following annotations: ServletSecurity, MultipartConfig, jakarta.annotation.security.RunAs, and jakarta.annotation.security.DeclareRoles. | true |
| true |
| Servlet:JAVADOC:681.2 | Servlet | jakarta.servlet.ServletContext.createServlet
(
Class
)
| In addition, this method supports resource injection if the given clazz represents a Managed Bean. See the Jakarta EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection. | true |
| true |
| Servlet:JAVADOC:681.3 | Servlet | jakarta.servlet.ServletContext.createServlet
(
Class
)
throws
UnsupportedOperationException
| if this ServletContext was passed to the ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener | true |
| true |
| Servlet:JAVADOC:682 | Servlet | jakarta.servlet.ServletContext.createServlet
(
Class
)
throws
ServletException
| if the given class fails to be instantiated | true |
| true |
| Servlet:JAVADOC:683 | ClassLoader | jakarta.servlet.ServletContext.getClassLoader
| Gets the class loader of the web application represented by this ServletContext. | true |
| true |
| Servlet:JAVADOC:683.1 | ClassLoader | jakarta.servlet.ServletContext.getClassLoader
| If a security manager exists, and the caller's class loader is not the same as, or an ancestor of the requested class loader, then the security manager's checkPermission method is called with a RuntimePermission("getClassLoader") permission to check whether access to the requested class loader should be granted. | true |
| true |
| Servlet:JAVADOC:683.2 | ClassLoader | jakarta.servlet.ServletContext.getClassLoader
throws
UnsupportedOperationException
| if this ServletContext was passed to the ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener | true |
| true |
| Servlet:JAVADOC:683.3 | ClassLoader | jakarta.servlet.ServletContext.getClassLoader
throws
SecurityException
| if a security manager denies access to the requested class loader | true |
| true |
| Servlet:JAVADOC:684 | Set | jakarta.servlet.ServletContext.getDefaultSessionTrackingModes
| Gets the session tracking modes that are supported by default for this ServletContext. | true |
| true |
| Servlet:JAVADOC:684.1 | Set | jakarta.servlet.ServletContext.getDefaultSessionTrackingModes
throws
UnsupportedOperationException
| if this ServletContext was passed to the ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener | true |
| true |
| Servlet:JAVADOC:685 | int | jakarta.servlet.ServletContext.getEffectiveMajorVersion
| Gets the major version of the Servlet specification that the application represented by this ServletContext is based on. The value returned may be different from #getMajorVersion, which returns the major version of the Servlet specification supported by the Servlet container. | true |
| true |
| Servlet:JAVADOC:685.1 | int | jakarta.servlet.ServletContext.getEffectiveMajorVersion
throws
UnsupportedOperationException
| if this ServletContext was passed to the ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener | true |
| true |
| Servlet:JAVADOC:686 | int | jakarta.servlet.ServletContext.getEffectiveMinorVersion
| Gets the minor version of the Servlet specification that the application represented by this ServletContext is based on. The value returned may be different from #getMinorVersion, which returns the minor version of the Servlet specification supported by the Servlet container. | true |
| true |
| Servlet:JAVADOC:686.1 | int | jakarta.servlet.ServletContext.getEffectiveMinorVersion
throws
UnsupportedOperationException
| if this ServletContext was passed to the ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener | true |
| true |
| Servlet:JAVADOC:687 | Set | jakarta.servlet.ServletContext.getEffectiveSessionTrackingModes
| Gets the session tracking modes that are in effect for this ServletContext. The session tracking modes in effect are those provided to #setSessionTrackingModes setSessionTrackingModes. By default, the session tracking modes returned by #getDefaultSessionTrackingModes getDefaultSessionTrackingModes are in effect. | true |
| true |
| Servlet:JAVADOC:687.1 | Set | jakarta.servlet.ServletContext.getEffectiveSessionTrackingModes
throws
UnsupportedOperationException
| if this ServletContext was passed to the ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener | true |
| true |
| Servlet:JAVADOC:688 | FilterRegistration | jakarta.servlet.ServletContext.getFilterRegistration
(
String
)
| Gets the FilterRegistration corresponding to the filter with the given filterName. | true |
| true |
| Servlet:JAVADOC:688.1 | FilterRegistration | jakarta.servlet.ServletContext.getFilterRegistration
(
String
)
throws
UnsupportedOperationException
| if this ServletContext was passed to the ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener | true |
| true |
| Servlet:JAVADOC:689 | Map | jakarta.servlet.ServletContext.getFilterRegistrations
| Gets a (possibly empty) Map of the FilterRegistration objects (keyed by filter name) corresponding to all filters registered with this ServletContext. The returned Map includes the FilterRegistration objects corresponding to all declared and annotated filters, as well as the FilterRegistration objects corresponding to all filters that have been added via one of the addFilter methods. | true |
| true |
| Servlet:JAVADOC:689.1 | Map | jakarta.servlet.ServletContext.getFilterRegistrations
| Any changes to the returned Map must not affect this ServletContext. | true |
| true |
| Servlet:JAVADOC:689.2 | Map | jakarta.servlet.ServletContext.getFilterRegistrations
throws
UnsupportedOperationException
| if this ServletContext was passed to the ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener | true |
| true |
| Servlet:JAVADOC:690 | JspConfigDescriptor | jakarta.servlet.ServletContext.getJspConfigDescriptor
| Gets the related configuration that was aggregated from the web.xml and web-fragment.xml descriptor files of the web application represented by this ServletContext. | true |
| true |
| Servlet:JAVADOC:690.1 | JspConfigDescriptor | jakarta.servlet.ServletContext.getJspConfigDescriptor
throws
UnsupportedOperationException
| if this ServletContext was passed to the ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener | true |
| true |
| Servlet:JAVADOC:691 | ServletRegistration | jakarta.servlet.ServletContext.getServletRegistration
(
String
)
| Gets the ServletRegistration corresponding to the servlet with the given servletName. | true |
| true |
| Servlet:JAVADOC:691.1 | ServletRegistration | jakarta.servlet.ServletContext.getServletRegistration
(
String
)
throws
UnsupportedOperationException
| if this ServletContext was passed to the ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener | true |
| true |
| Servlet:JAVADOC:692 | Map | jakarta.servlet.ServletContext.getServletRegistrations
| Gets a (possibly empty) Map of the ServletRegistration objects (keyed by servlet name) corresponding to all servlets registered with this ServletContext. The returned Map includes the ServletRegistration objects corresponding to all declared and annotated servlets, as well as the ServletRegistration objects corresponding to all servlets that have been added via one of the addServlet methods. | true |
| true |
| Servlet:JAVADOC:692.1 | Map | jakarta.servlet.ServletContext.getServletRegistrations
| Any changes to the returned Map must not affect this ServletContext. | true |
| true |
| Servlet:JAVADOC:692.2 | Map | jakarta.servlet.ServletContext.getServletRegistrations
throws
UnsupportedOperationException
| if this ServletContext was passed to the ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener | true |
| true |
| Servlet:JAVADOC:693 | SessionCookieConfig | jakarta.servlet.ServletContext.getSessionCookieConfig
| Gets the SessionCookieConfig object through which various properties of the session tracking cookies created on behalf of this ServletContext may be configured. | true |
| true |
| Servlet:JAVADOC:693.1 | SessionCookieConfig | jakarta.servlet.ServletContext.getSessionCookieConfig
| Repeated invocations of this method will return the same SessionCookieConfig instance. | true |
| true |
| Servlet:JAVADOC:693.2 | SessionCookieConfig | jakarta.servlet.ServletContext.getSessionCookieConfig
throws
UnsupportedOperationException
| if this ServletContext was passed to the ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener | true |
| true |
| Servlet:JAVADOC:694 | boolean | jakarta.servlet.ServletContext.setInitParameter
(
String
,
String
)
| Sets the context initialization parameter with the given name and value on this ServletContext. | true |
| true |
| Servlet:JAVADOC:694.1 | boolean | jakarta.servlet.ServletContext.setInitParameter
(
String
,
String
)
throws
IllegalStateException
| if this ServletContext has already been initialized | true |
| true |
| Servlet:JAVADOC:694.2 | boolean | jakarta.servlet.ServletContext.setInitParameter
(
String
,
String
)
throws
UnsupportedOperationException
| if this ServletContext was passed to the ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener | true |
| true |
| Servlet:JAVADOC:695 | void | jakarta.servlet.ServletContext.setSessionTrackingModes
(
Set
)
| Sets the session tracking modes that are to become effective for this ServletContext. The given sessionTrackingModes replaces any session tracking modes set by a previous invocation of this method on this ServletContext. | true |
| true |
| Servlet:JAVADOC:695.1 | void | jakarta.servlet.ServletContext.setSessionTrackingModes
(
Set
)
throws
UnsupportedOperationException
| if this ServletContext was passed to the ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener | true |
| true |
| Servlet:JAVADOC:695.2 | void | jakarta.servlet.ServletContext.setSessionTrackingModes
(
Set
)
throws
IllegalStateException
| if this ServletContext has already been initialized | true |
| true |
| Servlet:JAVADOC:695.3 | void | jakarta.servlet.ServletContext.setSessionTrackingModes
(
Set
)
throws
IllegalArgumentException
| if sessionTrackingModes specifies a combination of SessionTrackingMode.SSL with a session tracking mode other than SessionTrackingMode.SSL, or if sessionTrackingModes specifies a session tracking mode that is not supported by the servlet container | true |
| true |
| Servlet:JAVADOC:696 | Set | jakarta.servlet.ServletRegistration.addMapping
(
String[]
)
| Adds a servlet mapping with the given URL patterns for the Servlet represented by this ServletRegistration.. | true |
| true |
| Servlet:JAVADOC:696.1 | Set | jakarta.servlet.ServletRegistration.addMapping
(
String[]
)
| If any of the specified URL patterns are already mapped to a different Servlet, no updates will be performed. | true |
| true |
| Servlet:JAVADOC:696.2 | Set | jakarta.servlet.ServletRegistration.addMapping
(
String[]
)
| If this method is called multiple times, each successive call adds to the effects of the former. | true |
| true |
| Servlet:JAVADOC:696.3 | Set | jakarta.servlet.ServletRegistration.addMapping
(
String[]
)
throws
IllegalArgumentException
| if urlPatterns is null or empty | true |
| true |
| Servlet:JAVADOC:696.4 | Set | jakarta.servlet.ServletRegistration.addMapping
(
String[]
)
throws
IllegalStateException
| if the ServletContext from which this ServletRegistration was obtained has already been initialized | true |
| true |
| Servlet:JAVADOC:697 | Collection | jakarta.servlet.ServletRegistration.getMappings
| Gets the currently available mappings of the Servlet represented by this ServletRegistration. Any changes to the returned Collection must not affect this ServletRegistration. | true |
| true |
| Servlet:JAVADOC:698 | void | jakarta.servlet.ServletRegistration.Dynamic.setLoadOnStartup
(
int
)
| Sets the loadOnStartup priority on the Servlet represented by this dynamic ServletRegistration. A loadOnStartup value of greater than or equal to zero indicates to the container the initialization priority of the Servlet. In this case, the container must instantiate and initialize the Servlet during the initialization phase of the ServletContext, that is, after it has invoked all of the ServletContextListener objects configured for the ServletContext at their ServletContextListener#contextInitialized method. | true |
| true |
| Servlet:JAVADOC:698.1 | void | jakarta.servlet.ServletRegistration.Dynamic.setLoadOnStartup
(
int
)
| If loadOnStartup is a negative integer, the container is free to instantiate and initialize the Servlet lazily. | true |
| true |
| Servlet:JAVADOC:698.2 | void | jakarta.servlet.ServletRegistration.Dynamic.setLoadOnStartup
(
int
)
| The default value for loadOnStartup is -1. | true |
| true |
| Servlet:JAVADOC:698.3 | void | jakarta.servlet.ServletRegistration.Dynamic.setLoadOnStartup
(
int
)
| A call to this method overrides any previous setting. | true |
| true |
| Servlet:JAVADOC:698.4 | void | jakarta.servlet.ServletRegistration.Dynamic.setLoadOnStartup
(
int
)
throws
IllegalStateException
| if the ServletContext from which this ServletRegistration was obtained has already been initialized | true |
| true |
| Servlet:JAVADOC:701 | AsyncContext | jakarta.servlet.ServletRequest.getAsyncContext
| Gets the AsyncContext that was created or reinitialized by the most recent invocation of #startAsync or #startAsync(ServletRequest,ServletResponse) on this request. | true |
| true |
| Servlet:JAVADOC:701.1 | AsyncContext | jakarta.servlet.ServletRequest.getAsyncContext
throws
IllegalStateException
| if this request has not been put into asynchronous mode, i.e., if neither startAsync() nor startAsync(ServletRequest,ServletResponse) has been called | true |
| true |
| Servlet:JAVADOC:703 | DispatcherType | jakarta.servlet.ServletRequest.getDispatcherType
| Gets the dispatcher type of this request. The dispatcher type of a request is used by the container to select the filters that need to be applied to the request: Only filters with matching dispatcher type and url patterns will be applied. Allowing a filter that has been configured for multiple dispatcher types to query a request for its dispatcher type allows the filter to process the request differently depending on its dispatcher type. The initial dispatcher type of a request is defined as DispatcherType.REQUEST. The dispatcher type of a request dispatched via RequestDispatcher#forward(ServletRequest, ServletResponse) or RequestDispatcher#include(ServletRequest, ServletResponse) is given as DispatcherType.FORWARD or DispatcherType.INCLUDE, respectively, while the dispatcher type of an asynchronous request dispatched via one of the AsyncContext#dispatch methods is given as DispatcherType.ASYNC. Finally, the dispatcher type of a request dispatched to an error page by the container's error handling mechanism is given as DispatcherType.ERROR. | true |
| true |
| Servlet:JAVADOC:704 | String | jakarta.servlet.ServletRequest.getLocalAddr
| Returns the Internet Protocol (IP) address of the interface on which the request was received. | true |
| true |
| Servlet:JAVADOC:705 | int | jakarta.servlet.ServletRequest.getRemotePort
| Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request. | true |
| true |
| Servlet:JAVADOC:706 | ServletContext | jakarta.servlet.ServletRequest.getServletContext
| Gets the servlet context to which this ServletRequest was last dispatched. | true |
| true |
| Servlet:JAVADOC:707 | boolean | jakarta.servlet.ServletRequest.isAsyncStarted
| Checks if this request has been put into asynchronous mode. A ServletRequest is put into asynchronous mode by calling #startAsync or #startAsync(ServletRequest,ServletResponse) on it. This method returns false if this request was put into asynchronous mode, but has since been dispatched using one of the AsyncContext#dispatch methods or released from asynchronous mode via a call to AsyncContext#complete. | true |
| true |
| Servlet:JAVADOC:708 | boolean | jakarta.servlet.ServletRequest.isAsyncSupported
| Checks if this request supports asynchronous operation. Asynchronous operation is disabled for this request if this request is within the scope of a filter or servlet that has not been annotated or flagged in the deployment descriptor as being able to support asynchronous handling. | true |
| true |
| Servlet:JAVADOC:710 | AsyncContext | jakarta.servlet.ServletRequest.startAsync
| Puts this request into asynchronous mode, and initializes its AsyncContext with the original (unwrapped) ServletRequest and ServletResponse objects and the timeout as returned by #getAsyncTimeout. | true |
| true |
| Servlet:JAVADOC:710.1 | AsyncContext | jakarta.servlet.ServletRequest.startAsync
| This will delay committal of the associated response until AsyncContext#complete is called on the returned AsyncContext, or the AsyncContext times out. | true |
| true |
| Servlet:JAVADOC:710.2 | AsyncContext | jakarta.servlet.ServletRequest.startAsync
| Calling AsyncContext#hasOriginalRequestAndResponse() on the returned AsyncContext will return true. | true |
| true |
| Servlet:JAVADOC:710.3 | AsyncContext | jakarta.servlet.ServletRequest.startAsync
| Any filters invoked in the outbound direction after this request was put into asynchronous mode may use this as an indication that any request and/or response wrappers that they added during their inbound invocation need not stay around for the duration of the asynchronous operation, and therefore any of their associated resources may be released. | true |
| true |
| Servlet:JAVADOC:710.4 | AsyncContext | jakarta.servlet.ServletRequest.startAsync
| This method clears the list of AsyncListener instances (if any) that were registered with the AsyncContext returned by the previous call to one of the startAsync methods, after calling each AsyncListener at its onStartAsync method. | true |
| true |
| Servlet:JAVADOC:710.5 | AsyncContext | jakarta.servlet.ServletRequest.startAsync
| Subsequent invocations of this method, or its overloaded variant, will return the same AsyncContext instance, reinitialized as appropriate. | true |
| true |
| Servlet:JAVADOC:710.6 | AsyncContext | jakarta.servlet.ServletRequest.startAsync
| The timer for async timeouts will not start until the container-initiated dispatch that called startAsync has returned to the container.
If a timeout occurs and none of the AsyncListener#onTimeout(AsyncEvent) handlers call AsyncContext#complete or one of the AsyncContext#dispatch methods,
the container must call AsyncContext#complete.
| true |
| true |
| Servlet:JAVADOC:711 | AsyncContext | jakarta.servlet.ServletRequest.startAsync
throws
IllegalStateException
| if this request is within the scope of a filter or servlet that does not support asynchronous operation, that is, if #isAsyncSupported returns false, or if this method is called again outside the scope of a dispatch resulting from an AsyncContext#dispatch, or if the response has already been closed | true |
| true |
| Servlet:JAVADOC:712 | AsyncContext | jakarta.servlet.ServletRequest.startAsync
(
ServletRequest
,
ServletResponse
)
| Puts this request into asynchronous mode, and initializes its AsyncContext with the given request and response objects. | true |
| true |
| Servlet:JAVADOC:712.1 | AsyncContext | jakarta.servlet.ServletRequest.startAsync
(
ServletRequest
,
ServletResponse
)
| The ServletRequest and ServletResponse arguments must be the same instances, or instances of ServletRequestWrapper and ServletResponseWrapper that wrap them, that were passed to the service method of the Servlet or the doFilter method of the Filter, respectively, in whose scope this method is being called. | true |
| true |
| Servlet:JAVADOC:712.2 | AsyncContext | jakarta.servlet.ServletRequest.startAsync
(
ServletRequest
,
ServletResponse
)
| Calling this method will cause committal of the associated response to be delayed until AsyncContext.complete() is called on the returned AsyncContext, or the asynchronous operation has timed out. | true |
| true |
| Servlet:JAVADOC:712.3 | AsyncContext | jakarta.servlet.ServletRequest.startAsync
(
ServletRequest
,
ServletResponse
)
| Calling AsyncContext.hasOriginalRequestAndResponse() on the returned AsyncContext will return false, unless the passed in ServletRequest and ServletResponse arguments are the original ones or do not carry any application-provided wrappers. | true |
| true |
| Servlet:JAVADOC:712.4 | AsyncContext | jakarta.servlet.ServletRequest.startAsync
(
ServletRequest
,
ServletResponse
)
| Any filters invoked in the outbound direction after this request was put into asynchronous mode may use this as an indication that some of the request and/or response wrappers that they added during their inbound invocation may need to stay in place for the duration of the asynchronous operation, and their associated resources may not be released. A ServletRequestWrapper applied during the inbound invocation of a filter may be released by the outbound invocation of the filter only if the given servletRequest, which is used to initialize the AsyncContext and will be returned by a call to AsyncContext.getRequest(), does not contain said ServletRequestWrapper. The same holds true for ServletResponseWrapper instances. | true |
| true |
| Servlet:JAVADOC:712.5 | AsyncContext | jakarta.servlet.ServletRequest.startAsync
(
ServletRequest
,
ServletResponse
)
| This method clears the list of AsyncListener instances (if any) that were registered with the AsyncContext returned by the previous call to one of the startAsync methods, after calling each AsyncListener at its onStartAsync method. | true |
| true |
| Servlet:JAVADOC:712.6 | AsyncContext | jakarta.servlet.ServletRequest.startAsync
(
ServletRequest
,
ServletResponse
)
| Subsequent invocations of this method, or its zero-argument variant, will return the same AsyncContext instance, reinitialized as appropriate. | true |
| true |
| Servlet:JAVADOC:712.7 | AsyncContext | jakarta.servlet.ServletRequest.startAsync
(
ServletRequest
,
ServletResponse
)
| If a call to this method is followed by a call to its zero-argument variant, the specified (and possibly wrapped) request and response objects will remain locked in on the returned AsyncContext. | true |
| true |
| Servlet:JAVADOC:713 | AsyncContext | jakarta.servlet.ServletRequest.startAsync
(
ServletRequest
,
ServletResponse
)
throws
IllegalStateException
| if this request is within the scope of a filter or servlet that does not support asynchronous operation, that is, if #isAsyncSupported returns false, or if this method is called again outside the scope of a dispatch resulting from an AsyncContext#dispatch, or if the response has already been closed | true |
| true |
| Servlet:JAVADOC:716 | AsyncContext | jakarta.servlet.ServletRequestWrapper.getAsyncContext
| Gets the AsyncContext that was created or reinitialized by the most recent invocation of #startAsync or #startAsync(ServletRequest,ServletResponse) on the wrapped request. | true |
| true |
| Servlet:JAVADOC:716.1 | AsyncContext | jakarta.servlet.ServletRequestWrapper.getAsyncContext
throws
IllegalStateException
| if this request has not been put into asynchronous mode, i.e., if neither startAsync() nor startAsync(ServletRequest,ServletResponse) has been called | true |
| true |
| Servlet:JAVADOC:718 | DispatcherType | jakarta.servlet.ServletRequestWrapper.getDispatcherType
| Gets the dispatcher type of the wrapped request. | true |
| true |
| Servlet:JAVADOC:719 | String | jakarta.servlet.ServletRequestWrapper.getLocalAddr
| The default behavior of this method is to return getLocalAddr() on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:720 | int | jakarta.servlet.ServletRequestWrapper.getRemotePort
| The default behavior of this method is to return getRemotePort() on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:721 | ServletContext | jakarta.servlet.ServletRequestWrapper.getServletContext
| Gets the servlet context to which the wrapped servlet request was last dispatched. | true |
| true |
| Servlet:JAVADOC:722 | boolean | jakarta.servlet.ServletRequestWrapper.isAsyncStarted
| Checks if the wrapped request has been put into asynchronous mode. | true |
| true |
| Servlet:JAVADOC:723 | boolean | jakarta.servlet.ServletRequestWrapper.isAsyncSupported
| Checks if the wrapped request supports asynchronous operation. | true |
| true |
| Servlet:JAVADOC:724 | boolean | jakarta.servlet.ServletRequestWrapper.isWrapperFor
(
ServletRequest
)
| Checks (recursively) if this ServletRequestWrapper wraps the given ServletRequest instance. | true |
| true |
| Servlet:JAVADOC:725 | boolean | jakarta.servlet.ServletRequestWrapper.isWrapperFor
(
Class
)
| Checks (recursively) if this ServletRequestWrapper wraps a ServletRequest of the given class type. | true |
| true |
| Servlet:JAVADOC:725.1 | boolean | jakarta.servlet.ServletRequestWrapper.isWrapperFor
(
Class
)
throws
IllegalArgumentException
| if the given class does not implement ServletRequest | true |
| true |
| Servlet:JAVADOC:727 | AsyncContext | jakarta.servlet.ServletRequestWrapper.startAsync
| Puts the wrapped request into asynchronous mode, and initializes its AsyncContext with the original ServletRequest and ServletResponse objects and the timeout derived according to the rules laid out in #setAsyncTimeout. | true |
| true |
| Servlet:JAVADOC:728 | AsyncContext | jakarta.servlet.ServletRequestWrapper.startAsync
throws
IllegalStateException
| if this request is within the scope of a filter or servlet that does not support asynchronous operation, that is, if #isAsyncSupported returns false, or if this method is called again outside the scope of a dispatch resulting from an AsyncContext#dispatch, or if the response has already been closed | true |
| true |
| Servlet:JAVADOC:729 | AsyncContext | jakarta.servlet.ServletRequestWrapper.startAsync
(
ServletRequest
,
ServletResponse
)
| Puts the wrapped request into asynchronous mode, and initializes its AsyncContext with the given request and response objects and the timeout derived according to the rules laid out in #setAsyncTimeout. | true |
| true |
| Servlet:JAVADOC:730 | AsyncContext | jakarta.servlet.ServletRequestWrapper.startAsync
(
ServletRequest
,
ServletResponse
)
throws
IllegalStateException
| if this request is within the scope of a filter or servlet that does not support asynchronous operation, that is, if #isAsyncSupported returns false, or if this method is called again outside the scope of a dispatch resulting from an AsyncContext#dispatch, or if the response has already been closed | true |
| true |
| Servlet:JAVADOC:731 | boolean | jakarta.servlet.ServletResponseWrapper.isWrapperFor
(
ServletResponse
)
| Checks (recursively) if this ServletResponseWrapper wraps the given ServletResponse instance. | true |
| true |
| Servlet:JAVADOC:732 | boolean | jakarta.servlet.ServletResponseWrapper.isWrapperFor
(
Class
)
| Checks (recursively) if this ServletResponseWrapper wraps a ServletResponse of the given class type. | true |
| true |
| Servlet:JAVADOC:733 | String | jakarta.servlet.SessionCookieConfig.getComment
| Gets the comment that will be assigned to any session tracking cookies created on behalf of the ServletContext from which this SessionCookieConfig was acquired. | true |
| true |
| Servlet:JAVADOC:734 | String | jakarta.servlet.SessionCookieConfig.getDomain
| Gets the domain name that will be assigned to any session tracking cookies created on behalf of the ServletContext from which this SessionCookieConfig was acquired. | true |
| true |
| Servlet:JAVADOC:735 | int | jakarta.servlet.SessionCookieConfig.getMaxAge
| Gets the lifetime (in seconds) of the session tracking cookies created on behalf of the ServletContext from which this SessionCookieConfig was acquired. By default, -1 is returned. | true |
| true |
| Servlet:JAVADOC:736 | String | jakarta.servlet.SessionCookieConfig.getName
| Gets the name that will be assigned to any session tracking cookies created on behalf of the ServletContext from which this SessionCookieConfig was acquired. By default, JSESSIONID will be used as the cookie name. | true |
| true |
| Servlet:JAVADOC:737 | String | jakarta.servlet.SessionCookieConfig.getPath
| Gets the path that will be assigned to any session tracking cookies created on behalf of the ServletContext from which this SessionCookieConfig was acquired. By default, the context path of the ServletContext from which this SessionCookieConfig was acquired will be used. | true |
| true |
| Servlet:JAVADOC:738 | boolean | jakarta.servlet.SessionCookieConfig.isHttpOnly
| Checks if the session tracking cookies created on behalf of the ServletContext from which this SessionCookieConfig was acquired will be marked as HttpOnly. | true |
| true |
| Servlet:JAVADOC:739 | boolean | jakarta.servlet.SessionCookieConfig.isSecure
| Checks if the session tracking cookies created on behalf of the ServletContext from which this SessionCookieConfig was acquired will be marked as secure even if the request that initiated the corresponding session is using plain HTTP instead of HTTPS. | true |
| true |
| Servlet:JAVADOC:740 | void | jakarta.servlet.SessionCookieConfig.setComment
(
String
)
| Sets the comment that will be assigned to any session tracking cookies created on behalf of the ServletContext from which this SessionCookieConfig was acquired. | true |
| true |
| Servlet:JAVADOC:741 | void | jakarta.servlet.SessionCookieConfig.setDomain
(
String
)
| Sets the domain name that will be assigned to any session tracking cookies created on behalf of the ServletContext from which this SessionCookieConfig was acquired. | true |
| true |
| Servlet:JAVADOC:742 | void | jakarta.servlet.SessionCookieConfig.setHttpOnly
(
boolean
)
| Marks or unmarks the session tracking cookies created on behalf of the ServletContext from which this SessionCookieConfig was acquired as HttpOnly. A cookie is marked as HttpOnly by adding the HttpOnly attribute to it. HttpOnly cookies are not supposed to be exposed to client-side scripting code, and may therefore help mitigate certain kinds of cross-site scripting attacks. | true |
| true |
| Servlet:JAVADOC:743 | void | jakarta.servlet.SessionCookieConfig.setMaxAge
(
int
)
| Sets the lifetime (in seconds) for the session tracking cookies created on behalf of the ServletContext from which this SessionCookieConfig was acquired. | true |
| true |
| Servlet:JAVADOC:744 | void | jakarta.servlet.SessionCookieConfig.setName
(
String
)
| Sets the name that will be assigned to any session tracking cookies created on behalf of the ServletContext from which this SessionCookieConfig was acquired. NOTE: Changing the name of session tracking cookies may break other tiers (for example, a load balancing frontend) that assume the cookie name to be equal to the default JSESSIONID, and therefore should only be done cautiously. | true |
| true |
| Servlet:JAVADOC:745 | void | jakarta.servlet.SessionCookieConfig.setPath
(
String
)
| Sets the path that will be assigned to any session tracking cookies created on behalf of the ServletContext from which this SessionCookieConfig was acquired. | true |
| true |
| Servlet:JAVADOC:746 | void | jakarta.servlet.SessionCookieConfig.setSecure
(
boolean
)
| Marks or unmarks the session tracking cookies created on behalf of the ServletContext from which this SessionCookieConfig was acquired as secure. One use case for marking a session tracking cookie as secure, even though the request that initiated the session came over HTTP, is to support a topology where the web container is front-ended by an SSL offloading load balancer. In this case, the traffic between the client and the load balancer will be over HTTPS, whereas the traffic between the load balancer and the web container will be over HTTP. | true |
| true |
| Servlet:JAVADOC:747 | SessionTrackingMode | jakarta.servlet.SessionTrackingMode.valueOf
(
String
)
|
| true |
| true |
| Servlet:JAVADOC:748 | SessionTrackingMode[] | jakarta.servlet.SessionTrackingMode.values
|
| true |
| true |
| Servlet:JAVADOC:749 | boolean | jakarta.servlet.http.Cookie.isHttpOnly
| Checks whether this cookie has been marked as HttpOnly. | true |
| true |
| Servlet:JAVADOC:750 | void | jakarta.servlet.http.Cookie.setHttpOnly
(
boolean
)
| Marks or unmarks this cookie as HttpOnly. If isHttpOnly is set to true, this cookie is marked as HttpOnly, by adding the HttpOnly attribute to it. HttpOnly cookies are not supposed to be exposed to client-side scripting code, and may therefore help mitigate certain kinds of cross-site scripting attacks. | true |
| true |
| Servlet:JAVADOC:751 | boolean | jakarta.servlet.http.HttpServletRequest.authenticate
(
HttpServletResponse
)
| 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. | true |
| true |
| Servlet:JAVADOC:752 | boolean | jakarta.servlet.http.HttpServletRequest.authenticate
(
HttpServletResponse
)
throws
IOException
| if an error occurs while writing the response. | true |
| true |
| Servlet:JAVADOC:753 | boolean | jakarta.servlet.http.HttpServletRequest.authenticate
(
HttpServletResponse
)
throws
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). | true |
| true |
| Servlet:JAVADOC:754 | Part | jakarta.servlet.http.HttpServletRequest.getPart
(
String
)
| Gets the Part with the given name. | true |
| true |
| Servlet:JAVADOC:755 | Part | jakarta.servlet.http.HttpServletRequest.getPart
(
String
)
throws
IOException
| if an I/O error occurred during the retrieval of the requested Part | true |
| true |
| Servlet:JAVADOC:756 | Part | jakarta.servlet.http.HttpServletRequest.getPart
(
String
)
throws
ServletException
| if this request is not of type multipart/form-data | true |
| true |
| Servlet:JAVADOC:757 | Collection | 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. | true |
| true |
| Servlet:JAVADOC:758 | Collection | jakarta.servlet.http.HttpServletRequest.getParts
throws
IOException
| if an I/O error occurred during the retrieval of the Part components of this request | true |
| true |
| Servlet:JAVADOC:759 | Collection | jakarta.servlet.http.HttpServletRequest.getParts
throws
ServletException
| if this request is not of type multipart/form-data | true |
| true |
| Servlet:JAVADOC:760 | void | jakarta.servlet.http.HttpServletRequest.login
(
String
,
String
)
| 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. | true |
| true |
| Servlet:JAVADOC:761 | void | jakarta.servlet.http.HttpServletRequest.login
(
String
,
String
)
throws
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. | true |
| true |
| Servlet:JAVADOC:762 | void | jakarta.servlet.http.HttpServletRequest.logout
| Establish null as the value returned when getUserPrincipal, getRemoteUser, and getAuthType is called on the request. | true |
| true |
| Servlet:JAVADOC:763 | void | jakarta.servlet.http.HttpServletRequest.logout
throws
ServletException
| if logout fails | true |
| true |
| Servlet:JAVADOC:764 | boolean | jakarta.servlet.http.HttpServletRequestWrapper.authenticate
(
HttpServletResponse
)
| The default behavior of this method is to call authenticate on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:765 | boolean | jakarta.servlet.http.HttpServletRequestWrapper.authenticate
(
HttpServletResponse
)
throws
IOException
|
| true |
| true |
| Servlet:JAVADOC:766 | boolean | jakarta.servlet.http.HttpServletRequestWrapper.authenticate
(
HttpServletResponse
)
throws
ServletException
|
| true |
| true |
| Servlet:JAVADOC:767 | Part | jakarta.servlet.http.HttpServletRequestWrapper.getPart
(
String
)
| The default behavior of this method is to call getPart on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:768 | Part | jakarta.servlet.http.HttpServletRequestWrapper.getPart
(
String
)
throws
IOException
|
| true |
| true |
| Servlet:JAVADOC:769 | Part | jakarta.servlet.http.HttpServletRequestWrapper.getPart
(
String
)
throws
ServletException
|
| true |
| true |
| Servlet:JAVADOC:770 | Collection | jakarta.servlet.http.HttpServletRequestWrapper.getParts
| The default behavior of this method is to call getParts on the wrapped request object. Any changes to the returned Collection must not affect this HttpServletRequestWrapper. | true |
| true |
| Servlet:JAVADOC:771 | Collection | jakarta.servlet.http.HttpServletRequestWrapper.getParts
throws
IOException
|
| true |
| true |
| Servlet:JAVADOC:772 | Collection | jakarta.servlet.http.HttpServletRequestWrapper.getParts
throws
ServletException
|
| true |
| true |
| Servlet:JAVADOC:773 | void | jakarta.servlet.http.HttpServletRequestWrapper.login
(
String
,
String
)
| The default behavior of this method is to call login on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:774 | void | jakarta.servlet.http.HttpServletRequestWrapper.login
(
String
,
String
)
throws
ServletException
|
| true |
| true |
| Servlet:JAVADOC:775 | void | jakarta.servlet.http.HttpServletRequestWrapper.logout
| The default behavior of this method is to call login on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:776 | void | jakarta.servlet.http.HttpServletRequestWrapper.logout
throws
ServletException
|
| true |
| true |
| Servlet:JAVADOC:777 | String | jakarta.servlet.http.HttpServletResponse.getHeader
(
String
)
| Gets the value of the response header with the given name. If a response header with the given name exists and contains multiple values, the value that was added first will be returned. This method considers only response headers set or added via #setHeader, #addHeader, #setDateHeader, #addDateHeader, #setIntHeader, or #addIntHeader, respectively. | true |
| true |
| Servlet:JAVADOC:778 | Collection | jakarta.servlet.http.HttpServletResponse.getHeaderNames
| Gets the names of the headers of this response. This method considers only response headers set or added via #setHeader, #addHeader, #setDateHeader, #addDateHeader, #setIntHeader, or #addIntHeader, respectively. Any changes to the returned Collection must not affect this HttpServletResponse. | true |
| true |
| Servlet:JAVADOC:779 | Collection | jakarta.servlet.http.HttpServletResponse.getHeaders
(
String
)
| Gets the values of the response header with the given name. This method considers only response headers set or added via #setHeader, #addHeader, #setDateHeader, #addDateHeader, #setIntHeader, or #addIntHeader, respectively. Any changes to the returned Collection must not affect this HttpServletResponse. | true |
| true |
| Servlet:JAVADOC:780 | int | jakarta.servlet.http.HttpServletResponse.getStatus
| Gets the current status code of this response. | true |
| true |
| Servlet:JAVADOC:781 | String | jakarta.servlet.http.HttpServletResponseWrapper.getHeader
(
String
)
| The default behaviour of this method is to call HttpServletResponse#getHeader on the wrapped response object. | true |
| true |
| Servlet:JAVADOC:782 | Collection | jakarta.servlet.http.HttpServletResponseWrapper.getHeaderNames
| The default behaviour of this method is to call HttpServletResponse#getHeaderNames on the wrapped response object. Any changes to the returned Collection must not affect this HttpServletResponseWrapper. | true |
| true |
| Servlet:JAVADOC:783 | Collection | jakarta.servlet.http.HttpServletResponseWrapper.getHeaders
(
String
)
| The default behaviour of this method is to call HttpServletResponse#getHeaders on the wrapped response object. Any changes to the returned Collection must not affect this HttpServletResponseWrapper. | true |
| true |
| Servlet:JAVADOC:784 | int | jakarta.servlet.http.HttpServletResponseWrapper.getStatus
| The default behaviour of this method is to call HttpServletResponse#getStatus on the wrapped response object. | true |
| true |
| Servlet:JAVADOC:785 | void | jakarta.servlet.http.Part.delete
| Deletes the underlying storage for a file item, including deleting any associated temporary disk file. | true |
| true |
| Servlet:JAVADOC:786 | void | jakarta.servlet.http.Part.delete
throws
IOException
| if an error occurs. | true |
| true |
| Servlet:JAVADOC:787 | String | jakarta.servlet.http.Part.getContentType
| Gets the content type of this part. | true |
| true |
| Servlet:JAVADOC:788 | String | jakarta.servlet.http.Part.getHeader
(
String
)
| Returns the value of the specified mime header as a String. If the Part 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 header in the part. The header name is case insensitive. You can use this method with any request header. | true |
| true |
| Servlet:JAVADOC:789 | Collection | jakarta.servlet.http.Part.getHeaderNames
| Gets the header names of this Part. Some servlet containers do not allow servlets to access headers using this method, in which case this method returns null Any changes to the returned Collection must not affect this Part. | true |
| true |
| Servlet:JAVADOC:790 | Collection | jakarta.servlet.http.Part.getHeaders
(
String
)
| Gets the values of the Part header with the given name. Any changes to the returned Collection must not affect this Part. Part header names are case insensitive. | true |
| true |
| Servlet:JAVADOC:791 | InputStream | jakarta.servlet.http.Part.getInputStream
| Gets the content of this part as an InputStream | true |
| true |
| Servlet:JAVADOC:792 | InputStream | jakarta.servlet.http.Part.getInputStream
throws
IOException
| If an error occurs in retrieving the contet as an InputStream | true |
| true |
| Servlet:JAVADOC:793 | String | jakarta.servlet.http.Part.getName
| Gets the name of this part | true |
| true |
| Servlet:JAVADOC:794 | long | jakarta.servlet.http.Part.getSize
| Returns the size of this fille. | true |
| true |
| Servlet:JAVADOC:955 | String | jakarta.servlet.http.Part.getSubmittedFileName
| Gets the file name specified by the client | true |
| true |
| Servlet:JAVADOC:795 | void | jakarta.servlet.http.Part.write
(
String
)
| A convenience method to write this uploaded item to disk. This method is not guaranteed to succeed if called more than once for the same part. This allows a particular implementation to use, for example, file renaming, where possible, rather than copying all of the underlying data, thus gaining a significant performance benefit. | true |
| true |
| Servlet:JAVADOC:796 | void | jakarta.servlet.http.Part.write
(
String
)
throws
IOException
| if an error occurs. | true |
| true |
| Servlet:JAVADOC:797 | Class[] | jakarta.servlet.annotation.HandlesTypes.value
| The classes in which a jakarta.servlet.ServletContainerInitializer ServletContainerInitializer has expressed interest. If an implementation of ServletContainerInitializer specifies this annotation, the Servlet container must pass the Set of application classes that extend, implement, or have been annotated with the class types listed by this annotation to the jakarta.servlet.ServletContainerInitializer#onStartup method of the ServletContainerInitializer (if no matching classes are found, null must be passed instead) | true |
| true |
| Servlet:JAVADOC:798 | int | jakarta.servlet.annotation.MultipartConfig.fileSizeThreshold
| The size threshold after which the file will be written to disk | true |
| true |
| Servlet:JAVADOC:799 | String | jakarta.servlet.annotation.MultipartConfig.location
| The directory location where files will be stored | true |
| true |
| Servlet:JAVADOC:800 | long | jakarta.servlet.annotation.MultipartConfig.maxFileSize
| The maximum size allowed for uploaded files. The default is -1L, which means unlimited. | true |
| true |
| Servlet:JAVADOC:801 | long | jakarta.servlet.annotation.MultipartConfig.maxRequestSize
| The maximum size allowed for multipart/form-data requests The default is -1L, which means unlimited. | true |
| true |
| Servlet:JAVADOC:802 | boolean | jakarta.servlet.annotation.WebFilter.asyncSupported
| Declares whether the filter supports asynchronous operation mode. | true |
| true |
| Servlet:JAVADOC:803 | String | jakarta.servlet.annotation.WebFilter.description
| The description of the filter | true |
| true |
| Servlet:JAVADOC:804 | DispatcherType[] | jakarta.servlet.annotation.WebFilter.dispatcherTypes
| The dispatcher types to which the filter applies | true |
| true |
| Servlet:JAVADOC:805 | String | jakarta.servlet.annotation.WebFilter.displayName
| The display name of the filter | true |
| true |
| Servlet:JAVADOC:806 | String | jakarta.servlet.annotation.WebFilter.filterName
| The name of the filter | true |
| true |
| Servlet:JAVADOC:807 | WebInitParam[] | jakarta.servlet.annotation.WebFilter.initParams
| The init parameters of the filter | true |
| true |
| Servlet:JAVADOC:808 | String | jakarta.servlet.annotation.WebFilter.largeIcon
| The large-icon of the filter | true |
| true |
| Servlet:JAVADOC:809 | String[] | jakarta.servlet.annotation.WebFilter.servletNames
| The names of the servlets to which the filter applies. | true |
| true |
| Servlet:JAVADOC:810 | String | jakarta.servlet.annotation.WebFilter.smallIcon
| The small-icon of the filter | true |
| true |
| Servlet:JAVADOC:811 | String[] | jakarta.servlet.annotation.WebFilter.urlPatterns
| The URL patterns to which the filter applies | true |
| true |
| Servlet:JAVADOC:812 | String[] | jakarta.servlet.annotation.WebFilter.value
| The URL patterns to which the filter applies | true |
| true |
| Servlet:JAVADOC:813 | String | jakarta.servlet.annotation.WebInitParam.description
| Description of the init param | true |
| true |
| Servlet:JAVADOC:814 | String | jakarta.servlet.annotation.WebInitParam.name
| Name of the init param | true |
| true |
| Servlet:JAVADOC:815 | String | jakarta.servlet.annotation.WebInitParam.value
| Value of the init param | true |
| true |
| Servlet:JAVADOC:817 | boolean | jakarta.servlet.annotation.WebServlet.asyncSupported
| Declares whether the servlet supports asynchronous operation mode. | true |
| true |
| Servlet:JAVADOC:818 | String | jakarta.servlet.annotation.WebServlet.description
| The description of the servlet | true |
| true |
| Servlet:JAVADOC:819 | WebInitParam[] | jakarta.servlet.annotation.WebServlet.initParams
| The init parameters of the servlet | true |
| true |
| Servlet:JAVADOC:820 | String | jakarta.servlet.annotation.WebServlet.largeIcon
| The large-icon of the servlet | true |
| true |
| Servlet:JAVADOC:821 | int | jakarta.servlet.annotation.WebServlet.loadOnStartup
| The load-on-startup order of the servlet | true |
| true |
| Servlet:JAVADOC:822 | String | jakarta.servlet.annotation.WebServlet.name
| The name of the servlet | true |
| true |
| Servlet:JAVADOC:823 | String | jakarta.servlet.annotation.WebServlet.smallIcon
| The small-icon of the servlet | true |
| true |
| Servlet:JAVADOC:824 | String[] | jakarta.servlet.annotation.WebServlet.urlPatterns
| The URL patterns of the servlet | true |
| true |
| Servlet:JAVADOC:825 | String[] | jakarta.servlet.annotation.WebServlet.value
| The URL patterns of the servlet | true |
| true |
| Servlet:JAVADOC:826 | Collection | jakarta.servlet.descriptor.JspConfigDescriptor.getJspPropertyGroups
| Gets the child elements of the element represented by this JspConfigDescriptor. Any changes to the returned Collection must not affect this JspConfigDescriptor. | true |
| true |
| Servlet:JAVADOC:827 | Collection | jakarta.servlet.descriptor.JspConfigDescriptor.getTaglibs
| Gets the child elements of the element represented by this JspConfigDescriptor. Any changes to the returned Collection must not affect this JspConfigDescriptor. | true |
| true |
| Servlet:JAVADOC:828 | String | jakarta.servlet.descriptor.JspPropertyGroupDescriptor.getBuffer
| Gets the value of the buffer configuration, which specifies the default size of the response buffer for any JSP pages mapped to the JSP property group represented by this JspPropertyGroupDescriptor. | true |
| true |
| Servlet:JAVADOC:829 | String | jakarta.servlet.descriptor.JspPropertyGroupDescriptor.getDefaultContentType
| Gets the value of the default-content-type configuration, which specifies the default response content type for any JSP pages mapped to the JSP property group represented by this JspPropertyGroupDescriptor. | true |
| true |
| Servlet:JAVADOC:830 | String | jakarta.servlet.descriptor.JspPropertyGroupDescriptor.getDeferredSyntaxAllowedAsLiteral
| Gets the value of the deferred-syntax-allowed-as-literal configuration, which specifies whether the character sequence "#{", which is normally reserved for Expression Language (EL) expressions, will cause a translation error if it appears as a String literal in any JSP pages mapped to the JSP property group represented by this JspPropertyGroupDescriptor. | true |
| true |
| Servlet:JAVADOC:831 | String | jakarta.servlet.descriptor.JspPropertyGroupDescriptor.getElIgnored
| Gets the value of the el-ignored configuration, which specifies whether Expression Language (EL) evaluation is enabled for any JSP pages mapped to the JSP property group represented by this JspPropertyGroupDescriptor. | true |
| true |
| Servlet:JAVADOC:832 | String | jakarta.servlet.descriptor.JspPropertyGroupDescriptor.getErrorOnUndeclaredNamespace
| Gets the value of the error-on-undeclared-namespace configuration, which specifies whether an error will be raised at translation time if tag with an undeclared namespace is used in any JSP pages mapped to the JSP property group represented by this JspPropertyGroupDescriptor. | true |
| true |
| Servlet:JAVADOC:833 | Collection | jakarta.servlet.descriptor.JspPropertyGroupDescriptor.getIncludeCodas
| Gets the include-coda configuration of the JSP property group represented by this JspPropertyGroupDescriptor. Any changes to the returned Collection must not affect this JspPropertyGroupDescriptor. | true |
| true |
| Servlet:JAVADOC:834 | Collection | jakarta.servlet.descriptor.JspPropertyGroupDescriptor.getIncludePreludes
| Gets the include-prelude configuration of the JSP property group represented by this JspPropertyGroupDescriptor. Any changes to the returned Collection must not affect this JspPropertyGroupDescriptor. | true |
| true |
| Servlet:JAVADOC:835 | String | jakarta.servlet.descriptor.JspPropertyGroupDescriptor.getIsXml
| Gets the value of the is-xml configuration, which specifies whether any JSP pages mapped to the JSP property group represented by this JspPropertyGroupDescriptor will be treated as JSP documents (XML syntax). | true |
| true |
| Servlet:JAVADOC:836 | String | jakarta.servlet.descriptor.JspPropertyGroupDescriptor.getPageEncoding
| Gets the value of the page-encoding configuration, which specifies the default page encoding for any JSP pages mapped to the JSP property group represented by this JspPropertyGroupDescriptor. | true |
| true |
| Servlet:JAVADOC:837 | String | jakarta.servlet.descriptor.JspPropertyGroupDescriptor.getScriptingInvalid
| Gets the value of the scripting-invalid configuration, which specifies whether scripting is enabled for any JSP pages mapped to the JSP property group represented by this JspPropertyGroupDescriptor. | true |
| true |
| Servlet:JAVADOC:838 | String | jakarta.servlet.descriptor.JspPropertyGroupDescriptor.getTrimDirectiveWhitespaces
| Gets the value of the trim-directive-whitespaces configuration, which specifies whether template text containing only whitespaces must be removed from the response output of any JSP pages mapped to the JSP property group represented by this JspPropertyGroupDescriptor. | true |
| true |
| Servlet:JAVADOC:839 | Collection | jakarta.servlet.descriptor.JspPropertyGroupDescriptor.getUrlPatterns
| Gets the URL patterns of the JSP property group represented by this JspPropertyGroupDescriptor. Any changes to the returned Collection must not affect this JspPropertyGroupDescriptor. | true |
| true |
| Servlet:JAVADOC:840 | String | jakarta.servlet.descriptor.TaglibDescriptor.getTaglibLocation
| Gets the location of the tag library represented by this TaglibDescriptor. | true |
| true |
| Servlet:JAVADOC:841 | String | jakarta.servlet.descriptor.TaglibDescriptor.getTaglibURI
| Gets the unique identifier of the tag library represented by this TaglibDescriptor. | true |
| true |
| Servlet:JAVADOC:842 | AsyncEvent | jakarta.servlet.AsyncEvent.AsyncEvent
(
AsyncContext
)
| Constructs an AsyncEvent from the given AsyncContext. | true |
| true |
| Servlet:JAVADOC:843 | AsyncEvent | jakarta.servlet.AsyncEvent.AsyncEvent
(
AsyncContext
,
ServletRequest
,
ServletResponse
)
| Constructs an AsyncEvent from the given AsyncContext, ServletRequest, and ServletResponse. | true |
| true |
| Servlet:JAVADOC:844 | AsyncEvent | jakarta.servlet.AsyncEvent.AsyncEvent
(
AsyncContext
,
Throwable
)
| Constructs an AsyncEvent from the given AsyncContext and Throwable. | true |
| true |
| Servlet:JAVADOC:845 | AsyncEvent | jakarta.servlet.AsyncEvent.AsyncEvent
(
AsyncContext
,
ServletRequest
,
ServletResponse
,
Throwable
)
| Constructs an AsyncEvent from the given AsyncContext, ServletRequest, ServletResponse, and Throwable. | true |
| true |
| Servlet:JAVADOC:846 | AsyncContext | jakarta.servlet.AsyncEvent.getAsyncContext
| Gets the AsyncContext from this AsyncEvent. | true |
| true |
| Servlet:JAVADOC:847 | ServletRequest | jakarta.servlet.AsyncEvent.getSuppliedRequest
| Gets the ServletRequest from this AsyncEvent. If the AsyncListener to which this AsyncEvent is being delivered was added using ServletRequest#addAsyncListener(AsyncListener, ServletRequest, ServletResponse), the returned ServletRequest will be the same as the one supplied to the above method. If the AsyncListener was added via ServletRequest#addAsyncListener(AsyncListener), this method must return null. | true |
| true |
| Servlet:JAVADOC:848 | ServletResponse | jakarta.servlet.AsyncEvent.getSuppliedResponse
| Gets the ServletResponse from this AsyncEvent. If the AsyncListener to which this AsyncEvent is being delivered was added using ServletRequest#addAsyncListener(AsyncListener, ServletRequest, ServletResponse), the returned ServletResponse will be the same as the one supplied to the above method. If the AsyncListener was added via ServletRequest#addAsyncListener(AsyncListener), this method must return null. | true |
| true |
| Servlet:JAVADOC:849 | Throwable | jakarta.servlet.AsyncEvent.getThrowable
| Gets the Throwable from this AsyncEvent. | true |
| true |
| Servlet:JAVADOC:850 | void | jakarta.servlet.AsyncListener.onError
(
AsyncEvent
)
| Notifies this AsyncListener that an asynchronous operation has failed to complete. | true |
| true |
| Servlet:JAVADOC:850.1 | void | jakarta.servlet.AsyncListener.onError
(
AsyncEvent
)
| The AsyncContext corresponding to the asynchronous operation that failed to complete may be obtained by calling AsyncEvent#getAsyncContext getAsyncContext on the given event. | true |
| true |
| Servlet:JAVADOC:850.2 | void | jakarta.servlet.AsyncListener.onError
(
AsyncEvent
)
| In addition, if this AsyncListener had been registered via a call to ServletRequest#addAsyncListener(AsyncListener, ServletRequest, ServletResponse), the supplied ServletRequest and ServletResponse objects may be retrieved by calling AsyncEvent#getSuppliedRequest getSuppliedRequest and AsyncEvent#getSuppliedResponse getSuppliedResponse, respectively, on the given event. | true |
| true |
| Servlet:JAVADOC:851 | void | jakarta.servlet.AsyncListener.onError
(
AsyncEvent
)
throws
IOException
| if an I/O related error has occurred during the processing of the given AsyncEvent | true |
| true |
| Servlet:JAVADOC:852 | String[] | jakarta.servlet.annotation.HttpConstraint.rolesAllowed
| The names of the authorized roles.
Duplicate role names appearing in rolesAllowed are insignificant
and may be discarded during runtime processing of the annotation.
The String "*" has no special meaning as a role name (should it occur in rolesAllowed).
| true |
| true |
| Servlet:JAVADOC:853 | TransportGuarantee | jakarta.servlet.annotation.HttpConstraint.transportGuarantee
| The data protection requirements (i.e., whether or not SSL/TLS is required)
that must be satisfied by the connections on which requests arrive.
| true |
| true |
| Servlet:JAVADOC:854 | EmptyRoleSemantic | jakarta.servlet.annotation.HttpConstraint.value
| The default authorization semantic.
This value is insignificant when rolesAllowed returns a non-empty array,
and should not be specified when a non-empty array is specified for rolesAllowed.
| true |
| true |
| Servlet:JAVADOC:855 | EmptyRoleSemantic | jakarta.servlet.annotation.HttpMethodConstraint.emptyRoleSemantic
| The default authorization semantic. This value is insignificant when rolesAllowed returns a non-empty array, and should not be specified when a non-empty array is specified for rolesAllowed. | true |
| true |
| Servlet:JAVADOC:856 | String[] | jakarta.servlet.annotation.HttpMethodConstraint.rolesAllowed
| The names of the authorized roles. Duplicate role names appearing in rolesAllowed are insignificant and may be discarded during runtime processing of the annotation. The String "*" has no special meaning as a role name (should it occur in rolesAllowed). | true |
| true |
| Servlet:JAVADOC:857 | TransportGuarantee | jakarta.servlet.annotation.HttpMethodConstraint.transportGuarantee
| The data protection requirements (i.e., whether or not SSL/TLS is required) that must be satisfied by the connections on which requests arrive. | true |
| true |
| Servlet:JAVADOC:858 | String | jakarta.servlet.annotation.HttpMethodConstraint.value
| Http protocol method name | true |
| true |
| Servlet:JAVADOC:859 | HttpMethodConstraint[] | jakarta.servlet.annotation.ServletSecurity.httpMethodConstraints
| Get the HTTP method specific constraints. Each HttpMethodConstraint names an HTTP protocol method and defines the protection to be applied to it. | true |
| true |
| Servlet:JAVADOC:860 | HttpConstraint | jakarta.servlet.annotation.ServletSecurity.value
| Get the HttpConstraint that defines the protection that is to be applied to all HTTP methods that are NOT represented in the array returned by httpMethodConstraints. | true |
| true |
| Servlet:JAVADOC:861 | EmptyRoleSemantic | jakarta.servlet.annotation.ServletSecurity.EmptyRoleSemantic.valueOf
(
String
)
|
| true |
| true |
| Servlet:JAVADOC:862 | EmptyRoleSemantic[] | jakarta.servlet.annotation.ServletSecurity.EmptyRoleSemantic.values
|
| true |
| true |
| Servlet:JAVADOC:863 | TransportGuarantee | jakarta.servlet.annotation.ServletSecurity.TransportGuarantee.valueOf
(
String
)
|
| true |
| true |
| Servlet:JAVADOC:864 | TransportGuarantee[] | jakarta.servlet.annotation.ServletSecurity.TransportGuarantee.values
| Returns an array containing the constants of this enum type, in the order they are declared.
This method may be used to iterate over the constants as follows:
for (ServletSecurity.TransportGuarantee c : ServletSecurity.TransportGuarantee.values())
System.out.println(c);
| true |
| true |
| Servlet:JAVADOC:865 | String | jakarta.servlet.annotation.WebListener.value
| Description of the listener | true |
| true |
| Servlet:JAVADOC:866 | void | jakarta.servlet.AsyncContext.addListener
(
AsyncListener
)
| Registers the given AsyncListener with the most recent asynchronous cycle that was started by a call to one of the ServletRequest#startAsync methods. The given AsyncListener will receive an AsyncEvent when the asynchronous cycle completes successfully, times out, or results in an error. AsyncListener instances will be notified in the order in which they were added. | true |
| true |
| Servlet:JAVADOC:866.1 | void | jakarta.servlet.AsyncContext.addListener
(
AsyncListener
)
| The given AsyncListener will receive an AsyncEvent when the asynchronous cycle completes successfully, times out, or results in an error. | true |
| true |
| Servlet:JAVADOC:866.2 | void | jakarta.servlet.AsyncContext.addListener
(
AsyncListener
)
| AsyncListener instances will be notified in the order in which they were added. | true |
| true |
| Servlet:JAVADOC:948 | void | jakarta.servlet.AsyncContext.addListener
(
AsyncListener
)
| If ServletRequest#startAsync(ServletRequest, ServletResponse) or ServletRequest#startAsync is called,
the exact same request and response objects are available from the AsyncEvent when the AsyncListener is notified.
| true |
| true |
| Servlet:JAVADOC:866.3 | void | jakarta.servlet.AsyncContext.addListener
(
AsyncListener
)
throws
IllegalStateException
| if this method is called after the container-initiated dispatch, during which one of the ServletRequest.startAsync() methods was called, has returned to the container | true |
| true |
| Servlet:JAVADOC:867 | void | jakarta.servlet.AsyncContext.addListener
(
AsyncListener
,
ServletRequest
,
ServletResponse
)
| Registers the given AsyncListener with the most recent asynchronous cycle that was started by a call to one of the ServletRequest#startAsync methods. The given AsyncListener will receive an AsyncEvent when the asynchronous cycle completes successfully, times out, or results in an error. AsyncListener instances will be notified in the order in which they were added. The given ServletRequest and ServletResponse objects will be made available to the given AsyncListener via the AsyncEvent#getSuppliedRequest getSuppliedRequest and AsyncEvent#getSuppliedResponse getSuppliedResponse methods, respectively, of the AsyncEvent delivered to it. These objects should not be read from or written to, respectively, at the time the AsyncEvent is delivered, because additional wrapping may have occurred since the given AsyncListener was registered, but may be used in order to release any resources associated with them. | true |
| true |
| Servlet:JAVADOC:867.1 | void | jakarta.servlet.AsyncContext.addListener
(
AsyncListener
,
ServletRequest
,
ServletResponse
)
| The given AsyncListener will receive an AsyncEvent when the asynchronous cycle completes successfully, times out, or results in an error. | true |
| true |
| Servlet:JAVADOC:867.2 | void | jakarta.servlet.AsyncContext.addListener
(
AsyncListener
,
ServletRequest
,
ServletResponse
)
| AsyncListener instances will be notified in the order in which they were added. | true |
| true |
| Servlet:JAVADOC:867.3 | void | jakarta.servlet.AsyncContext.addListener
(
AsyncListener
,
ServletRequest
,
ServletResponse
)
| The given ServletRequest and ServletResponse objects will be made available to the given AsyncListener via the getSuppliedRequest and getSuppliedResponse methods, respectively, of the AsyncEvent delivered to it. These objects should not be read from or written to, respectively, at the time the AsyncEvent is delivered, because additional wrapping may have occurred since the given AsyncListener was registered, but may be used in order to release any resources associated with them. | true |
| true |
| Servlet:JAVADOC:867.4 | void | jakarta.servlet.AsyncContext.addListener
(
AsyncListener
,
ServletRequest
,
ServletResponse
)
throws
IllegalStateException
| if this method is called after the container-initiated dispatch, during which one of the ServletRequest.startAsync() methods was called, has returned to the container | true |
| true |
| Servlet:JAVADOC:868 | long | jakarta.servlet.AsyncContext.getTimeout
| Gets the timeout (in milliseconds) for this AsyncContext. This method returns the container's default timeout for asynchronous operations, or the timeout value passed to the most recent invocation of #setTimeout. A timeout value of zero or less indicates no timeout. | true |
| true |
| Servlet:JAVADOC:868.1 | long | jakarta.servlet.AsyncContext.getTimeout
| A timeout value of zero or less indicates no timeout. | true |
| true |
| Servlet:JAVADOC:869 | void | jakarta.servlet.AsyncContext.setTimeout
(
long
)
| Sets the timeout (in milliseconds) for this AsyncContext.
The timeout applies to this AsyncContext once the container-initiated dispatch
during which one of the ServletRequest#startAsync methods was called has returned to the container.
The timeout will expire if neither the #complete method nor any of the dispatch methods are called.
A timeout value of zero or less indicates no timeout.
If #setTimeout is not called, then the container's default timeout,
which is available via a call to #getTimeout, will apply.
| true |
| true |
| Servlet:JAVADOC:869.1 | void | jakarta.servlet.AsyncContext.setTimeout
(
long
)
| The timeout applies to this AsyncContext once the container-initiated dispatch during which one of the ServletRequest.startAsync() methods was called has returned to the container. | true |
| true |
| Servlet:JAVADOC:869.2 | void | jakarta.servlet.AsyncContext.setTimeout
(
long
)
| The timeout will expire if neither the complete() method nor any of the dispatch methods are called. | true |
| true |
| Servlet:JAVADOC:869.3 | void | jakarta.servlet.AsyncContext.setTimeout
(
long
)
| A timeout value of zero or less indicates no timeout. | true |
| true |
| Servlet:JAVADOC:869.4 | void | jakarta.servlet.AsyncContext.setTimeout
(
long
)
| If setTimeout(long) is not called, then the container's default timeout, which is available via a call to getTimeout(), will apply. | true |
| true |
| Servlet:JAVADOC:869.5 | void | jakarta.servlet.AsyncContext.setTimeout
(
long
)
throws
IllegalStateException
| if this method is called after the container-initiated dispatch, during which one of the ServletRequest.startAsync() methods was called, has returned to the container. | true |
| true |
| Servlet:JAVADOC:870 | void | jakarta.servlet.AsyncListener.onStartAsync
(
AsyncEvent
)
| Notifies this AsyncListener that a new asynchronous cycle is being initiated via a call to one of the ServletRequest#startAsync methods. | true |
| true |
| Servlet:JAVADOC:870.1 | void | jakarta.servlet.AsyncListener.onStartAsync
(
AsyncEvent
)
| The AsyncContext corresponding to the asynchronous operation that is being reinitialized may be obtained by calling AsyncEvent#getAsyncContext getAsyncContext on the given event. | true |
| true |
| Servlet:JAVADOC:870.2 | void | jakarta.servlet.AsyncListener.onStartAsync
(
AsyncEvent
)
| In addition, if this AsyncListener had been registered via a call to AsyncContext#addListener(AsyncListener, ServletRequest, ServletResponse), the supplied ServletRequest and ServletResponse objects may be retrieved by calling AsyncEvent#getSuppliedRequest getSuppliedRequest and AsyncEvent#getSuppliedResponse getSuppliedResponse, respectively, on the given event. | true |
| true |
| Servlet:JAVADOC:870.3 | void | jakarta.servlet.AsyncListener.onStartAsync
(
AsyncEvent
)
| This AsyncListener will not receive any events related to the new asynchronous cycle unless it registers itself (via a call to AsyncContext#addListener) with the AsyncContext that is delivered as part of the given AsyncEvent. | true |
| true |
| Servlet:JAVADOC:871 | void | jakarta.servlet.AsyncListener.onStartAsync
(
AsyncEvent
)
throws
IOException
| if an I/O related error has occurred during the processing of the given AsyncEvent | true |
| true |
| Servlet:JAVADOC:872 | AsyncListener | jakarta.servlet.AsyncContext.createListener
(
Class
)
| Instantiates the given AsyncListener class. The returned AsyncListener instance may be further customized before it is registered with this AsyncContext via a call to one of the addListener methods. The given AsyncListener class must define a zero argument constructor, which is used to instantiate it. This method supports any annotations applicable to AsyncListener. | true |
| true |
| Servlet:JAVADOC:872.1 | AsyncListener | jakarta.servlet.AsyncContext.createListener
(
Class
)
| The returned AsyncListener instance may be further customized before it is registered with this AsyncContext via a call to one of the addListener methods. | true |
| true |
| Servlet:JAVADOC:872.2 | AsyncListener | jakarta.servlet.AsyncContext.createListener
(
Class
)
| The given AsyncListener class must define a zero argument constructor, which is used to instantiate it. | true |
| true |
| Servlet:JAVADOC:872.3 | AsyncListener | jakarta.servlet.AsyncContext.createListener
(
Class
)
| This method supports resource injection if the given clazz represents a Managed Bean. See the Jakarta EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection. | true |
| true |
| Servlet:JAVADOC:872.4 | AsyncListener | jakarta.servlet.AsyncContext.createListener
(
Class
)
| This method supports any annotations applicable to AsyncListener. | true |
| true |
| Servlet:JAVADOC:872.5 | AsyncListener | jakarta.servlet.AsyncContext.createListener
(
Class
)
throws
ServletException
| if the given clazz fails to be instantiated | true |
| true |
| Servlet:JAVADOC:873 | AsyncListener | jakarta.servlet.AsyncContext.createListener
(
Class
)
throws
ServletException
| if the given clazz fails to be instantiated | true |
| true |
| Servlet:JAVADOC:874 | EmptyRoleSemantic | jakarta.servlet.HttpConstraintElement.getEmptyRoleSemantic
| Gets the default authorization semantic. This value is insignificant when getRolesAllowed returns a non-empty array, and should not be specified when a non-empty array is specified for getRolesAllowed. | true |
| true |
| Servlet:JAVADOC:875 | String[] | jakarta.servlet.HttpConstraintElement.getRolesAllowed
| Gets the names of the authorized roles. Duplicate role names appearing in getRolesAllowed are insignificant and may be discarded. The String "*" has no special meaning as a role name (should it occur in getRolesAllowed). | true |
| true |
| Servlet:JAVADOC:876 | TransportGuarantee | jakarta.servlet.HttpConstraintElement.getTransportGuarantee
| Gets the data protection requirement (i.e., whether or not SSL/TLS is required) that must be satisfied by the transport connection. | true |
| true |
| Servlet:JAVADOC:877 | HttpConstraintElement | jakarta.servlet.HttpConstraintElement.HttpConstraintElement
| Constructs a default HTTP constraint element | true |
| true |
| Servlet:JAVADOC:878 | HttpConstraintElement | jakarta.servlet.HttpConstraintElement.HttpConstraintElement
(
EmptyRoleSemantic
)
| Convenience constructor to establish EmptyRoleSemantic.DENY | true |
| true |
| Servlet:JAVADOC:879 | HttpConstraintElement | jakarta.servlet.HttpConstraintElement.HttpConstraintElement
(
TransportGuarantee
,
String[]
)
| Constructor to establish non-empty getRolesAllowed and/or TransportGuarantee.CONFIDENTIAL. | true |
| true |
| Servlet:JAVADOC:880 | HttpConstraintElement | jakarta.servlet.HttpConstraintElement.HttpConstraintElement
(
EmptyRoleSemantic
,
TransportGuarantee
,
String[]
)
| Constructor to establish all of getEmptyRoleSemantic, getRolesAllowed, and getTransportGuarantee. | true |
| true |
| Servlet:JAVADOC:881 | String | jakarta.servlet.HttpMethodConstraintElement.getMethodName
| Gets the HTTP method name. | true |
| true |
| Servlet:JAVADOC:882 | HttpMethodConstraintElement | jakarta.servlet.HttpMethodConstraintElement.HttpMethodConstraintElement
(
String
)
| Constructs an instance with default HttpConstraintElement value. | true |
| true |
| Servlet:JAVADOC:883 | HttpMethodConstraintElement | jakarta.servlet.HttpMethodConstraintElement.HttpMethodConstraintElement
(
String
,
HttpConstraintElement
)
| Constructs an instance with specified HttpConstraintElement value. | true |
| true |
| Servlet:JAVADOC:884 | int | jakarta.servlet.MultipartConfigElement.getFileSizeThreshold
| Gets the size threshold after which files will be written to disk. | true |
| true |
| Servlet:JAVADOC:885 | String | jakarta.servlet.MultipartConfigElement.getLocation
| Gets the directory location where files will be stored. | true |
| true |
| Servlet:JAVADOC:886 | long | jakarta.servlet.MultipartConfigElement.getMaxFileSize
| Gets the maximum size allowed for uploaded files. | true |
| true |
| Servlet:JAVADOC:887 | long | jakarta.servlet.MultipartConfigElement.getMaxRequestSize
| Gets the maximum size allowed for multipart/form-data requests. | true |
| true |
| Servlet:JAVADOC:888 | MultipartConfigElement | jakarta.servlet.MultipartConfigElement.MultipartConfigElement
(
String
)
| Constructs an instance with defaults for all but location. | true |
| true |
| Servlet:JAVADOC:889 | MultipartConfigElement | jakarta.servlet.MultipartConfigElement.MultipartConfigElement
(
String
,
long
,
long
,
int
)
| Constructs an instance with all values specified. | true |
| true |
| Servlet:JAVADOC:890 | MultipartConfigElement | jakarta.servlet.MultipartConfigElement.MultipartConfigElement
(
MultipartConfig
)
| Constructs an instance from a MultipartConfig annotation value. | true |
| true |
| Servlet:JAVADOC:891 | void | jakarta.servlet.ServletContext.declareRoles
(
String[]
)
| Declares role names that are tested using isUserInRole. Roles that are implicitly declared as a result of their use within the ServletRegistration.Dynamic#setServletSecurity setServletSecurity or ServletRegistration.Dynamic#setRunAsRole setRunAsRole methods of the ServletRegistration interface need not be declared. | true |
| true |
| Servlet:JAVADOC:892 | String | jakarta.servlet.ServletRegistration.getRunAsRole
| Gets the name of the runAs role of the Servlet represented by this ServletRegistration. | true |
| true |
| Servlet:JAVADOC:893 | void | jakarta.servlet.ServletRegistration.Dynamic.setMultipartConfig
(
MultipartConfigElement
)
| Sets the MultipartConfigElement to be applied to the mappings defined for this ServletRegistration. | true |
| true |
| Servlet:JAVADOC:893.1 | void | jakarta.servlet.ServletRegistration.Dynamic.setMultipartConfig
(
MultipartConfigElement
)
| If this method is called multiple times, each successive call overrides the effects of the former. | true |
| true |
| Servlet:JAVADOC:893.2 | void | jakarta.servlet.ServletRegistration.Dynamic.setMultipartConfig
(
MultipartConfigElement
)
throws
IllegalArgumentException
| if multipartConfig is null | true |
| true |
| Servlet:JAVADOC:893.3 | void | jakarta.servlet.ServletRegistration.Dynamic.setMultipartConfig
(
MultipartConfigElement
)
throws
IllegalStateException
| if the ServletContext from which this ServletRegistration was obtained has already been initialized | true |
| true |
| Servlet:JAVADOC:894 | void | jakarta.servlet.ServletRegistration.Dynamic.setRunAsRole
(
String
)
| Sets the name of the runAs role for the ServletRegistration. | true |
| true |
| Servlet:JAVADOC:894.1 | void | jakarta.servlet.ServletRegistration.Dynamic.setRunAsRole
(
String
)
throws
IllegalArgumentException
| if roleName is null | true |
| true |
| Servlet:JAVADOC:894.2 | void | jakarta.servlet.ServletRegistration.Dynamic.setRunAsRole
(
String
)
throws
IllegalStateException
| if the ServletContext from which this ServletRegistration was obtained has already been initialized | true |
| true |
| Servlet:JAVADOC:895 | Set | jakarta.servlet.ServletRegistration.Dynamic.setServletSecurity
(
ServletSecurityElement
)
| Sets the ServletSecurityElement to be applied to the mappings currently assigned to this ServletRegistration. | true |
| true |
| Servlet:JAVADOC:895.1 | Set | jakarta.servlet.ServletRegistration.Dynamic.setServletSecurity
(
ServletSecurityElement
)
| Any mappings added to this ServletRegistration after a call to this method may be secured by a subsequent call to this method. | true |
| true |
| Servlet:JAVADOC:895.2 | Set | jakarta.servlet.ServletRegistration.Dynamic.setServletSecurity
(
ServletSecurityElement
)
| If a url-pattern of this ServletRegistration is an exact target of a security-constraint that was established via the portable deployment descriptor, then this method does not change the security-constraint for that pattern, and the pattern will be included in the return value. | true |
| true |
| Servlet:JAVADOC:895.3 | Set | jakarta.servlet.ServletRegistration.Dynamic.setServletSecurity
(
ServletSecurityElement
)
| If a url-pattern of this ServletRegistration is an exact target of a security constraint that was established via the jakarta.servlet.annotation.ServletSecurity annotation or a previous call to this method, then this method replaces the security constraint for that pattern. | true |
| true |
| Servlet:JAVADOC:895.4 | Set | jakarta.servlet.ServletRegistration.Dynamic.setServletSecurity
(
ServletSecurityElement
)
| If a url-pattern of this ServletRegistration is neither the exact target of a security constraint that was established via the jakarta.servlet.annotation.ServletSecurity annotation or a previous call to this method, nor the exact target of a security-constraint in the portable deployment descriptor, then this method establishes the security constraint for that pattern from the argument ServletSecurityElement. | true |
| true |
| Servlet:JAVADOC:895.5 | Set | jakarta.servlet.ServletRegistration.Dynamic.setServletSecurity
(
ServletSecurityElement
)
throws
IllegalArgumentException
| if constraint is null | true |
| true |
| Servlet:JAVADOC:895.6 | Set | jakarta.servlet.ServletRegistration.Dynamic.setServletSecurity
(
ServletSecurityElement
)
throws
IllegalStateException
| if the ServletContext from which this ServletRegistration was obtained has already been initialized | true |
| true |
| Servlet:JAVADOC:896 | Collection | jakarta.servlet.ServletSecurityElement.getHttpMethodConstraints
| Gets the (possibly empty) collection of HTTP Method specific constraint elements. | true |
| true |
| Servlet:JAVADOC:897 | Collection | jakarta.servlet.ServletSecurityElement.getMethodNames
| Gets the set of HTTP methid names named by the HttpMethodConstraints. | true |
| true |
| Servlet:JAVADOC:898 | ServletSecurityElement | jakarta.servlet.ServletSecurityElement.ServletSecurityElement
| Constructs an instance using the default HttpConstraintElement value as the default Constraint element and with no HTTP Method specific constraint elements. | true |
| true |
| Servlet:JAVADOC:899 | ServletSecurityElement | jakarta.servlet.ServletSecurityElement.ServletSecurityElement
(
HttpConstraintElement
)
| Constructs an instance with a default Constraint element and with no HTTP Method specific constraint elements. | true |
| true |
| Servlet:JAVADOC:900 | ServletSecurityElement | jakarta.servlet.ServletSecurityElement.ServletSecurityElement
(
Collection
)
| Constructs an instance using the default HttpConstraintElement value as the default Constraint element and with a collection of HTTP Method specific constraint elements. | true |
| true |
| Servlet:JAVADOC:901 | ServletSecurityElement | jakarta.servlet.ServletSecurityElement.ServletSecurityElement
(
HttpConstraintElement
,
Collection
)
| Constructs an instance with a default Constraint element and with a collection of HTTP Method specific constraint elements. | true |
| true |
| Servlet:JAVADOC:902 | ServletSecurityElement | jakarta.servlet.ServletSecurityElement.ServletSecurityElement
(
ServletSecurity
)
| Constructs an instance from a ServletSecurity annotation value. | true |
| true |
| Servlet:JAVADOC:903 | String | jakarta.servlet.annotation.WebServlet.displayName
| The display name of the servlet | true |
| true |
| Servlet:JAVADOC:904 | void | jakarta.servlet.ReadListener.onAllDataRead
| Invoked when all data for the current request has been read. | true |
| true |
| Servlet:JAVADOC:944 | void | jakarta.servlet.ReadListener.onAllDataRead
throws
IOException
| if an I/O related error has occurred during processing | true |
| true |
| Servlet:JAVADOC:905 | void | jakarta.servlet.ReadListener.onDataAvailable
| When an instance of the ReadListener is registered with a ServletInputStream,
this method will be invoked by the container the first time when it is possible
to read data. Subsequently the container will invoke this method if and only
if jakarta.servlet.ServletInputStream#isReady() method
has been called and has returned false.
| true |
| true |
| Servlet:JAVADOC:945 | void | jakarta.servlet.ReadListener.onDataAvailable
throws
IOException
| if an I/O related error has occurred during processing | true |
| true |
| Servlet:JAVADOC:906 | void | jakarta.servlet.ReadListener.onError
(
Throwable
)
| Invoked when an error occurs processing the request. | true |
| true |
| Servlet:JAVADOC:907 | boolean | jakarta.servlet.ServletInputStream.isFinished
| Returns true when all the data from the stream has been read else it returns false. | true |
| true |
| Servlet:JAVADOC:908 | boolean | jakarta.servlet.ServletInputStream.isReady
| Returns true if data can be read without blocking else returns false. | true |
| true |
| Servlet:JAVADOC:909 | void | jakarta.servlet.ServletInputStream.setReadListener
(
ReadListener
)
| Instructs the ServletInputStream to invoke the provided ReadListener when it is possible to read | true |
| true |
| Servlet:JAVADOC:941 | void | jakarta.servlet.ServletInputStream.setReadListener
(
ReadListener
)
throws
IllegalStateException
| the associated request is neither upgraded nor the async started | true |
| true |
| Servlet:JAVADOC:942 | void | jakarta.servlet.ServletInputStream.setReadListener
(
ReadListener
)
throws
IllegalStateException
| setWriteListener is called more than once within the scope of the same request. | true |
| true |
| Servlet:JAVADOC:943 | void | jakarta.servlet.ServletInputStream.setReadListener
(
ReadListener
)
throws
NullPointerException
| if readListener is null | true |
| true |
| Servlet:JAVADOC:910 | boolean | jakarta.servlet.ServletOutputStream.isReady
| This method can be used to determine if data can be written without blocking. | true |
| true |
| Servlet:JAVADOC:911 | void | jakarta.servlet.ServletOutputStream.setWriteListener
(
WriteListener
)
| Instructs the ServletOutputStream to invoke the provided WriteListener when it is possible to write | true |
| true |
| Servlet:JAVADOC:938 | void | jakarta.servlet.ServletOutputStream.setWriteListener
(
WriteListener
)
throws
IllegalStateException
| the associated request is neither upgraded nor the async started | true |
| true |
| Servlet:JAVADOC:939 | void | jakarta.servlet.ServletOutputStream.setWriteListener
(
WriteListener
)
throws
IllegalStateException
| setWriteListener is called more than once within the scope of the same request. | true |
| true |
| Servlet:JAVADOC:940 | void | jakarta.servlet.ServletOutputStream.setWriteListener
(
WriteListener
)
throws
NullPointerException
| if writeListener is null | true |
| true |
| Servlet:JAVADOC:912 | long | jakarta.servlet.ServletRequest.getContentLengthLong
| Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known. For HTTP servlets, same as the value of the CGI variable CONTENT_LENGTH. | true |
| true |
| Servlet:JAVADOC:913 | long | jakarta.servlet.ServletRequestWrapper.getContentLengthLong
| The default behavior of this method is to return getContentLengthLong() on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:914 | void | jakarta.servlet.ServletResponse.setContentLengthLong
(
long
)
| Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header. | true |
| true |
| Servlet:JAVADOC:915 | void | jakarta.servlet.ServletResponseWrapper.setContentLengthLong
(
long
)
| The default behavior of this method is to call setContentLengthLong(long len) on the wrapped response object. | true |
| true |
| Servlet:JAVADOC:916 | void | jakarta.servlet.WriteListener.onError
(
Throwable
)
| Invoked when an error occurs writing data using the non-blocking APIs. | true |
| true |
| Servlet:JAVADOC:917 | void | jakarta.servlet.WriteListener.onWritePossible
| When an instance of the WriteListener is registered with s ServletOutputStream,
this method will be invoked by the container the first time when it is possible
to write data. Subsequently the container will invoke this method if and only
if jakarta.servlet.ServletOutputStream#isReady() method
has been called and has returned false.
| true |
| true |
| Servlet:JAVADOC:946 | void | jakarta.servlet.WriteListener.onWritePossible
throws
IOException
| if an I/O related error has occurred during processing | true |
| true |
| Servlet:JAVADOC:922 | void | jakarta.servlet.http.ProtocolHandler.init
(
WebConnection
)
| It is called once the HTTP Upgrade process has been completed and the upgraded connection is ready to start using the new protocol. | true |
| true |
| Servlet:JAVADOC:923 | ServletInputStream | jakarta.servlet.http.WebConnection.getInputStream
| Returns an input stream for this web connection. | true |
| true |
| Servlet:JAVADOC:924 | ServletInputStream | jakarta.servlet.http.WebConnection.getInputStream
throws
IOException
| if an I/O error occurs | true |
| true |
| Servlet:JAVADOC:925 | ServletOutputStream | jakarta.servlet.http.WebConnection.getOutputStream
| Returns an output stream for this web connection. | true |
| true |
| Servlet:JAVADOC:926 | ServletOutputStream | jakarta.servlet.http.WebConnection.getOutputStream
throws
IOException
| if an I/O error occurs | true |
| true |
| Servlet:JAVADOC:929 | String | jakarta.servlet.http.HttpServletRequest.changeSessionId
| Change the session id of the current session associated with this request and return the new session id. | true |
| true |
| Servlet:JAVADOC:929.1 | String | jakarta.servlet.http.HttpServletRequest.changeSessionId
throws
IllegalStateException
| If there is no session associated with the request | true |
| true |
| Servlet:JAVADOC:930 | HttpUpgradeHandler | jakarta.servlet.http.HttpServletRequest.upgrade
(
Class
)
| Create an instance of HttpUpgradeHandler for an given class and uses it for the http protocol upgrade processing. | true |
| true |
| Servlet:JAVADOC:931 | HttpUpgradeHandler | jakarta.servlet.http.HttpServletRequest.upgrade
(
Class
)
throws
IOException
| if an I/O error occurred during the upgrade | true |
| true |
| Servlet:JAVADOC:932 | String | jakarta.servlet.http.HttpServletRequestWrapper.changeSessionId
| The default behavior of this method is to return changeSessionId() on the wrapped request object. | true |
| true |
| Servlet:JAVADOC:932.1 | String | jakarta.servlet.http.HttpServletRequestWrapper.changeSessionId
throws
IllegalStateException
| If there is no session associated with the request | true |
| true |
| Servlet:JAVADOC:933 | HttpUpgradeHandler | jakarta.servlet.http.HttpServletRequestWrapper.upgrade
(
Class
)
| Create an instance of HttpUpgradeHandler for an given class and uses it for the http protocol upgrade processing. | true |
| true |
| Servlet:JAVADOC:934 | HttpUpgradeHandler | jakarta.servlet.http.HttpServletRequestWrapper.upgrade
(
Class
)
throws
IOException
|
| true |
| true |
| Servlet:JAVADOC:935 | void | jakarta.servlet.http.HttpSessionIdListener.sessionIdChanged
(
HttpSessionEvent
,
String
)
| Receives notification that session id has been changed in a session. | true |
| true |
| Servlet:JAVADOC:936 | void | jakarta.servlet.http.HttpUpgradeHandler.destroy
| It is called when the client is disconnected. | true |
| true |
| Servlet:JAVADOC:937 | void | jakarta.servlet.http.HttpUpgradeHandler.init
(
WebConnection
)
| It is called once the HTTP Upgrade process has been completed and the upgraded connection is ready to start using the new protocol. | true |
| true |