Package org.springframework.boot.web.servlet.server

Interface ConfigurableServletWebServerFactory

All Superinterfaces:

ConfigurableWebServerFactory, ErrorPageRegistry, ServletWebServerFactory, WebListenerRegistry, WebServerFactory

All Known Implementing Classes:

AbstractServletWebServerFactory, JettyServletWebServerFactory, TomcatServletWebServerFactory, UndertowServletWebServerFactory

public interface ConfigurableServletWebServerFactory
extends ConfigurableWebServerFactory, ServletWebServerFactory, WebListenerRegistry

A configurable ServletWebServerFactory.

Since:

2.0.0

Author:

Dave Syer, Andy Wilkinson, Stephane Nicoll, Eddú Meléndez, Brian Clozel

See Also:

• ServletWebServerFactory
• WebServerFactoryCustomizer

Method Summary

Modifier and Type	Method	Description
void	addCookieSameSiteSuppliers(CookieSameSiteSupplier... cookieSameSiteSuppliers)	Add CookieSameSiteSuppliers to those that should be used to obtain the Cookie.SameSite attribute of any added cookie.
void	addInitializers(ServletContextInitializer... initializers)	Add ServletContextInitializers to those that should be applied in addition to ServletWebServerFactory.getWebServer(ServletContextInitializer...) parameters.
void	addMimeMappings(MimeMappings mimeMappings)	Adds mime-type mappings.
void	setContextPath(String contextPath)	Sets the context path for the web server.
void	setCookieSameSiteSuppliers(List<? extends CookieSameSiteSupplier> cookieSameSiteSuppliers)	Sets CookieSameSiteSuppliers that should be used to obtain the Cookie.SameSite attribute of any added cookie.
void	setDisplayName(String displayName)	Sets the display name of the application deployed in the web server.
void	setDocumentRoot(File documentRoot)	Sets the document root directory which will be used by the web context to serve static files.
void	setInitializers(List<? extends ServletContextInitializer> initializers)	Sets ServletContextInitializer that should be applied in addition to ServletWebServerFactory.getWebServer(ServletContextInitializer...) parameters.
void	setInitParameters(Map<String,String> initParameters)	Sets the init parameters that are applied to the container's ServletContext.
void	setJsp(Jsp jsp)	Sets the configuration that will be applied to the server's JSP servlet.
void	setLocaleCharsetMappings(Map<Locale,Charset> localeCharsetMappings)	Sets the Locale to Charset mappings.
void	setMimeMappings(MimeMappings mimeMappings)	Sets the mime-type mappings.
void	setRegisterDefaultServlet(boolean registerDefaultServlet)	Set if the DefaultServlet should be registered.
void	setSession(Session session)	Sets the configuration that will be applied to the container's HTTP session support.

Methods inherited from interface org.springframework.boot.web.server.ConfigurableWebServerFactory

setAddress, setCompression, setErrorPages, setHttp2, setPort, setServerHeader, setShutdown, setSsl, setSslBundles

Methods inherited from interface org.springframework.boot.web.server.ErrorPageRegistry

addErrorPages

Methods inherited from interface org.springframework.boot.web.servlet.server.ServletWebServerFactory

getWebServer

Methods inherited from interface org.springframework.boot.web.servlet.WebListenerRegistry

addWebListeners

Method Details

setContextPath

void setContextPath(String contextPath)

Sets the context path for the web server. The context should start with a "/" character but not end with a "/" character. The default context path can be specified using an empty string.

Parameters:

contextPath - the contextPath to set

setDisplayName

void setDisplayName(String displayName)

Sets the display name of the application deployed in the web server.

Parameters:

displayName - the displayName to set

Since:

1.3.0

setSession

void setSession(Session session)

Sets the configuration that will be applied to the container's HTTP session support.

Parameters:

session - the session configuration

setRegisterDefaultServlet

void setRegisterDefaultServlet(boolean registerDefaultServlet)

Set if the DefaultServlet should be registered. Defaults to false since 2.4.

Parameters:

registerDefaultServlet - if the default servlet should be registered

setMimeMappings

void setMimeMappings(MimeMappings mimeMappings)

Sets the mime-type mappings.

Parameters:

mimeMappings - the mime type mappings (defaults to MimeMappings.DEFAULT)

addMimeMappings

void addMimeMappings(MimeMappings mimeMappings)

Adds mime-type mappings.

Parameters:

mimeMappings - the mime type mappings to add

Since:

3.3.0

setDocumentRoot

void setDocumentRoot(File documentRoot)

Sets the document root directory which will be used by the web context to serve static files.

Parameters:

documentRoot - the document root or null if not required

setInitializers

void setInitializers(List<? extends ServletContextInitializer> initializers)

Sets ServletContextInitializer that should be applied in addition to ServletWebServerFactory.getWebServer(ServletContextInitializer...) parameters. This method will replace any previously set or added initializers.

Parameters:

initializers - the initializers to set

See Also:

• addInitializers(org.springframework.boot.web.servlet.ServletContextInitializer...)

addInitializers

void addInitializers(ServletContextInitializer... initializers)

Add ServletContextInitializers to those that should be applied in addition to ServletWebServerFactory.getWebServer(ServletContextInitializer...) parameters.

Parameters:

initializers - the initializers to add

See Also:

• setInitializers(java.util.List<? extends org.springframework.boot.web.servlet.ServletContextInitializer>)

setJsp

void setJsp(Jsp jsp)

Sets the configuration that will be applied to the server's JSP servlet.

Parameters:

jsp - the JSP servlet configuration

setLocaleCharsetMappings

void setLocaleCharsetMappings(Map<Locale,Charset> localeCharsetMappings)

Sets the Locale to Charset mappings.

Parameters:

localeCharsetMappings - the Locale to Charset mappings

setInitParameters

void setInitParameters(Map<String,String> initParameters)

Sets the init parameters that are applied to the container's ServletContext.

Parameters:

initParameters - the init parameters

setCookieSameSiteSuppliers

void setCookieSameSiteSuppliers(List<? extends CookieSameSiteSupplier> cookieSameSiteSuppliers)

Sets CookieSameSiteSuppliers that should be used to obtain the Cookie.SameSite attribute of any added cookie. This method will replace any previously set or added suppliers.

Parameters:

cookieSameSiteSuppliers - the suppliers to add

See Also:

• addCookieSameSiteSuppliers(org.springframework.boot.web.servlet.server.CookieSameSiteSupplier...)

addCookieSameSiteSuppliers

void addCookieSameSiteSuppliers(CookieSameSiteSupplier... cookieSameSiteSuppliers)

Add CookieSameSiteSuppliers to those that should be used to obtain the Cookie.SameSite attribute of any added cookie.

Parameters:

cookieSameSiteSuppliers - the suppliers to add

See Also:

• setCookieSameSiteSuppliers(java.util.List<? extends org.springframework.boot.web.servlet.server.CookieSameSiteSupplier>)