Package 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, Victor Mandujano, Chris Bono, Parviz Rozikov

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ServerProperties()

Method Summary

Modifier and Type	Method	Description
InetAddress	getAddress()
Compression	getCompression()
ErrorProperties	getError()
ServerProperties.ForwardHeadersStrategy	getForwardHeadersStrategy()
Http2	getHttp2()
ServerProperties.Jetty	getJetty()
DataSize	getMaxHttpHeaderSize()	Deprecated, for removal: This API element is subject to removal in a future version.
DataSize	getMaxHttpRequestHeaderSize()
ServerProperties.Netty	getNetty()
Integer	getPort()
ServerProperties.Reactive	getReactive()
String	getServerHeader()
ServerProperties.Servlet	getServlet()
Shutdown	getShutdown()
Ssl	getSsl()
ServerProperties.Tomcat	getTomcat()
ServerProperties.Undertow	getUndertow()
void	setAddress(InetAddress address)
void	setForwardHeadersStrategy(ServerProperties.ForwardHeadersStrategy forwardHeadersStrategy)
void	setMaxHttpHeaderSize(DataSize maxHttpHeaderSize)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setMaxHttpRequestHeaderSize(DataSize maxHttpRequestHeaderSize)
void	setPort(Integer port)
void	setServerHeader(String serverHeader)
void	setShutdown(Shutdown shutdown)
void	setSsl(Ssl ssl)

Methods inherited from class java.lang.Object

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

Constructor Details

ServerProperties

public ServerProperties()

Method Details

getPort

public Integer getPort()

setPort

public void setPort(Integer port)

getAddress

public InetAddress getAddress()

setAddress

public void setAddress(InetAddress address)

getServerHeader

public String getServerHeader()

setServerHeader

public void setServerHeader(String serverHeader)

getMaxHttpHeaderSize

@Deprecated(since="3.0.0",
            forRemoval=true)
@DeprecatedConfigurationProperty
public DataSize getMaxHttpHeaderSize()

Deprecated, for removal: This API element is subject to removal in a future version.

setMaxHttpHeaderSize

@Deprecated(since="3.0.0",
            forRemoval=true)
public void setMaxHttpHeaderSize(DataSize maxHttpHeaderSize)

Deprecated, for removal: This API element is subject to removal in a future version.

getMaxHttpRequestHeaderSize

public DataSize getMaxHttpRequestHeaderSize()

setMaxHttpRequestHeaderSize

public void setMaxHttpRequestHeaderSize(DataSize maxHttpRequestHeaderSize)

getShutdown

public Shutdown getShutdown()

setShutdown

public void setShutdown(Shutdown shutdown)

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

getReactive

public ServerProperties.Reactive getReactive()

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)