Jakarta EE 11.0.0 · jakarta.servlet · APIdia, the JavaDoc alternative

Interface Summary

Modifier and Type	Interface and Description
public interface	AsyncContext Class representing the execution context for an asynchronous operation that was initiated on a ServletRequest.
public interface	AsyncListener Listener that will be notified in the event that an asynchronous operation initiated on a ServletRequest to which the listener had been added has completed, timed out, or resulted in an error.
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 This class represents a call-back mechanism that will notify implementations as HTTP request data becomes available to be read without blocking.
public interface	Registration Interface through which a `Servlet` or `Filter` may be further configured.
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 Interface which allows a library/runtime to be notified of a web application's startup phase and perform any required programmatic registration of servlets, filters, and listeners in response to it.
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 Interface for receiving notification events about ServletContext attribute changes.
public interface	ServletContextListener Interface for receiving notification events about ServletContext lifecycle changes.
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 Interface for receiving notification events about ServletRequest attribute changes.
public interface	ServletRequestListener Interface for receiving notification events about requests coming into and going out of scope of a web application.
public interface	ServletResponse Defines an object to assist a servlet in sending a response to the client.
public interface	SessionCookieConfig Class that may be used to configure various properties of cookies used for session tracking purposes.
public interface	WriteListener Callback notification mechanism that signals to the developer it's possible to write content without blocking.

Class Summary

Modifier and Type	Class and Description
public class	AsyncEvent Event that gets fired when the asynchronous operation initiated on a ServletRequest (via a call to `ServletRequest#startAsync` or `ServletRequest#startAsync(ServletRequest, ServletResponse)`) has completed, timed out, or produced an error.
public abstract class	GenericFilter Defines a generic, protocol-independent filter.
public abstract class	GenericServlet Defines a generic, protocol-independent servlet.
public class	HttpConstraintElement Java Class representation of an `HttpConstraint` annotation value.
public class	HttpMethodConstraintElement Java Class representation of an `HttpMethodConstraint` annotation value.
public class	MultipartConfigElement Java Class representation of an `MultipartConfig` annotation value.
public class	ServletContextAttributeEvent Event class for notifications about changes to the attributes of the ServletContext 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 Java Class representation of a `ServletSecurity` annotation value.
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 filter dispatcher types.
public enum	SessionTrackingMode Enumeration of session tracking modes.

Package jakarta.servlet

Interface Summary

Class Summary

Enum Summary