程序包 org.springframework.boot.web.server

类 AbstractConfigurableWebServerFactory

java.lang.Object

org.springframework.boot.web.server.AbstractConfigurableWebServerFactory

所有已实现的接口:

ConfigurableWebServerFactory, ErrorPageRegistry, WebServerFactory

直接已知子类:

AbstractReactiveWebServerFactory, AbstractServletWebServerFactory

public abstract class AbstractConfigurableWebServerFactory
extends Object
implements ConfigurableWebServerFactory

Abstract base class for ConfigurableWebServerFactory implementations.

从以下版本开始:

2.0.0

作者:

Phillip Webb, Dave Syer, Andy Wilkinson, Stephane Nicoll, Ivan Sopov, Eddú Meléndez, Brian Clozel, Scott Frederick

构造器概要

构造器

构造器	说明
AbstractConfigurableWebServerFactory()	Create a new AbstractConfigurableWebServerFactory instance.
AbstractConfigurableWebServerFactory(int port)	Create a new AbstractConfigurableWebServerFactory instance with the specified port.

方法概要

修饰符和类型	方法	说明
void	addErrorPages(ErrorPage... errorPages)	Adds error pages that will be used when handling exceptions.
protected final File	createTempDir(String prefix)	Return the absolute temp dir for given web server.
InetAddress	getAddress()	Return the address that the web server binds to.
Compression	getCompression()
Set<ErrorPage>	getErrorPages()	Returns a mutable set of ErrorPages that will be used when handling exceptions.
Http2	getHttp2()
int	getPort()	The port that the web server listens on.
String	getServerHeader()
protected final Map<String,SslBundle>	getServerNameSslBundles()
Shutdown	getShutdown()	Returns the shutdown configuration that will be applied to the server.
Ssl	getSsl()
protected final SslBundle	getSslBundle()	Return the SslBundle that should be used with this server.
SslBundles	getSslBundles()	Return the configured SslBundles.
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.
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	setSslBundles(SslBundles sslBundles)	Sets the SSL bundles that can be used to configure SSL connections.

从类继承的方法 java.lang.Object

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

构造器详细资料

AbstractConfigurableWebServerFactory

public AbstractConfigurableWebServerFactory()

Create a new AbstractConfigurableWebServerFactory instance.

AbstractConfigurableWebServerFactory

public AbstractConfigurableWebServerFactory(int port)

Create a new AbstractConfigurableWebServerFactory instance with the specified port.

参数:

port - the port number for the web server

方法详细资料

getPort

public int getPort()

The port that the web server listens on.

返回:

the port

setPort

public void setPort(int port)

从接口复制的说明: ConfigurableWebServerFactory

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

指定者:

setPort 在接口中 ConfigurableWebServerFactory

参数:

port - the port to set

getAddress

public InetAddress getAddress()

Return the address that the web server binds to.

返回:

the address

setAddress

public void setAddress(InetAddress address)

从接口复制的说明: ConfigurableWebServerFactory

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

指定者:

setAddress 在接口中 ConfigurableWebServerFactory

参数:

address - the address to set (defaults to null)

getErrorPages

public Set<ErrorPage> getErrorPages()

Returns a mutable set of ErrorPages that will be used when handling exceptions.

返回:

the error pages

setErrorPages

public void setErrorPages(Set<? extends ErrorPage> errorPages)

从接口复制的说明: ConfigurableWebServerFactory

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

指定者:

setErrorPages 在接口中 ConfigurableWebServerFactory

参数:

errorPages - the error pages

addErrorPages

public void addErrorPages(ErrorPage... errorPages)

从接口复制的说明: ErrorPageRegistry

Adds error pages that will be used when handling exceptions.

指定者:

addErrorPages 在接口中 ErrorPageRegistry

参数:

errorPages - the error pages

getSsl

public Ssl getSsl()

setSsl

public void setSsl(Ssl ssl)

从接口复制的说明: ConfigurableWebServerFactory

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

指定者:

setSsl 在接口中 ConfigurableWebServerFactory

参数:

ssl - the SSL configuration

getSslBundles

public SslBundles getSslBundles()

Return the configured SslBundles.

返回:

the SslBundles or null

从以下版本开始:

3.2.0

setSslBundles

public void setSslBundles(SslBundles sslBundles)

从接口复制的说明: ConfigurableWebServerFactory

Sets the SSL bundles that can be used to configure SSL connections.

指定者:

setSslBundles 在接口中 ConfigurableWebServerFactory

参数:

sslBundles - the SSL bundles

getHttp2

public Http2 getHttp2()

setHttp2

public void setHttp2(Http2 http2)

从接口复制的说明: ConfigurableWebServerFactory

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

指定者:

setHttp2 在接口中 ConfigurableWebServerFactory

参数:

http2 - the HTTP/2 configuration

getCompression

public Compression getCompression()

setCompression

public void setCompression(Compression compression)

从接口复制的说明: ConfigurableWebServerFactory

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

指定者:

setCompression 在接口中 ConfigurableWebServerFactory

参数:

compression - the compression configuration

getServerHeader

public String getServerHeader()

setServerHeader

public void setServerHeader(String serverHeader)

从接口复制的说明: ConfigurableWebServerFactory

Sets the server header value.

指定者:

setServerHeader 在接口中 ConfigurableWebServerFactory

参数:

serverHeader - the server header value

setShutdown

public void setShutdown(Shutdown shutdown)

从接口复制的说明: ConfigurableWebServerFactory

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

指定者:

setShutdown 在接口中 ConfigurableWebServerFactory

参数:

shutdown - the shutdown configuration

getShutdown

public Shutdown getShutdown()

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

返回:

the shutdown configuration

从以下版本开始:

2.3.0

getSslBundle

protected final SslBundle getSslBundle()

Return the SslBundle that should be used with this server.

返回:

the SSL bundle

getServerNameSslBundles

protected final Map<String,SslBundle> getServerNameSslBundles()

createTempDir

protected final File createTempDir(String prefix)

Return the absolute temp dir for given web server.

参数:

prefix - server name

返回:

the temp dir for given server.