Index (Servlet 6.1 API Documentation

A B C D E F G H I J L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

access(Consumer<HttpSession>) - Method in interface jakarta.servlet.http.HttpSession.Accessor: Call to access the session with the same semantics as if the session was accessed during an HTTP request.
addCookie(Cookie) - Method in interface jakarta.servlet.http.HttpServletResponse: Adds the specified cookie to the response.
addCookie(Cookie) - Method in class jakarta.servlet.http.HttpServletResponseWrapper: The default behavior of this method is to call addCookie(Cookie cookie) on the wrapped response object.
addDateHeader(String, long) - Method in interface jakarta.servlet.http.HttpServletResponse: Adds a response header with the given name and date-value.
addDateHeader(String, long) - Method in class jakarta.servlet.http.HttpServletResponseWrapper: The default behavior of this method is to call addDateHeader(String name, long date) on the wrapped response object.
addFilter(String, Filter) - Method in interface jakarta.servlet.ServletContext: Add filter to context.
addFilter(String, Class<? extends Filter>) - Method in interface jakarta.servlet.ServletContext: Add filter to context.
addFilter(String, String) - Method in interface jakarta.servlet.ServletContext: Add filter to context.
addHeader(String, String) - Method in interface jakarta.servlet.http.HttpServletResponse: Adds a response header with the given name and value.
addHeader(String, String) - Method in class jakarta.servlet.http.HttpServletResponseWrapper: The default behavior of this method is to return addHeader(String name, String value) on the wrapped response object.
addHeader(String, String) - Method in interface jakarta.servlet.http.PushBuilder: Deprecated.

Adds an HTTP header to the request.
addIntHeader(String, int) - Method in interface jakarta.servlet.http.HttpServletResponse: Adds a response header with the given name and integer value.
addIntHeader(String, int) - Method in class jakarta.servlet.http.HttpServletResponseWrapper: The default behavior of this method is to call addIntHeader(String name, int value) on the wrapped response object.
addJspFile(String, String) - Method in interface jakarta.servlet.ServletContext: Add a JSP to the context.
addListener(AsyncListener) - Method in interface jakarta.servlet.AsyncContext: Adds an event listener that will be called for different AsyncEvents fire
addListener(AsyncListener, ServletRequest, ServletResponse) - Method in interface jakarta.servlet.AsyncContext: Adds an event listener that will be called when different AsyncEvents fire
addListener(Class<? extends EventListener>) - Method in interface jakarta.servlet.ServletContext: TODO SERVLET3 - Add comments
addListener(String) - Method in interface jakarta.servlet.ServletContext: TODO SERVLET3 - Add comments
addListener(T) - Method in interface jakarta.servlet.ServletContext: TODO SERVLET3 - Add comments
addMapping(String...) - Method in interface jakarta.servlet.ServletRegistration: Adds a servlet mapping with the given URL patterns for the Servlet represented by this ServletRegistration.
addMappingForServletNames(EnumSet<DispatcherType>, boolean, String...) - Method in interface jakarta.servlet.FilterRegistration: Add a mapping for this filter to one or more named Servlets.
addMappingForUrlPatterns(EnumSet<DispatcherType>, boolean, String...) - Method in interface jakarta.servlet.FilterRegistration: Add a mapping for this filter to one or more URL patterns.
addServlet(String, Servlet) - Method in interface jakarta.servlet.ServletContext: Register a servlet instance for use in this ServletContext.
addServlet(String, Class<? extends Servlet>) - Method in interface jakarta.servlet.ServletContext: Add servlet to the context.
addServlet(String, String) - Method in interface jakarta.servlet.ServletContext: Register a servlet implementation for use in this ServletContext.
ASYNC - Enum constant in enum class jakarta.servlet.DispatcherType: AsyncContext.dispatch(), AsyncContext.dispatch(String) and AsyncContext.addListener(AsyncListener, ServletRequest, ServletResponse)
ASYNC_CONTEXT_PATH - Static variable in interface jakarta.servlet.AsyncContext: The attribute name for the Context Path of the async request
ASYNC_MAPPING - Static variable in interface jakarta.servlet.AsyncContext: The attribute name for the Mapping of the async request
ASYNC_PATH_INFO - Static variable in interface jakarta.servlet.AsyncContext: The attribute name for the Path Info of the async request
ASYNC_QUERY_STRING - Static variable in interface jakarta.servlet.AsyncContext: The attribute name for the Query String of the async request
ASYNC_REQUEST_URI - Static variable in interface jakarta.servlet.AsyncContext: The attribute name for the URI of the async request
ASYNC_SERVLET_PATH - Static variable in interface jakarta.servlet.AsyncContext: The attribute name for the Servlet Path of the async request
AsyncContext - Interface in jakarta.servlet: Provides the context for asynchronous request handling
AsyncEvent - Class in jakarta.servlet: Used to pass data to the methods of AsyncListener.
AsyncEvent(AsyncContext) - Constructor for class jakarta.servlet.AsyncEvent: Creates an instance using the provide parameters.
AsyncEvent(AsyncContext, ServletRequest, ServletResponse) - Constructor for class jakarta.servlet.AsyncEvent: Creates an instance using the provide parameters.
AsyncEvent(AsyncContext, ServletRequest, ServletResponse, Throwable) - Constructor for class jakarta.servlet.AsyncEvent: Creates an instance using the provide parameters.
AsyncEvent(AsyncContext, Throwable) - Constructor for class jakarta.servlet.AsyncEvent: Creates an instance using the provide parameters.
AsyncListener - Interface in jakarta.servlet: Listener for events associated with an AsyncContext.
asyncSupported() - Element in annotation interface jakarta.servlet.annotation.WebFilter
asyncSupported() - Element in annotation interface jakarta.servlet.annotation.WebServlet
attributeAdded(HttpSessionBindingEvent) - Method in interface jakarta.servlet.http.HttpSessionAttributeListener: Notification that an attribute has been added to a session.
attributeAdded(ServletContextAttributeEvent) - Method in interface jakarta.servlet.ServletContextAttributeListener: Notification that a new attribute was added to the servlet context.
attributeAdded(ServletRequestAttributeEvent) - Method in interface jakarta.servlet.ServletRequestAttributeListener: Notification that a new attribute was added to the servlet request.
attributeRemoved(HttpSessionBindingEvent) - Method in interface jakarta.servlet.http.HttpSessionAttributeListener: Notification that an attribute has been removed from a session.
attributeRemoved(ServletContextAttributeEvent) - Method in interface jakarta.servlet.ServletContextAttributeListener: Notification that an existing attribute has been removed from the servlet context.
attributeRemoved(ServletRequestAttributeEvent) - Method in interface jakarta.servlet.ServletRequestAttributeListener: Notification that an existing attribute has been removed from the servlet request.
attributeReplaced(HttpSessionBindingEvent) - Method in interface jakarta.servlet.http.HttpSessionAttributeListener: Notification that an attribute has been replaced in a session.
attributeReplaced(ServletContextAttributeEvent) - Method in interface jakarta.servlet.ServletContextAttributeListener: Notification that an attribute on the servlet context has been replaced.
attributeReplaced(ServletRequestAttributeEvent) - Method in interface jakarta.servlet.ServletRequestAttributeListener: Notification that an attribute was replaced on the servlet request.
authenticate(HttpServletResponse) - Method in interface jakarta.servlet.http.HttpServletRequest: Triggers the same authentication process as would be triggered if the request is for a resource that is protected by a security constraint.
authenticate(HttpServletResponse) - Method in class jakarta.servlet.http.HttpServletRequestWrapper: Triggers the same authentication process as would be triggered if the request is for a resource that is protected by a security constraint.

B

BASIC_AUTH - Static variable in interface jakarta.servlet.http.HttpServletRequest: String identifier for Basic authentication.

C

changeSessionId() - Method in interface jakarta.servlet.http.HttpServletRequest: Changes the session ID of the session associated with this request.
changeSessionId() - Method in class jakarta.servlet.http.HttpServletRequestWrapper: The default behavior of this method is to call changeSessionId() on the wrapped request object.
CLIENT_CERT_AUTH - Static variable in interface jakarta.servlet.http.HttpServletRequest: String identifier for Client Certificate authentication.
clone() - Method in class jakarta.servlet.http.Cookie: Overrides the standard java.lang.Object.clone method to return a copy of this cookie.
close() - Method in class jakarta.servlet.ServletOutputStream
complete() - Method in interface jakarta.servlet.AsyncContext: Completes the async request processing and closes the response stream
CONFIDENTIAL - Enum constant in enum class jakarta.servlet.annotation.ServletSecurity.TransportGuarantee: The container MUST encrypt user data during transport
containsHeader(String) - Method in interface jakarta.servlet.http.HttpServletResponse: Returns a boolean indicating whether the named response header has already been set.
containsHeader(String) - Method in class jakarta.servlet.http.HttpServletResponseWrapper: The default behavior of this method is to call containsHeader(String name) on the wrapped response object.
CONTEXT_ROOT - Enum constant in enum class jakarta.servlet.http.MappingMatch: The request was mapped to the servlet via the context root URL pattern of "".
contextDestroyed(ServletContextEvent) - Method in interface jakarta.servlet.ServletContextListener: Notification that the servlet context is about to be shut down.
contextInitialized(ServletContextEvent) - Method in interface jakarta.servlet.ServletContextListener: Notification that the web application initialization process is starting.
Cookie - Class in jakarta.servlet.http: Creates a cookie, a small amount of information sent by a servlet to a Web browser, saved by the browser, and later sent back to the server.
Cookie(String, String) - Constructor for class jakarta.servlet.http.Cookie: Constructs a cookie with a specified name and value.
COOKIE - Enum constant in enum class jakarta.servlet.SessionTrackingMode: Use HTTP cookies.
createFilter(Class<T>) - Method in interface jakarta.servlet.ServletContext: Create a Filter instance using the given class.
createListener(Class<T>) - Method in interface jakarta.servlet.AsyncContext: Creates and returns an AsyncListener object
createListener(Class<T>) - Method in interface jakarta.servlet.ServletContext: TODO SERVLET3 - Add comments
createServlet(Class<T>) - Method in interface jakarta.servlet.ServletContext: Create an Servlet instance using the given class.

D

declareRoles(String...) - Method in interface jakarta.servlet.ServletContext: Add to the declared roles for this ServletContext.
DEFAULT - Enum constant in enum class jakarta.servlet.http.MappingMatch: The request was mapped to the servlet via the default servlet URL pattern of "/" .
delete() - Method in interface jakarta.servlet.http.Part: Deletes the underlying storage for a part, including deleting any associated temporary disk file.
DENY - Enum constant in enum class jakarta.servlet.annotation.ServletSecurity.EmptyRoleSemantic: Access MUST be denied, regardless of authentication state or identity
description() - Element in annotation interface jakarta.servlet.annotation.WebFilter
description() - Element in annotation interface jakarta.servlet.annotation.WebInitParam
description() - Element in annotation interface jakarta.servlet.annotation.WebServlet
destroy() - Method in interface jakarta.servlet.Filter: Called by the web container to indicate to a filter that it is being taken out of service.
destroy() - Method in class jakarta.servlet.GenericServlet: Called by the servlet container to indicate to a servlet that the servlet is being taken out of service.
destroy() - Method in interface jakarta.servlet.http.HttpUpgradeHandler: This method is called after the upgraded connection has been closed.
destroy() - Method in interface jakarta.servlet.Servlet: Called by the servlet container to indicate to a servlet that the servlet is being taken out of service.
DIGEST_AUTH - Static variable in interface jakarta.servlet.http.HttpServletRequest: String identifier for Digest authentication.
dispatch() - Method in interface jakarta.servlet.AsyncContext
dispatch(ServletContext, String) - Method in interface jakarta.servlet.AsyncContext
dispatch(String) - Method in interface jakarta.servlet.AsyncContext
DispatcherType - Enum Class in jakarta.servlet: Enumeration of dispatcher types.
dispatcherTypes() - Element in annotation interface jakarta.servlet.annotation.WebFilter
displayName() - Element in annotation interface jakarta.servlet.annotation.WebFilter
displayName() - Element in annotation interface jakarta.servlet.annotation.WebServlet
doDelete(HttpServletRequest, HttpServletResponse) - Method in class jakarta.servlet.http.HttpServlet: Called by the server (via the service method) to allow a servlet to handle a DELETE request.
doFilter(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class jakarta.servlet.http.HttpFilter: 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.
doFilter(ServletRequest, ServletResponse) - Method in interface jakarta.servlet.FilterChain: 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.
doFilter(ServletRequest, ServletResponse, FilterChain) - Method in interface jakarta.servlet.Filter: 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.
doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class jakarta.servlet.http.HttpFilter: 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.
doGet(HttpServletRequest, HttpServletResponse) - Method in class jakarta.servlet.http.HttpServlet: Called by the server (via the service method) to allow a servlet to handle a GET request.
doHead(HttpServletRequest, HttpServletResponse) - Method in class jakarta.servlet.http.HttpServlet: Receives an HTTP HEAD request from the protected service method and handles the request.
doOptions(HttpServletRequest, HttpServletResponse) - Method in class jakarta.servlet.http.HttpServlet: Called by the server (via the service method) to allow a servlet to handle an OPTIONS request.
doPatch(HttpServletRequest, HttpServletResponse) - Method in class jakarta.servlet.http.HttpServlet: Called by the server (via the service method) to allow a servlet to handle a PATCH request.
doPost(HttpServletRequest, HttpServletResponse) - Method in class jakarta.servlet.http.HttpServlet: Called by the server (via the service method) to allow a servlet to handle a POST request.
doPut(HttpServletRequest, HttpServletResponse) - Method in class jakarta.servlet.http.HttpServlet: Called by the server (via the service method) to allow a servlet to handle a PUT request.
doTrace(HttpServletRequest, HttpServletResponse) - Method in class jakarta.servlet.http.HttpServlet: Called by the server (via the service method) to allow a servlet to handle a TRACE request.

E

emptyRoleSemantic() - Element in annotation interface jakarta.servlet.annotation.HttpMethodConstraint: The EmptyRoleSemantic determines the behaviour when the rolesAllowed list is empty.
encodeRedirectURL(String) - Method in interface jakarta.servlet.http.HttpServletResponse: Encodes the specified URL for use in the sendRedirect method or, if encoding is not needed, returns the URL unchanged.
encodeRedirectURL(String) - Method in class jakarta.servlet.http.HttpServletResponseWrapper: The default behavior of this method is to return encodeRedirectURL(String url) on the wrapped response object.
encodeURL(String) - Method in interface jakarta.servlet.http.HttpServletResponse: Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged.
encodeURL(String) - Method in class jakarta.servlet.http.HttpServletResponseWrapper: The default behavior of this method is to call encodeURL(String url) on the wrapped response object.
equals(Object) - Method in class jakarta.servlet.http.Cookie
ERROR - Enum constant in enum class jakarta.servlet.DispatcherType: When the container has passed processing to the error handler mechanism such as a defined error page.
ERROR_EXCEPTION - Static variable in interface jakarta.servlet.RequestDispatcher: The name of the request attribute that should be set by the container when custom error-handling servlet or JSP page is invoked.
ERROR_EXCEPTION_TYPE - Static variable in interface jakarta.servlet.RequestDispatcher: The name of the request attribute that should be set by the container when custom error-handling servlet or JSP page is invoked.
ERROR_MESSAGE - Static variable in interface jakarta.servlet.RequestDispatcher: The name of the request attribute that should be set by the container when custom error-handling servlet or JSP page is invoked.
ERROR_METHOD - Static variable in interface jakarta.servlet.RequestDispatcher: The name of the request attribute under which the method of the request whose processing caused the error is propagated during an error dispatch.
ERROR_QUERY_STRING - Static variable in interface jakarta.servlet.RequestDispatcher: The name of the request attribute under which the query string for request whose processing caused the error is propagated during an error dispatch
ERROR_REQUEST_URI - Static variable in interface jakarta.servlet.RequestDispatcher: The name of the request attribute that should be set by the container when custom error-handling servlet or JSP page is invoked.
ERROR_SERVLET_NAME - Static variable in interface jakarta.servlet.RequestDispatcher: The name of the request attribute that should be set by the container when custom error-handling servlet or JSP page is invoked.
ERROR_STATUS_CODE - Static variable in interface jakarta.servlet.RequestDispatcher: The name of the request attribute that should be set by the container when custom error-handling servlet or JSP page is invoked.
EXACT - Enum constant in enum class jakarta.servlet.http.MappingMatch: The request was mapped to the servlet using an exact URL pattern match.
EXTENSION - Enum constant in enum class jakarta.servlet.http.MappingMatch: The request was mapped to the servlet using an extension URL pattern match.

F

fileSizeThreshold() - Element in annotation interface jakarta.servlet.annotation.MultipartConfig
Filter - Interface in jakarta.servlet: A filter is an object that performs filtering tasks on either the request to a resource (a servlet or static content), or on the response from a resource, or both.
FilterChain - Interface in jakarta.servlet: A FilterChain is an object provided by the servlet container to the developer giving a view into the invocation chain of a filtered request for a resource.
FilterConfig - Interface in jakarta.servlet: A filter configuration object used by a servlet container to pass information to a filter during initialization.
filterName() - Element in annotation interface jakarta.servlet.annotation.WebFilter
FilterRegistration - Interface in jakarta.servlet: Interface through which a Filter may be further configured.
FilterRegistration.Dynamic - Interface in jakarta.servlet: Interface through which a Filter registered via one of the addFilter methods on ServletContext may be further configured.
flushBuffer() - Method in interface jakarta.servlet.ServletResponse: Forces any content in the buffer to be written to the client.
flushBuffer() - Method in class jakarta.servlet.ServletResponseWrapper: The default behavior of this method is to call flushBuffer() on the wrapped response object.
FORM_AUTH - Static variable in interface jakarta.servlet.http.HttpServletRequest: String identifier for Form authentication.
forward(ServletRequest, ServletResponse) - Method in interface jakarta.servlet.RequestDispatcher: Forwards a request from a servlet to another resource (servlet, JSP file, or HTML file) on the server.
FORWARD - Enum constant in enum class jakarta.servlet.DispatcherType: RequestDispatcher.forward(ServletRequest, ServletResponse)
FORWARD_CONTEXT_PATH - Static variable in interface jakarta.servlet.RequestDispatcher: The name of the request attribute that should be set by the container when the RequestDispatcher.forward(ServletRequest, ServletResponse) method is called.
FORWARD_MAPPING - Static variable in interface jakarta.servlet.RequestDispatcher: The name of the request attribute that should be set by the container when the RequestDispatcher.forward(ServletRequest, ServletResponse) method is called.
FORWARD_PATH_INFO - Static variable in interface jakarta.servlet.RequestDispatcher: The name of the request attribute that should be set by the container when the RequestDispatcher.forward(ServletRequest, ServletResponse) method is called.
FORWARD_QUERY_STRING - Static variable in interface jakarta.servlet.RequestDispatcher: The name of the request attribute that should be set by the container when the RequestDispatcher.forward(ServletRequest, ServletResponse) method is called.
FORWARD_REQUEST_URI - Static variable in interface jakarta.servlet.RequestDispatcher: The name of the request attribute that should be set by the container when the RequestDispatcher.forward(ServletRequest, ServletResponse) method is called.
FORWARD_SERVLET_PATH - Static variable in interface jakarta.servlet.RequestDispatcher: The name of the request attribute that should be set by the container when the RequestDispatcher.forward(ServletRequest, ServletResponse) method is called.

G

GenericFilter - Class in jakarta.servlet: Provides a base class that implements the Filter and FilterConfig interfaces to reduce boilerplate when writing new filters.
GenericFilter() - Constructor for class jakarta.servlet.GenericFilter
GenericServlet - Class in jakarta.servlet: Defines a generic, protocol-independent servlet.
GenericServlet() - Constructor for class jakarta.servlet.GenericServlet: Does nothing.
getAccessor() - Method in interface jakarta.servlet.http.HttpSession: Provides a mechanism for applications to interact with the HttpSession outside of the scope of an HTTP request.
getAsyncContext() - Method in class jakarta.servlet.AsyncEvent: Obtain the asynchronous context associated with the event.
getAsyncContext() - Method in interface jakarta.servlet.ServletRequest: Get the current AsyncContext.
getAsyncContext() - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return getAsyncContext() on the wrapped request object.
getAttribute(String) - Method in class jakarta.servlet.http.Cookie: Obtain the value for a given attribute.
getAttribute(String) - Method in interface jakarta.servlet.http.HttpSession: Returns the object bound with the specified name in this session, or null if no object is bound under the name.
getAttribute(String) - Method in interface jakarta.servlet.ServletContext: Returns the servlet container attribute with the given name, or null if there is no attribute by that name.
getAttribute(String) - Method in interface jakarta.servlet.ServletRequest: Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
getAttribute(String) - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to call getAttribute(String name) on the wrapped request object.
getAttribute(String) - Method in interface jakarta.servlet.SessionCookieConfig: Obtain the value for a sesison cookie given attribute.
getAttributeNames() - Method in interface jakarta.servlet.http.HttpSession: Returns an Enumeration of String objects containing the names of all the objects bound to this session.
getAttributeNames() - Method in interface jakarta.servlet.ServletContext: Returns an Enumeration containing the attribute names available within this servlet context.
getAttributeNames() - Method in interface jakarta.servlet.ServletRequest: Returns an Enumeration containing the names of the attributes available to this request.
getAttributeNames() - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return getAttributeNames() on the wrapped request object.
getAttributes() - Method in class jakarta.servlet.http.Cookie: Obtain the Map of attributes and values (excluding version) for this cookie.
getAttributes() - Method in interface jakarta.servlet.SessionCookieConfig: Obtain the Map of attributes and values (excluding version) for this session cookie.
getAuthType() - Method in interface jakarta.servlet.http.HttpServletRequest: Returns the name of the authentication scheme used to protect the servlet.
getAuthType() - Method in class jakarta.servlet.http.HttpServletRequestWrapper: The default behavior of this method is to return getAuthType() on the wrapped request object.
getBuffer() - Method in interface jakarta.servlet.descriptor.JspPropertyGroupDescriptor: Obtain the per-page buffer configuration for this group of JSP pages.
getBufferSize() - Method in interface jakarta.servlet.ServletResponse: Returns the actual buffer size used for the response.
getBufferSize() - Method in class jakarta.servlet.ServletResponseWrapper: The default behavior of this method is to return getBufferSize() on the wrapped response object.
getCharacterEncoding() - Method in interface jakarta.servlet.ServletRequest: Returns the name of the character encoding used in the body of this request.
getCharacterEncoding() - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return getCharacterEncoding() on the wrapped request object.
getCharacterEncoding() - Method in interface jakarta.servlet.ServletResponse: Returns the name of the character encoding (MIME charset) used for the body sent in this response.
getCharacterEncoding() - Method in class jakarta.servlet.ServletResponseWrapper: The default behavior of this method is to return getCharacterEncoding() on the wrapped response object.
getClassLoader() - Method in interface jakarta.servlet.ServletContext: Get the web application class loader associated with this ServletContext.
getClassName() - Method in interface jakarta.servlet.Registration: Obtain the name of the implementation class for the Servlet.
getComment() - Method in class jakarta.servlet.http.Cookie: Deprecated, for removal: This API element is subject to removal in a future version.
This is no longer required with RFC 6265
getComment() - Method in interface jakarta.servlet.SessionCookieConfig: Deprecated, for removal: This API element is subject to removal in a future version.
This is no longer required with RFC 6265
getConnectionId() - Method in interface jakarta.servlet.ServletConnection: Obtain a unique (within the lifetime of the JVM) identifier string for the network connection to the JVM that is being used for the ServletRequest from which this ServletConnection was obtained.
getContentLength() - Method in interface jakarta.servlet.ServletRequest: Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known.
getContentLength() - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return getContentLength() on the wrapped request object.
getContentLengthLong() - Method in interface jakarta.servlet.ServletRequest: Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known.
getContentLengthLong() - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return getContentLengthLong() on the wrapped request object.
getContentType() - Method in interface jakarta.servlet.http.Part: Obtain the content type passed by the browser.
getContentType() - Method in interface jakarta.servlet.ServletRequest: Returns the MIME type of the body of the request, or null if the type is not known.
getContentType() - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return getContentType() on the wrapped request object.
getContentType() - Method in interface jakarta.servlet.ServletResponse: Returns the content type used for the MIME body sent in this response.
getContentType() - Method in class jakarta.servlet.ServletResponseWrapper: The default behavior of this method is to return getContentType() on the wrapped response object.
getContext(String) - Method in interface jakarta.servlet.ServletContext: Returns a ServletContext object that corresponds to a specified URL on the server.
getContextPath() - Method in interface jakarta.servlet.http.HttpServletRequest: Returns the portion of the request URI that indicates the context of the request.
getContextPath() - Method in class jakarta.servlet.http.HttpServletRequestWrapper: The default behavior of this method is to return getContextPath() on the wrapped request object.
getContextPath() - Method in interface jakarta.servlet.ServletContext: Return the main path associated with this context.
getCookies() - Method in interface jakarta.servlet.http.HttpServletRequest: Returns an array containing all of the Cookie objects the client sent with this request.
getCookies() - Method in class jakarta.servlet.http.HttpServletRequestWrapper: The default behavior of this method is to return getCookies() on the wrapped request object.
getCreationTime() - Method in interface jakarta.servlet.http.HttpSession: Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.
getDateHeader(String) - Method in interface jakarta.servlet.http.HttpServletRequest: Returns the value of the specified request header as a long value that represents a Date object.
getDateHeader(String) - Method in class jakarta.servlet.http.HttpServletRequestWrapper: The default behavior of this method is to return getDateHeader(String name) on the wrapped request object.
getDefaultContentType() - Method in interface jakarta.servlet.descriptor.JspPropertyGroupDescriptor: Obtain the default content type this group of JSP pages
getDefaultSessionTrackingModes() - Method in interface jakarta.servlet.ServletContext: Obtains the default session tracking modes for this web application.
getDeferredSyntaxAllowedAsLiteral() - Method in interface jakarta.servlet.descriptor.JspPropertyGroupDescriptor: Is the deferred El syntax #{...} allowed to be used as a literal in this group?
getDispatcherType() - Method in interface jakarta.servlet.ServletRequest
getDispatcherType() - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to call getDispatcherType() on the wrapped request object.
getDomain() - Method in class jakarta.servlet.http.Cookie: Returns the domain name set for this cookie.
getDomain() - Method in interface jakarta.servlet.SessionCookieConfig: Obtain the domain to use for session cookies.
getEffectiveMajorVersion() - Method in interface jakarta.servlet.ServletContext: Obtain the major version of the servlet specification for which this web application is implemented.
getEffectiveMinorVersion() - Method in interface jakarta.servlet.ServletContext: Obtain the minor version of the servlet specification for which this web application is implemented.
getEffectiveSessionTrackingModes() - Method in interface jakarta.servlet.ServletContext: Obtains the currently enabled session tracking modes for this web application.
getElIgnored() - Method in interface jakarta.servlet.descriptor.JspPropertyGroupDescriptor: Is Expression Language ignored for this group?
getEmptyRoleSemantic() - Method in class jakarta.servlet.HttpConstraintElement: TODO
getErrorOnELNotFound() - Method in interface jakarta.servlet.descriptor.JspPropertyGroupDescriptor: Will the use of an unknown identifier in EL within a JSP page trigger an error for this group?
getErrorOnUndeclaredNamespace() - Method in interface jakarta.servlet.descriptor.JspPropertyGroupDescriptor: Should an error be raised at translation time for a page in this group if the page contains a reference (e.g. a tag) to a undeclared namespace.
getFileSizeThreshold() - Method in class jakarta.servlet.MultipartConfigElement: Obtain the size above which the file is save in the temporary location rather than retained in memory.
getFilterConfig() - Method in class jakarta.servlet.GenericFilter: Obtain the FilterConfig used to initialise this Filter instance.
getFilterName() - Method in interface jakarta.servlet.FilterConfig: Get the name of the filter.
getFilterName() - Method in class jakarta.servlet.GenericFilter
getFilterRegistration(String) - Method in interface jakarta.servlet.ServletContext: TODO SERVLET3 - Add comments
getFilterRegistrations() - Method in interface jakarta.servlet.ServletContext
getHeader(String) - Method in interface jakarta.servlet.http.HttpServletRequest: Returns the value of the specified request header as a String.
getHeader(String) - Method in class jakarta.servlet.http.HttpServletRequestWrapper: The default behavior of this method is to return getHeader(String name) on the wrapped request object.
getHeader(String) - Method in interface jakarta.servlet.http.HttpServletResponse: Return the value for the specified header, or null if this header has not been set.
getHeader(String) - Method in class jakarta.servlet.http.HttpServletResponseWrapper: Return the value for the specified header, or null if this header has not been set.
getHeader(String) - Method in interface jakarta.servlet.http.Part: Obtains the value of the specified part header as a String.
getHeader(String) - Method in interface jakarta.servlet.http.PushBuilder: Deprecated.

Obtain a value for the given HTTP header.
getHeaderNames() - Method in interface jakarta.servlet.http.HttpServletRequest: Returns an enumeration of all the header names this request contains.
getHeaderNames() - Method in class jakarta.servlet.http.HttpServletRequestWrapper: The default behavior of this method is to return getHeaderNames() on the wrapped request object.
getHeaderNames() - Method in interface jakarta.servlet.http.HttpServletResponse: Get the header names set for this HTTP response.
getHeaderNames() - Method in class jakarta.servlet.http.HttpServletResponseWrapper: Get the header names set for this HTTP response.
getHeaderNames() - Method in interface jakarta.servlet.http.Part: Get the header names provided for this part.
getHeaderNames() - Method in interface jakarta.servlet.http.PushBuilder: Deprecated.
getHeaders(String) - Method in interface jakarta.servlet.http.HttpServletRequest: Returns all the values of the specified request header as an Enumeration of String objects.
getHeaders(String) - Method in class jakarta.servlet.http.HttpServletRequestWrapper: The default behavior of this method is to return getHeaders(String name) on the wrapped request object.
getHeaders(String) - Method in interface jakarta.servlet.http.HttpServletResponse: Return a Collection of all the header values associated with the specified header name.
getHeaders(String) - Method in class jakarta.servlet.http.HttpServletResponseWrapper: Return a Collection of all the header values associated with the specified header name.
getHeaders(String) - Method in interface jakarta.servlet.http.Part: Obtain all the values of the specified part header.
getHttpMethodConstraints() - Method in class jakarta.servlet.ServletSecurityElement: Obtain the collection of security constraints configured for specific methods.
getHttpServletMapping() - Method in interface jakarta.servlet.http.HttpServletRequest: Obtain the mapping information for this request.
getHttpServletMapping() - Method in class jakarta.servlet.http.HttpServletRequestWrapper: The default behavior of this method is to return HttpServletRequest.getHttpServletMapping() on the wrapped request object.
getId() - Method in interface jakarta.servlet.http.HttpSession: Returns a string containing the unique identifier assigned to this session.
getIncludeCodas() - Method in interface jakarta.servlet.descriptor.JspPropertyGroupDescriptor: Obtain the codas to include for this group.
getIncludePreludes() - Method in interface jakarta.servlet.descriptor.JspPropertyGroupDescriptor: Obtain the preludes to include for this group.
getInitParameter(String) - Method in interface jakarta.servlet.FilterConfig: Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.
getInitParameter(String) - Method in class jakarta.servlet.GenericFilter
getInitParameter(String) - Method in class jakarta.servlet.GenericServlet: Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.
getInitParameter(String) - Method in interface jakarta.servlet.Registration: Get the value of an initialisation parameter.
getInitParameter(String) - Method in interface jakarta.servlet.ServletConfig: Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.
getInitParameter(String) - Method in interface jakarta.servlet.ServletContext: Returns a String containing the value of the named context-wide initialization parameter, or null if the parameter does not exist.
getInitParameterNames() - Method in interface jakarta.servlet.FilterConfig: Returns the names of the filter's initialization parameters as an Enumeration of String objects, or an empty Enumeration if the filter has no initialization parameters.
getInitParameterNames() - Method in class jakarta.servlet.GenericFilter
getInitParameterNames() - Method in class jakarta.servlet.GenericServlet: 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.
getInitParameterNames() - Method in interface jakarta.servlet.ServletConfig: 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.
getInitParameterNames() - Method in interface jakarta.servlet.ServletContext: Returns the names of the context's initialization parameters as an Enumeration of String objects, or an empty Enumeration if the context has no initialization parameters.
getInitParameters() - Method in interface jakarta.servlet.Registration: Get the names and values of all the initialisation parameters.
getInputStream() - Method in interface jakarta.servlet.http.Part: Obtain an InputStream that can be used to retrieve the contents of the file.
getInputStream() - Method in interface jakarta.servlet.http.WebConnection: Provides access to the ServletInputStream for reading data from the client.
getInputStream() - Method in interface jakarta.servlet.ServletRequest: Retrieves the body of the request as binary data using a ServletInputStream.
getInputStream() - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return getInputStream() on the wrapped request object.
getIntHeader(String) - Method in interface jakarta.servlet.http.HttpServletRequest: Returns the value of the specified request header as an int.
getIntHeader(String) - Method in class jakarta.servlet.http.HttpServletRequestWrapper: The default behavior of this method is to return getIntHeader(String name) on the wrapped request object.
getIsXml() - Method in interface jakarta.servlet.descriptor.JspPropertyGroupDescriptor: Should the JSPs in this group be treated as JSP documents?
getJspConfigDescriptor() - Method in interface jakarta.servlet.ServletContext
getJspPropertyGroups() - Method in interface jakarta.servlet.descriptor.JspConfigDescriptor: Provide the set of JSP property groups obtained from the <jsp-config> elements in the web application's deployment descriptors.
getLastAccessedTime() - Method in interface jakarta.servlet.http.HttpSession: 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 received the request.
getLastModified(HttpServletRequest) - Method in class jakarta.servlet.http.HttpServlet: Returns the time the HttpServletRequest object was last modified, in milliseconds since midnight January 1, 1970 GMT.
getLocalAddr() - Method in interface jakarta.servlet.ServletRequest: Returns the Internet Protocol (IP) address of the interface on which the request was received.
getLocalAddr() - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return getLocalAddr() on the wrapped request object.
getLocale() - Method in interface jakarta.servlet.ServletRequest: Returns the preferred Locale that the client will accept content in, based on the Accept-Language header.
getLocale() - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return getLocale() on the wrapped request object.
getLocale() - Method in interface jakarta.servlet.ServletResponse: Returns the locale specified for this response using the ServletResponse.setLocale(java.util.Locale) method.
getLocale() - Method in class jakarta.servlet.ServletResponseWrapper: The default behavior of this method is to return getLocale() on the wrapped response object.
getLocales() - Method in interface jakarta.servlet.ServletRequest: 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.
getLocales() - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return getLocales() on the wrapped request object.
getLocalName() - Method in interface jakarta.servlet.ServletRequest: Returns the host name of the Internet Protocol (IP) interface on which the request was received.
getLocalName() - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return getLocalName() on the wrapped request object.
getLocalPort() - Method in interface jakarta.servlet.ServletRequest: Returns the Internet Protocol (IP) port number of the interface on which the request was received.
getLocalPort() - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return getLocalPort() on the wrapped request object.
getLocation() - Method in class jakarta.servlet.MultipartConfigElement: Obtain the location where temporary files should be stored.
getMajorVersion() - Method in interface jakarta.servlet.ServletContext: Returns the major version of the Java Servlet API that this servlet container supports.
getMappingMatch() - Method in interface jakarta.servlet.http.HttpServletMapping
getMappings() - Method in interface jakarta.servlet.ServletRegistration: Gets the currently available mappings of the Servlet represented by this ServletRegistration.
getMatchValue() - Method in interface jakarta.servlet.http.HttpServletMapping
getMaxAge() - Method in class jakarta.servlet.http.Cookie: Returns the maximum age of the cookie, specified in seconds, By default, -1 indicating the cookie will persist until browser shutdown.
getMaxAge() - Method in interface jakarta.servlet.SessionCookieConfig: Obtain the maximum age to set for a session cookie.
getMaxFileSize() - Method in class jakarta.servlet.MultipartConfigElement: Obtain the maximum permitted size for a single file.
getMaxInactiveInterval() - Method in interface jakarta.servlet.http.HttpSession: Returns the maximum time interval, in seconds, that the servlet container will keep this session open between client accesses.
getMaxRequestSize() - Method in class jakarta.servlet.MultipartConfigElement: Obtain the maximum permitted size for a single request.
getMethod() - Method in interface jakarta.servlet.http.HttpServletRequest: Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
getMethod() - Method in class jakarta.servlet.http.HttpServletRequestWrapper: The default behavior of this method is to return getMethod() on the wrapped request object.
getMethod() - Method in interface jakarta.servlet.http.PushBuilder: Deprecated.

Obtain the name of the HTTP method that will be used for push requests generated by future calls to push().
getMethodName() - Method in class jakarta.servlet.HttpMethodConstraintElement: Obtain the name of the HTTP method for which this constraint was created.
getMethodNames() - Method in class jakarta.servlet.ServletSecurityElement: Obtain the collection HTTP methods for which security constraints have been defined.
getMimeType(String) - Method in interface jakarta.servlet.ServletContext: Returns the MIME type of the specified file, or null if the MIME type is not known.
getMinorVersion() - Method in interface jakarta.servlet.ServletContext: Returns the minor version of the Servlet API that this servlet container supports.
getName() - Method in class jakarta.servlet.http.Cookie: Returns the name of the cookie.
getName() - Method in class jakarta.servlet.http.HttpSessionBindingEvent: Returns the name with which the attribute is bound to or unbound from the session.
getName() - Method in interface jakarta.servlet.http.Part: Obtain the name of the field in the multipart form corresponding to this part.
getName() - Method in interface jakarta.servlet.Registration: Obtain the name of the Servlet.
getName() - Method in class jakarta.servlet.ServletContextAttributeEvent: Return the name of the attribute that changed on the ServletContext.
getName() - Method in class jakarta.servlet.ServletRequestAttributeEvent: Return the name of the attribute that changed on the ServletRequest.
getName() - Method in interface jakarta.servlet.SessionCookieConfig: Obtain the name to use for the session cookies.
getNamedDispatcher(String) - Method in interface jakarta.servlet.ServletContext: Returns a RequestDispatcher object that acts as a wrapper for the named servlet.
getOutputStream() - Method in interface jakarta.servlet.http.WebConnection: Provides access to the ServletOutputStream for writing data to the client.
getOutputStream() - Method in interface jakarta.servlet.ServletResponse: Returns a ServletOutputStream suitable for writing binary data in the response.
getOutputStream() - Method in class jakarta.servlet.ServletResponseWrapper: The default behavior of this method is to return getOutputStream() on the wrapped response object.
getPageEncoding() - Method in interface jakarta.servlet.descriptor.JspPropertyGroupDescriptor: Obtain the page encoding for this group.
getParameter(String) - Method in interface jakarta.servlet.ServletRequest: Returns the value of a request parameter as a String, or null if the parameter does not exist.
getParameter(String) - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return getParameter(String name) on the wrapped request object.
getParameterMap() - Method in interface jakarta.servlet.ServletRequest: Returns a java.util.Map of the parameters of this request.
getParameterMap() - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return getParameterMap() on the wrapped request object.
getParameterNames() - Method in interface jakarta.servlet.ServletRequest: Returns an Enumeration of String objects containing the names of the parameters contained in this request.
getParameterNames() - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return getParameterNames() on the wrapped request object.
getParameterValues(String) - Method in interface jakarta.servlet.ServletRequest: Returns an array of String objects containing all of the values the given request parameter has, or null if the parameter does not exist.
getParameterValues(String) - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return getParameterValues(String name) on the wrapped request object.
getPart(String) - Method in interface jakarta.servlet.http.HttpServletRequest: Gets the named Part or null if the Part does not exist.
getPart(String) - Method in class jakarta.servlet.http.HttpServletRequestWrapper: Gets the named Part or null if the Part does not exist.
getParts() - Method in interface jakarta.servlet.http.HttpServletRequest: Return a collection of all uploaded Parts.
getParts() - Method in class jakarta.servlet.http.HttpServletRequestWrapper: Return a collection of all uploaded Parts.
getPath() - Method in class jakarta.servlet.http.Cookie: Returns the path on the server to which the browser returns this cookie.
getPath() - Method in interface jakarta.servlet.http.PushBuilder: Deprecated.

Obtain the path that will be used for the push request that will be generated by the next call to push().
getPath() - Method in interface jakarta.servlet.SessionCookieConfig: Obtain the path to use for session cookies.
getPathInfo() - Method in interface jakarta.servlet.http.HttpServletRequest: Returns any extra path information associated with the URL the client sent when it made this request.
getPathInfo() - Method in class jakarta.servlet.http.HttpServletRequestWrapper: The default behavior of this method is to return getPathInfo() on the wrapped request object.
getPathTranslated() - Method in interface jakarta.servlet.http.HttpServletRequest: Returns any extra path information after the servlet name but before the query string, and translates it to a real path.
getPathTranslated() - Method in class jakarta.servlet.http.HttpServletRequestWrapper: The default behavior of this method is to return getPathTranslated() on the wrapped request object.
getPattern() - Method in interface jakarta.servlet.http.HttpServletMapping
getProtocol() - Method in interface jakarta.servlet.ServletConnection: Obtain the name of the protocol as presented to the server after the removal, if present, of any TLS or similar encryption.
getProtocol() - Method in interface jakarta.servlet.ServletRequest: Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1.
getProtocol() - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return getProtocol() on the wrapped request object.
getProtocolConnectionId() - Method in interface jakarta.servlet.ServletConnection: Obtain the connection identifier for the network connection to the server that is being used for the ServletRequest from which this ServletConnection was obtained as defined by the protocol in use.
getProtocolRequestId() - Method in interface jakarta.servlet.ServletRequest: Obtain the request identifier for this request as defined by the protocol in use.
getProtocolRequestId() - Method in class jakarta.servlet.ServletRequestWrapper: Gets the protocol defined request ID, if any, for the wrapped request.
getQueryString() - Method in interface jakarta.servlet.http.HttpServletRequest: Returns the query string that is contained in the request URL after the path.
getQueryString() - Method in class jakarta.servlet.http.HttpServletRequestWrapper: The default behavior of this method is to return getQueryString() on the wrapped request object.
getQueryString() - Method in interface jakarta.servlet.http.PushBuilder: Deprecated.

Obtain the query string that will be used for push requests generated by future calls to push().
getReader() - Method in interface jakarta.servlet.ServletRequest: Retrieves the body of the request as character data using a BufferedReader.
getReader() - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return getReader() on the wrapped request object.
getRealPath(String) - Method in interface jakarta.servlet.ServletContext: Returns a String containing the real path for a given virtual path.
getRemoteAddr() - Method in interface jakarta.servlet.ServletRequest: Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.
getRemoteAddr() - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return getRemoteAddr() on the wrapped request object.
getRemoteHost() - Method in interface jakarta.servlet.ServletRequest: Returns the fully qualified name of the client or the last proxy that sent the request.
getRemoteHost() - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return getRemoteHost() on the wrapped request object.
getRemotePort() - Method in interface jakarta.servlet.ServletRequest: Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.
getRemotePort() - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return getRemotePort() on the wrapped request object.
getRemoteUser() - Method in interface jakarta.servlet.http.HttpServletRequest: Returns the login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated.
getRemoteUser() - Method in class jakarta.servlet.http.HttpServletRequestWrapper: The default behavior of this method is to return getRemoteUser() on the wrapped request object.
getRequest() - Method in interface jakarta.servlet.AsyncContext
getRequest() - Method in class jakarta.servlet.ServletRequestWrapper: Get the wrapped request.
getRequestCharacterEncoding() - Method in interface jakarta.servlet.ServletContext: Get the default character encoding for reading request bodies.
getRequestDispatcher(String) - Method in interface jakarta.servlet.ServletContext: Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path.
getRequestDispatcher(String) - Method in interface jakarta.servlet.ServletRequest: Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path.
getRequestDispatcher(String) - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return getRequestDispatcher(String path) on the wrapped request object.
getRequestedSessionId() - Method in interface jakarta.servlet.http.HttpServletRequest: Returns the session ID specified by the client.
getRequestedSessionId() - Method in class jakarta.servlet.http.HttpServletRequestWrapper: The default behavior of this method is to return getRequestedSessionId() on the wrapped request object.
getRequestId() - Method in interface jakarta.servlet.ServletRequest: Obtain a unique (within the lifetime of the Servlet container) identifier string for this request.
getRequestId() - Method in class jakarta.servlet.ServletRequestWrapper: Gets the request ID for the wrapped request.
getRequestURI() - Method in interface jakarta.servlet.http.HttpServletRequest: 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.
getRequestURI() - Method in class jakarta.servlet.http.HttpServletRequestWrapper: The default behavior of this method is to return getRequestURI() on the wrapped request object.
getRequestURL() - Method in interface jakarta.servlet.http.HttpServletRequest: Reconstructs the URL the client used to make the request.
getRequestURL() - Method in class jakarta.servlet.http.HttpServletRequestWrapper: The default behavior of this method is to return getRequestURL() on the wrapped request object.
getResource(String) - Method in interface jakarta.servlet.ServletContext: Returns a URL to the resource that is mapped to a specified path.
getResourceAsStream(String) - Method in interface jakarta.servlet.ServletContext: Returns the resource located at the named path as an InputStream object.
getResourcePaths(String) - Method in interface jakarta.servlet.ServletContext: Returns a directory-like listing of all the paths to resources within the web application whose longest sub-path matches the supplied path argument.
getResponse() - Method in interface jakarta.servlet.AsyncContext
getResponse() - Method in class jakarta.servlet.ServletResponseWrapper: Return the wrapped ServletResponse object.
getResponseCharacterEncoding() - Method in interface jakarta.servlet.ServletContext: Get the default character encoding for writing response bodies.
getRolesAllowed() - Method in class jakarta.servlet.HttpConstraintElement: TODO
getRootCause() - Method in exception class jakarta.servlet.ServletException: Returns the exception that caused this servlet exception.
getRunAsRole() - Method in interface jakarta.servlet.ServletRegistration: Obtain the name of the user / group under which the Servlet has been configured to run.
getScheme() - Method in interface jakarta.servlet.ServletRequest: Returns the name of the scheme used to make this request, for example, http, https, or ftp.
getScheme() - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return getScheme() on the wrapped request object.
getScriptingInvalid() - Method in interface jakarta.servlet.descriptor.JspPropertyGroupDescriptor: Is scripting disabled for this group?
getSecure() - Method in class jakarta.servlet.http.Cookie: Returns true if the browser is sending cookies only over a secure protocol, or false if the browser can send cookies using any protocol.
getServerInfo() - Method in interface jakarta.servlet.ServletContext: Returns the name and version of the servlet container on which the servlet is running.
getServerName() - Method in interface jakarta.servlet.ServletRequest: Returns the host name of the server to which the request was sent.
getServerName() - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return getServerName() on the wrapped request object.
getServerPort() - Method in interface jakarta.servlet.ServletRequest: Returns the port number to which the request was sent.
getServerPort() - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return getServerPort() on the wrapped request object.
getServletConfig() - Method in class jakarta.servlet.GenericServlet: Returns this servlet's ServletConfig object.
getServletConfig() - Method in interface jakarta.servlet.Servlet: Returns a ServletConfig object, which contains initialization and startup parameters for this servlet.
getServletConnection() - Method in interface jakarta.servlet.ServletRequest: Obtain details of the network connection to the Servlet container that is being used by this request.
getServletConnection() - Method in class jakarta.servlet.ServletRequestWrapper: Gets the connection information for the wrapped request.
getServletContext() - Method in interface jakarta.servlet.FilterConfig: Returns a reference to the ServletContext in which the caller is executing.
getServletContext() - Method in class jakarta.servlet.GenericFilter
getServletContext() - Method in class jakarta.servlet.GenericServlet: Returns a reference to the ServletContext in which this servlet is running.
getServletContext() - Method in interface jakarta.servlet.http.HttpSession: Returns the ServletContext to which this session belongs.
getServletContext() - Method in interface jakarta.servlet.ServletConfig: Returns a reference to the ServletContext in which the caller is executing.
getServletContext() - Method in class jakarta.servlet.ServletContextEvent: Return the ServletContext that changed.
getServletContext() - Method in interface jakarta.servlet.ServletRequest
getServletContext() - Method in class jakarta.servlet.ServletRequestEvent: Get the associated ServletContext.
getServletContext() - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return getServletContext() on the wrapped request object.
getServletContextName() - Method in interface jakarta.servlet.ServletContext: Returns the name of this web application corresponding to this ServletContext as specified in the deployment descriptor for this web application by the display-name element.
getServletInfo() - Method in class jakarta.servlet.GenericServlet: Returns information about the servlet, such as author, version, and copyright.
getServletInfo() - Method in interface jakarta.servlet.Servlet: Returns information about the servlet, such as author, version, and copyright.
getServletName() - Method in class jakarta.servlet.GenericServlet: Returns the name of this servlet instance.
getServletName() - Method in interface jakarta.servlet.http.HttpServletMapping
getServletName() - Method in interface jakarta.servlet.ServletConfig: Returns the name of this servlet instance.
getServletNameMappings() - Method in interface jakarta.servlet.FilterRegistration: Gets the currently available servlet name mappings of the Filter represented by this FilterRegistration.
getServletPath() - Method in interface jakarta.servlet.http.HttpServletRequest: Returns the part of this request's URL that calls the servlet.
getServletPath() - Method in class jakarta.servlet.http.HttpServletRequestWrapper: The default behavior of this method is to return getServletPath() on the wrapped request object.
getServletRegistration(String) - Method in interface jakarta.servlet.ServletContext: Obtain the details of the named servlet.
getServletRegistrations() - Method in interface jakarta.servlet.ServletContext: Obtain a Map of servlet names to servlet registrations for all servlets registered with this context.
getServletRequest() - Method in class jakarta.servlet.ServletRequestEvent: Get the associated ServletRequest.
getSession() - Method in interface jakarta.servlet.http.HttpServletRequest: Returns the current session associated with this request, or if the request does not have a session, creates one.
getSession() - Method in class jakarta.servlet.http.HttpServletRequestWrapper: The default behavior of this method is to return getSession() on the wrapped request object.
getSession() - Method in class jakarta.servlet.http.HttpSessionBindingEvent: Get the session that changed.
getSession() - Method in class jakarta.servlet.http.HttpSessionEvent: Get the session that changed.
getSession(boolean) - Method in interface jakarta.servlet.http.HttpServletRequest: Returns the current HttpSession associated with this request or, if there is no current session and create is true, returns a new session.
getSession(boolean) - Method in class jakarta.servlet.http.HttpServletRequestWrapper: The default behavior of this method is to return getSession(boolean create) on the wrapped request object.
getSessionCookieConfig() - Method in interface jakarta.servlet.ServletContext
getSessionId() - Method in interface jakarta.servlet.http.PushBuilder: Deprecated.

Obtain the session ID that will be used for push requests generated by future calls to push().
getSessionTimeout() - Method in interface jakarta.servlet.ServletContext: Get the default session timeout.
getSize() - Method in interface jakarta.servlet.http.Part: Obtain the size of this part.
getStatus() - Method in interface jakarta.servlet.http.HttpServletResponse: Get the HTTP status code for this Response.
getStatus() - Method in class jakarta.servlet.http.HttpServletResponseWrapper: Get the HTTP status code for this Response.
getSubmittedFileName() - Method in interface jakarta.servlet.http.Part: If this part represents an uploaded file, gets the file name submitted in the upload.
getSuppliedRequest() - Method in class jakarta.servlet.AsyncEvent: Obtain the request associated with the event.
getSuppliedResponse() - Method in class jakarta.servlet.AsyncEvent: Obtain the response associated with the event.
getTaglibLocation() - Method in interface jakarta.servlet.descriptor.TaglibDescriptor: Obtain the location of the tag library.
getTaglibs() - Method in interface jakarta.servlet.descriptor.JspConfigDescriptor: Provide the set of tag library descriptors obtained from the <jsp-config> elements in the web application's deployment descriptors.
getTaglibURI() - Method in interface jakarta.servlet.descriptor.TaglibDescriptor: Obtain the URI for the tag library.
getThrowable() - Method in class jakarta.servlet.AsyncEvent: Obtain the throwable associated with the event.
getTimeout() - Method in interface jakarta.servlet.AsyncContext: Get the current timeout.
getTrailerFields() - Method in interface jakarta.servlet.http.HttpServletRequest: Obtain a Map of the trailer fields that is not backed by the request object.
getTrailerFields() - Method in class jakarta.servlet.http.HttpServletRequestWrapper: Obtain a Map of the trailer fields that is not backed by the request object.
getTrailerFields() - Method in interface jakarta.servlet.http.HttpServletResponse: Obtain the supplier of the trailer headers.
getTrailerFields() - Method in class jakarta.servlet.http.HttpServletResponseWrapper: Obtain the supplier of the trailer headers.
getTransportGuarantee() - Method in class jakarta.servlet.HttpConstraintElement: TODO
getTrimDirectiveWhitespaces() - Method in interface jakarta.servlet.descriptor.JspPropertyGroupDescriptor: Should the JSPs in this group have template text that only contains whitespace removed?
getUnavailableSeconds() - Method in exception class jakarta.servlet.UnavailableException: Returns the number of seconds the servlet expects to be temporarily unavailable.
getUrlPatternMappings() - Method in interface jakarta.servlet.FilterRegistration: Gets the currently available URL pattern mappings of the Filter represented by this FilterRegistration.
getUrlPatterns() - Method in interface jakarta.servlet.descriptor.JspPropertyGroupDescriptor: Obtain the patterns to which this group applies.
getUserPrincipal() - Method in interface jakarta.servlet.http.HttpServletRequest: Returns a java.security.Principal object containing the name of the current authenticated user.
getUserPrincipal() - Method in class jakarta.servlet.http.HttpServletRequestWrapper: The default behavior of this method is to return getUserPrincipal() on the wrapped request object.
getValue() - Method in class jakarta.servlet.http.Cookie: Returns the value of the cookie.
getValue() - Method in class jakarta.servlet.http.HttpSessionBindingEvent: Returns the value of the attribute that has been added, removed or replaced.
getValue() - Method in class jakarta.servlet.ServletContextAttributeEvent: Returns the value of the attribute that has been added, removed, or replaced.
getValue() - Method in class jakarta.servlet.ServletRequestAttributeEvent: Returns the value of the attribute that has been added, removed or replaced.
getVersion() - Method in class jakarta.servlet.http.Cookie: Deprecated, for removal: This API element is subject to removal in a future version.
This is no longer required with RFC 6265
getVirtualServerName() - Method in interface jakarta.servlet.ServletContext: Get the primary name of the virtual host on which this context is deployed.
getWriter() - Method in interface jakarta.servlet.ServletResponse: Returns a PrintWriter object that can send character text to the client.
getWriter() - Method in class jakarta.servlet.ServletResponseWrapper: The default behavior of this method is to return getWriter() on the wrapped response object.

H

HandlesTypes - Annotation Interface in jakarta.servlet.annotation: This annotation is used to declare an array of application classes which are passed to a ServletContainerInitializer.
hashCode() - Method in class jakarta.servlet.http.Cookie
hasOriginalRequestAndResponse() - Method in interface jakarta.servlet.AsyncContext
HttpConstraint - Annotation Interface in jakarta.servlet.annotation: This annotation represents the security constraints that are applied to all requests with HTTP protocol method types that are not otherwise represented by a corresponding HttpMethodConstraint in a ServletSecurity annotation.
HttpConstraintElement - Class in jakarta.servlet: Equivalent of HttpConstraint for programmatic configuration of security constraints.
HttpConstraintElement() - Constructor for class jakarta.servlet.HttpConstraintElement: Default constraint is permit with no transport guarantee.
HttpConstraintElement(ServletSecurity.EmptyRoleSemantic) - Constructor for class jakarta.servlet.HttpConstraintElement: Construct a constraint with an empty role semantic.
HttpConstraintElement(ServletSecurity.EmptyRoleSemantic, ServletSecurity.TransportGuarantee, String...) - Constructor for class jakarta.servlet.HttpConstraintElement: Construct a constraint with an empty role semantic, a transport guarantee and roles.
HttpConstraintElement(ServletSecurity.TransportGuarantee, String...) - Constructor for class jakarta.servlet.HttpConstraintElement: Construct a constraint with a transport guarantee and roles.
HttpFilter - Class in jakarta.servlet.http: Provides a base class that implements the Filter interface and ensures that the Request and Response are of type HttpServletRequest and HttpServletResponse respectively.
HttpFilter() - Constructor for class jakarta.servlet.http.HttpFilter
HttpMethodConstraint - Annotation Interface in jakarta.servlet.annotation: Specific security constraints can be applied to different types of request, differentiated by the HTTP protocol method type by using this annotation inside the ServletSecurity annotation.
HttpMethodConstraintElement - Class in jakarta.servlet: Programmatic equivalent of a security constraint defined for a single HTTP method.
HttpMethodConstraintElement(String) - Constructor for class jakarta.servlet.HttpMethodConstraintElement: Construct an instance for the given HTTP method name and a default HttpConstraintElement.
HttpMethodConstraintElement(String, HttpConstraintElement) - Constructor for class jakarta.servlet.HttpMethodConstraintElement: Construct an instance for the given HTTP method name and HttpConstraintElement.
httpMethodConstraints() - Element in annotation interface jakarta.servlet.annotation.ServletSecurity: An array of HttpMethodConstraint objects to which the security constraint will be applied
HttpServlet - Class in jakarta.servlet.http: Provides an abstract class to be subclassed to create an HTTP servlet suitable for a Web site.
HttpServlet() - Constructor for class jakarta.servlet.http.HttpServlet: Does nothing, because this is an abstract class.
HttpServletMapping - Interface in jakarta.servlet.http: Represents how the request from which this object was obtained was mapped to the associated servlet.
HttpServletRequest - Interface in jakarta.servlet.http: Extends the ServletRequest interface to provide request information for HTTP servlets.
HttpServletRequestWrapper - Class in jakarta.servlet.http: Provides a convenient implementation of the HttpServletRequest interface that can be subclassed by developers wishing to adapt the request to a Servlet.
HttpServletRequestWrapper(HttpServletRequest) - Constructor for class jakarta.servlet.http.HttpServletRequestWrapper: Constructs a request object wrapping the given request.
HttpServletResponse - Interface in jakarta.servlet.http: Extends the ServletResponse interface to provide HTTP-specific functionality in sending a response.
HttpServletResponseWrapper - Class in jakarta.servlet.http: Provides a convenient implementation of the HttpServletResponse interface that can be subclassed by developers wishing to adapt the response from a Servlet.
HttpServletResponseWrapper(HttpServletResponse) - Constructor for class jakarta.servlet.http.HttpServletResponseWrapper: Constructs a response adaptor wrapping the given response.
HttpSession - Interface in jakarta.servlet.http: Provides a way to identify a user across more than one page request or visit to a Web site and to store information about that user.
HttpSession.Accessor - Interface in jakarta.servlet.http: Provides a mechanism for applications to interact with the HttpSession outside of the scope of an HTTP request.
HttpSessionActivationListener - Interface in jakarta.servlet.http: Objects that are bound to a session may listen to container events notifying them that sessions will be passivated and that session will be activated.
HttpSessionAttributeListener - Interface in jakarta.servlet.http: This listener interface can be implemented in order to get notifications of changes to the attribute lists of sessions within this web application.
HttpSessionBindingEvent - Class in jakarta.servlet.http: Events of this type are either sent to an object that implements HttpSessionBindingListener when it is bound or unbound from a session, or to an HttpSessionAttributeListener that has been configured in the deployment descriptor when any attribute is bound, unbound or replaced in a session.
HttpSessionBindingEvent(HttpSession, String) - Constructor for class jakarta.servlet.http.HttpSessionBindingEvent: Constructs an event that notifies an object that it has been bound to or unbound from a session.
HttpSessionBindingEvent(HttpSession, String, Object) - Constructor for class jakarta.servlet.http.HttpSessionBindingEvent: Constructs an event that notifies an object that it has been bound to or unbound from a session.
HttpSessionBindingListener - Interface in jakarta.servlet.http: Causes an object to be notified when it is bound to or unbound from a session.
HttpSessionEvent - Class in jakarta.servlet.http: This is the class representing event notifications for changes to sessions within a web application.
HttpSessionEvent(HttpSession) - Constructor for class jakarta.servlet.http.HttpSessionEvent: Construct a session event from the given source.
HttpSessionIdListener - Interface in jakarta.servlet.http: Implementations of this interface are notified when an HttpSession's ID changes.
HttpSessionListener - Interface in jakarta.servlet.http: Implementations of this interface are notified of changes to the list of active sessions in a web application.
HttpUpgradeHandler - Interface in jakarta.servlet.http: Interface between the HTTP upgrade process and the new protocol.

I

include(ServletRequest, ServletResponse) - Method in interface jakarta.servlet.RequestDispatcher: Includes the content of a resource (servlet, JSP page, HTML file) in the response.
INCLUDE - Enum constant in enum class jakarta.servlet.DispatcherType: RequestDispatcher.include(ServletRequest, ServletResponse)
INCLUDE_CONTEXT_PATH - Static variable in interface jakarta.servlet.RequestDispatcher: The name of the request attribute that should be set by the container when the RequestDispatcher.include(ServletRequest, ServletResponse) method is called on the RequestDispatcher obtained by a path and not by a name.
INCLUDE_MAPPING - Static variable in interface jakarta.servlet.RequestDispatcher: The name of the request attribute that should be set by the container when the RequestDispatcher.include(ServletRequest, ServletResponse) method is called on the RequestDispatcher obtained by a path and not by a name.
INCLUDE_PATH_INFO - Static variable in interface jakarta.servlet.RequestDispatcher: The name of the request attribute that should be set by the container when the RequestDispatcher.include(ServletRequest, ServletResponse) method is called on the RequestDispatcher obtained by a path and not by a name.
INCLUDE_QUERY_STRING - Static variable in interface jakarta.servlet.RequestDispatcher: The name of the request attribute that should be set by the container when the RequestDispatcher.include(ServletRequest, ServletResponse) method is called on the RequestDispatcher obtained by a path and not by a name.
INCLUDE_REQUEST_URI - Static variable in interface jakarta.servlet.RequestDispatcher: The name of the request attribute that should be set by the container when the RequestDispatcher.include(ServletRequest, ServletResponse) method is called on the RequestDispatcher obtained by a path and not by a name.
INCLUDE_SERVLET_PATH - Static variable in interface jakarta.servlet.RequestDispatcher: The name of the request attribute that should be set by the container when the RequestDispatcher.include(ServletRequest, ServletResponse) method is called on the RequestDispatcher obtained by a path and not by a name.
init() - Method in class jakarta.servlet.GenericFilter: Convenience method for sub-classes to save them having to call super.init(config).
init() - Method in class jakarta.servlet.GenericServlet: A convenience method which can be overridden so that there's no need to call super.init(config).
init(FilterConfig) - Method in interface jakarta.servlet.Filter: Called by the web container to indicate to a filter that it is being placed into service.
init(FilterConfig) - Method in class jakarta.servlet.GenericFilter
init(WebConnection) - Method in interface jakarta.servlet.http.HttpUpgradeHandler: This method is called once the request/response pair where HttpServletRequest.upgrade(Class) is called has completed processing and is the point where control of the connection passes from the container to the HttpUpgradeHandler.
init(ServletConfig) - Method in class jakarta.servlet.GenericServlet: Called by the servlet container to indicate to a servlet that the servlet is being placed into service.
init(ServletConfig) - Method in class jakarta.servlet.http.HttpServlet
init(ServletConfig) - Method in interface jakarta.servlet.Servlet: Called by the servlet container to indicate to a servlet that the servlet is being placed into service.
initParams() - Element in annotation interface jakarta.servlet.annotation.WebFilter
initParams() - Element in annotation interface jakarta.servlet.annotation.WebServlet
invalidate() - Method in interface jakarta.servlet.http.HttpSession: Invalidates this session then unbinds any objects bound to it.
isAsyncStarted() - Method in interface jakarta.servlet.ServletRequest
isAsyncStarted() - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return isAsyncStarted() on the wrapped request object.
isAsyncSupported() - Method in interface jakarta.servlet.ServletRequest
isAsyncSupported() - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return isAsyncSupported() on the wrapped request object.
isCommitted() - Method in interface jakarta.servlet.ServletResponse: Returns a boolean indicating if the response has been committed.
isCommitted() - Method in class jakarta.servlet.ServletResponseWrapper: The default behavior of this method is to return isCommitted() on the wrapped response object.
isFinished() - Method in class jakarta.servlet.ServletInputStream: Has the end of this InputStream been reached?
isHttpOnly() - Method in class jakarta.servlet.http.Cookie: Gets the flag that controls if this cookie will be hidden from scripts on the client side.
isHttpOnly() - Method in interface jakarta.servlet.SessionCookieConfig: Will session cookies be created with the httpOnly flag set?
isNew() - Method in interface jakarta.servlet.http.HttpSession: Returns true if the client does not yet know about the session or if the client chooses not to join the session.
isPermanent() - Method in exception class jakarta.servlet.UnavailableException: Returns a boolean indicating whether the servlet is permanently unavailable.
isReady() - Method in class jakarta.servlet.ServletInputStream: Returns true if it is allowable to call a read() method.
isReady() - Method in class jakarta.servlet.ServletOutputStream: Returns true if it is allowable to call any method that may write data (e.g.
isRequestedSessionIdFromCookie() - Method in interface jakarta.servlet.http.HttpServletRequest: Checks whether the requested session ID came in as a cookie.
isRequestedSessionIdFromCookie() - Method in class jakarta.servlet.http.HttpServletRequestWrapper: The default behavior of this method is to return isRequestedSessionIdFromCookie() on the wrapped request object.
isRequestedSessionIdFromURL() - Method in interface jakarta.servlet.http.HttpServletRequest: Checks whether the requested session ID came in as part of the request URL.
isRequestedSessionIdFromURL() - Method in class jakarta.servlet.http.HttpServletRequestWrapper: The default behavior of this method is to return isRequestedSessionIdFromURL() on the wrapped request object.
isRequestedSessionIdValid() - Method in interface jakarta.servlet.http.HttpServletRequest: Checks whether the requested session ID is still valid.
isRequestedSessionIdValid() - Method in class jakarta.servlet.http.HttpServletRequestWrapper: The default behavior of this method is to return isRequestedSessionIdValid() on the wrapped request object.
isSecure() - Method in interface jakarta.servlet.ServletConnection: Determine whether or not the incoming network connection to the server used encryption or not.
isSecure() - Method in interface jakarta.servlet.ServletRequest: Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
isSecure() - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return isSecure() on the wrapped request object.
isSecure() - Method in interface jakarta.servlet.SessionCookieConfig: Will session cookies be created with the secure flag set?
isSensitiveHeader(String) - Method in class jakarta.servlet.http.HttpServlet: Is the provided HTTP request header considered sensitive and therefore should be excluded from the response to a TRACE request?
isTrailerFieldsReady() - Method in interface jakarta.servlet.http.HttpServletRequest: Are trailer fields ready to be read (there may still be no trailers to read).
isTrailerFieldsReady() - Method in class jakarta.servlet.http.HttpServletRequestWrapper: Are trailer fields ready to be read (there may still be no trailers to read).
isUserInRole(String) - Method in interface jakarta.servlet.http.HttpServletRequest: Returns a boolean indicating whether the authenticated user is included in the specified logical "role".
isUserInRole(String) - Method in class jakarta.servlet.http.HttpServletRequestWrapper: The default behavior of this method is to return isUserInRole(String role) on the wrapped request object.
isWrapperFor(ServletRequest) - Method in class jakarta.servlet.ServletRequestWrapper: TODO SERVLET3 - Add comments
isWrapperFor(ServletResponse) - Method in class jakarta.servlet.ServletResponseWrapper: TODO SERVLET3 - Add comments
isWrapperFor(Class<?>) - Method in class jakarta.servlet.ServletRequestWrapper: TODO SERVLET3 - Add comments
isWrapperFor(Class<?>) - Method in class jakarta.servlet.ServletResponseWrapper: TODO SERVLET3 - Add comments

J

jakarta.servlet - package jakarta.servlet: The jakarta.servlet package contains a number of classes and interfaces that describe and define the contracts between a servlet class and the runtime environment provided for an instance of such a class by a conforming servlet container.
jakarta.servlet.annotation - package jakarta.servlet.annotation
jakarta.servlet.descriptor - package jakarta.servlet.descriptor
jakarta.servlet.http - package jakarta.servlet.http: The jakarta.servlet.http package contains a number of classes and interfaces that describe and define the contracts between a servlet class running under the HTTP protocol and the runtime environment provided for an instance of such a class by a conforming servlet container.
JspConfigDescriptor - Interface in jakarta.servlet.descriptor: This interface exposes the JSP specific configuration information obtain ed from the deployment descriptors.
JspPropertyGroupDescriptor - Interface in jakarta.servlet.descriptor: Represents the JSP property groups in the deployment descriptors.

L

largeIcon() - Element in annotation interface jakarta.servlet.annotation.WebFilter
largeIcon() - Element in annotation interface jakarta.servlet.annotation.WebServlet
LEGACY_DO_HEAD - Static variable in class jakarta.servlet.http.HttpServlet: Deprecated, for removal: This API element is subject to removal in a future version.
May be removed in a future release
loadOnStartup() - Element in annotation interface jakarta.servlet.annotation.WebServlet
location() - Element in annotation interface jakarta.servlet.annotation.MultipartConfig
log(String) - Method in class jakarta.servlet.GenericServlet: Writes the specified message to a servlet log file, prepended by the servlet's name.
log(String) - Method in interface jakarta.servlet.ServletContext: Writes the specified message to a servlet log file, usually an event log.
log(String, Throwable) - Method in class jakarta.servlet.GenericServlet: Writes an explanatory message and a stack trace for a given Throwable exception to the servlet log file, prepended by the servlet's name.
log(String, Throwable) - Method in interface jakarta.servlet.ServletContext: Writes an explanatory message and a stack trace for a given Throwable exception to the servlet log file.
login(String, String) - Method in interface jakarta.servlet.http.HttpServletRequest: Authenticate the provided user name and password and then associated the authenticated user with the request.
login(String, String) - Method in class jakarta.servlet.http.HttpServletRequestWrapper: Authenticate the provided user name and password and then associated the authenticated user with the request.
logout() - Method in interface jakarta.servlet.http.HttpServletRequest: Removes any authenticated user from the request.
logout() - Method in class jakarta.servlet.http.HttpServletRequestWrapper: Removes any authenticated user from the request.

M

MappingMatch - Enum Class in jakarta.servlet.http: Represents the ways that a request can be mapped to a servlet
maxFileSize() - Element in annotation interface jakarta.servlet.annotation.MultipartConfig
maxRequestSize() - Element in annotation interface jakarta.servlet.annotation.MultipartConfig
method(String) - Method in interface jakarta.servlet.http.PushBuilder: Deprecated.

Specify the HTTP method to use for the push request.
MultipartConfig - Annotation Interface in jakarta.servlet.annotation: This annotation is used to indicate that the Servlet on which it is declared expects requests to made using the multipart/form-data MIME type.
MultipartConfigElement - Class in jakarta.servlet: The programmatic equivalent of MultipartConfig used to configure multi-part handling for a Servlet when registering a Servlet via code.
MultipartConfigElement(MultipartConfig) - Constructor for class jakarta.servlet.MultipartConfigElement: Create a programmatic configuration from an annotation.
MultipartConfigElement(String) - Constructor for class jakarta.servlet.MultipartConfigElement: Create a programmatic multi-part configuration with a specific location and defaults for the remaining configuration elements.
MultipartConfigElement(String, long, long, int) - Constructor for class jakarta.servlet.MultipartConfigElement: Create a programmatic multi-part configuration from the individual configuration elements.

N

name() - Element in annotation interface jakarta.servlet.annotation.WebInitParam
name() - Element in annotation interface jakarta.servlet.annotation.WebServlet
newPushBuilder() - Method in interface jakarta.servlet.http.HttpServletRequest: Deprecated.
In favor of 103 early hints
newPushBuilder() - Method in class jakarta.servlet.http.HttpServletRequestWrapper: Deprecated.
In favor of 103 early hints
NONE - Enum constant in enum class jakarta.servlet.annotation.ServletSecurity.TransportGuarantee: User data must not be encrypted by the container during transport

O

onAllDataRead() - Method in interface jakarta.servlet.ReadListener: Invoked when the request body has been fully read.
onComplete(AsyncEvent) - Method in interface jakarta.servlet.AsyncListener: This event is fired after the call to AsyncContext.complete() has been processed by the container.
onDataAvailable() - Method in interface jakarta.servlet.ReadListener: Invoked when data is available to read.
onError(AsyncEvent) - Method in interface jakarta.servlet.AsyncListener: This event is fired if an error occurs during an asynchronous operation but before the container takes any action as a result of the error.
onError(Throwable) - Method in interface jakarta.servlet.ReadListener: Invoked if an error occurs while reading the request body.
onError(Throwable) - Method in interface jakarta.servlet.WriteListener: Invoked if an error occurs while writing the response.
onStartAsync(AsyncEvent) - Method in interface jakarta.servlet.AsyncListener: This event is fired if new call is made to ServletRequest.startAsync() after the completion of the AsyncContext to which this listener was added.
onStartup(Set<Class<?>>, ServletContext) - Method in interface jakarta.servlet.ServletContainerInitializer: Receives notification during startup of a web application of the classes within the web application that matched the criteria defined via the HandlesTypes annotation.
onTimeout(AsyncEvent) - Method in interface jakarta.servlet.AsyncListener: This event is fired if an asynchronous operation times out but before the container takes any action as a result of the timeout.
onWritePossible() - Method in interface jakarta.servlet.WriteListener: Invoked when it it possible to write data without blocking.
ORDERED_LIBS - Static variable in interface jakarta.servlet.ServletContext: The name of the ServletContext attribute that holds the ordered list of web fragments for this web application.

P

Part - Interface in jakarta.servlet.http: This class represents a part as uploaded to the server as part of a multipart/form-data request body.
path(String) - Method in interface jakarta.servlet.http.PushBuilder: Deprecated.

Sets the URI path to be used for the push request.
PATH - Enum constant in enum class jakarta.servlet.http.MappingMatch: The request was mapped to the servlet using a path URL pattern.
PERMIT - Enum constant in enum class jakarta.servlet.annotation.ServletSecurity.EmptyRoleSemantic: Access MUST be permitted, regardless of authentication state or identity
print(boolean) - Method in class jakarta.servlet.ServletOutputStream: Writes a boolean value to the client, with no carriage return-line feed (CRLF) character at the end.
print(char) - Method in class jakarta.servlet.ServletOutputStream: Writes a character to the client, with no carriage return-line feed (CRLF) at the end.
print(double) - Method in class jakarta.servlet.ServletOutputStream: Writes a double value to the client, with no carriage return-line feed (CRLF) at the end.
print(float) - Method in class jakarta.servlet.ServletOutputStream: Writes a float value to the client, with no carriage return-line feed (CRLF) at the end.
print(int) - Method in class jakarta.servlet.ServletOutputStream: Writes an int to the client, with no carriage return-line feed (CRLF) at the end.
print(long) - Method in class jakarta.servlet.ServletOutputStream: Writes a long value to the client, with no carriage return-line feed (CRLF) at the end.
print(String) - Method in class jakarta.servlet.ServletOutputStream: Writes a String to the client, without a carriage return-line feed (CRLF) character at the end.
println() - Method in class jakarta.servlet.ServletOutputStream: Writes a carriage return-line feed (CRLF) to the client.
println(boolean) - Method in class jakarta.servlet.ServletOutputStream: Writes a boolean value to the client, followed by a carriage return-line feed (CRLF).
println(char) - Method in class jakarta.servlet.ServletOutputStream: Writes a character to the client, followed by a carriage return-line feed (CRLF).
println(double) - Method in class jakarta.servlet.ServletOutputStream: Writes a double value to the client, followed by a carriage return-line feed (CRLF).
println(float) - Method in class jakarta.servlet.ServletOutputStream: Writes a float value to the client, followed by a carriage return-line feed (CRLF).
println(int) - Method in class jakarta.servlet.ServletOutputStream: Writes an int to the client, followed by a carriage return-line feed (CRLF) character.
println(long) - Method in class jakarta.servlet.ServletOutputStream: Writes a long value to the client, followed by a carriage return-line feed (CRLF).
println(String) - Method in class jakarta.servlet.ServletOutputStream: Writes a String to the client, followed by a carriage return-line feed (CRLF).
push() - Method in interface jakarta.servlet.http.PushBuilder: Deprecated.

Generates the push request and sends it to the client unless pushes are not available for some reason.
PushBuilder - Interface in jakarta.servlet.http: Deprecated.
In favor of 103 early hints

Q

queryString(String) - Method in interface jakarta.servlet.http.PushBuilder: Deprecated.

Specifies the query string to use in subsequent push requests generated by a call to PushBuilder.push().

R

read(ByteBuffer) - Method in class jakarta.servlet.ServletInputStream: Reads from the input stream into the given buffer.
readAllBytes() - Method in class jakarta.servlet.ServletInputStream
readLine(byte[], int, int) - Method in class jakarta.servlet.ServletInputStream: Reads the input stream, one line at a time.
ReadListener - Interface in jakarta.servlet: Receives notification of read events when using non-blocking IO.
readNBytes(byte[], int, int) - Method in class jakarta.servlet.ServletInputStream
readNBytes(int) - Method in class jakarta.servlet.ServletInputStream
Registration - Interface in jakarta.servlet: Common interface for the registration of Filters and Servlets.
Registration.Dynamic - Interface in jakarta.servlet: Interface through which a Servlet or Filter registered via one of the addServlet or addFilter methods, respectively, on ServletContext may be further configured.
removeAttribute(String) - Method in interface jakarta.servlet.http.HttpSession: Removes the object bound with the specified name from this session.
removeAttribute(String) - Method in interface jakarta.servlet.ServletContext: Removes the attribute with the given name from the servlet context.
removeAttribute(String) - Method in interface jakarta.servlet.ServletRequest: Removes an attribute from this request.
removeAttribute(String) - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to call removeAttribute(String name) on the wrapped request object.
removeHeader(String) - Method in interface jakarta.servlet.http.PushBuilder: Deprecated.

Removes an HTTP header from the request.
REQUEST - Enum constant in enum class jakarta.servlet.DispatcherType: Normal (non-dispatched) requests.
requestDestroyed(ServletRequestEvent) - Method in interface jakarta.servlet.ServletRequestListener: The request is about to go out of scope of the web application.
RequestDispatcher - Interface in jakarta.servlet: Defines an object that receives requests from the client and sends them to any resource (such as a servlet, HTML file, or JSP file) on the server.
requestInitialized(ServletRequestEvent) - Method in interface jakarta.servlet.ServletRequestListener: The request is about to come into scope of the web application.
reset() - Method in interface jakarta.servlet.ServletResponse: Clears any data that exists in the buffer as well as the status code and headers.
reset() - Method in class jakarta.servlet.ServletResponseWrapper: The default behavior of this method is to call reset() on the wrapped response object.
resetBuffer() - Method in interface jakarta.servlet.ServletResponse: Clears the content of the underlying buffer in the response without clearing headers or status code.
resetBuffer() - Method in class jakarta.servlet.ServletResponseWrapper: The default behavior of this method is to call resetBuffer() on the wrapped response object.
rolesAllowed() - Element in annotation interface jakarta.servlet.annotation.HttpConstraint: The authorized roles' names.
rolesAllowed() - Element in annotation interface jakarta.servlet.annotation.HttpMethodConstraint: The authorized roles' names.

S

SC_ACCEPTED - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (202) indicating that a request was accepted for processing, but was not completed.
SC_BAD_GATEWAY - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (502) indicating that the HTTP server received an invalid response from a server it consulted when acting as a proxy or gateway.
SC_BAD_REQUEST - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (400) indicating the request sent by the client was syntactically incorrect.
SC_CONFLICT - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (409) indicating that the request could not be completed due to a conflict with the current state of the resource.
SC_CONTINUE - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (100) indicating the client can continue.
SC_CREATED - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (201) indicating the request succeeded and created a new resource on the server.
SC_EXPECTATION_FAILED - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (417) indicating that the server could not meet the expectation given in the Expect request header.
SC_FORBIDDEN - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (403) indicating the server understood the request but refused to fulfill it.
SC_FOUND - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (302) indicating that the resource reside temporarily under a different URI.
SC_GATEWAY_TIMEOUT - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (504) indicating that the server did not receive a timely response from the upstream server while acting as a gateway or proxy.
SC_GONE - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (410) indicating that the resource is no longer available at the server and no forwarding address is known.
SC_HTTP_VERSION_NOT_SUPPORTED - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (505) indicating that the server does not support or refuses to support the HTTP protocol version that was used in the request message.
SC_INTERNAL_SERVER_ERROR - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (500) indicating an error inside the HTTP server which prevented it from fulfilling the request.
SC_LENGTH_REQUIRED - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (411) indicating that the request cannot be handled without a defined Content-Length.
SC_METHOD_NOT_ALLOWED - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (405) indicating that the method specified in the Request-Line is not allowed for the resource identified by the Request-URI.
SC_MISDIRECTED_REQUEST - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (421) indicating that the server is unwilling or unable to produce an authoritative response for the target URI.
SC_MOVED_PERMANENTLY - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (301) indicating that the resource has permanently moved to a new location, and that future references should use a new URI with their requests.
SC_MOVED_TEMPORARILY - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (302) indicating that the resource has temporarily moved to another location, but that future references should still use the original URI to access the resource.
SC_MULTIPLE_CHOICES - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (300) indicating that the requested resource corresponds to any one of a set of representations, each with its own specific location.
SC_NO_CONTENT - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (204) indicating that the request succeeded but that there was no new information to return.
SC_NON_AUTHORITATIVE_INFORMATION - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (203) indicating that the meta information presented by the client did not originate from the server.
SC_NOT_ACCEPTABLE - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (406) indicating that the resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.
SC_NOT_FOUND - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (404) indicating that the requested resource is not available.
SC_NOT_IMPLEMENTED - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (501) indicating the HTTP server does not support the functionality needed to fulfill the request.
SC_NOT_MODIFIED - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (304) indicating that a conditional GET operation found that the resource was available and not modified.
SC_OK - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (200) indicating the request succeeded normally.
SC_PARTIAL_CONTENT - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (206) indicating that the server has fulfilled the partial GET request for the resource.
SC_PAYMENT_REQUIRED - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (402) reserved for future use.
SC_PERMANENT_REDIRECT - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (308) indicating that the requested resource resides permanently under a different URI.
SC_PRECONDITION_FAILED - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (412) indicating that the precondition given in one or more of the request-header fields evaluated to false when it was tested on the server.
SC_PROXY_AUTHENTICATION_REQUIRED - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (407) indicating that the client MUST first authenticate itself with the proxy.
SC_REQUEST_ENTITY_TOO_LARGE - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (413) indicating that the server is refusing to process the request because the request entity is larger than the server is willing or able to process.
SC_REQUEST_TIMEOUT - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (408) indicating that the client did not produce a request within the time that the server was prepared to wait.
SC_REQUEST_URI_TOO_LONG - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (414) indicating that the server is refusing to service the request because the Request-URI is longer than the server is willing to interpret.
SC_REQUESTED_RANGE_NOT_SATISFIABLE - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (416) indicating that the server cannot serve the requested byte range.
SC_RESET_CONTENT - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (205) indicating that the agent SHOULD reset the document view which caused the request to be sent.
SC_SEE_OTHER - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (303) indicating that the response to the request can be found under a different URI.
SC_SERVICE_UNAVAILABLE - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (503) indicating that the HTTP server is temporarily overloaded, and unable to handle the request.
SC_SWITCHING_PROTOCOLS - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (101) indicating the server is switching protocols according to Upgrade header.
SC_TEMPORARY_REDIRECT - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (307) indicating that the requested resource resides temporarily under a different URI.
SC_UNAUTHORIZED - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (401) indicating that the request requires HTTP authentication.
SC_UNPROCESSABLE_CONTENT - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (422) indicating that the server understands the content type of the request but is unable to process the contained instructions.
SC_UNSUPPORTED_MEDIA_TYPE - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (415) indicating that the server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method.
SC_UPGRADE_REQUIRED - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (426) indicating that the server refuses to perform the request using the current protocol but may be willing to do so after the client upgrades to a different protocol.
SC_USE_PROXY - Static variable in interface jakarta.servlet.http.HttpServletResponse: Status code (305) indicating that the requested resource MUST be accessed through the proxy given by the Location field.
sendError(int) - Method in interface jakarta.servlet.http.HttpServletResponse: Sends an error response to the client using the specified status code and clears the buffer.
sendError(int) - Method in class jakarta.servlet.http.HttpServletResponseWrapper: The default behavior of this method is to call sendError(int sc) on the wrapped response object.
sendError(int, String) - Method in interface jakarta.servlet.http.HttpServletResponse: Sends an error response to the client using the specified status code and clears the output buffer.
sendError(int, String) - Method in class jakarta.servlet.http.HttpServletResponseWrapper: The default behavior of this method is to call sendError(int sc, String msg) on the wrapped response object.
sendRedirect(String) - Method in interface jakarta.servlet.http.HttpServletResponse: Sends a redirect response to the client using the specified redirect location URL with the status code HttpServletResponse.SC_FOUND 302 (Found), clears the response buffer and commits the response.
sendRedirect(String) - Method in class jakarta.servlet.http.HttpServletResponseWrapper: The default behavior of this method is to call sendRedirect(String location) on the wrapped response object.
sendRedirect(String, boolean) - Method in interface jakarta.servlet.http.HttpServletResponse: Sends a redirect response to the client using the specified redirect location URL with the status code HttpServletResponse.SC_FOUND 302 (Found), optionally clears the response buffer and commits the response.
sendRedirect(String, boolean) - Method in class jakarta.servlet.http.HttpServletResponseWrapper: The default behavior of this method is to call sendRedirect(String location, boolean clearBuffer) on the wrapped response object.
sendRedirect(String, int) - Method in interface jakarta.servlet.http.HttpServletResponse: Sends a redirect response to the client using the specified redirect location URL and status code, clears the response buffer and commits the response.
sendRedirect(String, int) - Method in class jakarta.servlet.http.HttpServletResponseWrapper: The default behavior of this method is to call sendRedirect(String location, int sc) on the wrapped response object.
sendRedirect(String, int, boolean) - Method in interface jakarta.servlet.http.HttpServletResponse: Sends a redirect response to the client using the specified redirect location URL and status code, optionally clears the response buffer and commits the response.
sendRedirect(String, int, boolean) - Method in class jakarta.servlet.http.HttpServletResponseWrapper: The default behavior of this method is to call sendRedirect(String location, int sc, boolean clearBuffer) on the wrapped response object.
service(HttpServletRequest, HttpServletResponse) - Method in class jakarta.servlet.http.HttpServlet: Receives standard HTTP requests from the public service method and dispatches them to the doMethod methods defined in this class.
service(ServletRequest, ServletResponse) - Method in class jakarta.servlet.GenericServlet: Called by the servlet container to allow the servlet to respond to a request.
service(ServletRequest, ServletResponse) - Method in class jakarta.servlet.http.HttpServlet: Dispatches client requests to the protected service method.
service(ServletRequest, ServletResponse) - Method in interface jakarta.servlet.Servlet: Called by the servlet container to allow the servlet to respond to a request.
Servlet - Interface in jakarta.servlet: Defines methods that all servlets must implement.
ServletConfig - Interface in jakarta.servlet: A servlet configuration object used by a servlet container to pass information to a servlet during initialization.
ServletConnection - Interface in jakarta.servlet: Provides information about the connection made to the Servlet container.
ServletContainerInitializer - Interface in jakarta.servlet: ServletContainerInitializers (SCIs) are registered via an entry in the file META-INF/services/jakarta.servlet.ServletContainerInitializer that must be included in the JAR file that contains the SCI implementation.
ServletContext - Interface in jakarta.servlet: Defines a set of methods that a servlet uses to communicate with its servlet container, for example, to get the MIME type of a file, dispatch requests, or write to a log file.
ServletContextAttributeEvent - Class in jakarta.servlet: This is the event class for notifications about changes to the attributes of the servlet context of a web application.
ServletContextAttributeEvent(ServletContext, String, Object) - Constructor for class jakarta.servlet.ServletContextAttributeEvent: Construct a ServletContextAttributeEvent from the given context for the given attribute name and attribute value.
ServletContextAttributeListener - Interface in jakarta.servlet: Implementations of this interface receive notifications of changes to the attribute list on the servlet context of a web application.
ServletContextEvent - Class in jakarta.servlet: This is the event class for notifications about changes to the servlet context of a web application.
ServletContextEvent(ServletContext) - Constructor for class jakarta.servlet.ServletContextEvent: Construct a ServletContextEvent from the given context.
ServletContextListener - Interface in jakarta.servlet: Implementations of this interface receive notifications about changes to the servlet context of the web application they are part of.
ServletException - Exception Class in jakarta.servlet: Defines a general exception a servlet can throw when it encounters difficulty.
ServletException() - Constructor for exception class jakarta.servlet.ServletException: Constructs a new servlet exception.
ServletException(String) - Constructor for exception class jakarta.servlet.ServletException: Constructs a new servlet exception with the specified message.
ServletException(String, Throwable) - Constructor for exception class jakarta.servlet.ServletException: 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.
ServletException(Throwable) - Constructor for exception class jakarta.servlet.ServletException: 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.
ServletInputStream - Class in jakarta.servlet: Provides an input stream for reading binary data from a client request, including an efficient readLine method for reading data one line at a time.
ServletInputStream() - Constructor for class jakarta.servlet.ServletInputStream: Does nothing, because this is an abstract class.
servletNames() - Element in annotation interface jakarta.servlet.annotation.WebFilter
ServletOutputStream - Class in jakarta.servlet: Provides an output stream for sending binary data to the client.
ServletOutputStream() - Constructor for class jakarta.servlet.ServletOutputStream: Does nothing, because this is an abstract class.
ServletRegistration - Interface in jakarta.servlet: Interface through which a Servlet may be further configured.
ServletRegistration.Dynamic - Interface in jakarta.servlet: Interface through which a Servlet registered via one of the addServlet methods on ServletContext may be further configured.
ServletRequest - Interface in jakarta.servlet: Defines an object to provide client request information to a servlet.
ServletRequestAttributeEvent - Class in jakarta.servlet: This is the event class for notifications of changes to the attributes of the servlet request in an application.
ServletRequestAttributeEvent(ServletContext, ServletRequest, String, Object) - Constructor for class jakarta.servlet.ServletRequestAttributeEvent: Construct a ServletRequestAttributeEvent giving the servlet context of this web application, the ServletRequest whose attributes are changing and the name and value of the attribute.
ServletRequestAttributeListener - Interface in jakarta.servlet: A ServletRequestAttributeListener can be implemented by the developer interested in being notified of request attribute changes.
ServletRequestEvent - Class in jakarta.servlet: Events of this kind indicate lifecycle events for a ServletRequest.
ServletRequestEvent(ServletContext, ServletRequest) - Constructor for class jakarta.servlet.ServletRequestEvent: Construct a ServletRequestEvent for the given ServletContext and ServletRequest.
ServletRequestListener - Interface in jakarta.servlet: A ServletRequestListener can be implemented by the developer interested in being notified of requests coming in and out of scope in a web component.
ServletRequestWrapper - Class in jakarta.servlet: Provides a convenient implementation of the ServletRequest interface that can be subclassed by developers wishing to adapt the request to a Servlet.
ServletRequestWrapper(ServletRequest) - Constructor for class jakarta.servlet.ServletRequestWrapper: Creates a ServletRequest adaptor wrapping the given request object.
ServletResponse - Interface in jakarta.servlet: Defines an object to assist a servlet in sending a response to the client.
ServletResponseWrapper - Class in jakarta.servlet: Provides a convenient implementation of the ServletResponse interface that can be subclassed by developers wishing to adapt the response from a Servlet.
ServletResponseWrapper(ServletResponse) - Constructor for class jakarta.servlet.ServletResponseWrapper: Creates a ServletResponse adaptor wrapping the given response object.
ServletSecurity - Annotation Interface in jakarta.servlet.annotation: Declare this annotation on a Servlet implementation class to enforce security constraints on HTTP protocol requests.
The container applies constraints to the URL patterns mapped to each Servlet which declares this annotation.
ServletSecurity.EmptyRoleSemantic - Enum Class in jakarta.servlet.annotation: Represents the two possible values of the empty role semantic, active when a list of role names is empty.
ServletSecurity.TransportGuarantee - Enum Class in jakarta.servlet.annotation: Represents the two possible values of data transport, encrypted or not.
ServletSecurityElement - Class in jakarta.servlet: The programmatic equivalent of ServletSecurity used to configre security constraints for a Servlet.
ServletSecurityElement() - Constructor for class jakarta.servlet.ServletSecurityElement: Use default HttpConstraint.
ServletSecurityElement(ServletSecurity) - Constructor for class jakarta.servlet.ServletSecurityElement: Create from an annotation.
ServletSecurityElement(HttpConstraintElement) - Constructor for class jakarta.servlet.ServletSecurityElement: Use specified HttpConstraintElement.
ServletSecurityElement(HttpConstraintElement, Collection<HttpMethodConstraintElement>) - Constructor for class jakarta.servlet.ServletSecurityElement: Use specified HttpConstraintElement as default and specific constraints for specified methods.
ServletSecurityElement(Collection<HttpMethodConstraintElement>) - Constructor for class jakarta.servlet.ServletSecurityElement: Use specific constraints for specified methods and default HttpConstraintElement for all other methods.
SessionCookieConfig - Interface in jakarta.servlet: Configures the session cookies used by the web application associated with the ServletContext from which this SessionCookieConfig was obtained.
sessionCreated(HttpSessionEvent) - Method in interface jakarta.servlet.http.HttpSessionListener: Notification that a session was created.
sessionDestroyed(HttpSessionEvent) - Method in interface jakarta.servlet.http.HttpSessionListener: Notification that a session is about to be invalidated.
sessionDidActivate(HttpSessionEvent) - Method in interface jakarta.servlet.http.HttpSessionActivationListener: Notification that the session has just been activated.
sessionId(String) - Method in interface jakarta.servlet.http.PushBuilder: Deprecated.

Specifies the session ID to use in subsequent push requests generated by a call to PushBuilder.push().
sessionIdChanged(HttpSessionEvent, String) - Method in interface jakarta.servlet.http.HttpSessionIdListener: Notification that a session ID has been changed.
SessionTrackingMode - Enum Class in jakarta.servlet: Defines the permitted options for configuring the session tracking mode.
sessionWillPassivate(HttpSessionEvent) - Method in interface jakarta.servlet.http.HttpSessionActivationListener: Notification that the session is about to be passivated.
setAsyncSupported(boolean) - Method in interface jakarta.servlet.Registration.Dynamic: Mark this Servlet/Filter as supported asynchronous processing.
setAttribute(String, Object) - Method in interface jakarta.servlet.http.HttpSession: Binds an object to this session, using the name specified.
setAttribute(String, Object) - Method in interface jakarta.servlet.ServletContext: Binds an object to a given attribute name in this servlet context.
setAttribute(String, Object) - Method in interface jakarta.servlet.ServletRequest: Stores an attribute in this request.
setAttribute(String, Object) - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return setAttribute(String name, Object o) on the wrapped request object.
setAttribute(String, String) - Method in class jakarta.servlet.http.Cookie: Sets the value for the given cookie attribute.
setAttribute(String, String) - Method in interface jakarta.servlet.SessionCookieConfig: Sets the value for the given session cookie attribute.
setBufferSize(int) - Method in interface jakarta.servlet.ServletResponse: Sets the preferred buffer size for the body of the response.
setBufferSize(int) - Method in class jakarta.servlet.ServletResponseWrapper: The default behavior of this method is to call setBufferSize(int size) on the wrapped response object.
setCharacterEncoding(String) - Method in interface jakarta.servlet.ServletRequest: Overrides the name of the character encoding used in the body of this request.
setCharacterEncoding(String) - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to set the character encoding on the wrapped request object.
setCharacterEncoding(String) - Method in interface jakarta.servlet.ServletResponse: Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8.
setCharacterEncoding(String) - Method in class jakarta.servlet.ServletResponseWrapper: The default behavior of this method is to call setCharacterEncoding(String charset) on the wrapped response object.
setCharacterEncoding(Charset) - Method in interface jakarta.servlet.ServletRequest: Overrides the character encoding used in the body of this request.
setCharacterEncoding(Charset) - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to set the character encoding on the wrapped request object.
setCharacterEncoding(Charset) - Method in interface jakarta.servlet.ServletResponse: Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8.
setCharacterEncoding(Charset) - Method in class jakarta.servlet.ServletResponseWrapper: The default behavior of this method is to call setCharacterEncoding(Charset) on the wrapped response object.
setComment(String) - Method in class jakarta.servlet.http.Cookie: Deprecated, for removal: This API element is subject to removal in a future version.
This is no longer required with RFC 6265
setComment(String) - Method in interface jakarta.servlet.SessionCookieConfig: Deprecated, for removal: This API element is subject to removal in a future version.
This is no longer required with RFC 6265
setContentLength(int) - Method in interface jakarta.servlet.ServletResponse: Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.
setContentLength(int) - Method in class jakarta.servlet.ServletResponseWrapper: The default behavior of this method is to call setContentLength(int len) on the wrapped response object.
setContentLengthLong(long) - Method in interface jakarta.servlet.ServletResponse: Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.
setContentLengthLong(long) - Method in class jakarta.servlet.ServletResponseWrapper: The default behavior of this method is to call setContentLengthLong(long len) on the wrapped response object.
setContentType(String) - Method in interface jakarta.servlet.ServletResponse: Sets the content type of the response being sent to the client, if the response has not been committed yet.
setContentType(String) - Method in class jakarta.servlet.ServletResponseWrapper: The default behavior of this method is to call setContentType(String type) on the wrapped response object.
setDateHeader(String, long) - Method in interface jakarta.servlet.http.HttpServletResponse: Sets a response header with the given name and date-value.
setDateHeader(String, long) - Method in class jakarta.servlet.http.HttpServletResponseWrapper: The default behavior of this method is to call setDateHeader(String name, long date) on the wrapped response object.
setDomain(String) - Method in class jakarta.servlet.http.Cookie: Specifies the domain within which this cookie should be presented.
setDomain(String) - Method in interface jakarta.servlet.SessionCookieConfig: Sets the domain for the session cookie
setHeader(String, String) - Method in interface jakarta.servlet.http.HttpServletResponse: Sets a response header with the given name and value.
setHeader(String, String) - Method in class jakarta.servlet.http.HttpServletResponseWrapper: The default behavior of this method is to return setHeader(String name, String value) on the wrapped response object.
setHeader(String, String) - Method in interface jakarta.servlet.http.PushBuilder: Deprecated.

Sets an HTTP header on the request.
setHttpOnly(boolean) - Method in class jakarta.servlet.http.Cookie: Sets the flag that controls if this cookie will be hidden from scripts on the client side.
setHttpOnly(boolean) - Method in interface jakarta.servlet.SessionCookieConfig: Sets the httpOnly flag for the session cookie.
setInitParameter(String, String) - Method in interface jakarta.servlet.Registration: Add an initialisation parameter if not already added.
setInitParameter(String, String) - Method in interface jakarta.servlet.ServletContext: Set the given initialisation parameter to the given value.
setInitParameters(Map<String, String>) - Method in interface jakarta.servlet.Registration: Add multiple initialisation parameters.
setIntHeader(String, int) - Method in interface jakarta.servlet.http.HttpServletResponse: Sets a response header with the given name and integer value.
setIntHeader(String, int) - Method in class jakarta.servlet.http.HttpServletResponseWrapper: The default behavior of this method is to call setIntHeader(String name, int value) on the wrapped response object.
setLoadOnStartup(int) - Method in interface jakarta.servlet.ServletRegistration.Dynamic: Set the loadOnStartup order for the Servlet
setLocale(Locale) - Method in interface jakarta.servlet.ServletResponse: Sets the locale of the response, if the response has not been committed yet.
setLocale(Locale) - Method in class jakarta.servlet.ServletResponseWrapper: The default behavior of this method is to call setLocale(Locale loc) on the wrapped response object.
setMaxAge(int) - Method in class jakarta.servlet.http.Cookie: Sets the maximum age of the cookie in seconds.
setMaxAge(int) - Method in interface jakarta.servlet.SessionCookieConfig: Sets the maximum age.
setMaxInactiveInterval(int) - Method in interface jakarta.servlet.http.HttpSession: Specifies the time, in seconds, between client requests before the servlet container will invalidate this session.
setMultipartConfig(MultipartConfigElement) - Method in interface jakarta.servlet.ServletRegistration.Dynamic: Set the multi-part configuration for the associated Servlet.
setName(String) - Method in interface jakarta.servlet.SessionCookieConfig: Sets the session cookie name.
setPath(String) - Method in class jakarta.servlet.http.Cookie: Specifies a path for the cookie to which the client should return the cookie.
setPath(String) - Method in interface jakarta.servlet.SessionCookieConfig: Sets the path of the session cookie.
setReadListener(ReadListener) - Method in class jakarta.servlet.ServletInputStream: Sets the ReadListener for this ServletInputStream and thereby switches to non-blocking IO.
setRequest(ServletRequest) - Method in class jakarta.servlet.ServletRequestWrapper: Sets the request object being wrapped.
setRequestCharacterEncoding(String) - Method in interface jakarta.servlet.ServletContext: Set the default character encoding to use for reading request bodies.
setRequestCharacterEncoding(Charset) - Method in interface jakarta.servlet.ServletContext: Sets the request character encoding for this ServletContext.
setResponse(ServletResponse) - Method in class jakarta.servlet.ServletResponseWrapper: Sets the response being wrapped.
setResponseCharacterEncoding(String) - Method in interface jakarta.servlet.ServletContext: Set the default character encoding to use for writing response bodies.
setResponseCharacterEncoding(Charset) - Method in interface jakarta.servlet.ServletContext: Sets the response character encoding for this ServletContext.
setRunAsRole(String) - Method in interface jakarta.servlet.ServletRegistration.Dynamic: Set the name of the user / group under which the Servlet should be configured to run.
setSecure(boolean) - Method in class jakarta.servlet.http.Cookie: Indicates to the browser whether the cookie should only be sent using a secure protocol, such as HTTPS or SSL.
setSecure(boolean) - Method in interface jakarta.servlet.SessionCookieConfig: Sets the secure flag for the session cookie.
setServletSecurity(ServletSecurityElement) - Method in interface jakarta.servlet.ServletRegistration.Dynamic: Add security constraints to this Servlet.
setSessionTimeout(int) - Method in interface jakarta.servlet.ServletContext: Set the default session timeout.
setSessionTrackingModes(Set<SessionTrackingMode>) - Method in interface jakarta.servlet.ServletContext: Configures the available session tracking modes for this web application.
setStatus(int) - Method in interface jakarta.servlet.http.HttpServletResponse: Sets the status code for this response.
setStatus(int) - Method in class jakarta.servlet.http.HttpServletResponseWrapper: The default behavior of this method is to call setStatus(int sc) on the wrapped response object.
setTimeout(long) - Method in interface jakarta.servlet.AsyncContext: Set the timeout.
setTrailerFields(Supplier<Map<String, String>>) - Method in interface jakarta.servlet.http.HttpServletResponse: Configure the supplier of the trailer headers.
setTrailerFields(Supplier<Map<String, String>>) - Method in class jakarta.servlet.http.HttpServletResponseWrapper: Configure the supplier of the trailer headers.
setValue(String) - Method in class jakarta.servlet.http.Cookie: Assigns a new value to a cookie after the cookie is created.
setVersion(int) - Method in class jakarta.servlet.http.Cookie: Deprecated, for removal: This API element is subject to removal in a future version.
This is no longer required with RFC 6265
setWriteListener(WriteListener) - Method in class jakarta.servlet.ServletOutputStream: Sets the WriteListener for this ServletOutputStream and thereby switches to non-blocking IO.
smallIcon() - Element in annotation interface jakarta.servlet.annotation.WebFilter
smallIcon() - Element in annotation interface jakarta.servlet.annotation.WebServlet
SSL - Enum constant in enum class jakarta.servlet.SessionTrackingMode: Use SSL session.
start(Runnable) - Method in interface jakarta.servlet.AsyncContext: Starts a new thread to process the asynchronous request
startAsync() - Method in interface jakarta.servlet.ServletRequest
startAsync() - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return startAsync() on the wrapped request object.
startAsync(ServletRequest, ServletResponse) - Method in interface jakarta.servlet.ServletRequest
startAsync(ServletRequest, ServletResponse) - Method in class jakarta.servlet.ServletRequestWrapper: The default behavior of this method is to return startAsync(Runnable) on the wrapped request object.

T

TaglibDescriptor - Interface in jakarta.servlet.descriptor: Represents a taglib descriptor definitions in the deployment descriptor.
TEMPDIR - Static variable in interface jakarta.servlet.ServletContext: The name of the ServletContext attribute that holds the temporary file location for the web application.
transportGuarantee() - Element in annotation interface jakarta.servlet.annotation.HttpConstraint: Determines whether SSL/TLS is required to process the current request.
transportGuarantee() - Element in annotation interface jakarta.servlet.annotation.HttpMethodConstraint: Determines whether SSL/TLS is required to process the current request.

U

UnavailableException - Exception Class in jakarta.servlet: Defines an exception that a servlet or filter throws to indicate that it is permanently or temporarily unavailable.
UnavailableException(String) - Constructor for exception class jakarta.servlet.UnavailableException: Constructs a new exception with a descriptive message indicating that the servlet is permanently unavailable.
UnavailableException(String, int) - Constructor for exception class jakarta.servlet.UnavailableException: 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.
upgrade(Class<T>) - Method in interface jakarta.servlet.http.HttpServletRequest: Start the HTTP upgrade process and create and instance of the provided protocol handler class.
upgrade(Class<T>) - Method in class jakarta.servlet.http.HttpServletRequestWrapper: Start the HTTP upgrade process and create and instance of the provided protocol handler class.
URL - Enum constant in enum class jakarta.servlet.SessionTrackingMode: Use url rewriting (also known as path parameter)
urlPatterns() - Element in annotation interface jakarta.servlet.annotation.WebFilter
urlPatterns() - Element in annotation interface jakarta.servlet.annotation.WebServlet

V

value() - Element in annotation interface jakarta.servlet.annotation.HandlesTypes
value() - Element in annotation interface jakarta.servlet.annotation.HttpConstraint: The EmptyRoleSemantic determines the behaviour when the rolesAllowed list is empty.
value() - Element in annotation interface jakarta.servlet.annotation.HttpMethodConstraint: HTTP Protocol method name (e.g.
value() - Element in annotation interface jakarta.servlet.annotation.ServletSecurity: The default constraint to apply to requests not handled by specific method constraints
value() - Element in annotation interface jakarta.servlet.annotation.WebFilter: A convenience method, to allow extremely simple annotation of a class.
value() - Element in annotation interface jakarta.servlet.annotation.WebInitParam
value() - Element in annotation interface jakarta.servlet.annotation.WebListener
value() - Element in annotation interface jakarta.servlet.annotation.WebServlet: A convenience method, to allow extremely simple annotation of a class.
valueBound(HttpSessionBindingEvent) - Method in interface jakarta.servlet.http.HttpSessionBindingListener: Notifies the object that it is being bound to a session and identifies the session.
valueOf(String) - Static method in enum class jakarta.servlet.annotation.ServletSecurity.EmptyRoleSemantic: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class jakarta.servlet.annotation.ServletSecurity.TransportGuarantee: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class jakarta.servlet.DispatcherType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class jakarta.servlet.http.MappingMatch: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class jakarta.servlet.SessionTrackingMode: Returns the enum constant of this class with the specified name.
values() - Static method in enum class jakarta.servlet.annotation.ServletSecurity.EmptyRoleSemantic: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class jakarta.servlet.annotation.ServletSecurity.TransportGuarantee: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class jakarta.servlet.DispatcherType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class jakarta.servlet.http.MappingMatch: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class jakarta.servlet.SessionTrackingMode: Returns an array containing the constants of this enum class, in the order they are declared.
valueUnbound(HttpSessionBindingEvent) - Method in interface jakarta.servlet.http.HttpSessionBindingListener: Notifies the object that it is being unbound from a session and identifies the session.

W

WebConnection - Interface in jakarta.servlet.http: The interface used by an HttpUpgradeHandler to interact with an upgraded HTTP connection.
WebFilter - Annotation Interface in jakarta.servlet.annotation: The annotation used to declare a Servlet Filter.
WebInitParam - Annotation Interface in jakarta.servlet.annotation: The annotation used to declare an initialization parameter on a Servlet or Filter, within a WebFilter or WebServlet annotation.

E.g.
WebListener - Annotation Interface in jakarta.servlet.annotation: The annotation used to declare a listener for various types of event, in a given web application context.

The class annotated MUST implement one, (or more), of the following interfaces: HttpSessionAttributeListener, HttpSessionListener, ServletContextAttributeListener, ServletContextListener, ServletRequestAttributeListener, ServletRequestListener or HttpSessionIdListener
E.g.
WebServlet - Annotation Interface in jakarta.servlet.annotation: This annotation is used to declare the configuration of a Servlet.
write(String) - Method in interface jakarta.servlet.http.Part: A convenience method to write an uploaded part to disk.
write(ByteBuffer) - Method in class jakarta.servlet.ServletOutputStream: Writes from the given buffer to the output stream.
WriteListener - Interface in jakarta.servlet: Receives notification of write events when using non-blocking IO.

A B C D E F G H I J L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form