org.springframework.boot.context.embedded.jetty

Class JettyEmbeddedServletContainerFactory

java.lang.Object

org.springframework.boot.context.embedded.AbstractConfigurableEmbeddedServletContainer

org.springframework.boot.context.embedded.AbstractEmbeddedServletContainerFactory

org.springframework.boot.context.embedded.jetty.JettyEmbeddedServletContainerFactory

All Implemented Interfaces:

Aware, ConfigurableEmbeddedServletContainer, EmbeddedServletContainerFactory, ResourceLoaderAware

public class JettyEmbeddedServletContainerFactory
extends AbstractEmbeddedServletContainerFactory
implements ResourceLoaderAware

EmbeddedServletContainerFactory that can be used to create JettyEmbeddedServletContainers. Can be initialized using Spring's ServletContextInitializers or Jetty Configurations.

Unless explicitly configured otherwise this factory will created containers that listens for HTTP requests on port 8080.

Author:

Phillip Webb, Dave Syer, Andrey Hihlovskiy, Andy Wilkinson, Eddú Meléndez

See Also:

AbstractConfigurableEmbeddedServletContainer.setPort(int), setConfigurations(Collection), JettyEmbeddedServletContainer

Field Summary

Fields inherited from class org.springframework.boot.context.embedded.AbstractEmbeddedServletContainerFactory

logger

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addConfigurations(Configuration... configurations) Add Configurations that will be applied to the WebAppContext before the server is started.
protected void	addDefaultServlet(WebAppContext context) Add Jetty's DefaultServlet to the given WebAppContext.
protected void	addJspServlet(WebAppContext context) Add Jetty's JspServlet to the given WebAppContext.
void	addServerCustomizers(JettyServerCustomizer... customizers) Add JettyServerCustomizers that will be applied to the Server before it is started.
protected void	configureSsl(SslContextFactory factory, Ssl ssl) Configure the SSL connection.
protected void	configureWebAppContext(WebAppContext context, ServletContextInitializer... initializers) Configure the given Jetty WebAppContext for use.
Collection<Configuration>	getConfigurations() Returns a mutable collection of Jetty Configurations that will be applied to the WebAppContext before the server is created.
EmbeddedServletContainer	getEmbeddedServletContainer(ServletContextInitializer... initializers) Gets a new fully configured but paused EmbeddedServletContainer instance.
protected JettyEmbeddedServletContainer	getJettyEmbeddedServletContainer(Server server) Factory method called to create the JettyEmbeddedServletContainer .
Collection<JettyServerCustomizer>	getServerCustomizers() Returns a mutable collection of Jetty Configurations that will be applied to the WebAppContext before the server is created.
protected Configuration	getServletContextInitializerConfiguration(WebAppContext webAppContext, ServletContextInitializer... initializers) Return a Jetty Configuration that will invoke the specified ServletContextInitializers.
protected Configuration[]	getWebAppContextConfigurations(WebAppContext webAppContext, ServletContextInitializer... initializers) Return the Jetty Configurations that should be applied to the server.
protected void	postProcessWebAppContext(WebAppContext webAppContext) Post process the Jetty WebAppContext before it used with the Jetty Server.
void	setConfigurations(Collection<? extends Configuration> configurations) Sets Jetty Configurations that will be applied to the WebAppContext before the server is created.
void	setResourceLoader(ResourceLoader resourceLoader)
void	setServerCustomizers(Collection<? extends JettyServerCustomizer> customizers) Sets JettyServerCustomizers that will be applied to the Server before it is started.
void	setUseForwardHeaders(boolean useForwardHeaders) Set if x-forward-* headers should be processed.

Methods inherited from class org.springframework.boot.context.embedded.AbstractEmbeddedServletContainerFactory

createTempDir, getValidDocumentRoot, getValidSessionStoreDir, getValidSessionStoreDir

Methods inherited from class org.springframework.boot.context.embedded.AbstractConfigurableEmbeddedServletContainer

addErrorPages, addInitializers, getAddress, getCompression, getContextPath, getDisplayName, getDocumentRoot, getErrorPages, getJspServlet, getMimeMappings, getPort, getServerHeader, getSessionStoreDir, getSessionTimeout, getSsl, isPersistSession, isRegisterDefaultServlet, mergeInitializers, setAddress, setCompression, setContextPath, setDisplayName, setDocumentRoot, setErrorPages, setInitializers, setJspServlet, setMimeMappings, setPersistSession, setPort, setRegisterDefaultServlet, setServerHeader, setSessionStoreDir, setSessionTimeout, setSessionTimeout, setSsl, shouldRegisterJspServlet

Methods inherited from class java.lang.Object

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

Constructor Detail

JettyEmbeddedServletContainerFactory

public JettyEmbeddedServletContainerFactory()

Create a new JettyEmbeddedServletContainerFactory instance.

JettyEmbeddedServletContainerFactory

public JettyEmbeddedServletContainerFactory(int port)

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

Parameters:

port - the port to listen on

JettyEmbeddedServletContainerFactory

public JettyEmbeddedServletContainerFactory(String contextPath,
                                            int port)

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

Parameters:

contextPath - root the context path

port - the port to listen on

Method Detail

getEmbeddedServletContainer

public EmbeddedServletContainer getEmbeddedServletContainer(ServletContextInitializer... initializers)

Description copied from interface: EmbeddedServletContainerFactory

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

Specified by:

getEmbeddedServletContainer in interface EmbeddedServletContainerFactory

Parameters:

initializers - ServletContextInitializers that should be applied as the container starts

Returns:

a fully configured and started EmbeddedServletContainer

See Also:

EmbeddedServletContainer.stop()

configureSsl

protected void configureSsl(SslContextFactory factory,
                            Ssl ssl)

Configure the SSL connection.

Parameters:

factory - the Jetty SslContextFactory.

ssl - the ssl details.

configureWebAppContext

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

Configure the given Jetty WebAppContext for use.

Parameters:

context - the context to configure

initializers - the set of initializers to apply

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,
                                                         ServletContextInitializer... 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,
                                                                  ServletContextInitializer... 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 used with the Jetty Server. Subclasses can override this method to apply additional processing to the WebAppContext.

Parameters:

webAppContext - the Jetty WebAppContext

getJettyEmbeddedServletContainer

protected JettyEmbeddedServletContainer getJettyEmbeddedServletContainer(Server server)

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

Parameters:

server - the Jetty server.

Returns:

a new JettyEmbeddedServletContainer instance

setResourceLoader

public void setResourceLoader(ResourceLoader resourceLoader)

Specified by:

setResourceLoader in interface ResourceLoaderAware

setUseForwardHeaders

public void setUseForwardHeaders(boolean useForwardHeaders)

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

Parameters:

useForwardHeaders - if x-forward headers should be used

Since:

1.3.0

setServerCustomizers

public void setServerCustomizers(Collection<? extends JettyServerCustomizer> customizers)

Sets JettyServerCustomizers that will be applied to the Server before it is started. Calling this method will replace any existing configurations.

Parameters:

customizers - the Jetty customizers to apply

getServerCustomizers

public Collection<JettyServerCustomizer> getServerCustomizers()

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

Returns:

the Jetty Configurations

addServerCustomizers

public void addServerCustomizers(JettyServerCustomizer... customizers)

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

Parameters:

customizers - the customizers to add

setConfigurations

public void setConfigurations(Collection<? extends Configuration> configurations)

Sets Jetty Configurations that will be applied to the WebAppContext before the server is created. Calling this method will replace any existing configurations.

Parameters:

configurations - the Jetty configurations to apply

getConfigurations

public Collection<Configuration> getConfigurations()

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

Returns:

the Jetty Configurations

addConfigurations

public void addConfigurations(Configuration... configurations)

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

Parameters:

configurations - the configurations to add