Interface ConfigurableServletWebServerFactory
- All Superinterfaces:
ConfigurableWebServerFactory
,ErrorPageRegistry
,ServletWebServerFactory
,WebServerFactory
- All Known Implementing Classes:
AbstractServletWebServerFactory
,JettyServletWebServerFactory
,TomcatServletWebServerFactory
,UndertowServletWebServerFactory
public interface ConfigurableServletWebServerFactory extends ConfigurableWebServerFactory, ServletWebServerFactory
A configurableServletWebServerFactory
.- Since:
- 2.0.0
- See Also:
ServletWebServerFactory
,WebServerFactoryCustomizer
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addInitializers(ServletContextInitializer... initializers)
AddServletContextInitializer
s to those that should be applied in addition toServletWebServerFactory.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)
SetsServletContextInitializer
that should be applied in addition toServletWebServerFactory.getWebServer(ServletContextInitializer...)
parameters.void
setInitParameters(Map<String,String> initParameters)
Sets the init parameters that are applied to the container'sServletContext
.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, 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
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 totrue
so that files from thedocument 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 toMimeMappings.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 ornull
if not required
setInitializers
void setInitializers(List<? extends ServletContextInitializer> initializers)
SetsServletContextInitializer
that should be applied in addition toServletWebServerFactory.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)
AddServletContextInitializer
s to those that should be applied in addition toServletWebServerFactory.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'sServletContext
.- Parameters:
initParameters
- the init parameters