org.springframework.boot.web.servlet.server

Interface ConfigurableServletWebServerFactory

All Superinterfaces:

ConfigurableWebServerFactory, ErrorPageRegistry, ServletWebServerFactory, WebServerFactory

All Known Implementing Classes:

AbstractServletWebServerFactory, JettyServletWebServerFactory, TomcatServletWebServerFactory, UndertowServletWebServerFactory

public interface ConfigurableServletWebServerFactory
extends ConfigurableWebServerFactory, ServletWebServerFactory

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 and Description
void	addInitializers(ServletContextInitializer... initializers) Add ServletContextInitializers to those that should be applied in addition to ServletWebServerFactory.getWebServer(ServletContextInitializer...) parameters.
void	setContextPath(String contextPath) Sets the context path for the web server.
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	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	setPersistSession(boolean persistSession) Sets if session data should be persisted between restarts.
void	setRegisterDefaultServlet(boolean registerDefaultServlet) Set if the DefaultServlet should be registered.
void	setSessionStoreDir(File sessionStoreDir) Set the directory used to store serialized session data.
void	setSessionTimeout(int sessionTimeout) The session timeout in seconds (default 30 minutes).
void	setSessionTimeout(int sessionTimeout, TimeUnit timeUnit) The session timeout in the specified TimeUnit (default 30 minutes).

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

setAddress, setCompression, setErrorPages, setPort, setServerHeader, setSsl, setSslStoreProvider

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

addErrorPages

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

getWebServer

Method Detail

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

setSessionTimeout

void setSessionTimeout(int sessionTimeout)

The session timeout in seconds (default 30 minutes). If 0 or negative then sessions never expire.

Parameters:

sessionTimeout - the session timeout

setSessionTimeout

void setSessionTimeout(int sessionTimeout,
                       TimeUnit timeUnit)

The session timeout in the specified TimeUnit (default 30 minutes). If 0 or negative then sessions never expire.

Parameters:

sessionTimeout - the session timeout

timeUnit - the time unit

setPersistSession

void setPersistSession(boolean persistSession)

Sets if session data should be persisted between restarts.

Parameters:

persistSession - true if session data should be persisted

setSessionStoreDir

void setSessionStoreDir(File sessionStoreDir)

Set the directory used to store serialized session data.

Parameters:

sessionStoreDir - the directory or null to use a default location.

setRegisterDefaultServlet

void setRegisterDefaultServlet(boolean registerDefaultServlet)

Set if the DefaultServlet should be registered. Defaults to true so that files from the document root will be served.

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)

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