org.springframework.boot.autoconfigure.web.servlet

Class DispatcherServletRegistrationBean

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<org.springframework.web.servlet.DispatcherServlet>

org.springframework.boot.autoconfigure.web.servlet.DispatcherServletRegistrationBean

All Implemented Interfaces:

DispatcherServletPath, org.springframework.boot.web.servlet.ServletContextInitializer, org.springframework.core.Ordered

public class DispatcherServletRegistrationBean
extends org.springframework.boot.web.servlet.ServletRegistrationBean<org.springframework.web.servlet.DispatcherServlet>
implements DispatcherServletPath

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

Since:

2.0.4

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
DispatcherServletRegistrationBean(org.springframework.web.servlet.DispatcherServlet servlet, java.lang.String path) Create a new DispatcherServletRegistrationBean instance for the given servlet and path.

Method Summary

Modifier and Type	Method and Description
void	addUrlMappings(java.lang.String... urlMappings)
java.lang.String	getPath() Returns the configured path of the dispatcher servlet.
void	setUrlMappings(java.util.Collection<java.lang.String> urlMappings)

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

addRegistration, configure, getDescription, getMultipartConfig, getServlet, getServletName, getUrlMappings, setLoadOnStartup, setMultipartConfig, setServlet, 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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.boot.autoconfigure.web.servlet.DispatcherServletPath

getPrefix, getRelativePath, getServletUrlMapping

Constructor Detail

DispatcherServletRegistrationBean

public DispatcherServletRegistrationBean(org.springframework.web.servlet.DispatcherServlet servlet,
                                         java.lang.String path)

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

Parameters:

servlet - the dispatcher servlet

path - the dispatcher servlet path

Method Detail

getPath

public java.lang.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(java.util.Collection<java.lang.String> urlMappings)

Overrides:

setUrlMappings in class org.springframework.boot.web.servlet.ServletRegistrationBean<org.springframework.web.servlet.DispatcherServlet>

addUrlMappings

public void addUrlMappings(java.lang.String... urlMappings)

Overrides:

addUrlMappings in class org.springframework.boot.web.servlet.ServletRegistrationBean<org.springframework.web.servlet.DispatcherServlet>