Class ServerProperties

java.lang.Object

org.springframework.boot.web.server.autoconfigure.ServerProperties

@ConfigurationProperties("server")
public class ServerProperties
extends Object

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

Since:

4.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, Florian Storz, Michael Weidmann, Lasse Wulff

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ServerProperties()

Method Summary

Modifier and Type	Method	Description
@Nullable InetAddress	getAddress()
Compression	getCompression()
ErrorProperties	getError()
@Nullable ServerProperties.ForwardHeadersStrategy	getForwardHeadersStrategy()
Http2	getHttp2()
DataSize	getMaxHttpRequestHeaderSize()
MimeMappings	getMimeMappings()
@Nullable Integer	getPort()
ServerProperties.Reactive	getReactive()
@Nullable String	getServerHeader()
ServerProperties.Servlet	getServlet()
Shutdown	getShutdown()
@Nullable Ssl	getSsl()
void	setAddress(@Nullable InetAddress address)
void	setForwardHeadersStrategy(@Nullable ServerProperties.ForwardHeadersStrategy forwardHeadersStrategy)
void	setMaxHttpRequestHeaderSize(DataSize maxHttpRequestHeaderSize)
void	setMimeMappings(Map<String,String> customMappings)
void	setPort(@Nullable Integer port)
void	setServerHeader(@Nullable String serverHeader)
void	setShutdown(Shutdown shutdown)
void	setSsl(@Nullable Ssl ssl)

Methods inherited from class Object

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

Constructor Details

ServerProperties

public ServerProperties()

Method Details

getPort

public @Nullable Integer getPort()

setPort

public void setPort(@Nullable Integer port)

getAddress

public @Nullable InetAddress getAddress()

setAddress

public void setAddress(@Nullable InetAddress address)

getServerHeader

public @Nullable String getServerHeader()

setServerHeader

public void setServerHeader(@Nullable String serverHeader)

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 @Nullable Ssl getSsl()

setSsl

public void setSsl(@Nullable Ssl ssl)

getCompression

public Compression getCompression()

getMimeMappings

public MimeMappings getMimeMappings()

setMimeMappings

public void setMimeMappings(Map<String,String> customMappings)

getHttp2

public Http2 getHttp2()

getServlet

public ServerProperties.Servlet getServlet()

getReactive

public ServerProperties.Reactive getReactive()

getForwardHeadersStrategy

public @Nullable ServerProperties.ForwardHeadersStrategy getForwardHeadersStrategy()

setForwardHeadersStrategy

public void setForwardHeadersStrategy(@Nullable ServerProperties.ForwardHeadersStrategy forwardHeadersStrategy)