org.springframework.web.reactive.support

Class AbstractDispatcherHandlerInitializer

java.lang.Object

org.springframework.web.reactive.support.AbstractDispatcherHandlerInitializer

All Implemented Interfaces:

WebApplicationInitializer

Direct Known Subclasses:

AbstractAnnotationConfigDispatcherHandlerInitializer

public abstract class AbstractDispatcherHandlerInitializer
extends java.lang.Object
implements WebApplicationInitializer

Base class for WebApplicationInitializer implementations that register a DispatcherHandler in the servlet context, wrapping it in a ServletHttpHandlerAdapter.

Most applications should consider extending the Spring Java config, sub-class AbstractAnnotationConfigDispatcherHandlerInitializer.

Since:

5.0

Author:

Arjen Poutsma

See Also:

AbstractServletHttpHandlerAdapterInitializer

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_SERVLET_MAPPING The default servlet mapping.
static java.lang.String	DEFAULT_SERVLET_NAME The default servlet name.

Constructor Summary

Constructors

Constructor and Description
AbstractDispatcherHandlerInitializer()

Method Summary

Modifier and Type	Method and Description
protected abstract ApplicationContext	createApplicationContext() Create an application context to be provided to the DispatcherHandler.
protected WebHandler	createDispatcherHandler(ApplicationContext applicationContext) Create a DispatcherHandler (or other kind of WebHandler-derived dispatcher) with the specified ApplicationContext.
protected ServletHttpHandlerAdapter	createHandlerAdapter(WebHandler webHandler) Create a ServletHttpHandlerAdapter.
protected void	customizeRegistration(ServletRegistration.Dynamic registration) Optionally perform further registration customization once registerDispatcherHandler(ServletContext) has completed.
protected java.lang.String	getServletMapping() Specify the servlet mapping for the ServletHttpHandlerAdapter.
protected java.lang.String	getServletName() Return the name under which the ServletHttpHandlerAdapter will be registered.
void	onStartup(ServletContext servletContext) 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 servletContext, ApplicationContext applicationContext) Register a ServletContextListener that closes the given application context when the servlet context is destroyed.
protected void	registerDispatcherHandler(ServletContext servletContext) Register a DispatcherHandler against the given servlet context.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SERVLET_NAME

public static final java.lang.String DEFAULT_SERVLET_NAME

The default servlet name. Can be customized by overriding getServletName().

See Also:

Constant Field Values

DEFAULT_SERVLET_MAPPING

public static final java.lang.String DEFAULT_SERVLET_MAPPING

The default servlet mapping. Can be customized by overriding getServletMapping().

See Also:

Constant Field Values

Constructor Detail

AbstractDispatcherHandlerInitializer

public AbstractDispatcherHandlerInitializer()

Method Detail

onStartup

public void onStartup(ServletContext servletContext)
               throws 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:

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

registerDispatcherHandler

protected void registerDispatcherHandler(ServletContext servletContext)

Register a DispatcherHandler against the given servlet context.

This method will create a DispatcherHandler, initializing it with the application context returned from createApplicationContext(). The created handler will be wrapped in a ServletHttpHandlerAdapter servlet with the name returned by getServletName(), mapping it to the pattern returned from getServletMapping().

Further customization can be achieved by overriding customizeRegistration(ServletRegistration.Dynamic) or createDispatcherHandler(ApplicationContext).

Parameters:

servletContext - the context to register the servlet against

getServletName

protected java.lang.String getServletName()

Return the name under which the ServletHttpHandlerAdapter will be registered. Defaults to DEFAULT_SERVLET_NAME.

See Also:

registerDispatcherHandler(ServletContext)

createApplicationContext

protected abstract ApplicationContext createApplicationContext()

Create an application context to be provided to the DispatcherHandler.

The returned context is delegated to Spring's DispatcherHandler.DispatcherHandler(ApplicationContext). As such, it typically contains controllers, view resolvers, and other web-related beans.

See Also:

registerDispatcherHandler(ServletContext)

refreshApplicationContext

protected void refreshApplicationContext(ApplicationContext context)

Refresh the given application context, if necessary.

createDispatcherHandler

protected WebHandler createDispatcherHandler(ApplicationContext applicationContext)

Create a DispatcherHandler (or other kind of WebHandler-derived dispatcher) with the specified ApplicationContext.

createHandlerAdapter

protected ServletHttpHandlerAdapter createHandlerAdapter(WebHandler webHandler)

Create a ServletHttpHandlerAdapter.

Default implementation returns a ServletHttpHandlerAdapter with the provided webHandler.

getServletMapping

protected java.lang.String getServletMapping()

Specify the servlet mapping for the ServletHttpHandlerAdapter.

Default implementation returns /.

See Also:

registerDispatcherHandler(ServletContext)

customizeRegistration

protected void customizeRegistration(ServletRegistration.Dynamic registration)

Optionally perform further registration customization once registerDispatcherHandler(ServletContext) has completed.

Parameters:

registration - the ServletHttpHandlerAdapter registration to be customized

See Also:

registerDispatcherHandler(ServletContext)

registerCloseListener

protected void registerCloseListener(ServletContext servletContext,
                                     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