spring-boot/org.springframework.boot.web.servlet.server/AbstractServletWebServerFactory

AbstractServletWebServerFactory

abstract class AbstractServletWebServerFactory : AbstractConfigurableWebServerFactory, ConfigurableServletWebServerFactory

Abstract base class for ConfigurableServletWebServerFactory implementations.

Author

Phillip Webb

Dave Syer

Andy Wilkinson

Stephane Nicoll

Ivan Sopov

Eddú Meléndez

Brian Clozel

Since

2.0.0

Inheritors

Constructors

Link copied to clipboard
constructor()
Create a new AbstractServletWebServerFactory instance.
constructor(port: Int)
Create a new AbstractServletWebServerFactory instance with the specified port.
constructor(contextPath: String, port: Int)
Create a new AbstractServletWebServerFactory instance with the specified context path and port.

Properties

Link copied to clipboard
open var address: InetAddress
Link copied to clipboard
Link copied to clipboard
open var contextPath: String
Link copied to clipboard
Link copied to clipboard
open var displayName: String
Link copied to clipboard
open val errorPages: Set<ErrorPage>
Link copied to clipboard
open var http2: Http2
Link copied to clipboard
Link copied to clipboard
open var jsp: Jsp
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open var port: Int
Link copied to clipboard
open var serverHeader: String
Link copied to clipboard
open var session: Session
Link copied to clipboard
open var shutdown: Shutdown
Link copied to clipboard
open var ssl: Ssl
Link copied to clipboard

Functions

Link copied to clipboard
open fun addCookieSameSiteSuppliers(cookieSameSiteSuppliers: Array<CookieSameSiteSupplier>)
Add CookieSameSiteSuppliers to those that should be used to obtain the SameSite attribute of any added cookie.
Link copied to clipboard
open fun addErrorPages(errorPages: Array<ErrorPage>)
Adds error pages that will be used when handling exceptions.
Link copied to clipboard
open fun addInitializers(initializers: Array<ServletContextInitializer>)
Add ServletContextInitializers to those that should be applied in addition to getWebServer parameters.
Link copied to clipboard
open fun addMimeMappings(mimeMappings: MimeMappings)
Adds mime-type mappings.
Link copied to clipboard
open fun addWebListeners(webListenerClassNames: Array<String>)
Adds web listeners that will be registered with the servlet container.
Link copied to clipboard
open fun getDocumentRoot(): File
Returns the document root which will be used by the web context to serve static files.
Link copied to clipboard
abstract fun getWebServer(initializers: Array<ServletContextInitializer>): WebServer
Gets a new fully configured but paused WebServer instance.
Link copied to clipboard
open fun isRegisterDefaultServlet(): Boolean
Flag to indicate that the default servlet should be registered.
Link copied to clipboard
open fun setCookieSameSiteSuppliers(cookieSameSiteSuppliers: List<out CookieSameSiteSupplier>)
Sets CookieSameSiteSuppliers that should be used to obtain the SameSite attribute of any added cookie.
Link copied to clipboard
open fun setDocumentRoot(documentRoot: File)
Sets the document root directory which will be used by the web context to serve static files.
Link copied to clipboard
open fun setErrorPages(errorPages: Set<out ErrorPage>)
Sets the error pages that will be used when handling exceptions.
Link copied to clipboard
open fun setInitializers(initializers: List<out ServletContextInitializer>)
Sets ServletContextInitializer that should be applied in addition to getWebServer parameters.
Link copied to clipboard
open fun setRegisterDefaultServlet(registerDefaultServlet: Boolean)
Set if the DefaultServlet should be registered.