org.springframework.web.reactive.support

Class AbstractServletHttpHandlerAdapterInitializer

java.lang.Object

org.springframework.web.reactive.support.AbstractServletHttpHandlerAdapterInitializer

All Implemented Interfaces:

WebApplicationInitializer

public abstract class AbstractServletHttpHandlerAdapterInitializer
extends Object
implements WebApplicationInitializer

Base class for WebApplicationInitializer implementations that register a ServletHttpHandlerAdapter in the servlet context.

Concrete implementations are required to implement createHttpHandler(), as well as getServletMappings(), both of which get invoked from registerHandlerAdapter(ServletContext). Further customization can be achieved by overriding customizeRegistration(ServletRegistration.Dynamic).

Since:

5.0

Author:

Arjen Poutsma

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVLET_NAME The default servlet name.

Constructor Summary

Constructors

Constructor and Description
AbstractServletHttpHandlerAdapterInitializer()

Method Summary

Modifier and Type	Method and Description
protected abstract HttpHandler	createHttpHandler() Create the HttpHandler.
protected ServletHttpHandlerAdapter	createServlet(HttpHandler httpHandler) Create a ServletHttpHandlerAdapter with the specified .
protected void	customizeRegistration(ServletRegistration.Dynamic registration) Optionally perform further registration customization once registerHandlerAdapter(ServletContext) has completed.
protected abstract String[]	getServletMappings() Specify the servlet mapping(s) for the ServletHttpHandlerAdapter — for example "/", "/app", etc.
protected 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	registerHandlerAdapter(ServletContext servletContext) Register a ServletHttpHandlerAdapter 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 String DEFAULT_SERVLET_NAME

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

See Also:

Constant Field Values

Constructor Detail

AbstractServletHttpHandlerAdapterInitializer

public AbstractServletHttpHandlerAdapterInitializer()

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

registerHandlerAdapter

protected void registerHandlerAdapter(ServletContext servletContext)

Register a ServletHttpHandlerAdapter against the given servlet context.

This method will create a HttpHandler using createHttpHandler(), and use it to create a ServletHttpHandlerAdapter with the name returned by getServletName(), and mapping it to the patterns returned from getServletMappings().

Further customization can be achieved by overriding customizeRegistration(ServletRegistration.Dynamic) or createServlet(HttpHandler).

Parameters:

servletContext - the context to register the servlet against

getServletName

protected String getServletName()

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

See Also:

registerHandlerAdapter(ServletContext)

createHttpHandler

protected abstract HttpHandler createHttpHandler()

Create the HttpHandler.

createServlet

protected ServletHttpHandlerAdapter createServlet(HttpHandler httpHandler)

Create a ServletHttpHandlerAdapter with the specified .

Default implementation returns a ServletHttpHandlerAdapter with the provided httpHandler.

getServletMappings

protected abstract String[] getServletMappings()

Specify the servlet mapping(s) for the ServletHttpHandlerAdapter — for example "/", "/app", etc.

See Also:

registerHandlerAdapter(ServletContext)

customizeRegistration

protected void customizeRegistration(ServletRegistration.Dynamic registration)

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

Parameters:

registration - the DispatcherServlet registration to be customized

See Also:

registerHandlerAdapter(ServletContext)