Package org.springframework.boot.web.servlet

Class ServletRegistrationBean<T extends Servlet>

java.lang.Object

org.springframework.boot.web.servlet.RegistrationBean

org.springframework.boot.web.servlet.DynamicRegistrationBean<ServletRegistration.Dynamic>

org.springframework.boot.web.servlet.ServletRegistrationBean<T>

Type Parameters:

T - the type of the Servlet to register

All Implemented Interfaces:

Aware, BeanNameAware, ServletContextInitializer, Ordered

Direct Known Subclasses:

DispatcherServletRegistrationBean

public class ServletRegistrationBean<T extends Servlet>
extends DynamicRegistrationBean<ServletRegistration.Dynamic>

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 RegistrationBean.onStartup(jakarta.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	Description
ServletRegistrationBean()	Create a new ServletRegistrationBean instance.
ServletRegistrationBean(T servlet, boolean alwaysMapUrl, String... urlMappings)	Create a new ServletRegistrationBean instance with the specified Servlet and URL mappings.
ServletRegistrationBean(T servlet, String... urlMappings)	Create a new ServletRegistrationBean instance with the specified Servlet and URL mappings.

Method Summary

Modifier and Type	Method	Description
protected ServletRegistration.Dynamic	addRegistration(String description, ServletContext servletContext)
void	addUrlMappings(String... urlMappings)	Add URL mappings, as defined in the Servlet specification, for the servlet.
protected void	configure(ServletRegistration.Dynamic registration)	Configure registration settings.
protected String	getDescription()	Return a description of the registration.
MultipartConfigElement	getMultipartConfig()	Returns the multi-part configuration to be applied or null.
T	getServlet()	Return 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, as defined in the Servlet specification, for the servlet.
void	setLoadOnStartup(int loadOnStartup)	Sets the loadOnStartup priority.
void	setMultipartConfig(MultipartConfigElement multipartConfig)	Set the multi-part configuration.
void	setServlet(T servlet)	Sets the servlet to be registered.
void	setUrlMappings(Collection<String> urlMappings)	Set the URL mappings for the servlet.
String	toString()

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

addInitParameter, getInitParameters, getOrDeduceName, isAsyncSupported, register, setAsyncSupported, setBeanName, setIgnoreRegistrationFailure, setInitParameters, setName

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

getOrder, isEnabled, onStartup, setEnabled, setOrder

Methods inherited from class java.lang.Object

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

Constructor Details

ServletRegistrationBean

public ServletRegistrationBean()

Create a new ServletRegistrationBean instance.

ServletRegistrationBean

public ServletRegistrationBean(T 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(T servlet,
 boolean alwaysMapUrl,
 String... urlMappings)

Create a new ServletRegistrationBean instance with the specified