程序包 org.springframework.boot.web.embedded.undertow

类 UndertowServletWebServerFactory

java.lang.Object

org.springframework.boot.web.server.AbstractConfigurableWebServerFactory

org.springframework.boot.web.servlet.server.AbstractServletWebServerFactory

org.springframework.boot.web.embedded.undertow.UndertowServletWebServerFactory

所有已实现的接口:

Aware, ConfigurableUndertowWebServerFactory, ConfigurableWebServerFactory, ErrorPageRegistry, WebServerFactory, ConfigurableServletWebServerFactory, ServletWebServerFactory, WebListenerRegistry, ResourceLoaderAware

public class UndertowServletWebServerFactory
extends AbstractServletWebServerFactory
implements ConfigurableUndertowWebServerFactory, ResourceLoaderAware

ServletWebServerFactory that can be used to create UndertowServletWebServers.

Unless explicitly configured otherwise, the factory will create servers that listen for HTTP requests on port 8080.

从以下版本开始:

2.0.0

作者:

Ivan Sopov, Andy Wilkinson, Marcos Barbero, Eddú Meléndez, Scott Frederick

另请参阅:

• UndertowServletWebServer

字段概要

从类继承的字段 org.springframework.boot.web.servlet.server.AbstractServletWebServerFactory

logger

构造器概要

构造器

构造器	说明
UndertowServletWebServerFactory()	Create a new UndertowServletWebServerFactory instance.
UndertowServletWebServerFactory(int port)	Create a new UndertowServletWebServerFactory that listens for requests using the specified port.
UndertowServletWebServerFactory(String contextPath, int port)	Create a new UndertowServletWebServerFactory with the specified context path and port.

方法概要

修饰符和类型	方法	说明
void	addBuilderCustomizers(UndertowBuilderCustomizer... customizers)	Add UndertowBuilderCustomizers that should be used to customize the Undertow Undertow.Builder.
void	addDeploymentInfoCustomizers(UndertowDeploymentInfoCustomizer... customizers)	Add UndertowDeploymentInfoCustomizers that should be used to customize the Undertow DeploymentInfo.
String	getAccessLogPrefix()
Collection<UndertowBuilderCustomizer>	getBuilderCustomizers()	Returns a mutable collection of the UndertowBuilderCustomizers that will be applied to the Undertow Undertow.Builder.
Collection<UndertowDeploymentInfoCustomizer>	getDeploymentInfoCustomizers()	Returns a mutable collection of the UndertowDeploymentInfoCustomizers that will be applied to the Undertow DeploymentInfo.
protected UndertowServletWebServer	getUndertowWebServer(io.undertow.Undertow.Builder builder, io.undertow.servlet.api.DeploymentManager manager, int port)	Factory method called to create the UndertowServletWebServer.
WebServer	getWebServer(ServletContextInitializer... initializers)	Gets a new fully configured but paused WebServer instance.
boolean	isAccessLogEnabled()
boolean	isEagerFilterInit()	Return if filters should be eagerly initialized.
boolean	isPreservePathOnForward()	Return whether the request path should be preserved on forward.
protected final boolean	isUseForwardHeaders()
void	setAccessLogDirectory(File accessLogDirectory)	Set the access log directory.
void	setAccessLogEnabled(boolean accessLogEnabled)	Set whether access logs are enabled.
void	setAccessLogPattern(String accessLogPattern)	Set the access log pattern.
void	setAccessLogPrefix(String accessLogPrefix)	Set the access log prefix.
void	setAccessLogRotate(boolean accessLogRotate)	Set whether access logs rotation is enabled.
void	setAccessLogSuffix(String accessLogSuffix)	Set the access log suffix.
void	setBufferSize(Integer bufferSize)	Set the buffer size.
void	setBuilderCustomizers(Collection<? extends UndertowBuilderCustomizer> customizers)	Set UndertowBuilderCustomizers that should be applied to the Undertow Undertow.Builder.
void	setDeploymentInfoCustomizers(Collection<? extends UndertowDeploymentInfoCustomizer> customizers)	Set UndertowDeploymentInfoCustomizers that should be applied to the Undertow DeploymentInfo.
void	setEagerFilterInit(boolean eagerFilterInit)	Set whether filters should be eagerly initialized.
void	setIoThreads(Integer ioThreads)	Set the number of IO Threads.
void	setPreservePathOnForward(boolean preservePathOnForward)	Set whether the request path should be preserved on forward.
void	setResourceLoader(ResourceLoader resourceLoader)
void	setUseDirectBuffers(Boolean directBuffers)	Set whether direct buffers should be used.
void	setUseForwardHeaders(boolean useForwardHeaders)	Set if x-forward-* headers should be processed.
void	setWorkerThreads(Integer workerThreads)	Set the number of Worker Threads.

从类继承的方法 org.springframework.boot.web.servlet.server.AbstractServletWebServerFactory

addCookieSameSiteSuppliers, addInitializers, addMimeMappings, addWebListeners, getContextPath, getCookieSameSiteSuppliers, getDisplayName, getDocumentRoot, getInitParameters, getJsp, getLocaleCharsetMappings, getMimeMappings, getSession, getUrlsOfJarsWithMetaInfResources, getValidDocumentRoot, getValidSessionStoreDir, getValidSessionStoreDir, getWebListenerClassNames, isRegisterDefaultServlet, mergeInitializers, setContextPath, setCookieSameSiteSuppliers, setDisplayName, setDocumentRoot, setInitializers, setInitParameters, setJsp, setLocaleCharsetMappings, setMimeMappings, setRegisterDefaultServlet, setSession, shouldRegisterJspServlet

从类继承的方法 org.springframework.boot.web.server.AbstractConfigurableWebServerFactory

addErrorPages, createTempDir, getAddress, getCompression, getErrorPages, getHttp2, getPort, getServerHeader, getServerNameSslBundles, getShutdown, getSsl, getSslBundle, getSslBundles, setAddress, setCompression, setErrorPages, setHttp2, setPort, setServerHeader, setShutdown, setSsl, setSslBundles

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

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

从接口继承的方法 org.springframework.boot.web.server.ConfigurableWebServerFactory

setAddress, setCompression, setErrorPages, setHttp2, setPort, setServerHeader, setShutdown, setSsl, setSslBundles

从接口继承的方法 org.springframework.boot.web.server.ErrorPageRegistry

addErrorPages

构造器详细资料

UndertowServletWebServerFactory

public UndertowServletWebServerFactory()

Create a new UndertowServletWebServerFactory instance.

UndertowServletWebServerFactory

public UndertowServletWebServerFactory(int port)

Create a new UndertowServletWebServerFactory that listens for requests using the specified port.

参数:

port - the port to listen on

UndertowServletWebServerFactory

public UndertowServletWebServerFactory(String contextPath,
 int port)

Create a new UndertowServletWebServerFactory with the specified context path and port.

参数:

contextPath - the root context path

port - the port to listen on

方法详细资料

setBuilderCustomizers

public void setBuilderCustomizers(Collection<? extends UndertowBuilderCustomizer> customizers)

从接口复制的说明: ConfigurableUndertowWebServerFactory

Set UndertowBuilderCustomizers that should be applied to the Undertow Undertow.Builder. Calling this method will replace any existing customizers.

指定者:

setBuilderCustomizers 在接口中 ConfigurableUndertowWebServerFactory

参数:

customizers - the customizers to set

addBuilderCustomizers

public void addBuilderCustomizers(UndertowBuilderCustomizer... customizers)

从接口复制的说明: ConfigurableUndertowWebServerFactory

Add UndertowBuilderCustomizers that should be used to customize the Undertow Undertow.Builder.

指定者:

addBuilderCustomizers 在接口中 ConfigurableUndertowWebServerFactory

参数:

customizers - the customizers to add

getBuilderCustomizers

public Collection<UndertowBuilderCustomizer> getBuilderCustomizers()

Returns a mutable collection of the UndertowBuilderCustomizers that will be applied to the Undertow Undertow.Builder.

返回:

the customizers that will be applied

setBufferSize

public void setBufferSize(Integer bufferSize)

从接口复制的说明: ConfigurableUndertowWebServerFactory

Set the buffer size.

指定者:

setBufferSize 在接口中 ConfigurableUndertowWebServerFactory

参数:

bufferSize - buffer size

setIoThreads

public void setIoThreads(Integer ioThreads)

从接口复制的说明: ConfigurableUndertowWebServerFactory

Set the number of IO Threads.

指定者:

setIoThreads 在接口中 ConfigurableUndertowWebServerFactory

参数:

ioThreads - number of IO Threads

setWorkerThreads

public void setWorkerThreads(Integer workerThreads)

从接口复制的说明: ConfigurableUndertowWebServerFactory

Set the number of Worker Threads.

指定者:

setWorkerThreads 在接口中 ConfigurableUndertowWebServerFactory

参数:

workerThreads - number of Worker Threads

setUseDirectBuffers

public void setUseDirectBuffers(Boolean directBuffers)

从接口复制的说明: ConfigurableUndertowWebServerFactory

Set whether direct buffers should be used.

指定者:

setUseDirectBuffers 在接口中 ConfigurableUndertowWebServerFactory

参数:

directBuffers - whether direct buffers should be used

setAccessLogDirectory

public void setAccessLogDirectory(File accessLogDirectory)

从接口复制的说明: ConfigurableUndertowWebServerFactory

Set the access log directory.

指定者:

setAccessLogDirectory 在接口中 ConfigurableUndertowWebServerFactory

参数:

accessLogDirectory - access log directory

setAccessLogPattern

public void setAccessLogPattern(String accessLogPattern)

从接口复制的说明: ConfigurableUndertowWebServerFactory

Set the access log pattern.

指定者:

setAccessLogPattern 在接口中 ConfigurableUndertowWebServerFactory

参数:

accessLogPattern - access log pattern

setAccessLogPrefix

public void setAccessLogPrefix(String accessLogPrefix)

从接口复制的说明: ConfigurableUndertowWebServerFactory

Set the access log prefix.

指定者:

setAccessLogPrefix 在接口中 ConfigurableUndertowWebServerFactory

参数:

accessLogPrefix - log prefix

getAccessLogPrefix

public String getAccessLogPrefix()

setAccessLogSuffix

public void setAccessLogSuffix(String accessLogSuffix)

从接口复制的说明: ConfigurableUndertowWebServerFactory

Set the access log suffix.

指定者:

setAccessLogSuffix 在接口中 ConfigurableUndertowWebServerFactory

参数:

accessLogSuffix - access log suffix

setAccessLogEnabled

public void setAccessLogEnabled(boolean accessLogEnabled)

从接口复制的说明: ConfigurableUndertowWebServerFactory

Set whether access logs are enabled.

指定者:

setAccessLogEnabled 在接口中 ConfigurableUndertowWebServerFactory

参数:

accessLogEnabled - whether access logs are enabled

isAccessLogEnabled

public boolean isAccessLogEnabled()

setAccessLogRotate

public void setAccessLogRotate(boolean accessLogRotate)

从接口复制的说明: ConfigurableUndertowWebServerFactory

Set whether access logs rotation is enabled.

指定者:

setAccessLogRotate 在接口中 ConfigurableUndertowWebServerFactory

参数:

accessLogRotate - whether access logs rotation is enabled

setUseForwardHeaders

public void setUseForwardHeaders(boolean useForwardHeaders)

从接口复制的说明: ConfigurableUndertowWebServerFactory

Set if x-forward-* headers should be processed.

指定者:

setUseForwardHeaders 在接口中 ConfigurableUndertowWebServerFactory

参数:

useForwardHeaders - if x-forward headers should be used

isUseForwardHeaders

protected final boolean isUseForwardHeaders()

setDeploymentInfoCustomizers

public void setDeploymentInfoCustomizers(Collection<? extends UndertowDeploymentInfoCustomizer> customizers)

Set UndertowDeploymentInfoCustomizers that should be applied to the Undertow DeploymentInfo. Calling this method will replace any existing customizers.

参数:

customizers - the customizers to set

addDeploymentInfoCustomizers

public void addDeploymentInfoCustomizers(UndertowDeploymentInfoCustomizer... customizers)

Add UndertowDeploymentInfoCustomizers that should be used to customize the Undertow DeploymentInfo.

参数:

customizers - the customizers to add

getDeploymentInfoCustomizers

public Collection<UndertowDeploymentInfoCustomizer> getDeploymentInfoCustomizers()

Returns a mutable collection of the UndertowDeploymentInfoCustomizers that will be applied to the Undertow DeploymentInfo.

返回:

the customizers that will be applied

setResourceLoader

public void setResourceLoader(ResourceLoader resourceLoader)

指定者:

setResourceLoader 在接口中 ResourceLoaderAware

isEagerFilterInit

public boolean isEagerFilterInit()

Return if filters should be eagerly initialized.

返回:

true if filters are eagerly initialized, otherwise false.

从以下版本开始:

2.4.0

setEagerFilterInit

public void setEagerFilterInit(boolean eagerFilterInit)

Set whether filters should be eagerly initialized.

参数:

eagerFilterInit - true if filters are eagerly initialized, otherwise false.

从以下版本开始:

2.4.0

isPreservePathOnForward

public boolean isPreservePathOnForward()

Return whether the request path should be preserved on forward.

返回:

true if the path should be preserved when a request is forwarded, otherwise false.

从以下版本开始:

2.4.0

setPreservePathOnForward

public void setPreservePathOnForward(boolean preservePathOnForward)

Set whether the request path should be preserved on forward.

参数:

preservePathOnForward - true if the path should be preserved when a request is forwarded, otherwise false.

从以下版本开始:

2.4.0

getWebServer

public WebServer getWebServer(ServletContextInitializer... initializers)

从接口复制的说明: ServletWebServerFactory

Gets a new fully configured but paused WebServer instance. Clients should not be able to connect to the returned server until WebServer.start() is called (which happens when the ApplicationContext has been fully refreshed).

指定者:

getWebServer 在接口中 ServletWebServerFactory

参数:

initializers - ServletContextInitializers that should be applied as the server starts

返回:

a fully configured and started WebServer

另请参阅:

• WebServer.stop()

getUndertowWebServer

protected UndertowServletWebServer getUndertowWebServer(io.undertow.Undertow.Builder builder,
 io.undertow.servlet.api.DeploymentManager manager,
 int port)

Factory method called to create the UndertowServletWebServer. Subclasses can override this method to return a different UndertowServletWebServer or apply additional processing to the Undertow.Builder and DeploymentManager used to bootstrap Undertow

参数:

builder - the builder

manager - the deployment manager

port - the port that Undertow should listen on

返回:

a new UndertowServletWebServer instance