ServletRegistrationBean (spring-boot 2.0.3.RELEASE)

java.lang.Object
- org.springframework.boot.web.servlet.RegistrationBean
- - org.springframework.boot.web.servlet.DynamicRegistrationBean<javax.servlet.ServletRegistration.Dynamic>
  - - org.springframework.boot.web.servlet.ServletRegistrationBean<T>

Type Parameters:

T - the type of the Servlet to register

All Implemented Interfaces:

ServletContextInitializer, org.springframework.core.Ordered
```
public class ServletRegistrationBean<T extends javax.servlet.Servlet>
extends DynamicRegistrationBean<javax.servlet.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(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(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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected javax.servlet.ServletRegistration.Dynamic`	`addRegistration(String description, javax.servlet.ServletContext servletContext)`
`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.
`protected String`	`getDescription()` Return a description of the registration.
`javax.servlet.MultipartConfigElement`	`getMultipartConfig()` Returns the `multi-part configuration` to be applied or `null`.
`protected T`	`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`	`setLoadOnStartup(int loadOnStartup)` Sets the `loadOnStartup` priority.
`void`	`setMultipartConfig(javax.servlet.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.

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

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(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 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 T getServlet()
```
    Returns the servlet being registered.
    
    Returns:
    
    the servlet
  - setServlet
```
public void setServlet(T 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, as defined in the Servlet specification, for the servlet.
    
    Returns:
    
    the urlMappings
  - addUrlMappings
```
public void addUrlMappings(String... urlMappings)
```
    Add URL mappings, as defined in the Servlet specification, 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(javax.servlet.MultipartConfigElement multipartConfig)
```
    Set the multi-part configuration.
    
    Parameters:
    
    multipartConfig - the multi-part configuration to set or null
  - getMultipartConfig
```
public javax.servlet.MultipartConfigElement getMultipartConfig()
```
    Returns the multi-part configuration to be applied or null.
    
    Returns:
    
    the multipart config
  - getDescription
```
protected String getDescription()
```
    Description copied from class: RegistrationBean
    
    Return a description of the registration. For example "Servlet resourceServlet"
    
    Specified by:
    
    getDescription in class RegistrationBean
    
    Returns:
    
    a description of the registration
  - addRegistration
```
protected javax.servlet.ServletRegistration.Dynamic addRegistration(String description,
                                                                    javax.servlet.ServletContext servletContext)
```
    Specified by:
    
    addRegistration in class DynamicRegistrationBean<javax.servlet.ServletRegistration.Dynamic>
  - configure
```
protected void configure(javax.servlet.ServletRegistration.Dynamic registration)
```
    Configure registration settings. Subclasses can override this method to perform additional configuration if required.
    
    Overrides:
    
    configure in class DynamicRegistrationBean<javax.servlet.ServletRegistration.Dynamic>
    
    Parameters:
    
    registration - the registration
  - getServletName
```
public String getServletName()
```
    Returns the servlet name that will be registered.
    
    Returns:
    
    the servlet name

Class ServletRegistrationBean<T extends javax.servlet.Servlet>

Field Summary

Fields inherited from interface org.springframework.core.Ordered

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

ServletRegistrationBean

ServletRegistrationBean

ServletRegistrationBean

Method Detail

getServlet

setServlet

setUrlMappings

getUrlMappings

addUrlMappings

setLoadOnStartup

setMultipartConfig

getMultipartConfig

getDescription

addRegistration

configure

getServletName