org.springframework.boot.web.servlet

Class ServletRegistrationBean

java.lang.Object

org.springframework.boot.web.servlet.RegistrationBean

org.springframework.boot.web.servlet.ServletRegistrationBean

All Implemented Interfaces:

ServletContextInitializer, org.springframework.core.Ordered

public class ServletRegistrationBean
extends RegistrationBean

A ServletContextInitializer to register Servlets in a Servlet 3.0+ container. Similar to the registration features provided by ServletContext but with a Spring Bean friendly design.

The servlet must be specified before calling onStartup(javax.servlet.ServletContext). URL mapping can be configured used setUrlMappings(java.util.Collection<java.lang.String>) or omitted when mapping to '/*' (unless alwaysMapUrl is set to false). The servlet name will be deduced if not specified.

Since:

1.4.0

Author:

Phillip Webb

See Also:

ServletContextInitializer, ServletContext.addServlet(String, Servlet)

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
ServletRegistrationBean() Create a new ServletRegistrationBean instance.
ServletRegistrationBean(Servlet servlet, boolean alwaysMapUrl, String... urlMappings) Create a new ServletRegistrationBean instance with the specified Servlet and URL mappings.
ServletRegistrationBean(Servlet servlet, String... urlMappings) Create a new ServletRegistrationBean instance with the specified Servlet and URL mappings.

Method Summary

Modifier and Type	Method and Description
void	addUrlMappings(String... urlMappings) Add URL mappings for the servlet.
protected void	configure(ServletRegistration.Dynamic registration) Configure registration settings.
MultipartConfigElement	getMultipartConfig() Returns the multi-part configuration to be applied or null.
protected Servlet	getServlet() Returns the servlet being registered.
String	getServletName() Returns the servlet name that will be registered.
Collection<String>	getUrlMappings() Return a mutable collection of the URL mappings for the servlet.
void	onStartup(ServletContext servletContext) Configure the given ServletContext with any servlets, filters, listeners context-params and attributes necessary for initialization.
void	setLoadOnStartup(int loadOnStartup) Sets the loadOnStartup priority.
void	setMultipartConfig(MultipartConfigElement multipartConfig) Set the multi-part configuration.
void	setServlet(Servlet servlet) Sets the servlet to be registered.
void	setUrlMappings(Collection<String> urlMappings) Set the URL mappings for the servlet.

Methods inherited from class org.springframework.boot.web.servlet.RegistrationBean

addInitParameter, configure, getInitParameters, getOrDeduceName, getOrder, isAsyncSupported, isEnabled, setAsyncSupported, setEnabled, setInitParameters, setName, setOrder

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletRegistrationBean

public ServletRegistrationBean()

Create a new ServletRegistrationBean instance.

ServletRegistrationBean

public ServletRegistrationBean(Servlet servlet,
                               String... urlMappings)

Create a new ServletRegistrationBean instance with the specified Servlet and URL mappings.

Parameters:

servlet - the servlet being mapped

urlMappings - the URLs being mapped

ServletRegistrationBean

public ServletRegistrationBean(Servlet servlet,
                               boolean alwaysMapUrl,
                               String... urlMappings)

Create a new ServletRegistrationBean instance with the specified Servlet and URL mappings.

Parameters:

servlet - the servlet being mapped

alwaysMapUrl - if omitted URL mappings should be replaced with '/*'

urlMappings - the URLs being mapped

Method Detail

getServlet

protected Servlet getServlet()

Returns the servlet being registered.

Returns:

the servlet

setServlet

public void setServlet(Servlet servlet)

Sets the servlet to be registered.

Parameters:

servlet - the servlet

setUrlMappings

public void setUrlMappings(Collection<String> urlMappings)

Set the URL mappings for the servlet. If not specified the mapping will default to '/'. This will replace any previously specified mappings.

Parameters:

urlMappings - the mappings to set

See Also:

addUrlMappings(String...)

getUrlMappings

public Collection<String> getUrlMappings()

Return a mutable collection of the URL mappings for the servlet.

Returns:

the urlMappings

addUrlMappings

public void addUrlMappings(String... urlMappings)

Add URL mappings for the servlet.

Parameters:

urlMappings - the mappings to add

See Also:

setUrlMappings(Collection)

setLoadOnStartup

public void setLoadOnStartup(int loadOnStartup)

Sets the loadOnStartup priority. See ServletRegistration.Dynamic#setLoadOnStartup for details.

Parameters:

loadOnStartup - if load on startup is enabled

setMultipartConfig

public void setMultipartConfig(MultipartConfigElement multipartConfig)

Set the multi-part configuration.

Parameters:

multipartConfig - the multi-part configuration to set or null

getMultipartConfig

public MultipartConfigElement getMultipartConfig()

Returns the multi-part configuration to be applied or null.

Returns:

the multipart config

getServletName

public String getServletName()

Returns the servlet name that will be registered.

Returns:

the servlet name

onStartup

public void onStartup(ServletContext servletContext)
               throws ServletException

Description copied from interface: ServletContextInitializer

Configure the given ServletContext with any servlets, filters, listeners context-params and attributes necessary for initialization.

Parameters:

servletContext - the ServletContext to initialize

Throws:

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

configure

protected void configure(ServletRegistration.Dynamic registration)

Configure registration settings. Subclasses can override this method to perform additional configuration if required.

Parameters:

registration - the registration