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

类 AbstractServletWebServerFactory

java.lang.Object

org.springframework.boot.web.server.AbstractConfigurableWebServerFactory

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

所有已实现的接口:

ConfigurableWebServerFactory, ErrorPageRegistry, WebServerFactory, ConfigurableServletWebServerFactory, ServletWebServerFactory, WebListenerRegistry

直接已知子类:

JettyServletWebServerFactory, TomcatServletWebServerFactory, UndertowServletWebServerFactory

public abstract class AbstractServletWebServerFactory
extends AbstractConfigurableWebServerFactory
implements ConfigurableServletWebServerFactory

Abstract base class for ConfigurableServletWebServerFactory implementations.

从以下版本开始:

2.0.0

作者:

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

字段概要

字段

修饰符和类型	字段	说明
protected final Log	logger

构造器概要

构造器

构造器	说明
AbstractServletWebServerFactory()	Create a new AbstractServletWebServerFactory instance.
AbstractServletWebServerFactory(int port)	Create a new AbstractServletWebServerFactory instance with the specified port.
AbstractServletWebServerFactory(String contextPath, int port)	Create a new AbstractServletWebServerFactory instance with the specified context path and port.

方法概要

修饰符和类型	方法	说明
void	addCookieSameSiteSuppliers(CookieSameSiteSupplier... cookieSameSiteSuppliers)	Add CookieSameSiteSuppliers to those that should be used to obtain the Cookie.SameSite attribute of any added cookie.
void	addInitializers(ServletContextInitializer... initializers)	Add ServletContextInitializers to those that should be applied in addition to ServletWebServerFactory.getWebServer(ServletContextInitializer...) parameters.
void	addMimeMappings(MimeMappings mimeMappings)	Adds mime-type mappings.
void	addWebListeners(String... webListenerClassNames)	Adds web listeners that will be registered with the servlet container.
String	getContextPath()	Returns the context path for the web server.
List<CookieSameSiteSupplier>	getCookieSameSiteSuppliers()
String	getDisplayName()
File	getDocumentRoot()	Returns the document root which will be used by the web context to serve static files.
Map<String,String>	getInitParameters()
Jsp	getJsp()
Map<Locale,Charset>	getLocaleCharsetMappings()	Return the Locale to Charset mappings.
MimeMappings	getMimeMappings()	Returns the mime-type mappings.
Session	getSession()
protected final List<URL>	getUrlsOfJarsWithMetaInfResources()
protected final File	getValidDocumentRoot()	Returns the absolute document root when it points to a valid directory, logging a warning and returning null otherwise.
protected final File	getValidSessionStoreDir()
protected final File	getValidSessionStoreDir(boolean mkdirs)
protected final Set<String>	getWebListenerClassNames()
boolean	isRegisterDefaultServlet()	Flag to indicate that the default servlet should be registered.
protected final ServletContextInitializer[]	mergeInitializers(ServletContextInitializer... initializers)	Utility method that can be used by subclasses wishing to combine the specified ServletContextInitializer parameters with those defined in this instance.
void	setContextPath(String contextPath)	Sets the context path for the web server.
void	setCookieSameSiteSuppliers(List<? extends CookieSameSiteSupplier> cookieSameSiteSuppliers)	Sets CookieSameSiteSuppliers that should be used to obtain the Cookie.SameSite attribute of any added cookie.
void	setDisplayName(String displayName)	Sets the display name of the application deployed in the web server.
void	setDocumentRoot(File documentRoot)	Sets the document root directory which will be used by the web context to serve static files.
void	setInitializers(List<? extends ServletContextInitializer> initializers)	Sets ServletContextInitializer that should be applied in addition to ServletWebServerFactory.getWebServer(ServletContextInitializer...) parameters.
void	setInitParameters(Map<String,String> initParameters)	Sets the init parameters that are applied to the container's ServletContext.
void	setJsp(Jsp jsp)	Sets the configuration that will be applied to the server's JSP servlet.
void	setLocaleCharsetMappings(Map<Locale,Charset> localeCharsetMappings)	Sets the Locale to Charset mappings.
void	setMimeMappings(MimeMappings mimeMappings)	Sets the mime-type mappings.
void	setRegisterDefaultServlet(boolean registerDefaultServlet)	Set if the DefaultServlet should be registered.
void	setSession(Session session)	Sets the configuration that will be applied to the container's HTTP session support.
protected boolean	shouldRegisterJspServlet()	Returns whether the JSP servlet should be registered with the web server.

从类继承的方法 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

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

getWebServer

字段详细资料

logger

protected final Log logger

构造器详细资料

AbstractServletWebServerFactory

public AbstractServletWebServerFactory()

Create a new AbstractServletWebServerFactory instance.

AbstractServletWebServerFactory

public AbstractServletWebServerFactory(int port)

Create a new AbstractServletWebServerFactory instance with the specified port.

参数:

port - the port number for the web server

AbstractServletWebServerFactory

public AbstractServletWebServerFactory(String contextPath,
 int port)

Create a new AbstractServletWebServerFactory instance with the specified context path and port.

参数:

contextPath - the context path for the web server

port - the port number for the web server

方法详细资料

getContextPath

public String getContextPath()

Returns the context path for the web server. The path will start with "/" and not end with "/". The root context is represented by an empty string.

返回:

the context path

setContextPath

public void setContextPath(String contextPath)

从接口复制的说明: ConfigurableServletWebServerFactory

Sets the context path for the web server. The context should start with a "/" character but not end with a "/" character. The default context path can be specified using an empty string.

指定者:

setContextPath 在接口中 ConfigurableServletWebServerFactory

参数:

contextPath - the contextPath to set

getDisplayName

public String getDisplayName()

setDisplayName

public void setDisplayName(String displayName)

从接口复制的说明: ConfigurableServletWebServerFactory

Sets the display name of the application deployed in the web server.

指定者:

setDisplayName 在接口中 ConfigurableServletWebServerFactory

参数:

displayName - the displayName to set

isRegisterDefaultServlet

public boolean isRegisterDefaultServlet()

Flag to indicate that the default servlet should be registered.

返回:

true if the default servlet is to be registered

setRegisterDefaultServlet

public void setRegisterDefaultServlet(boolean registerDefaultServlet)

从接口复制的说明: ConfigurableServletWebServerFactory

Set if the DefaultServlet should be registered. Defaults to false since 2.4.

指定者:

setRegisterDefaultServlet 在接口中 ConfigurableServletWebServerFactory

参数:

registerDefaultServlet - if the default servlet should be registered

getMimeMappings

public MimeMappings getMimeMappings()

Returns the mime-type mappings.

返回:

the mimeMappings the mime-type mappings.

setMimeMappings

public void setMimeMappings(MimeMappings mimeMappings)

从接口复制的说明: ConfigurableServletWebServerFactory

Sets the mime-type mappings.

指定者:

setMimeMappings 在接口中 ConfigurableServletWebServerFactory

参数:

mimeMappings - the mime type mappings (defaults to MimeMappings.DEFAULT)

addMimeMappings

public void addMimeMappings(MimeMappings mimeMappings)

从接口复制的说明: ConfigurableServletWebServerFactory

Adds mime-type mappings.

指定者:

addMimeMappings 在接口中 ConfigurableServletWebServerFactory

参数:

mimeMappings - the mime type mappings to add

getDocumentRoot

public File getDocumentRoot()

Returns the document root which will be used by the web context to serve static files.

返回:

the document root

setDocumentRoot

public void setDocumentRoot(File documentRoot)

从接口复制的说明: ConfigurableServletWebServerFactory

Sets the document root directory which will be used by the web context to serve static files.

指定者:

setDocumentRoot 在接口中 ConfigurableServletWebServerFactory

参数:

documentRoot - the document root or null if not required

setInitializers

public void setInitializers(List<? extends ServletContextInitializer> initializers)

从接口复制的说明: ConfigurableServletWebServerFactory

Sets ServletContextInitializer that should be applied in addition to ServletWebServerFactory.getWebServer(ServletContextInitializer...) parameters. This method will replace any previously set or added initializers.

指定者:

setInitializers 在接口中 ConfigurableServletWebServerFactory

参数:

initializers - the initializers to set

另请参阅:

• ConfigurableServletWebServerFactory.addInitializers(org.springframework.boot.web.servlet.ServletContextInitializer...)

addInitializers

public void addInitializers(ServletContextInitializer... initializers)

从接口复制的说明: ConfigurableServletWebServerFactory

Add ServletContextInitializers to those that should be applied in addition to ServletWebServerFactory.getWebServer(ServletContextInitializer...) parameters.

指定者:

addInitializers 在接口中 ConfigurableServletWebServerFactory

参数:

initializers - the initializers to add

另请参阅:

• ConfigurableServletWebServerFactory.setInitializers(java.util.List<? extends org.springframework.boot.web.servlet.ServletContextInitializer>)

getJsp

public Jsp getJsp()

setJsp

public void setJsp(Jsp jsp)

从接口复制的说明: ConfigurableServletWebServerFactory

Sets the configuration that will be applied to the server's JSP servlet.

指定者:

setJsp 在接口中 ConfigurableServletWebServerFactory

参数:

jsp - the JSP servlet configuration

getSession

public Session getSession()

setSession

public void setSession(Session session)

从接口复制的说明: ConfigurableServletWebServerFactory

Sets the configuration that will be applied to the container's HTTP session support.

指定者:

setSession 在接口中 ConfigurableServletWebServerFactory

参数:

session - the session configuration

getLocaleCharsetMappings

public Map<Locale,Charset> getLocaleCharsetMappings()

Return the Locale to Charset mappings.

返回:

the charset mappings

setLocaleCharsetMappings

public void setLocaleCharsetMappings(Map<Locale,Charset> localeCharsetMappings)

从接口复制的说明: ConfigurableServletWebServerFactory

Sets the Locale to Charset mappings.

指定者:

setLocaleCharsetMappings 在接口中 ConfigurableServletWebServerFactory

参数:

localeCharsetMappings - the Locale to Charset mappings

setInitParameters

public void setInitParameters(Map<String,String> initParameters)

从接口复制的说明: ConfigurableServletWebServerFactory

Sets the init parameters that are applied to the container's ServletContext.

指定者:

setInitParameters 在接口中 ConfigurableServletWebServerFactory

参数:

initParameters - the init parameters

getInitParameters

public Map<String,String> getInitParameters()

setCookieSameSiteSuppliers

public void setCookieSameSiteSuppliers(List<? extends CookieSameSiteSupplier> cookieSameSiteSuppliers)

从接口复制的说明: ConfigurableServletWebServerFactory

Sets CookieSameSiteSuppliers that should be used to obtain the Cookie.SameSite attribute of any added cookie. This method will replace any previously set or added suppliers.

指定者:

setCookieSameSiteSuppliers 在接口中 ConfigurableServletWebServerFactory

参数:

cookieSameSiteSuppliers - the suppliers to add

另请参阅:

• ConfigurableServletWebServerFactory.addCookieSameSiteSuppliers(org.springframework.boot.web.servlet.server.CookieSameSiteSupplier...)

addCookieSameSiteSuppliers

public void addCookieSameSiteSuppliers(CookieSameSiteSupplier... cookieSameSiteSuppliers)

从接口复制的说明: ConfigurableServletWebServerFactory

Add CookieSameSiteSuppliers to those that should be used to obtain the Cookie.SameSite attribute of any added cookie.

指定者:

addCookieSameSiteSuppliers 在接口中 ConfigurableServletWebServerFactory

参数:

cookieSameSiteSuppliers - the suppliers to add

另请参阅:

• ConfigurableServletWebServerFactory.setCookieSameSiteSuppliers(java.util.List<? extends org.springframework.boot.web.servlet.server.CookieSameSiteSupplier>)

getCookieSameSiteSuppliers

public List<CookieSameSiteSupplier> getCookieSameSiteSuppliers()

mergeInitializers

protected final ServletContextInitializer[] mergeInitializers(ServletContextInitializer... initializers)

Utility method that can be used by subclasses wishing to combine the specified ServletContextInitializer parameters with those defined in this instance.

参数:

initializers - the initializers to merge

返回:

a complete set of merged initializers (with the specified parameters appearing first)

shouldRegisterJspServlet

protected boolean shouldRegisterJspServlet()

Returns whether the JSP servlet should be registered with the web server.

返回:

true if the servlet should be registered, otherwise false

getValidDocumentRoot

protected final File getValidDocumentRoot()

Returns the absolute document root when it points to a valid directory, logging a warning and returning null otherwise.

返回:

the valid document root

getUrlsOfJarsWithMetaInfResources

protected final List<URL> getUrlsOfJarsWithMetaInfResources()

getValidSessionStoreDir

protected final File getValidSessionStoreDir()

getValidSessionStoreDir

protected final File getValidSessionStoreDir(boolean mkdirs)

addWebListeners

public void addWebListeners(String... webListenerClassNames)

从接口复制的说明: WebListenerRegistry

Adds web listeners that will be registered with the servlet container.

指定者:

addWebListeners 在接口中 WebListenerRegistry

参数:

webListenerClassNames - the class names of the web listeners

getWebListenerClassNames

protected final Set<String> getWebListenerClassNames()