public class ServletRegistrationBean extends RegistrationBean
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.
ServletContextInitializer,
ServletContext.addServlet(String, Servlet)| Constructor and Description |
|---|
ServletRegistrationBean()
Create a new
ServletRegistrationBean instance. |
ServletRegistrationBean(javax.servlet.Servlet servlet,
boolean alwaysMapUrl,
String... urlMappings)
Create a new
ServletRegistrationBean instance with the specified
Servlet and URL mappings. |
ServletRegistrationBean(javax.servlet.Servlet servlet,
String... urlMappings)
Create a new
ServletRegistrationBean instance with the specified
Servlet and URL mappings. |
| Modifier and Type | Method and Description |
|---|---|
void |
addUrlMappings(String... urlMappings)
Add URL mappings, as defined in the Servlet specification, for the servlet.
|
protected void |
configure(javax.servlet.ServletRegistration.Dynamic registration)
Configure registration settings.
|
javax.servlet.MultipartConfigElement |
getMultipartConfig()
Returns the
multi-part configuration to be applied
or null. |
protected javax.servlet.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, as defined in the Servlet
specification, for the servlet.
|
void |
onStartup(javax.servlet.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(javax.servlet.MultipartConfigElement multipartConfig)
Set the
multi-part configuration. |
void |
setServlet(javax.servlet.Servlet servlet)
Sets the servlet to be registered.
|
void |
setUrlMappings(Collection<String> urlMappings)
Set the URL mappings for the servlet.
|
addInitParameter, configure, getInitParameters, getOrDeduceName, getOrder, isAsyncSupported, isEnabled, setAsyncSupported, setEnabled, setInitParameters, setName, setOrderpublic ServletRegistrationBean()
ServletRegistrationBean instance.public ServletRegistrationBean(javax.servlet.Servlet servlet,
String... urlMappings)
ServletRegistrationBean instance with the specified
Servlet and URL mappings.servlet - the servlet being mappedurlMappings - the URLs being mappedpublic ServletRegistrationBean(javax.servlet.Servlet servlet,
boolean alwaysMapUrl,
String... urlMappings)
ServletRegistrationBean instance with the specified
Servlet and URL mappings.servlet - the servlet being mappedalwaysMapUrl - if omitted URL mappings should be replaced with '/*'urlMappings - the URLs being mappedprotected javax.servlet.Servlet getServlet()
public void setServlet(javax.servlet.Servlet servlet)
servlet - the servletpublic void setUrlMappings(Collection<String> urlMappings)
urlMappings - the mappings to setaddUrlMappings(String...)public Collection<String> getUrlMappings()
public void addUrlMappings(String... urlMappings)
urlMappings - the mappings to addsetUrlMappings(Collection)public void setLoadOnStartup(int loadOnStartup)
loadOnStartup priority. See
ServletRegistration.Dynamic#setLoadOnStartup for details.loadOnStartup - if load on startup is enabledpublic void setMultipartConfig(javax.servlet.MultipartConfigElement multipartConfig)
multi-part configuration.multipartConfig - the multi-part configuration to set or nullpublic javax.servlet.MultipartConfigElement getMultipartConfig()
multi-part configuration to be applied
or null.public String getServletName()
public void onStartup(javax.servlet.ServletContext servletContext)
throws javax.servlet.ServletException
ServletContextInitializerServletContext with any servlets, filters, listeners
context-params and attributes necessary for initialization.servletContext - the ServletContext to initializejavax.servlet.ServletException - if any call against the given ServletContext
throws a ServletExceptionprotected void configure(javax.servlet.ServletRegistration.Dynamic registration)
registration - the registrationCopyright © 2018 Pivotal Software, Inc.. All rights reserved.