Class JettyServletWebServerFactory

java.lang.Object

org.springframework.boot.web.server.AbstractConfigurableWebServerFactory

org.springframework.boot.jetty.JettyWebServerFactory

org.springframework.boot.jetty.servlet.JettyServletWebServerFactory

All Implemented Interfaces:

Aware, ConfigurableJettyWebServerFactory, ErrorPageRegistry, ConfigurableWebServerFactory, ConfigurableServletWebServerFactory, ServletWebServerFactory, WebListenerRegistry, WebServerFactory, ResourceLoaderAware

public class JettyServletWebServerFactory
extends JettyWebServerFactory
implements ConfigurableJettyWebServerFactory, ConfigurableServletWebServerFactory, 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.

Since:

4.0.0

Author:

Phillip Webb, Dave Syer, Andrey Hihlovskiy, Andy Wilkinson, Eddú Meléndez, Venil Noronha, Henri Kerola, Moritz Halbritter, Onur Kagan Ozcan

See Also:

• AbstractConfigurableWebServerFactory.setPort(int)
• JettyWebServerFactory.setConfigurations(Collection)
• JettyWebServer

Nested Class Summary

Nested classes/interfaces inherited from class AbstractConfigurableWebServerFactory

AbstractConfigurableWebServerFactory.TempDirs

Constructor Summary

Constructors

Constructor	Description
JettyServletWebServerFactory()	Create a new JettyServletWebServerFactory instance.
JettyServletWebServerFactory(int port)	Create a new JettyServletWebServerFactory that listens for requests using the specified port.
JettyServletWebServerFactory(String contextPath, int port)	Create a new JettyServletWebServerFactory with the specified context path and port.

Method Summary

Modifier and Type	Method	Description
protected final void	addDefaultServlet(WebAppContext context)	Add Jetty's DefaultServlet to the given WebAppContext.
protected Handler	addHandlerWrappers(Handler handler)
protected final void	addJspServlet(WebAppContext context)	Add Jetty's JspServlet to the given WebAppContext.
protected final void	configureWebAppContext(WebAppContext context, AbstractConfigurableWebServerFactory.TempDirs tempDirs, ServletContextInitializer... initializers)	Configure the given Jetty WebAppContext for use.
protected final void	configureWebAppContext(WebAppContext context, ServletContextInitializer... initializers)	Deprecated, for removal: This API element is subject to removal in a future version. since 4.1.0 for removal in 4.3.0 in favor of configureWebAppContext(WebAppContext, TempDirs, ServletContextInitializer...)
protected JettyWebServer	getJettyWebServer(Server server)	Factory method called to create the JettyWebServer.
protected Configuration	getServletContextInitializerConfiguration(WebAppContext webAppContext, ServletContextInitializers initializers)	Return a Jetty Configuration that will invoke the specified ServletContextInitializers.
ServletWebServerSettings	getSettings()
protected Configuration[]	getWebAppContextConfigurations(WebAppContext webAppContext, ServletContextInitializers initializers)	Return the Jetty Configurations that should be applied to the server.
WebServer	getWebServer(ServletContextInitializer... initializers)	Gets a new fully configured but paused WebServer instance.
protected void	postProcessWebAppContext(WebAppContext webAppContext)	Post process the Jetty WebAppContext before it's used with the Jetty Server.
void	setResourceLoader(ResourceLoader resourceLoader)

Methods inherited from class JettyWebServerFactory

addConfigurations, addServerCustomizers, applyWrapper, createConnector, createConnector, customizeSsl, getAcceptors, getConfigurations, getMaxConnections, getSelectors, getServerCustomizers, getThreadPool, isUseForwardHeaders, isUseRfcForwardHeader, setAcceptors, setConfigurations, setMaxConnections, setSelectors, setServerCustomizers, setThreadPool, setUseForwardHeaders, setUseRfcForwardHeader

Methods inherited from class AbstractConfigurableWebServerFactory

addErrorPages, createTempDir, getAddress, getCompression, getErrorPages, getHttp2, getPort, getServerHeader, getServerNameSslBundles, getShutdown, getSsl, getSslBundle, getSslBundles, setAddress, setCompression, setErrorPages, setHttp2, setPort, setServerHeader, setShutdown, setSsl, setSslBundles

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ConfigurableJettyWebServerFactory

addServerCustomizers, setAcceptors, setMaxConnections, setSelectors, setThreadPool, setUseForwardHeaders, setUseRfcForwardHeader

Methods inherited from interface ConfigurableServletWebServerFactory

addCookieSameSiteSuppliers, addInitializers, addMimeMappings, addWebListeners, getContextPath, setContextPath, setCookieSameSiteSuppliers, setDisplayName, setDocumentRoot, setInitializers, setInitParameters, setJsp, setLocaleCharsetMappings, setMimeMappings, setRegisterDefaultServlet, setSession

Methods inherited from interface ConfigurableWebServerFactory

setAddress, setCompression, setErrorPages, setHttp2, setPort, setServerHeader, setShutdown, setSsl, setSslBundles

Methods inherited from interface ErrorPageRegistry

addErrorPages

Constructor Details

JettyServletWebServerFactory

public JettyServletWebServerFactory()

Create a new JettyServletWebServerFactory instance.

JettyServletWebServerFactory

public JettyServletWebServerFactory(int port)

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

Parameters:

port - the port to listen on

JettyServletWebServerFactory

public JettyServletWebServerFactory(String contextPath,
 int port)

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

Parameters:

contextPath - the root context path

port - the port to listen on

Method Details

getWebServer

public WebServer getWebServer(ServletContextInitializer... initializers)

Description copied from interface: ServletWebServerFactory

Gets a new fully configured but paused WebServer instance. Clients should not be able to connect to the returned server until WebServer.start() is called (which happens when the ApplicationContext has been fully refreshed).

Specified by:

getWebServer in interface ServletWebServerFactory

Parameters:

initializers - ServletContextInitializers that should be applied as the server starts

Returns:

a fully configured and started WebServer

See Also:

• WebServer.stop()

addHandlerWrappers

protected Handler addHandlerWrappers(Handler handler)

Overrides:

addHandlerWrappers in class JettyWebServerFactory

configureWebAppContext

@Deprecated(forRemoval=true,
            since="4.1.0")
protected final void configureWebAppContext(WebAppContext context,
 ServletContextInitializer... initializers)

Deprecated, for removal: This API element is subject to removal in a future version.

since 4.1.0 for removal in 4.3.0 in favor of configureWebAppContext(WebAppContext, TempDirs, ServletContextInitializer...)

Configure the given Jetty WebAppContext for use.

Parameters:

context - the context to configure

initializers - the set of initializers to apply

configureWebAppContext

protected final void configureWebAppContext(WebAppContext context,
 AbstractConfigurableWebServerFactory.TempDirs tempDirs,
 ServletContextInitializer... initializers)

Configure the given Jetty WebAppContext for use.

Parameters:

context - the context to configure

tempDirs - to manage temporary directories

initializers - the set of initializers to apply

Since:

4.1.0

addDefaultServlet

protected final void addDefaultServlet(WebAppContext context)

Add Jetty's DefaultServlet to the given WebAppContext.

Parameters:

context - the jetty WebAppContext

addJspServlet

protected final void addJspServlet(WebAppContext context)

Add Jetty's JspServlet to the given WebAppContext.

Parameters:

context - the jetty WebAppContext

getWebAppContextConfigurations

protected Configuration[] getWebAppContextConfigurations(WebAppContext webAppContext,
 ServletContextInitializers initializers)

Return the Jetty Configurations that should be applied to the server.

Parameters:

webAppContext - the Jetty WebAppContext

initializers - the ServletContextInitializers to apply

Returns:

configurations to apply

getServletContextInitializerConfiguration

protected Configuration getServletContextInitializerConfiguration(WebAppContext webAppContext,
 ServletContextInitializers initializers)

Return a Jetty Configuration that will invoke the specified ServletContextInitializers. By default this method will return a ServletContextInitializerConfiguration.

Parameters:

webAppContext - the Jetty WebAppContext

initializers - the ServletContextInitializers to apply

Returns:

the Configuration instance

postProcessWebAppContext

protected void postProcessWebAppContext(WebAppContext webAppContext)

Post process the Jetty WebAppContext before it's used with the Jetty Server. Subclasses can override this method to apply additional processing to the WebAppContext.

Parameters:

webAppContext - the Jetty WebAppContext

getJettyWebServer

protected JettyWebServer getJettyWebServer(Server server)

Factory method called to create the JettyWebServer. Subclasses can override this method to return a different JettyWebServer or apply additional processing to the Jetty server.

Parameters:

server - the Jetty server.

Returns:

a new JettyWebServer instance

setResourceLoader

public void setResourceLoader(ResourceLoader resourceLoader)

Specified by:

setResourceLoader in interface ResourceLoaderAware

getSettings

public ServletWebServerSettings getSettings()

Specified by:

getSettings in interface ConfigurableServletWebServerFactory