Tomcat 10.1.19 · jakarta.servlet · APIdia, the JavaDoc alternative

Interface Summary

Modifier and Type	Interface and Description
public interface	AsyncContext Provides the context for asynchronous request handling
public interface	AsyncListener Listener for events associated with an `AsyncContext`.
public interface	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.
public interface	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.
public interface	FilterConfig A filter configuration object used by a servlet container to pass information to a filter during initialization.
public interface	FilterRegistration Interface through which a Filter may be further configured.
public interface	ReadListener Receives notification of read events when using non-blocking IO.
public interface	Registration Common interface for the registration of Filters and Servlets.
public interface	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.
public interface	Servlet Defines methods that all servlets must implement.
public interface	ServletConfig A servlet configuration object used by a servlet container to pass information to a servlet during initialization.
public interface	ServletConnection Provides information about the connection made to the Servlet container.
public interface	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.
public interface	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.
public interface	ServletContextAttributeListener Implementations of this interface receive notifications of changes to the attribute list on the servlet context of a web application.
public interface	ServletContextListener Implementations of this interface receive notifications about changes to the servlet context of the web application they are part of.
public interface	ServletRegistration Interface through which a Servlet may be further configured.
public interface	ServletRequest Defines an object to provide client request information to a servlet.
public interface	ServletRequestAttributeListener A ServletRequestAttributeListener can be implemented by the developer interested in being notified of request attribute changes.
public interface	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.
public interface	ServletResponse Defines an object to assist a servlet in sending a response to the client.
public interface	SessionCookieConfig Configures the session cookies used by the web application associated with the ServletContext from which this SessionCookieConfig was obtained.
public interface	WriteListener Receives notification of write events when using non-blocking IO.

Class Summary

Modifier and Type	Class and Description
public class	AsyncEvent Used to pass data to the methods of `AsyncListener`.
public abstract class	GenericFilter Provides a base class that implements the Filter and FilterConfig interfaces to reduce boilerplate when writing new filters.
public abstract class	GenericServlet Defines a generic, protocol-independent servlet.
public class	HttpConstraintElement Equivalent of `jakarta.servlet.annotation.HttpConstraint` for programmatic configuration of security constraints.
public class	HttpMethodConstraintElement Programmatic equivalent of a security constraint defined for a single HTTP method.
public class	MultipartConfigElement The programmatic equivalent of `jakarta.servlet.annotation.MultipartConfig` used to configure multi-part handling for a Servlet when registering a Servlet via code.
public class	ServletContextAttributeEvent This is the event class for notifications about changes to the attributes of the servlet context of a web application.
public class	ServletContextEvent This is the event class for notifications about changes to the servlet context of a web application.
public class	ServletException Defines a general exception a servlet can throw when it encounters difficulty.
public abstract class	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.
public abstract class	ServletOutputStream Provides an output stream for sending binary data to the client.
public class	ServletRequestAttributeEvent This is the event class for notifications of changes to the attributes of the servlet request in an application.
public class	ServletRequestEvent Events of this kind indicate lifecycle events for a ServletRequest.
public class	ServletRequestWrapper Provides a convenient implementation of the ServletRequest interface that can be subclassed by developers wishing to adapt the request to a Servlet.
public class	ServletResponseWrapper Provides a convenient implementation of the ServletResponse interface that can be subclassed by developers wishing to adapt the response from a Servlet.
public class	ServletSecurityElement The programmatic equivalent of `jakarta.servlet.annotation.ServletSecurity` used to configre security constraints for a Servlet.
public class	UnavailableException Defines an exception that a servlet or filter throws to indicate that it is permanently or temporarily unavailable.

Modifier and Type	Enum and Description
public enum	DispatcherType Enumeration of dispatcher types.
public enum	SessionTrackingMode Defines the permitted options for configuring the session tracking mode.

Package jakarta.servlet

Interface Summary

Class Summary

Enum Summary