spring-boot/org.springframework.boot.web.embedded.jetty/JettyServletWebServerFactory

JettyServletWebServerFactory

open class JettyServletWebServerFactory : AbstractServletWebServerFactory, ConfigurableJettyWebServerFactory, ResourceLoaderAware

ServletWebServerFactory that can be used to create a JettyWebServer. Can be initialized using Spring's ServletContextInitializers or Jetty Configurations.

Unless explicitly configured otherwise this factory will create servers that listen for HTTP requests on port 8080.

Author

Phillip Webb

Dave Syer

Andrey Hihlovskiy

Andy Wilkinson

Eddú Meléndez

Venil Noronha

Henri Kerola

Moritz Halbritter

Onur Kagan Ozcan

Since

2.0.0

Constructors

JettyServletWebServerFactory

constructor()

Create a new JettyServletWebServerFactory instance.

constructor(port: Int)

Create a new JettyServletWebServerFactory that listens for requests using the specified port.

constructor(contextPath: String, port: Int)

Create a new JettyServletWebServerFactory with the specified context path and port.

Properties

address

open var address: InetAddress

compression

open var compression: Compression

contextPath

open var contextPath: String

cookieSameSiteSuppliers

open val cookieSameSiteSuppliers: List<CookieSameSiteSupplier>

displayName

open var displayName: String

errorPages

open val errorPages: Set<ErrorPage>

http2

open var http2: Http2

initParameters

open var initParameters: Map<String, String>

jsp

open var jsp: Jsp

localeCharsetMappings

open var localeCharsetMappings: Map<Locale, Charset>

mimeMappings

open var mimeMappings: MimeMappings

port

open var port: Int

serverHeader

open var serverHeader: String

session

open var session: Session

shutdown

open var shutdown: Shutdown

ssl

open var ssl: Ssl

sslBundles

open var sslBundles: SslBundles

threadPool

open var threadPool: ThreadPool

Functions

addConfigurations

open fun addConfigurations(configurations: Array<Configuration>)

Add Configurations that will be applied to the WebAppContext before the server is started.

addCookieSameSiteSuppliers

open fun addCookieSameSiteSuppliers(cookieSameSiteSuppliers: Array<CookieSameSiteSupplier>)

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

addErrorPages

open fun addErrorPages(errorPages: Array<ErrorPage>)

Adds error pages that will be used when handling exceptions.

addInitializers

open fun addInitializers(initializers: Array<ServletContextInitializer>)

Add ServletContextInitializers to those that should be applied in addition to getWebServer parameters.

addMimeMappings

open fun addMimeMappings(mimeMappings: MimeMappings)

Adds mime-type mappings.

addServerCustomizers

open fun addServerCustomizers(customizers: Array<JettyServerCustomizer>)

Add JettyServerCustomizers that will be applied to the Server before it is started.

addWebListeners

open fun addWebListeners(webListenerClassNames: Array<String>)

Adds web listeners that will be registered with the servlet container.

getConfigurations

open fun getConfigurations(): Collection<Configuration>

Returns a mutable collection of Jetty Configurations that will be applied to the WebAppContext before the server is created.

getDocumentRoot

open fun getDocumentRoot(): File

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

getServerCustomizers

open fun getServerCustomizers(): Collection<JettyServerCustomizer>

Returns a mutable collection of Jetty JettyServerCustomizers that will be applied to the Server before it is created.

getWebServer

open fun getWebServer(initializers: Array<ServletContextInitializer>): WebServer

Gets a new fully configured but paused WebServer instance.

isRegisterDefaultServlet

open fun isRegisterDefaultServlet(): Boolean

Flag to indicate that the default servlet should be registered.

setAcceptors

open fun setAcceptors(acceptors: Int)

Set the number of acceptor threads to use.

setConfigurations

open fun setConfigurations(configurations: Collection<out Configuration>)

Sets Jetty Configurations that will be applied to the WebAppContext before the server is created.

setCookieSameSiteSuppliers

open fun setCookieSameSiteSuppliers(cookieSameSiteSuppliers: List<out CookieSameSiteSupplier>)

Sets CookieSameSiteSuppliers that should be used to obtain the SameSite attribute of any added cookie.

setDocumentRoot

open fun setDocumentRoot(documentRoot: File)

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

setErrorPages

open fun setErrorPages(errorPages: Set<out ErrorPage>)

Sets the error pages that will be used when handling exceptions.

setInitializers

open fun setInitializers(initializers: List<out ServletContextInitializer>)

Sets ServletContextInitializer that should be applied in addition to getWebServer parameters.

setMaxConnections

open fun setMaxConnections(maxConnections: Int)

Sets the maximum number of concurrent connections.

setRegisterDefaultServlet

open fun setRegisterDefaultServlet(registerDefaultServlet: Boolean)

Set if the DefaultServlet should be registered.

setResourceLoader

open fun setResourceLoader(resourceLoader: ResourceLoader)

setSelectors

open fun setSelectors(selectors: Int)

Set the number of selector threads to use.

setServerCustomizers

open fun setServerCustomizers(customizers: Collection<out JettyServerCustomizer>)

Sets JettyServerCustomizers that will be applied to the Server before it is started.

setUseForwardHeaders

open fun setUseForwardHeaders(useForwardHeaders: Boolean)

Set if x-forward-* headers should be processed.

JettyServletWebServerFactory

Author

Since

See also

Constructors

Properties

Functions