Base class for a org.springframework.web.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.

Modifier and Type	Class and Description
private static class	AbstractReactiveWebInitializer.ServletContextDestroyedListener

Field Summary

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

Constructor Summary

Access	Constructor and Description
public	AbstractReactiveWebInitializer()

Method Summary

Modifier and Type	Method and Description
protected 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`.
public void	onStartup(ServletContext the `ServletContext` to initialize servletContext) Implements org.springframework.web.WebApplicationInitializer.onStartup. Configure the given `ServletContext` with any servlets, filters, listeners context-params and attributes necessary for initializing this web application.
protected void	refreshApplicationContext(ApplicationContext context) Refresh the given application context, if necessary.
protected void	registerCloseListener(ServletContext the servlet context to listen to servletContext, ApplicationContext the application context that is to be closed when `servletContext` is destroyed applicationContext) Register a `ServletContextListener` that closes the given application context when the servlet context is destroyed.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DEFAULT_SERVLET_NAME	back to summary
public static final String DEFAULT_SERVLET_NAME The default servlet name to use. See `getServletName`.

Constructor Detail

AbstractReactiveWebInitializer	back to summary
public AbstractReactiveWebInitializer()

Method Detail

createApplicationContext	back to summary
protected ApplicationContext createApplicationContext() Return the Spring configuration that contains application beans including the ones detected by `WebHttpHandlerBuilder#applicationContext`.

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

getServletMapping	back to summary
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 '/'.

getServletMapping

back to summary

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 '/'.

getServletName back to summary

getServletName	back to summary
protected String getServletName() Return the name to use to register the `ServletHttpHandlerAdapter`. By default this is `DEFAULT_SERVLET_NAME`.

protected String getServletName()

Return the name to use to register the ServletHttpHandlerAdapter.

By default this is DEFAULT_SERVLET_NAME.

onStartup back to summary

onStartup	back to summary
public void onStartup(ServletContext servletContext) throws ServletException Implements org.springframework.web.WebApplicationInitializer.onStartup. Doc from org.springframework.web.WebApplicationInitializer.onStartup. Configure the given `ServletContext` with any servlets, filters, listeners context-params and attributes necessary for initializing this web application. See examples above. Parameters servletContext:ServletContext the `ServletContext` to initialize Annotations @Override Exceptions ServletException: if any call against the given `ServletContext` throws a `ServletException`

public void onStartup(ServletContext servletContext) throws ServletException

Implements org.springframework.web.WebApplicationInitializer.onStartup.

Doc from org.springframework.web.WebApplicationInitializer.onStartup.

Configure the given ServletContext with any servlets, filters, listeners context-params and attributes necessary for initializing this web application. See examples above.

Parameters

servletContext:ServletContext: the ServletContext to initialize

Annotations

@Override

Exceptions

ServletException:: if any call against the given ServletContext throws a ServletException

refreshApplicationContext	back to summary
protected void refreshApplicationContext(ApplicationContext context) Refresh the given application context, if necessary.

registerCloseListener back to summary

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

protected void registerCloseListener(ServletContext servletContext, ApplicationContext applicationContext)

Parameters

servletContext:ServletContext: the servlet context to listen to
applicationContext:ApplicationContext: the application context that is to be closed when servletContext is destroyed

org.springframework.web.server.adapter back to summary

private Class AbstractReactiveWebInitializer.ServletContextDestroyedListener

Class Inheritance

extends Object
implements ServletContextListener

java.lang.Object
org.springframework.web.server.adapter.AbstractReactiveWebInitializer.ServletContextDestroyedListener

All Implemented Interfaces

jakarta.servlet.ServletContextListener, java.util.EventListener

Field Summary

Modifier and Type	Field and Description
private final ConfigurableApplicationContext	applicationContext

Constructor Summary

Access	Constructor and Description
public	ServletContextDestroyedListener(ConfigurableApplicationContext applicationContext)

Method Summary

Modifier and Type	Method and Description
public void	contextDestroyed(ServletContextEvent Information about the ServletContext that was destroyed sce) Overrides default jakarta.servlet.ServletContextListener.contextDestroyed. Notification that the servlet context is about to be shut down.
public void	contextInitialized(ServletContextEvent Information about the ServletContext that was initialized sce) Overrides default jakarta.servlet.ServletContextListener.contextInitialized. Notification that the web application initialization process is starting.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

applicationContext	back to summary
private final ConfigurableApplicationContext applicationContext

Constructor Detail

ServletContextDestroyedListener	back to summary
public ServletContextDestroyedListener(ConfigurableApplicationContext applicationContext)

Method Detail

contextDestroyed	back to summary
public void contextDestroyed(ServletContextEvent sce) Overrides default jakarta.servlet.ServletContextListener.contextDestroyed. Doc from jakarta.servlet.ServletContextListener.contextDestroyed. Notification that the servlet context is about to be shut down. All servlets and filters have been destroyed before any ServletContextListeners are notified of context destruction. The default implementation is a NO-OP. Parameters sce:ServletContextEvent Information about the ServletContext that was destroyed Annotations @Override

contextDestroyed

back to summary

public void contextDestroyed(ServletContextEvent sce)

Overrides default jakarta.servlet.ServletContextListener.contextDestroyed.

Doc from jakarta.servlet.ServletContextListener.contextDestroyed.

Notification that the servlet context is about to be shut down. All servlets and filters have been destroyed before any ServletContextListeners are notified of context destruction. The default implementation is a NO-OP.

Parameters

sce:ServletContextEvent: Information about the ServletContext that was destroyed

Annotations

@Override

contextInitialized	back to summary
public void contextInitialized(ServletContextEvent sce) Overrides default jakarta.servlet.ServletContextListener.contextInitialized. Doc from jakarta.servlet.ServletContextListener.contextInitialized. Notification that the web application initialization process is starting. All ServletContextListeners are notified of context initialization before any filter or servlet in the web application is initialized. The default implementation is a NO-OP. Parameters sce:ServletContextEvent Information about the ServletContext that was initialized Annotations @Override

contextInitialized

back to summary

public void contextInitialized(ServletContextEvent sce)

Overrides default jakarta.servlet.ServletContextListener.contextInitialized.

Doc from jakarta.servlet.ServletContextListener.contextInitialized.

Notification that the web application initialization process is starting. All ServletContextListeners are notified of context initialization before any filter or servlet in the web application is initialized. The default implementation is a NO-OP.

Parameters

sce:ServletContextEvent: Information about the ServletContext that was initialized

Annotations

@Override

public abstract Class AbstractReactiveWebInitializer

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class AbstractReactiveWebInitializer.ServletContextDestroyedListener

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail