org.springframework.boot.autoconfigure.web

Class ServerProperties

java.lang.Object

org.springframework.boot.autoconfigure.web.ServerProperties

All Implemented Interfaces:

Aware, EmbeddedServletContainerCustomizer, EnvironmentAware, Ordered

@ConfigurationProperties(prefix="server",
                         ignoreUnknownFields=true)
public class ServerProperties
extends Object
implements EmbeddedServletContainerCustomizer, EnvironmentAware, Ordered

ConfigurationProperties for a web server (e.g. port and path settings). Will be used to customize an EmbeddedServletContainerFactory when an EmbeddedServletContainerCustomizerBeanPostProcessor is active.

Author:

Dave Syer, Stephane Nicoll, Andy Wilkinson, Ivan Sopov, Marcos Barbero, Eddú Meléndez

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServerProperties.Session
static class	ServerProperties.Tomcat
static class	ServerProperties.Undertow

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
ServerProperties()

Method Summary

Modifier and Type	Method and Description
void	customize(ConfigurableEmbeddedServletContainer container) Customize the specified ConfigurableEmbeddedServletContainer.
InetAddress	getAddress()
Compression	getCompression()
Map<String,String>	getContextParameters()
String	getContextPath()
String	getDisplayName()
ErrorProperties	getError()
JspServlet	getJspServlet()
protected boolean	getOrDeduceUseForwardHeaders()
int	getOrder()
String	getPath(String path)
String[]	getPathsArray(Collection<String> paths)
String[]	getPathsArray(String[] paths)
Integer	getPort()
String	getServerHeader()
String	getServletMapping()
String	getServletPath()
String	getServletPrefix()
ServerProperties.Session	getSession()
Integer	getSessionTimeout() Deprecated. since 1.3.0 in favor of session.timeout.
Ssl	getSsl()
ServerProperties.Tomcat	getTomcat()
ServerProperties.Undertow	getUndertow()
Boolean	isUseForwardHeaders()
void	setAddress(InetAddress address)
void	setContextPath(String contextPath)
void	setDisplayName(String displayName)
void	setEnvironment(Environment environment)
void	setJspServlet(JspServlet jspServlet)
void	setLoader(String value)
void	setPort(Integer port)
void	setServerHeader(String serverHeader)
void	setServletPath(String servletPath)
void	setSession(ServerProperties.Session session)
void	setSessionTimeout(Integer sessionTimeout) Deprecated. since 1.3.0 in favor of session.timeout.
void	setSsl(Ssl ssl)
void	setUseForwardHeaders(Boolean useForwardHeaders)

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerProperties

public ServerProperties()

Method Detail

getOrder

public int getOrder()

Specified by:

getOrder in interface Ordered

setEnvironment

public void setEnvironment(Environment environment)

Specified by:

setEnvironment in interface EnvironmentAware

customize

public void customize(ConfigurableEmbeddedServletContainer container)

Description copied from interface: EmbeddedServletContainerCustomizer

Customize the specified ConfigurableEmbeddedServletContainer.

Specified by:

customize in interface EmbeddedServletContainerCustomizer

Parameters:

container - the container to customize

getServletMapping

public String getServletMapping()

getPath

public String getPath(String path)

getServletPrefix

public String getServletPrefix()

getPathsArray

public String[] getPathsArray(Collection<String> paths)

getPathsArray

public String[] getPathsArray(String[] paths)

setLoader

public void setLoader(String value)

getPort

public Integer getPort()

setPort

public void setPort(Integer port)

getAddress

public InetAddress getAddress()

setAddress

public void setAddress(InetAddress address)

getContextPath

public String getContextPath()

setContextPath

public void setContextPath(String contextPath)

getDisplayName

public String getDisplayName()

setDisplayName

public void setDisplayName(String displayName)

getServletPath

public String getServletPath()

setServletPath

public void setServletPath(String servletPath)

getContextParameters

public Map<String,String> getContextParameters()

isUseForwardHeaders

public Boolean isUseForwardHeaders()

setUseForwardHeaders

public void setUseForwardHeaders(Boolean useForwardHeaders)

getServerHeader

public String getServerHeader()

setServerHeader

public void setServerHeader(String serverHeader)

getOrDeduceUseForwardHeaders

protected final boolean getOrDeduceUseForwardHeaders()

getSessionTimeout

@Deprecated
 @DeprecatedConfigurationProperty(replacement="server.session.timeout")
public Integer getSessionTimeout()

Deprecated. since 1.3.0 in favor of session.timeout.

Get the session timeout.

Returns:

the session timeout

setSessionTimeout

@Deprecated
public void setSessionTimeout(Integer sessionTimeout)

Deprecated. since 1.3.0 in favor of session.timeout.

Set the session timeout.

Parameters:

sessionTimeout - the session timeout

getError

public ErrorProperties getError()

getSession

public ServerProperties.Session getSession()

setSession

public void setSession(ServerProperties.Session session)

getSsl

public Ssl getSsl()

setSsl

public void setSsl(Ssl ssl)

getCompression

public Compression getCompression()

getJspServlet

public JspServlet getJspServlet()

setJspServlet

public void setJspServlet(JspServlet jspServlet)

getTomcat

public ServerProperties.Tomcat getTomcat()

getUndertow

public ServerProperties.Undertow getUndertow()