org.springframework.boot.web.server

Interface ConfigurableWebServerFactory

All Superinterfaces:

ErrorPageRegistry, WebServerFactory

All Known Subinterfaces:

ConfigurableJettyWebServerFactory, ConfigurableReactiveWebServerFactory, ConfigurableServletWebServerFactory, ConfigurableTomcatWebServerFactory, ConfigurableUndertowWebServerFactory

All Known Implementing Classes:

AbstractConfigurableWebServerFactory, AbstractReactiveWebServerFactory, AbstractServletWebServerFactory, JettyReactiveWebServerFactory, JettyServletWebServerFactory, NettyReactiveWebServerFactory, TomcatReactiveWebServerFactory, TomcatServletWebServerFactory, UndertowReactiveWebServerFactory, UndertowServletWebServerFactory

public interface ConfigurableWebServerFactory
extends WebServerFactory, ErrorPageRegistry

A configurable WebServerFactory.

Since:

2.0.0

Author:

Phillip Webb, Brian Clozel

See Also:

ErrorPageRegistry

Method Summary

Modifier and Type	Method and Description
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 server's default connector.
void	setErrorPages(Set<? extends ErrorPage> errorPages) Sets the error pages that will be used when handling exceptions.
void	setHttp2(Http2 http2) Sets the HTTP/2 configuration that will be applied to the server.
void	setPort(int port) Sets the port that the web server should listen on.
void	setServerHeader(String serverHeader) Sets the server header value.
default void	setShutdown(Shutdown shutdown) Sets the shutdown configuration that will be applied to the server.
void	setSsl(Ssl ssl) Sets the SSL configuration that will be applied to the server's default connector.
void	setSslStoreProvider(SslStoreProvider sslStoreProvider) Sets a provider that will be used to obtain SSL stores.

Methods inherited from interface org.springframework.boot.web.server.ErrorPageRegistry

addErrorPages

Method Detail

setPort

void setPort(int port)

Sets the port that the web server 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).

Parameters:

port - the port to set

setAddress

void setAddress(InetAddress address)

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

Parameters:

address - the address to set (defaults to null)

setErrorPages

void setErrorPages(Set<? extends ErrorPage> errorPages)

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

Parameters:

errorPages - the error pages

setSsl

void setSsl(Ssl ssl)

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

Parameters:

ssl - the SSL configuration

setSslStoreProvider

void setSslStoreProvider(SslStoreProvider sslStoreProvider)

Sets a provider that will be used to obtain SSL stores.

Parameters:

sslStoreProvider - the SSL store provider

setHttp2

void setHttp2(Http2 http2)

Sets the HTTP/2 configuration that will be applied to the server.

Parameters:

http2 - the HTTP/2 configuration

setCompression

void setCompression(Compression compression)

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

Parameters:

compression - the compression configuration

setServerHeader

void setServerHeader(String serverHeader)

Sets the server header value.

Parameters:

serverHeader - the server header value

setShutdown

default void setShutdown(Shutdown shutdown)

Sets the shutdown configuration that will be applied to the server.

Parameters:

shutdown - the shutdown configuration

Since:

2.3.0