AbstractServletWebServerFactory (spring-boot 2.7.1)

java.lang.Object
- org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
- - org.springframework.boot.web.servlet.server.AbstractServletWebServerFactory

All Implemented Interfaces:

ConfigurableWebServerFactory, ErrorPageRegistry, WebServerFactory, ConfigurableServletWebServerFactory, ServletWebServerFactory, WebListenerRegistry

Direct Known Subclasses:

JettyServletWebServerFactory, TomcatServletWebServerFactory, UndertowServletWebServerFactory
```
public abstract class AbstractServletWebServerFactory
extends AbstractConfigurableWebServerFactory
implements ConfigurableServletWebServerFactory
```
Abstract base class for ConfigurableServletWebServerFactory implementations.

Since:

2.0.0

Field Summary

Fields
Modifier and Type Field and Description

protected org.apache.commons.logging.Log logger

Fields
Modifier and Type	Field and Description
`protected org.apache.commons.logging.Log`	`logger`

Constructor Summary

Constructors
Constructor and Description
`AbstractServletWebServerFactory()` Create a new `AbstractServletWebServerFactory` instance.
`AbstractServletWebServerFactory(int port)` Create a new `AbstractServletWebServerFactory` instance with the specified port.
`AbstractServletWebServerFactory(java.lang.String contextPath, int port)` Create a new `AbstractServletWebServerFactory` instance with the specified context path and port.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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 `ServletContextInitializer`s to those that should be applied in addition to `ServletWebServerFactory.getWebServer(ServletContextInitializer...)` parameters.
`void`	`addWebListeners(java.lang.String... webListenerClassNames)` Adds web listeners that will be registered with the servlet container.
`java.lang.String`	`getContextPath()` Returns the context path for the web server.
`java.util.List<CookieSameSiteSupplier>`	`getCookieSameSiteSuppliers()`
`java.lang.String`	`getDisplayName()`
`java.io.File`	`getDocumentRoot()` Returns the document root which will be used by the web context to serve static files.
`java.util.Map<java.lang.String,java.lang.String>`	`getInitParameters()`
`Jsp`	`getJsp()`
`java.util.Map<java.util.Locale,java.nio.charset.Charset>`	`getLocaleCharsetMappings()` Return the Locale to Charset mappings.
`MimeMappings`	`getMimeMappings()` Returns the mime-type mappings.
`Session`	`getSession()`
`protected java.util.List<java.net.URL>`	`getUrlsOfJarsWithMetaInfResources()`
`protected java.io.File`	`getValidDocumentRoot()` Returns the absolute document root when it points to a valid directory, logging a warning and returning `null` otherwise.
`protected java.io.File`	`getValidSessionStoreDir()`
`protected java.io.File`	`getValidSessionStoreDir(boolean mkdirs)`
`protected java.util.Set<java.lang.String>`	`getWebListenerClassNames()`
`boolean`	`isRegisterDefaultServlet()` Flag to indicate that the default servlet should be registered.
`protected ServletContextInitializer[]`	`mergeInitializers(ServletContextInitializer... initializers)` Utility method that can be used by subclasses wishing to combine the specified `ServletContextInitializer` parameters with those defined in this instance.
`void`	`setContextPath(java.lang.String contextPath)` Sets the context path for the web server.
`void`	`setCookieSameSiteSuppliers(java.util.List<? extends CookieSameSiteSupplier> cookieSameSiteSuppliers)` Sets `CookieSameSiteSuppliers` that should be used to obtain the `Cookie.SameSite` attribute of any added cookie.
`void`	`setDisplayName(java.lang.String displayName)` Sets the display name of the application deployed in the web server.
`void`	`setDocumentRoot(java.io.File documentRoot)` Sets the document root directory which will be used by the web context to serve static files.
`void`	`setInitializers(java.util.List<? extends ServletContextInitializer> initializers)` Sets `ServletContextInitializer` that should be applied in addition to `ServletWebServerFactory.getWebServer(ServletContextInitializer...)` parameters.
`void`	`setInitParameters(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.util.Locale,java.nio.charset.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.
`protected boolean`	`shouldRegisterJspServlet()` Returns whether or not the JSP servlet should be registered with the web server.

Methods inherited from class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
addErrorPages, createTempDir, getAddress, getCompression, getErrorPages, getHttp2, getOrCreateSslStoreProvider, getPort, getServerHeader, getShutdown, getSsl, getSslStoreProvider, setAddress, setCompression, setErrorPages, setHttp2, setPort, setServerHeader, setShutdown, setSsl, setSslStoreProvider

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.boot.web.server.ConfigurableWebServerFactory
setAddress, setCompression, setErrorPages, setHttp2, setPort, setServerHeader, setShutdown, 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

- Field Detail
  - logger
```
protected final org.apache.commons.logging.Log logger
```
- Constructor Detail
  - AbstractServletWebServerFactory
```
public AbstractServletWebServerFactory()
```
    Create a new AbstractServletWebServerFactory instance.
  - AbstractServletWebServerFactory
```
public AbstractServletWebServerFactory(int port)
```
    Create a new AbstractServletWebServerFactory instance with the specified port.
    
    Parameters:
    
    port - the port number for the web server
  - AbstractServletWebServerFactory
```
public AbstractServletWebServerFactory(java.lang.String contextPath,
                                       int port)
```
    Create a new AbstractServletWebServerFactory instance with the specified context path and port.
    
    Parameters:
    
    contextPath - the context path for the web server
    
    port - the port number for the web server
- Method Detail
  - getContextPath
```
public java.lang.String getContextPath()
```
    Returns the context path for the web server. The path will start with "/" and not end with "/". The root context is represented by an empty string.
    
    Returns:
    
    the context path
  - setContextPath
```
public void setContextPath(java.lang.String contextPath)
```
    Description copied from interface: ConfigurableServletWebServerFactory
    
    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.
    
    Specified by:
    
    setContextPath in interface ConfigurableServletWebServerFactory
    
    Parameters:
    
    contextPath - the contextPath to set
  - getDisplayName
```
public java.lang.String getDisplayName()
```
  - setDisplayName
```
public void setDisplayName(java.lang.String displayName)
```
    Description copied from interface: ConfigurableServletWebServerFactory
    
    Sets the display name of the application deployed in the web server.
    
    Specified by:
    
    setDisplayName in interface ConfigurableServletWebServerFactory
    
    Parameters:
    
    displayName - the displayName to set
  - isRegisterDefaultServlet
```
public boolean isRegisterDefaultServlet()
```
    Flag to indicate that the default servlet should be registered.
    
    Returns:
    
    true if the default servlet is to be registered
  - setRegisterDefaultServlet
```
public void setRegisterDefaultServlet(boolean registerDefaultServlet)
```
    Description copied from interface: ConfigurableServletWebServerFactory
    
    Set if the DefaultServlet should be registered. Defaults to false since 2.4.
    
    Specified by:
    
    setRegisterDefaultServlet in interface ConfigurableServletWebServerFactory
    
    Parameters:
    
    registerDefaultServlet - if the default servlet should be registered
  - getMimeMappings
```
public MimeMappings getMimeMappings()
```
    Returns the mime-type mappings.
    
    Returns:
    
    the mimeMappings the mime-type mappings.
  - setMimeMappings
```
public void setMimeMappings(MimeMappings mimeMappings)
```
    Description copied from interface: ConfigurableServletWebServerFactory
    
    Sets the mime-type mappings.
    
    Specified by:
    
    setMimeMappings in interface ConfigurableServletWebServerFactory
    
    Parameters:
    
    mimeMappings - the mime type mappings (defaults to MimeMappings.DEFAULT)
  - getDocumentRoot
```
public java.io.File getDocumentRoot()
```
    Returns the document root which will be used by the web context to serve static files.
    
    Returns:
    
    the document root
  - setDocumentRoot
```
public void setDocumentRoot(java.io.File documentRoot)
```
    Description copied from interface: ConfigurableServletWebServerFactory
    
    Sets the document root directory which will be used by the web context to serve static files.
    
    Specified by:
    
    setDocumentRoot in interface ConfigurableServletWebServerFactory
    
    Parameters:
    
    documentRoot - the document root or null if not required
  - setInitializers
```
public void setInitializers(java.util.List<? extends ServletContextInitializer> initializers)
```
    Description copied from interface: ConfigurableServletWebServerFactory
    
    Sets ServletContextInitializer that should be applied in addition to ServletWebServerFactory.getWebServer(ServletContextInitializer...) parameters. This method will replace any previously set or added initializers.
    
    Specified by:
    
    setInitializers in interface ConfigurableServletWebServerFactory
    
    Parameters:
    
    initializers - the initializers to set
    
    See Also:
    
    ConfigurableServletWebServerFactory.addInitializers(org.springframework.boot.web.servlet.ServletContextInitializer...)
  - addInitializers
```
public void addInitializers(ServletContextInitializer... initializers)
```
    Description copied from interface: ConfigurableServletWebServerFactory
    
    Add ServletContextInitializers to those that should be applied in addition to ServletWebServerFactory.getWebServer(ServletContextInitializer...) parameters.
    
    Specified by:
    
    addInitializers in interface ConfigurableServletWebServerFactory
    
    Parameters:
    
    initializers - the initializers to add
    
    See Also:
    
    ConfigurableServletWebServerFactory.setInitializers(java.util.List<? extends org.springframework.boot.web.servlet.ServletContextInitializer>)
  - getJsp
```
public Jsp getJsp()
```
  - setJsp
```
public void setJsp(Jsp jsp)
```
    Description copied from interface: ConfigurableServletWebServerFactory
    
    Sets the configuration that will be applied to the server's JSP servlet.
    
    Specified by:
    
    setJsp in interface ConfigurableServletWebServerFactory
    
    Parameters:
    
    jsp - the JSP servlet configuration
  - getSession
```
public Session getSession()
```
  - setSession
```
public void setSession(Session session)
```
    Description copied from interface: ConfigurableServletWebServerFactory
    
    Sets the configuration that will be applied to the container's HTTP session support.
    
    Specified by:
    
    setSession in interface ConfigurableServletWebServerFactory
    
    Parameters:
    
    session - the session configuration
  - getLocaleCharsetMappings
```
public java.util.Map<java.util.Locale,java.nio.charset.Charset> getLocaleCharsetMappings()
```
    Return the Locale to Charset mappings.
    
    Returns:
    
    the charset mappings
  - setLocaleCharsetMappings
```
public void setLocaleCharsetMappings(java.util.Map<java.util.Locale,java.nio.charset.Charset> localeCharsetMappings)
```
    Description copied from interface: ConfigurableServletWebServerFactory
    
    Sets the Locale to Charset mappings.
    
    Specified by:
    
    setLocaleCharsetMappings in interface ConfigurableServletWebServerFactory
    
    Parameters:
    
    localeCharsetMappings - the Locale to Charset mappings
  - setInitParameters
```
public void setInitParameters(java.util.Map<java.lang.String,java.lang.String> initParameters)
```
    Description copied from interface: ConfigurableServletWebServerFactory
    
    Sets the init parameters that are applied to the container's ServletContext.
    
    Specified by:
    
    setInitParameters in interface ConfigurableServletWebServerFactory
    
    Parameters:
    
    initParameters - the init parameters
  - getInitParameters
```
public java.util.Map<java.lang.String,java.lang.String> getInitParameters()
```
  - setCookieSameSiteSuppliers
```
public void setCookieSameSiteSuppliers(java.util.List<? extends CookieSameSiteSupplier> cookieSameSiteSuppliers)
```
    Description copied from interface: ConfigurableServletWebServerFactory
    
    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.
    
    Specified by:
    
    setCookieSameSiteSuppliers in interface ConfigurableServletWebServerFactory
    
    Parameters:
    
    cookieSameSiteSuppliers - the suppliers to add
    
    See Also:
    
    ConfigurableServletWebServerFactory.addCookieSameSiteSuppliers(org.springframework.boot.web.servlet.server.CookieSameSiteSupplier...)
  - addCookieSameSiteSuppliers
```
public void addCookieSameSiteSuppliers(CookieSameSiteSupplier... cookieSameSiteSuppliers)
```
    Description copied from interface: ConfigurableServletWebServerFactory
    
    Add CookieSameSiteSuppliers to those that should be used to obtain the Cookie.SameSite attribute of any added cookie.
    
    Specified by:
    
    addCookieSameSiteSuppliers in interface ConfigurableServletWebServerFactory
    
    Parameters:
    
    cookieSameSiteSuppliers - the suppliers to add
    
    See Also:
    
    ConfigurableServletWebServerFactory.setCookieSameSiteSuppliers(java.util.List<? extends org.springframework.boot.web.servlet.server.CookieSameSiteSupplier>)
  - getCookieSameSiteSuppliers
```
public java.util.List<CookieSameSiteSupplier> getCookieSameSiteSuppliers()
```
  - mergeInitializers
```
protected final ServletContextInitializer[] mergeInitializers(ServletContextInitializer... initializers)
```
    Utility method that can be used by subclasses wishing to combine the specified ServletContextInitializer parameters with those defined in this instance.
    
    Parameters:
    
    initializers - the initializers to merge
    
    Returns:
    
    a complete set of merged initializers (with the specified parameters appearing first)
  - shouldRegisterJspServlet
```
protected boolean shouldRegisterJspServlet()
```
    Returns whether or not the JSP servlet should be registered with the web server.
    
    Returns:
    
    true if the servlet should be registered, otherwise false
  - getValidDocumentRoot
```
protected final java.io.File getValidDocumentRoot()
```
    Returns the absolute document root when it points to a valid directory, logging a warning and returning null otherwise.
    
    Returns:
    
    the valid document root
  - getUrlsOfJarsWithMetaInfResources
```
protected final java.util.List<java.net.URL> getUrlsOfJarsWithMetaInfResources()
```
  - getValidSessionStoreDir
```
protected final java.io.File getValidSessionStoreDir()
```
  - getValidSessionStoreDir
```
protected final java.io.File getValidSessionStoreDir(boolean mkdirs)
```
  - addWebListeners
```
public void addWebListeners(java.lang.String... webListenerClassNames)
```
    Description copied from interface: WebListenerRegistry
    
    Adds web listeners that will be registered with the servlet container.
    
    Specified by:
    
    addWebListeners in interface WebListenerRegistry
    
    Parameters:
    
    webListenerClassNames - the class names of the web listeners
  - getWebListenerClassNames
```
protected final java.util.Set<java.lang.String> getWebListenerClassNames()
```

Class AbstractServletWebServerFactory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory

Methods inherited from class java.lang.Object

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

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

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

Field Detail

logger

Constructor Detail

AbstractServletWebServerFactory

AbstractServletWebServerFactory

AbstractServletWebServerFactory

Method Detail

getContextPath

setContextPath

getDisplayName

setDisplayName

isRegisterDefaultServlet

setRegisterDefaultServlet

getMimeMappings

setMimeMappings

getDocumentRoot

setDocumentRoot

setInitializers

addInitializers

getJsp

setJsp

getSession

setSession

getLocaleCharsetMappings

setLocaleCharsetMappings

setInitParameters

getInitParameters

setCookieSameSiteSuppliers

addCookieSameSiteSuppliers

getCookieSameSiteSuppliers

mergeInitializers

shouldRegisterJspServlet

getValidDocumentRoot

getUrlsOfJarsWithMetaInfResources

getValidSessionStoreDir

getValidSessionStoreDir

addWebListeners

getWebListenerClassNames