Class DispatcherServletRegistrationBean

java.lang.Object

org.springframework.boot.web.servlet.RegistrationBean

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

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

org.springframework.boot.webmvc.autoconfigure.DispatcherServletRegistrationBean

All Implemented Interfaces:

Aware, BeanNameAware, ServletContextInitializer, DispatcherServletPath, Ordered

public class DispatcherServletRegistrationBean
extends ServletRegistrationBean<DispatcherServlet>
implements DispatcherServletPath

ServletRegistrationBean for the auto-configured DispatcherServlet. Both registers the servlet and exposes DispatcherServletPath information.

Since:

4.0.0

Author:

Phillip Webb

Field Summary

Fields inherited from interface Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
DispatcherServletRegistrationBean(DispatcherServlet servlet, String path)	Create a new DispatcherServletRegistrationBean instance for the given servlet and path.

Method Summary

Modifier and Type	Method	Description
void	addUrlMappings(String... urlMappings)	Add URL mappings, as defined in the Servlet specification, for the servlet.
String	getPath()	Returns the configured path of the dispatcher servlet.
void	setUrlMappings(Collection<String> urlMappings)	Set the URL mappings for the servlet.

Methods inherited from class ServletRegistrationBean

addRegistration, configure, getDescription, getMultipartConfig, getServlet, getServletName, getUrlMappings, setLoadOnStartup, setMultipartConfig, setServlet, toString

Methods inherited from class DynamicRegistrationBean

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

Methods inherited from class RegistrationBean

getOrder, isEnabled, onStartup, setEnabled, setOrder

Methods inherited from class Object

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

Methods inherited from interface DispatcherServletPath

getPrefix, getRelativePath, getServletUrlMapping

Constructor Details

DispatcherServletRegistrationBean

public DispatcherServletRegistrationBean(DispatcherServlet servlet,
 String path)

Create a new DispatcherServletRegistrationBean instance for the given servlet and path.

Parameters:

servlet - the dispatcher servlet

path - the dispatcher servlet path

Method Details

getPath

public String getPath()

Description copied from interface: DispatcherServletPath

Returns the configured path of the dispatcher servlet.

Specified by:

getPath in interface DispatcherServletPath

Returns:

the configured path

setUrlMappings

public void setUrlMappings(Collection<String> urlMappings)

Description copied from class: ServletRegistrationBean

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

Overrides:

setUrlMappings in class ServletRegistrationBean<DispatcherServlet>

Parameters:

urlMappings - the mappings to set

See Also:

• ServletRegistrationBean.addUrlMappings(String...)

addUrlMappings

public void addUrlMappings(String... urlMappings)

Description copied from class: ServletRegistrationBean

Add URL mappings, as defined in the Servlet specification, for the servlet.

Overrides:

addUrlMappings in class ServletRegistrationBean<DispatcherServlet>

Parameters:

urlMappings - the mappings to add

See Also:

• ServletRegistrationBean.setUrlMappings(Collection)