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 theServlet
to register
- All Implemented Interfaces:
ServletContextInitializer
,Ordered
- Direct Known Subclasses:
DispatcherServletRegistrationBean
public class ServletRegistrationBean<T extends Servlet>
extends DynamicRegistrationBean<ServletRegistration.Dynamic>
A
ServletContextInitializer
to register Servlet
s 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:
-
Field Summary
Fields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
-
Constructor Summary
ConstructorDescriptionCreate a newServletRegistrationBean
instance.ServletRegistrationBean
(T servlet, boolean alwaysMapUrl, String... urlMappings) Create a newServletRegistrationBean
instance with the specifiedServlet
and URL mappings.ServletRegistrationBean
(T servlet, String... urlMappings) Create a newServletRegistrationBean
instance with the specifiedServlet
and URL mappings. -
Method Summary
Modifier and TypeMethodDescriptionprotected 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
Return a description of the registration.Returns themulti-part configuration
to be applied ornull
.Return the servlet being registered.Returns the servlet name that will be registered.Return a mutable collection of the URL mappings, as defined in the Servlet specification, for the servlet.void
setLoadOnStartup
(int loadOnStartup) Sets theloadOnStartup
priority.void
setMultipartConfig
(MultipartConfigElement multipartConfig) Set themulti-part configuration
.void
setServlet
(T servlet) Sets the servlet to be registered.void
setUrlMappings
(Collection<String> urlMappings) Set the URL mappings for the servlet.toString()
Methods inherited from class org.springframework.boot.web.servlet.DynamicRegistrationBean
addInitParameter, getInitParameters, getOrDeduceName, isAsyncSupported, register, setAsyncSupported, setInitParameters, setName
Methods inherited from class org.springframework.boot.web.servlet.RegistrationBean
getOrder, isEnabled, onStartup, setEnabled, setOrder
-
Constructor Details
-
ServletRegistrationBean
public ServletRegistrationBean()Create a newServletRegistrationBean
instance. -
ServletRegistrationBean
Create a newServletRegistrationBean
instance with the specifiedServlet
and URL mappings.- Parameters:
servlet
- the servlet being mappedurlMappings
- the URLs being mapped
-
ServletRegistrationBean
Create a newServletRegistrationBean
instance with the specifiedServlet
and URL mappings.- Parameters:
servlet
- the servlet being mappedalwaysMapUrl
- if omitted URL mappings should be replaced with '/*'urlMappings
- the URLs being mapped
-
-
Method Details
-
setServlet
Sets the servlet to be registered.- Parameters:
servlet
- the servlet
-
getServlet
Return the servlet being registered.- Returns:
- the servlet
-
setUrlMappings
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:
-
getUrlMappings
Return a mutable collection of the URL mappings, as defined in the Servlet specification, for the servlet.- Returns:
- the urlMappings
-
addUrlMappings
Add URL mappings, as defined in the Servlet specification, for the servlet.- Parameters:
urlMappings
- the mappings to add- See Also:
-
setLoadOnStartup
public void setLoadOnStartup(int loadOnStartup) Sets theloadOnStartup
priority. SeeServletRegistration.Dynamic.setLoadOnStartup(int)
for details.- Parameters:
loadOnStartup
- if load on startup is enabled
-
setMultipartConfig
Set themulti-part configuration
.- Parameters:
multipartConfig
- the multipart configuration to set ornull
-
getMultipartConfig
Returns themulti-part configuration
to be applied ornull
.- Returns:
- the multipart config
-
getDescription
Description copied from class:RegistrationBean
Return a description of the registration. For example "Servlet resourceServlet"- Specified by:
getDescription
in classRegistrationBean
- Returns:
- a description of the registration
-
addRegistration
protected ServletRegistration.Dynamic addRegistration(String description, ServletContext servletContext) - Specified by:
addRegistration
in classDynamicRegistrationBean<ServletRegistration.Dynamic>
-
configure
Configure registration settings. Subclasses can override this method to perform additional configuration if required.- Overrides:
configure
in classDynamicRegistrationBean<ServletRegistration.Dynamic>
- Parameters:
registration
- the registration
-
getServletName
Returns the servlet name that will be registered.- Returns:
- the servlet name
-
toString
-