org.springframework.boot.context.embedded

Class AbstractConfigurableEmbeddedServletContainer

java.lang.Object

org.springframework.boot.context.embedded.AbstractConfigurableEmbeddedServletContainer

All Implemented Interfaces:

ConfigurableEmbeddedServletContainer

Direct Known Subclasses:

AbstractEmbeddedServletContainerFactory, ErrorPageFilter

public abstract class AbstractConfigurableEmbeddedServletContainer
extends Object
implements ConfigurableEmbeddedServletContainer

Abstract base class for ConfigurableEmbeddedServletContainer implementations.

Author:

Phillip Webb, Dave Syer, Andy Wilkinson, Stephane Nicoll, Ivan Sopov

See Also:

AbstractEmbeddedServletContainerFactory

Constructor Summary

Constructors

Constructor and Description
AbstractConfigurableEmbeddedServletContainer() Create a new AbstractConfigurableEmbeddedServletContainer instance.
AbstractConfigurableEmbeddedServletContainer(int port) Create a new AbstractConfigurableEmbeddedServletContainer instance with the specified port.
AbstractConfigurableEmbeddedServletContainer(String contextPath, int port) Create a new AbstractConfigurableEmbeddedServletContainer instance with the specified context path and port.

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.
InetAddress	getAddress() Return the address that the embedded container binds to.
Compression	getCompression()
String	getContextPath() Returns the context path for the embedded servlet container.
String	getDisplayName()
File	getDocumentRoot() Returns the document root which will be used by the web context to serve static files.
Set<ErrorPage>	getErrorPages() Returns a mutable set of ErrorPages that will be used when handling exceptions.
JspServlet	getJspServlet()
MimeMappings	getMimeMappings() Returns the mime-type mappings.
int	getPort() The port that the embedded server listens on.
File	getSessionStoreDir()
int	getSessionTimeout() Return the session timeout in seconds.
Ssl	getSsl()
boolean	isPersistSession()
boolean	isRegisterDefaultServlet() Flag to indicate that the default servlet should be registered.
protected ServletContextInitializer[]	mergeInitializers(ServletContextInitializer... initializers) Utility method that can be used by subclasses wishing to combine the specified ServletContextInitializer parameters with those defined in this instance.
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) The class name for the jsp servlet if used.
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) Set if the JspServlet should be registered if it is on the classpath.
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.
protected boolean	shouldRegisterJspServlet() Returns whether or not the JSP servlet should be registered with the embedded container.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractConfigurableEmbeddedServletContainer

public AbstractConfigurableEmbeddedServletContainer()

Create a new AbstractConfigurableEmbeddedServletContainer instance.

AbstractConfigurableEmbeddedServletContainer

public AbstractConfigurableEmbeddedServletContainer(int port)

Create a new AbstractConfigurableEmbeddedServletContainer instance with the specified port.

Parameters:

port - the port number for the embedded servlet container

AbstractConfigurableEmbeddedServletContainer

public AbstractConfigurableEmbeddedServletContainer(String contextPath,
                                                    int port)

Create a new AbstractConfigurableEmbeddedServletContainer instance with the specified context path and port.

Parameters:

contextPath - the context path for the embedded servlet container

port - the port number for the embedded servlet container

Method Detail

setContextPath

public void setContextPath(String contextPath)

Description copied from interface: ConfigurableEmbeddedServletContainer

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.

Specified by:

setContextPath in interface ConfigurableEmbeddedServletContainer

Parameters:

contextPath - the contextPath to set

getContextPath

public String getContextPath()

Returns the context path for the embedded servlet container. The path will start with "/" and not end with "/". The root context is represented by an empty string.

Returns:

the context path

setDisplayName

public void setDisplayName(String displayName)

Description copied from interface: ConfigurableEmbeddedServletContainer

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

Specified by:

setDisplayName in interface ConfigurableEmbeddedServletContainer

Parameters:

displayName - the displayName to set

getDisplayName

public String getDisplayName()

setPort

public void setPort(int port)

Description copied from interface: ConfigurableEmbeddedServletContainer

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).

Specified by:

setPort in interface ConfigurableEmbeddedServletContainer

Parameters:

port - the port to set

getPort

public int getPort()

The port that the embedded server listens on.

Returns:

the port

setAddress

public void setAddress(InetAddress address)

Description copied from interface: ConfigurableEmbeddedServletContainer

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

Specified by:

setAddress in interface ConfigurableEmbeddedServletContainer

Parameters:

address - the address to set (defaults to null)

getAddress

public InetAddress getAddress()

Return the address that the embedded container binds to.

Returns:

the address

setSessionTimeout

public void setSessionTimeout(int sessionTimeout)

Description copied from interface: ConfigurableEmbeddedServletContainer

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

Specified by:

setSessionTimeout in interface ConfigurableEmbeddedServletContainer

Parameters:

sessionTimeout - the session timeout

setSessionTimeout

public void setSessionTimeout(int sessionTimeout,
                              TimeUnit timeUnit)

Description copied from interface: ConfigurableEmbeddedServletContainer

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

Specified by:

setSessionTimeout in interface ConfigurableEmbeddedServletContainer

Parameters:

sessionTimeout - the session timeout

timeUnit - the time unit

getSessionTimeout

public int getSessionTimeout()

Return the session timeout in seconds.

Returns:

the timeout in seconds

setPersistSession

public void setPersistSession(boolean persistSession)

Description copied from interface: ConfigurableEmbeddedServletContainer

Sets if session data should be persisted between restarts.

Specified by:

setPersistSession in interface ConfigurableEmbeddedServletContainer

Parameters:

persistSession - true if session data should be persisted

isPersistSession

public boolean isPersistSession()

setSessionStoreDir

public void setSessionStoreDir(File sessionStoreDir)

Description copied from interface: ConfigurableEmbeddedServletContainer

Set the directory used to store serialized session data.

Specified by:

setSessionStoreDir in interface ConfigurableEmbeddedServletContainer

Parameters:

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

getSessionStoreDir

public File getSessionStoreDir()

setInitializers

public void setInitializers(List<? extends ServletContextInitializer> initializers)

Description copied from interface: ConfigurableEmbeddedServletContainer

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

Specified by:

setInitializers in interface ConfigurableEmbeddedServletContainer

Parameters:

initializers - the initializers to set

See Also:

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

addInitializers

public void addInitializers(ServletContextInitializer... initializers)

Description copied from interface: ConfigurableEmbeddedServletContainer

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

Specified by:

addInitializers in interface ConfigurableEmbeddedServletContainer

Parameters:

initializers - the initializers to add

See Also:

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

setDocumentRoot

public void setDocumentRoot(File documentRoot)

Description copied from interface: ConfigurableEmbeddedServletContainer

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

Specified by:

setDocumentRoot in interface ConfigurableEmbeddedServletContainer

Parameters:

documentRoot - the document root or null if not required

getDocumentRoot

public File getDocumentRoot()

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

Returns:

the document root

setErrorPages

public void setErrorPages(Set<ErrorPage> errorPages)

Description copied from interface: ConfigurableEmbeddedServletContainer

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

Specified by:

setErrorPages in interface ConfigurableEmbeddedServletContainer

Parameters:

errorPages - the error pages

addErrorPages

public void addErrorPages(ErrorPage... errorPages)

Description copied from interface: ConfigurableEmbeddedServletContainer

Adds error pages that will be used when handling exceptions.

Specified by:

addErrorPages in interface ConfigurableEmbeddedServletContainer

Parameters:

errorPages - the error pages

getErrorPages

public Set<ErrorPage> getErrorPages()

Returns a mutable set of ErrorPages that will be used when handling exceptions.

Returns:

the error pages

setMimeMappings

public void setMimeMappings(MimeMappings mimeMappings)

Description copied from interface: ConfigurableEmbeddedServletContainer

Sets the mime-type mappings.

Specified by:

setMimeMappings in interface ConfigurableEmbeddedServletContainer

Parameters:

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

getMimeMappings

public MimeMappings getMimeMappings()

Returns the mime-type mappings.

Returns:

the mimeMappings the mime-type mappings.

setRegisterDefaultServlet

public void setRegisterDefaultServlet(boolean registerDefaultServlet)

Description copied from interface: ConfigurableEmbeddedServletContainer

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

Specified by:

setRegisterDefaultServlet in interface ConfigurableEmbeddedServletContainer

Parameters:

registerDefaultServlet - if the default servlet should be registered

setRegisterJspServlet

public void setRegisterJspServlet(boolean registerJspServlet)

Description copied from interface: ConfigurableEmbeddedServletContainer

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.

Specified by:

setRegisterJspServlet in interface ConfigurableEmbeddedServletContainer

Parameters:

registerJspServlet - if the JSP servlet should be registered

See Also:

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

isRegisterDefaultServlet

public boolean isRegisterDefaultServlet()

Flag to indicate that the default servlet should be registered.

Returns:

true if the default servlet is to be registered

setSsl

public void setSsl(Ssl ssl)

Description copied from interface: ConfigurableEmbeddedServletContainer

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

Specified by:

setSsl in interface ConfigurableEmbeddedServletContainer

Parameters:

ssl - the SSL configuration

getSsl

public Ssl getSsl()

setJspServletClassName

public void setJspServletClassName(String jspServletClassName)

Description copied from interface: ConfigurableEmbeddedServletContainer

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.

Specified by:

setJspServletClassName in interface ConfigurableEmbeddedServletContainer

Parameters:

jspServletClassName - the class name for the JSP servlet if used

See Also:

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

setJspServlet

public void setJspServlet(JspServlet jspServlet)

Description copied from interface: ConfigurableEmbeddedServletContainer

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

Specified by:

setJspServlet in interface ConfigurableEmbeddedServletContainer

Parameters:

jspServlet - the JSP servlet configuration

getJspServlet

public JspServlet getJspServlet()

getCompression

public Compression getCompression()

setCompression

public void setCompression(Compression compression)

Description copied from interface: ConfigurableEmbeddedServletContainer

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

Specified by:

setCompression in interface ConfigurableEmbeddedServletContainer

Parameters:

compression - the compression configuration

mergeInitializers

protected final ServletContextInitializer[] mergeInitializers(ServletContextInitializer... initializers)

Utility method that can be used by subclasses wishing to combine the specified ServletContextInitializer parameters with those defined in this instance.

Parameters:

initializers - the initializers to merge

Returns:

a complete set of merged initializers (with the specified parameters appearing first)

shouldRegisterJspServlet

protected boolean shouldRegisterJspServlet()

Returns whether or not the JSP servlet should be registered with the embedded container.

Returns:

true if the container should be registered, otherwise false