Class AbstractReactiveWebInitializer

java.lang.Object
org.springframework.web.server.adapter.AbstractReactiveWebInitializer
All Implemented Interfaces:
WebApplicationInitializer
public abstract class AbstractReactiveWebInitializer extends Object implements WebApplicationInitializer
Base class for a WebApplicationInitializer that installs a Spring Reactive Web Application on a Servlet container.

Spring configuration is loaded and given to WebHttpHandlerBuilder which scans the context looking for specific beans and creates a reactive HttpHandler. The resulting handler is installed as a Servlet through the ServletHttpHandlerAdapter.

Since:
5.0.2
Author:
Rossen Stoyanchev, Sam Brannen

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DEFAULT_SERVLET_NAME
    The default servlet name to use.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractReactiveWebInitializer()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected org.springframework.context.ApplicationContext
    createApplicationContext()
    Return the Spring configuration that contains application beans including the ones detected by WebHttpHandlerBuilder.applicationContext.
    protected abstract Class<?>[]
    getConfigClasses()
    Specify @Configuration and/or @Component classes that make up the application configuration.
    protected String
    getServletMapping()
    Return the Servlet mapping to use.
    protected String
    getServletName()
    Return the name to use to register the ServletHttpHandlerAdapter.
    void
    onStartup(jakarta.servlet.ServletContext servletContext)
    Configure the given ServletContext with any servlets, filters, listeners context-params and attributes necessary for initializing this web application.
    protected void
    refreshApplicationContext(org.springframework.context.ApplicationContext context)
    Refresh the given application context, if necessary.
    protected void
    registerCloseListener(jakarta.servlet.ServletContext servletContext, org.springframework.context.ApplicationContext applicationContext)
    Register a ServletContextListener that closes the given application context when the servlet context is destroyed.

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Constructor Details

    • AbstractReactiveWebInitializer

      public AbstractReactiveWebInitializer()

  • Method Details

    • onStartup

      public void onStartup(jakarta.servlet.ServletContext servletContext) throws jakarta.servlet.ServletException
      Description copied from interface: WebApplicationInitializer
      Configure the given ServletContext with any servlets, filters, listeners context-params and attributes necessary for initializing this web application. See examples above.
      Specified by:
      onStartup in interface WebApplicationInitializer
      Parameters:
      servletContext - the ServletContext to initialize
      Throws:
      jakarta.servlet.ServletException - if any call against the given ServletContext throws a ServletException

    • getServletName

      protected String getServletName()
      Return the name to use to register the ServletHttpHandlerAdapter.

      By default this is DEFAULT_SERVLET_NAME.

    • createApplicationContext

      protected org.springframework.context.ApplicationContext createApplicationContext()
      Return the Spring configuration that contains application beans including the ones detected by WebHttpHandlerBuilder.applicationContext.

    • getConfigClasses

      protected abstract Class<?>[] getConfigClasses()
      Specify @Configuration and/or @Component classes that make up the application configuration. The config classes are given to createApplicationContext().

    • refreshApplicationContext

      protected void refreshApplicationContext(org.springframework.context.ApplicationContext context)
      Refresh the given application context, if necessary.

    • registerCloseListener

      protected void registerCloseListener(jakarta.servlet.ServletContext servletContext, org.springframework.context.ApplicationContext applicationContext)
      Register a ServletContextListener that closes the given application context when the servlet context is destroyed.
      Parameters:
      servletContext - the servlet context to listen to
      applicationContext - the application context that is to be closed when servletContext is destroyed

    • getServletMapping

      protected String getServletMapping()
      Return the Servlet mapping to use. Only the default Servlet mapping '/' and path-based Servlet mappings such as '/api/*' are supported.

      By default this is set to '/'.