All Classes and Interfaces (Servlet 6.1 API Documentation - Apache Tomcat 11.0.25)
Description: class index

# All Classes and Interfaces

Class
Description
AsyncContext
Provides the context for asynchronous request handling
AsyncEvent
Used to pass data to the methods of `AsyncListener`.
AsyncListener
Listener for events associated with an `AsyncContext`.
Cookie
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.
DispatcherType
Enumeration of dispatcher types.
Filter
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
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
A filter configuration object used by a servlet container to pass information to a filter during initialization.
FilterRegistration
Interface through which a Filter may be further configured.
FilterRegistration.Dynamic
Interface through which a Filter registered via one of the addFilter methods on ServletContext may be further configured.
GenericFilter
Provides a base class that implements the Filter and FilterConfig interfaces to reduce boilerplate when writing new filters.
GenericServlet
Defines a generic, protocol-independent servlet.
HandlesTypes
This annotation is used to declare an array of application classes which are passed to a `ServletContainerInitializer`.
HttpConstraint
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
Equivalent of `HttpConstraint` for programmatic configuration of security constraints.
HttpFilter
Provides a base class that implements the Filter interface and ensures that the Request and Response are of type HttpServletRequest and HttpServletResponse respectively.
HttpMethodConstraint
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
Programmatic equivalent of a security constraint defined for a single HTTP method.
HttpServlet
Provides an abstract class to be subclassed to create an HTTP servlet suitable for a website.
HttpServletMapping
Represents how the request from which this object was obtained was mapped to the associated servlet.
HttpServletRequest
Extends the `ServletRequest` interface to provide request information for HTTP servlets.
HttpServletRequestWrapper
Provides a convenient implementation of the HttpServletRequest interface that can be subclassed by developers wishing to adapt the request to a Servlet.
HttpServletResponse
Extends the `ServletResponse` interface to provide HTTP-specific functionality in sending a response.
HttpServletResponseWrapper
Provides a convenient implementation of the HttpServletResponse interface that can be subclassed by developers wishing to adapt the response from a Servlet.
HttpSession
Provides a way to identify a user across more than one page request or visit to a website and to store information about that user.
HttpSession.Accessor
Provides a mechanism for applications to interact with the `HttpSession` outside of the scope of an HTTP request.
HttpSessionActivationListener
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
This listener interface can be implemented in order to get notifications of changes to the attribute lists of sessions within this web application.
HttpSessionBindingEvent
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.
HttpSessionBindingListener
Causes an object to be notified when it is bound to or unbound from a session.
HttpSessionEvent
This is the class representing event notifications for changes to sessions within a web application.
HttpSessionIdListener
Implementations of this interface are notified when an `HttpSession`'s ID changes.
HttpSessionListener
Implementations of this interface are notified of changes to the list of active sessions in a web application.
HttpUpgradeHandler
Interface between the HTTP upgrade process and the new protocol.
JspConfigDescriptor
This interface exposes the JSP specific configuration information obtain ed from the deployment descriptors.
JspPropertyGroupDescriptor
Represents the JSP property groups in the deployment descriptors.
MappingMatch
Represents the ways that a request can be mapped to a servlet
MultipartConfig
This annotation is used to indicate that the `Servlet` on which it is declared expects requests to be made using the `multipart/form-data` MIME type.
MultipartConfigElement
The programmatic equivalent of `MultipartConfig` used to configure multipart handling for a Servlet when registering a Servlet via code.
Part
This class represents a part as uploaded to the server as part of a `multipart/form-data` request body.
PushBuilder
Deprecated.
In favor of 103 early hints
ReadListener
Receives notification of read events when using non-blocking IO.
Registration
Common interface for the registration of Filters and Servlets.
Registration.Dynamic
Interface through which a Servlet or Filter registered via one of the addServlet or addFilter methods, respectively, on ServletContext may be further configured.
RequestDispatcher
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.
Servlet
Defines methods that all servlets must implement.
ServletConfig
A servlet configuration object used by a servlet container to pass information to a servlet during initialization.
ServletConnection
Provides information about the connection made to the Servlet container.
ServletContainerInitializer
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
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
This is the event class for notifications about changes to the attributes of the servlet context of a web application.
ServletContextAttributeListener
Implementations of this interface receive notifications of changes to the attribute list on the servlet context of a web application.
ServletContextEvent
This is the event class for notifications about changes to the servlet context of a web application.
ServletContextListener
Implementations of this interface receive notifications about changes to the servlet context of the web application they are part of.
ServletException
Defines a general exception a servlet can throw when it encounters difficulty.
ServletInputStream
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.
ServletOutputStream
Provides an output stream for sending binary data to the client.
ServletRegistration
Interface through which a Servlet may be further configured.
ServletRegistration.Dynamic
Interface through which a Servlet registered via one of the addServlet methods on ServletContext may be further configured.
ServletRequest
Defines an object to provide client request information to a servlet.
ServletRequestAttributeEvent
This is the event class for notifications of changes to the attributes of the servlet request in an application.
ServletRequestAttributeListener
A ServletRequestAttributeListener can be implemented by the developer interested in being notified of request attribute changes.
ServletRequestEvent
Events of this kind indicate lifecycle events for a ServletRequest.
ServletRequestListener
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
Provides a convenient implementation of the ServletRequest interface that can be subclassed by developers wishing to adapt the request to a Servlet.
ServletResponse
Defines an object to assist a servlet in sending a response to the client.
ServletResponseWrapper
Provides a convenient implementation of the ServletResponse interface that can be subclassed by developers wishing to adapt the response from a Servlet.
ServletSecurity
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
Represents the two possible values of the empty role semantic, active when a list of role names is empty.
ServletSecurity.TransportGuarantee
Represents the two possible values of data transport, encrypted or not.
ServletSecurityElement
The programmatic equivalent of `ServletSecurity` used to configure security constraints for a Servlet.
SessionCookieConfig
Configures the session cookies used by the web application associated with the ServletContext from which this SessionCookieConfig was obtained.
SessionTrackingMode
Defines the permitted options for configuring the session tracking mode.
TaglibDescriptor
Represents a taglib descriptor definitions in the deployment descriptor.
UnavailableException
Defines an exception that a servlet or filter throws to indicate that it is permanently or temporarily unavailable.
WebConnection
The interface used by an `HttpUpgradeHandler` to interact with an upgraded HTTP connection.
WebFilter
The annotation used to declare a Servlet `Filter`.
WebInitParam
The annotation used to declare an initialization parameter on a `Servlet` or `Filter`, within a `WebFilter` or `WebServlet` annotation.
E.g.
WebListener
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
This annotation is used to declare the configuration of a `Servlet`.
WriteListener
Receives notification of write events when using non-blocking IO.