org.springframework.boot.autoconfigure.web

Class ServerProperties

java.lang.Object

org.springframework.boot.autoconfigure.web.ServerProperties

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

@ConfigurationProperties for a web server (e.g. port and path settings).

Since:

1.0.0

Author:

Dave Syer, Stephane Nicoll, Andy Wilkinson, Ivan Sopov, Marcos Barbero, Eddú Meléndez, Quinten De Swaef, Venil Noronha, Aurélien Leboulanger, Brian Clozel, Olivier Lamy, Chentao Qu, Artsiom Yudovin, Andrew McGhie, Rafiullah Hamedy, Dirk Deyne, HaiTao Zhang

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServerProperties.ForwardHeadersStrategy Strategies for supporting forward headers.
static class	ServerProperties.Jetty Jetty properties.
static class	ServerProperties.Netty Netty properties.
static class	ServerProperties.Servlet Servlet properties.
static class	ServerProperties.Tomcat Tomcat properties.
static class	ServerProperties.Undertow Undertow properties.

Constructor Summary

Constructors

Constructor and Description
ServerProperties()

Method Summary

Modifier and Type	Method and Description
InetAddress	getAddress()
Compression	getCompression()
Duration	getConnectionTimeout() Deprecated.
ErrorProperties	getError()
ServerProperties.ForwardHeadersStrategy	getForwardHeadersStrategy()
Http2	getHttp2()
ServerProperties.Jetty	getJetty()
DataSize	getMaxHttpHeaderSize()
ServerProperties.Netty	getNetty()
Integer	getPort()
String	getServerHeader()
ServerProperties.Servlet	getServlet()
Ssl	getSsl()
ServerProperties.Tomcat	getTomcat()
ServerProperties.Undertow	getUndertow()
Boolean	isUseForwardHeaders() Deprecated.
void	setAddress(InetAddress address)
void	setConnectionTimeout(Duration connectionTimeout) Deprecated.
void	setForwardHeadersStrategy(ServerProperties.ForwardHeadersStrategy forwardHeadersStrategy)
void	setMaxHttpHeaderSize(DataSize maxHttpHeaderSize)
void	setPort(Integer port)
void	setServerHeader(String serverHeader)
void	setSsl(Ssl ssl)
void	setUseForwardHeaders(Boolean useForwardHeaders) Deprecated.

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

getPort

public Integer getPort()

setPort

public void setPort(Integer port)

getAddress

public InetAddress getAddress()

setAddress

public void setAddress(InetAddress address)

isUseForwardHeaders

@DeprecatedConfigurationProperty(reason="Replaced to support additional strategies.",
                                 replacement="server.forward-headers-strategy")
 @Deprecated
public Boolean isUseForwardHeaders()

Deprecated.

setUseForwardHeaders

@Deprecated
public void setUseForwardHeaders(Boolean useForwardHeaders)

Deprecated.

getServerHeader

public String getServerHeader()

setServerHeader

public void setServerHeader(String serverHeader)

getMaxHttpHeaderSize

public DataSize getMaxHttpHeaderSize()

setMaxHttpHeaderSize

public void setMaxHttpHeaderSize(DataSize maxHttpHeaderSize)

getConnectionTimeout

@Deprecated
 @DeprecatedConfigurationProperty(reason="Each server behaves differently. Use server specific properties instead.")
public Duration getConnectionTimeout()

Deprecated.

setConnectionTimeout

@Deprecated
public void setConnectionTimeout(Duration connectionTimeout)

Deprecated.

getError

public ErrorProperties getError()

getSsl

public Ssl getSsl()

setSsl

public void setSsl(Ssl ssl)

getCompression

public Compression getCompression()

getHttp2

public Http2 getHttp2()

getServlet

public ServerProperties.Servlet getServlet()

getTomcat

public ServerProperties.Tomcat getTomcat()

getJetty

public ServerProperties.Jetty getJetty()

getNetty

public ServerProperties.Netty getNetty()

getUndertow

public ServerProperties.Undertow getUndertow()

getForwardHeadersStrategy

public ServerProperties.ForwardHeadersStrategy getForwardHeadersStrategy()

setForwardHeadersStrategy

public void setForwardHeadersStrategy(ServerProperties.ForwardHeadersStrategy forwardHeadersStrategy)