org.springframework.boot.context.embedded

Interface ConfigurableEmbeddedServletContainer

All Known Implementing Classes:

AbstractConfigurableEmbeddedServletContainer, AbstractEmbeddedServletContainerFactory, ErrorPageFilter, JettyEmbeddedServletContainerFactory, TomcatEmbeddedServletContainerFactory, UndertowEmbeddedServletContainerFactory

public interface ConfigurableEmbeddedServletContainer

Simple interface that represents customizations to an EmbeddedServletContainerFactory.

Author:

Dave Syer, Andy Wilkinson, Stephane Nicoll, Eddú Meléndez

See Also:

EmbeddedServletContainerFactory, EmbeddedServletContainerCustomizer

Method Summary

Modifier and Type	Method and Description
void	addErrorPages(ErrorPage... errorPages) Adds error pages that will be used when handling exceptions.
void	addInitializers(ServletContextInitializer... initializers) Add ServletContextInitializers to those that should be applied in addition to EmbeddedServletContainerFactory.getEmbeddedServletContainer(ServletContextInitializer...) parameters.
void	setAddress(InetAddress address) Sets the specific network address that the server should bind to.
void	setCompression(Compression compression) Sets the compression configuration that will be applied to the container's default connector.
void	setContextPath(String contextPath) Sets the context path for the embedded servlet container.
void	setDisplayName(String displayName) Sets the display name of the application deployed in the embedded servlet container.
void	setDocumentRoot(File documentRoot) Sets the document root directory which will be used by the web context to serve static files.
void	setErrorPages(Set<ErrorPage> errorPages) Sets the error pages that will be used when handling exceptions.
void	setInitializers(List<? extends ServletContextInitializer> initializers) Sets ServletContextInitializer that should be applied in addition to EmbeddedServletContainerFactory.getEmbeddedServletContainer(ServletContextInitializer...) parameters.
void	setJspServlet(JspServlet jspServlet) Sets the configuration that will be applied to the container's JSP servlet.
void	setJspServletClassName(String jspServletClassName) Deprecated. in 1.3.0 in favor of JspServlet.setClassName(String)
void	setMimeMappings(MimeMappings mimeMappings) Sets the mime-type mappings.
void	setPersistSession(boolean persistSession) Sets if session data should be persisted between restarts.
void	setPort(int port) Sets the port that the embedded servlet container should listen on.
void	setRegisterDefaultServlet(boolean registerDefaultServlet) Set if the DefaultServlet should be registered.
void	setRegisterJspServlet(boolean registerJspServlet) Deprecated. in 1.3.0 in favor of JspServlet.setRegistered(boolean)
void	setServerHeader(String serverHeader) Sets the server header value.
void	setSessionStoreDir(File sessionStoreDir) Set the directory used to store serialized session data.
void	setSessionTimeout(int sessionTimeout) The session timeout in seconds (default 30 minutes).
void	setSessionTimeout(int sessionTimeout, TimeUnit timeUnit) The session timeout in the specified TimeUnit (default 30 minutes).
void	setSsl(Ssl ssl) Sets the SSL configuration that will be applied to the container's default connector.

Method Detail

setContextPath

void setContextPath(String contextPath)

Sets the context path for the embedded servlet container. The context should start with a "/" character but not end with a "/" character. The default context path can be specified using an empty string.

Parameters:

contextPath - the contextPath to set

setDisplayName

void setDisplayName(String displayName)

Sets the display name of the application deployed in the embedded servlet container.

Parameters:

displayName - the displayName to set

Since:

1.3.0

setPort

void setPort(int port)

Sets the port that the embedded servlet container should listen on. If not specified port '8080' will be used. Use port -1 to disable auto-start (i.e start the web application context but not have it listen to any port).

Parameters:

port - the port to set

setSessionTimeout

void setSessionTimeout(int sessionTimeout)

The session timeout in seconds (default 30 minutes). If 0 or negative then sessions never expire.

Parameters:

sessionTimeout - the session timeout

setSessionTimeout

void setSessionTimeout(int sessionTimeout,
                       TimeUnit timeUnit)

The session timeout in the specified TimeUnit (default 30 minutes). If 0 or negative then sessions never expire.

Parameters:

sessionTimeout - the session timeout

timeUnit - the time unit

setPersistSession

void setPersistSession(boolean persistSession)

Sets if session data should be persisted between restarts.

Parameters:

persistSession - true if session data should be persisted

setSessionStoreDir

void setSessionStoreDir(File sessionStoreDir)

Set the directory used to store serialized session data.

Parameters:

sessionStoreDir - the directory or null to use a default location.

setAddress

void setAddress(InetAddress address)

Sets the specific network address that the server should bind to.

Parameters:

address - the address to set (defaults to null)

setJspServletClassName

@Deprecated
void setJspServletClassName(String jspServletClassName)

Deprecated. in 1.3.0 in favor of JspServlet.setClassName(String)

The class name for the jsp servlet if used. If registerJspServlet is true and this class is on the classpath then it will be registered. Since both Tomcat and Jetty use Jasper for their JSP implementation the default is org.apache.jasper.servlet.JspServlet.

Parameters:

jspServletClassName - the class name for the JSP servlet if used

See Also:

setJspServlet(org.springframework.boot.context.embedded.JspServlet), JspServlet.setClassName(String)

setRegisterJspServlet

@Deprecated
void setRegisterJspServlet(boolean registerJspServlet)

Deprecated. in 1.3.0 in favor of JspServlet.setRegistered(boolean)

Set if the JspServlet should be registered if it is on the classpath. Defaults to true so that files from the document root will be served.

Parameters:

registerJspServlet - if the JSP servlet should be registered

See Also:

setJspServlet(org.springframework.boot.context.embedded.JspServlet), JspServlet.setRegistered(boolean)

setRegisterDefaultServlet

void setRegisterDefaultServlet(boolean registerDefaultServlet)

Set if the DefaultServlet should be registered. Defaults to true so that files from the document root will be served.

Parameters:

registerDefaultServlet - if the default servlet should be registered

addErrorPages

void addErrorPages(ErrorPage... errorPages)

Adds error pages that will be used when handling exceptions.

Parameters:

errorPages - the error pages

setErrorPages

void setErrorPages(Set<ErrorPage> errorPages)

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

Parameters:

errorPages - the error pages

setMimeMappings

void setMimeMappings(MimeMappings mimeMappings)

Sets the mime-type mappings.

Parameters:

mimeMappings - the mime type mappings (defaults to MimeMappings.DEFAULT)

setDocumentRoot

void setDocumentRoot(File documentRoot)

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

Parameters:

documentRoot - the document root or null if not required

setInitializers

void setInitializers(List<? extends ServletContextInitializer> initializers)

Sets ServletContextInitializer that should be applied in addition to EmbeddedServletContainerFactory.getEmbeddedServletContainer(ServletContextInitializer...) parameters. This method will replace any previously set or added initializers.

Parameters:

initializers - the initializers to set

See Also:

addInitializers(org.springframework.boot.context.embedded.ServletContextInitializer...)

addInitializers

void addInitializers(ServletContextInitializer... initializers)

Add ServletContextInitializers to those that should be applied in addition to EmbeddedServletContainerFactory.getEmbeddedServletContainer(ServletContextInitializer...) parameters.

Parameters:

initializers - the initializers to add

See Also:

setInitializers(java.util.List<? extends org.springframework.boot.context.embedded.ServletContextInitializer>)

setSsl

void setSsl(Ssl ssl)

Sets the SSL configuration that will be applied to the container's default connector.

Parameters:

ssl - the SSL configuration

setJspServlet

void setJspServlet(JspServlet jspServlet)

Sets the configuration that will be applied to the container's JSP servlet.

Parameters:

jspServlet - the JSP servlet configuration

setCompression

void setCompression(Compression compression)

Sets the compression configuration that will be applied to the container's default connector.

Parameters:

compression - the compression configuration

setServerHeader

void setServerHeader(String serverHeader)

Sets the server header value.

Parameters:

serverHeader - the server header value