Package jakarta.servlet

Interface ServletContextListener

All Superinterfaces:
EventListener
public interface ServletContextListener
extends EventListener
Interface for receiving notification events about ServletContext lifecycle changes.

In order to receive these notification events, the implementation class must be either declared in the deployment descriptor of the web application, annotated with WebListener, or registered via one of the addListener methods defined on ServletContext.

Implementations of this interface are invoked at their contextInitialized(jakarta.servlet.ServletContextEvent) method in the order in which they have been declared, and at their contextDestroyed(jakarta.servlet.ServletContextEvent) method in reverse order.

Since:
Servlet 2.3
See Also:
ServletContextEvent

  • Method Summary

    Modifier and Type Method Description
    default void contextDestroyed​(ServletContextEvent sce)
    Receives notification that the ServletContext is about to be shut down.
    default void contextInitialized​(ServletContextEvent sce)
    Receives notification that the web application initialization process is starting.

  • Method Details

    • contextInitialized

      default void contextInitialized​(ServletContextEvent sce)
      Receives notification that the web application initialization process is starting.

      All ServletContextListeners are notified of context initialization before any filters or servlets in the web application are initialized.

      Implementation Requirements:
      The default implementation takes no action.
      Parameters:
      sce - the ServletContextEvent containing the ServletContext that is being initialized

    • contextDestroyed

      default void contextDestroyed​(ServletContextEvent sce)
      Receives notification that the ServletContext is about to be shut down.

      All servlets and filters will have been destroyed before any ServletContextListeners are notified of context destruction.

      Implementation Requirements:
      The default implementation takes no action.
      Parameters:
      sce - the ServletContextEvent containing the ServletContext that is being destroyed