Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractConfigurableWebServerFactory - Class in org.springframework.boot.web.server
-
Abstract base class for
ConfigurableWebServerFactoryimplementations. - AbstractConfigurableWebServerFactory() - Constructor for class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
-
Create a new
AbstractConfigurableWebServerFactoryinstance. - AbstractConfigurableWebServerFactory(int) - Constructor for class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
-
Create a new
AbstractConfigurableWebServerFactoryinstance with the specified port. - AbstractReactiveWebServerFactory - Class in org.springframework.boot.web.server.reactive
-
Abstract base class for
ReactiveWebServerFactoryimplementations. - AbstractReactiveWebServerFactory() - Constructor for class org.springframework.boot.web.server.reactive.AbstractReactiveWebServerFactory
- AbstractReactiveWebServerFactory(int) - Constructor for class org.springframework.boot.web.server.reactive.AbstractReactiveWebServerFactory
- add(String, String) - Method in class org.springframework.boot.web.server.MimeMappings
-
Add a new mime mapping.
- addCookieSameSiteSuppliers(CookieSameSiteSupplier...) - Method in interface org.springframework.boot.web.server.servlet.ConfigurableServletWebServerFactory
-
Add
CookieSameSiteSuppliersto those that should be used to obtain theCookie.SameSiteattribute of any added cookie. - addCookieSameSiteSuppliers(CookieSameSiteSupplier...) - Method in class org.springframework.boot.web.server.servlet.ServletWebServerSettings
- addErrorPages(ErrorPage...) - Method in class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
- addInitializers(ServletContextInitializer...) - Method in interface org.springframework.boot.web.server.servlet.ConfigurableServletWebServerFactory
-
Add
ServletContextInitializers to those that should be applied in addition toServletWebServerFactory.getWebServer(ServletContextInitializer...)parameters. - addInitializers(ServletContextInitializer...) - Method in class org.springframework.boot.web.server.servlet.ServletWebServerSettings
- addMimeMappings(MimeMappings) - Method in interface org.springframework.boot.web.server.servlet.ConfigurableServletWebServerFactory
-
Adds mime-type mappings.
- addMimeMappings(MimeMappings) - Method in class org.springframework.boot.web.server.servlet.ServletWebServerSettings
- addWebListenerClassNames(String...) - Method in class org.springframework.boot.web.server.servlet.ServletWebServerSettings
- addWebListeners(String...) - Method in interface org.springframework.boot.web.server.servlet.ConfigurableServletWebServerFactory
- addWebListeners(String...) - Method in interface org.springframework.boot.web.server.servlet.WebListenerRegistry
-
Adds web listeners that will be registered with the servlet web server.
- AnnotationConfigReactiveWebServerApplicationContext - Class in org.springframework.boot.web.server.reactive.context
-
ReactiveWebServerApplicationContextthat accepts annotated classes as input - in particular@Configuration-annotated classes, but also plain@Componentclasses and JSR-330 compliant classes usingjavax.injectannotations. - AnnotationConfigReactiveWebServerApplicationContext() - Constructor for class org.springframework.boot.web.server.reactive.context.AnnotationConfigReactiveWebServerApplicationContext
-
Create a new
AnnotationConfigReactiveWebServerApplicationContextthat needs to be populated throughAnnotationConfigReactiveWebServerApplicationContext.register(java.lang.Class<?>...)calls and then manually refreshed. - AnnotationConfigReactiveWebServerApplicationContext(Class<?>...) - Constructor for class org.springframework.boot.web.server.reactive.context.AnnotationConfigReactiveWebServerApplicationContext
-
Create a new
AnnotationConfigReactiveWebServerApplicationContext, deriving bean definitions from the given annotated classes and automatically refreshing the context. - AnnotationConfigReactiveWebServerApplicationContext(String...) - Constructor for class org.springframework.boot.web.server.reactive.context.AnnotationConfigReactiveWebServerApplicationContext
-
Create a new
AnnotationConfigReactiveWebServerApplicationContext, scanning for bean definitions in the given packages and automatically refreshing the context. - AnnotationConfigReactiveWebServerApplicationContext(DefaultListableBeanFactory) - Constructor for class org.springframework.boot.web.server.reactive.context.AnnotationConfigReactiveWebServerApplicationContext
-
Create a new
AnnotationConfigReactiveWebServerApplicationContextwith the givenDefaultListableBeanFactory. - AnnotationConfigServletWebServerApplicationContext - Class in org.springframework.boot.web.server.servlet.context
-
ServletWebServerApplicationContextthat accepts annotated classes as input - in particular@Configuration-annotated classes, but also plain@Componentclasses and JSR-330 compliant classes usingjavax.injectannotations. - AnnotationConfigServletWebServerApplicationContext() - Constructor for class org.springframework.boot.web.server.servlet.context.AnnotationConfigServletWebServerApplicationContext
-
Create a new
AnnotationConfigServletWebServerApplicationContextthat needs to be populated throughAnnotationConfigServletWebServerApplicationContext.register(java.lang.Class<?>...)calls and then manually refreshed. - AnnotationConfigServletWebServerApplicationContext(Class<?>...) - Constructor for class org.springframework.boot.web.server.servlet.context.AnnotationConfigServletWebServerApplicationContext
-
Create a new
AnnotationConfigServletWebServerApplicationContext, deriving bean definitions from the given annotated classes and automatically refreshing the context. - AnnotationConfigServletWebServerApplicationContext(String...) - Constructor for class org.springframework.boot.web.server.servlet.context.AnnotationConfigServletWebServerApplicationContext
-
Create a new
AnnotationConfigServletWebServerApplicationContext, scanning for bean definitions in the given packages and automatically refreshing the context. - AnnotationConfigServletWebServerApplicationContext(DefaultListableBeanFactory) - Constructor for class org.springframework.boot.web.server.servlet.context.AnnotationConfigServletWebServerApplicationContext
-
Create a new
AnnotationConfigServletWebServerApplicationContextwith the givenDefaultListableBeanFactory. - attributeValue() - Method in enum class org.springframework.boot.web.server.Cookie.SameSite
B
- basePackageClasses() - Element in annotation interface org.springframework.boot.web.server.servlet.context.ServletComponentScan
-
Type-safe alternative to
ServletComponentScan.basePackages()for specifying the packages to scan for annotated servlet components. - basePackages() - Element in annotation interface org.springframework.boot.web.server.servlet.context.ServletComponentScan
-
Base packages to scan for annotated servlet components.
- BeanPostProcessorsRegistrar() - Constructor for class org.springframework.boot.web.server.autoconfigure.reactive.ReactiveWebServerConfiguration.BeanPostProcessorsRegistrar
- bundle() - Method in record class org.springframework.boot.web.server.Ssl.ServerNameSslBundle
-
Returns the value of the
bundlerecord component.
C
- Compression - Class in org.springframework.boot.web.server
-
Simple server-independent abstraction for compression configuration.
- Compression() - Constructor for class org.springframework.boot.web.server.Compression
- ConfigurableReactiveWebServerFactory - Interface in org.springframework.boot.web.server.reactive
-
Configurable
ReactiveWebServerFactory. - ConfigurableServletWebServerFactory - Interface in org.springframework.boot.web.server.servlet
-
A configurable
ServletWebServerFactory. - ConfigurableWebServerApplicationContext - Interface in org.springframework.boot.web.server.context
-
SPI interface to be implemented by most if not all
web server application contexts. - ConfigurableWebServerFactory - Interface in org.springframework.boot.web.server
-
A configurable
WebServerFactory. - ContextPath - Class in org.springframework.boot.web.server.servlet
-
The context path of a servlet web server.
- Cookie - Class in org.springframework.boot.web.server
-
Cookie properties.
- Cookie() - Constructor for class org.springframework.boot.web.server.Cookie
- COOKIE - Enum constant in enum class org.springframework.boot.web.server.servlet.Session.SessionTrackingMode
-
Send a cookie in response to the client's first request.
- Cookie.SameSite - Enum Class in org.springframework.boot.web.server
-
SameSite values.
- CookieSameSiteSupplier - Interface in org.springframework.boot.web.server.servlet
-
Strategy interface that can be used with
ConfigurableServletWebServerFactoryimplementations in order to supply customCookie.SameSitevalues for specificcookies. - createTempDir(String) - Method in class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
-
Return the absolute temp dir for given web server.
- customize(ConfigurableReactiveWebServerFactory) - Method in class org.springframework.boot.web.server.autoconfigure.reactive.ReactiveWebServerFactoryCustomizer
- customize(ConfigurableServletWebServerFactory) - Method in class org.springframework.boot.web.server.autoconfigure.servlet.ServletWebServerFactoryCustomizer
- customize(ForwardedHeaderFilter) - Method in interface org.springframework.boot.web.server.autoconfigure.servlet.ForwardedHeaderFilterCustomizer
-
Customizes the given
filter. - customize(T) - Method in interface org.springframework.boot.web.server.WebServerFactoryCustomizer
-
Customize the specified
WebServerFactory.
D
- DEFAULT - Static variable in class org.springframework.boot.web.server.MimeMappings
-
Default mime mapping commonly used.
- DEFAULT - Static variable in class org.springframework.boot.web.server.servlet.ContextPath
-
The default context path.
- destroy() - Method in interface org.springframework.boot.web.server.WebServer
-
Destroys the web server such that it cannot be started again.
- DISPATCHER_SERVLET_NAME - Static variable in class org.springframework.boot.web.server.servlet.context.ServletWebServerApplicationContext
-
Constant value for the DispatcherServlet bean name.
- doClose() - Method in class org.springframework.boot.web.server.reactive.context.ReactiveWebServerApplicationContext
- doClose() - Method in class org.springframework.boot.web.server.servlet.context.ServletWebServerApplicationContext
- DocumentRoot - Class in org.springframework.boot.web.server.servlet
-
Manages a
ServletWebServerFactorydocument root. - DocumentRoot(Log) - Constructor for class org.springframework.boot.web.server.servlet.DocumentRoot
E
- Encoding() - Constructor for class org.springframework.boot.web.server.autoconfigure.ServerProperties.Encoding
- equals(Object) - Method in class org.springframework.boot.web.server.MimeMappings
- equals(Object) - Method in class org.springframework.boot.web.server.MimeMappings.Mapping
- equals(Object) - Method in record class org.springframework.boot.web.server.Ssl.ServerNameSslBundle
-
Indicates whether some other object is "equal to" this one.
- ExistingWebApplicationScopes(ConfigurableListableBeanFactory) - Constructor for class org.springframework.boot.web.server.servlet.context.ServletWebServerApplicationContext.ExistingWebApplicationScopes
F
- forBundle(String) - Static method in class org.springframework.boot.web.server.Ssl
-
Factory method to create an
Sslinstance for a specific bundle name. - ForwardedHeaderFilterCustomizer - Interface in org.springframework.boot.web.server.autoconfigure.servlet
-
Customizer for the auto-configured
ForwardedHeaderFilter. - forwardedHeaderTransformer() - Method in class org.springframework.boot.web.server.autoconfigure.reactive.ReactiveWebServerConfiguration
- FRAMEWORK - Enum constant in enum class org.springframework.boot.web.server.autoconfigure.ServerProperties.ForwardHeadersStrategy
-
Use Spring's support for handling forwarded headers.
- from(ServletWebServerSettings, ServletContextInitializer...) - Static method in class org.springframework.boot.web.server.servlet.ServletContextInitializers
-
Creates a new instance from the given
settingsandinitializers.
G
- get(String) - Method in class org.springframework.boot.web.server.MimeMappings
-
Get a mime mapping for the given extension.
- get(Ssl, SslBundles) - Static method in class org.springframework.boot.web.server.WebServerSslBundle
-
Get the
SslBundlethat should be used for the givenSslinstance. - get(Ssl) - Static method in class org.springframework.boot.web.server.WebServerSslBundle
-
Get the
SslBundlethat should be used for the givenSslinstance. - getAddress() - Method in class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
-
Return the address that the web server binds to.
- getAddress() - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties
- getAll() - Method in class org.springframework.boot.web.server.MimeMappings
-
Returns all defined mappings.
- getApplicationContext() - Method in class org.springframework.boot.web.server.context.WebServerInitializedEvent
-
Access the application context that the server was created in.
- getApplicationContext() - Method in class org.springframework.boot.web.server.reactive.context.ReactiveWebServerInitializedEvent
- getApplicationContext() - Method in class org.springframework.boot.web.server.servlet.context.ServletWebServerInitializedEvent
-
Access the application context that the server was created in.
- getApplicationDisplayName() - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties.Servlet
- getBundle() - Method in class org.springframework.boot.web.server.Ssl
-
Return the name of the SSL bundle to use.
- getCertificate() - Method in class org.springframework.boot.web.server.Ssl
-
Return the location of the certificate in PEM format.
- getCertificatePrivateKey() - Method in class org.springframework.boot.web.server.Ssl
-
Return the location of the private key for the certificate in PEM format.
- getCiphers() - Method in class org.springframework.boot.web.server.Ssl
-
Return the supported SSL ciphers.
- getClassName() - Method in class org.springframework.boot.web.server.servlet.Jsp
-
Return the class name of the servlet to use for JSPs.
- getClientAuth() - Method in class org.springframework.boot.web.server.Ssl
-
Return Whether client authentication is not wanted ("none"), wanted ("want") or needed ("need").
- getCompression() - Method in class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
- getCompression() - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties
- getContextParameters() - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties.Servlet
- getContextPath() - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties.Servlet
- getContextPath() - Method in interface org.springframework.boot.web.server.servlet.ConfigurableServletWebServerFactory
-
Returns the context path for the servlet web server.
- getContextPath() - Method in class org.springframework.boot.web.server.servlet.ServletWebServerSettings
- getCookie() - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties.Reactive.Session
- getCookie() - Method in class org.springframework.boot.web.server.servlet.Session
- getCookieSameSiteSuppliers() - Method in class org.springframework.boot.web.server.servlet.ServletWebServerSettings
- getDisplayName() - Method in class org.springframework.boot.web.server.servlet.ServletWebServerSettings
- getDocumentRoot() - Method in class org.springframework.boot.web.server.servlet.ServletWebServerSettings
- getDomain() - Method in class org.springframework.boot.web.server.Cookie
- getEnabled() - Method in class org.springframework.boot.web.server.Compression
-
Return whether response compression is enabled.
- getEnabledProtocols() - Method in class org.springframework.boot.web.server.Ssl
-
Return the enabled SSL protocols.
- getEncoding() - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties.Servlet
- getError() - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties
- getErrorPages() - Method in class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
-
Returns a mutable set of
ErrorPagesthat will be used when handling exceptions. - getExcludedUserAgents() - Method in class org.springframework.boot.web.server.Compression
- getExtension() - Method in class org.springframework.boot.web.server.MimeMappings.Mapping
- getForwardHeadersStrategy() - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties
- getHttp2() - Method in class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
- getHttp2() - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties
- getHttpHandler() - Method in class org.springframework.boot.web.server.reactive.context.ReactiveWebServerApplicationContext
-
Return the
HttpHandlerthat should be used to process the reactive web server. - getHttpOnly() - Method in class org.springframework.boot.web.server.Cookie
- getInitializers() - Method in class org.springframework.boot.web.server.servlet.ServletWebServerSettings
- getInitParameters() - Method in class org.springframework.boot.web.server.servlet.Jsp
-
Return the init parameters used to configure the JSP servlet.
- getInitParameters() - Method in class org.springframework.boot.web.server.servlet.ServletWebServerSettings
- getJsp() - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties.Servlet
- getJsp() - Method in class org.springframework.boot.web.server.servlet.ServletWebServerSettings
- getKey() - Method in class org.springframework.boot.web.server.WebServerSslBundle
- getKeyAlias() - Method in class org.springframework.boot.web.server.Ssl
-
Return the alias that identifies the key in the key store.
- getKeyPassword() - Method in class org.springframework.boot.web.server.Ssl
-
Return the password used to access the key in the key store.
- getKeyStore() - Method in class org.springframework.boot.web.server.Ssl
-
Return the path to the key store that holds the SSL certificate (typically a jks file).
- getKeyStorePassword() - Method in class org.springframework.boot.web.server.Ssl
-
Return the password used to access the key store.
- getKeyStoreProvider() - Method in class org.springframework.boot.web.server.Ssl
-
Return the provider for the key store.
- getKeyStoreType() - Method in class org.springframework.boot.web.server.Ssl
-
Return the type of the key store.
- getLocaleCharsetMappings() - Method in class org.springframework.boot.web.server.servlet.ServletWebServerSettings
- getManagers() - Method in class org.springframework.boot.web.server.WebServerSslBundle
- getMapping() - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties.Encoding
- getMaxAge() - Method in class org.springframework.boot.web.server.Cookie
- getMaxHttpRequestHeaderSize() - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties
- getMaxSessions() - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties.Reactive.Session
- getMimeMappings() - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties
- getMimeMappings() - Method in class org.springframework.boot.web.server.servlet.ServletWebServerSettings
- getMimeType() - Method in class org.springframework.boot.web.server.MimeMappings.Mapping
- getMimeTypes() - Method in class org.springframework.boot.web.server.Compression
-
Return the MIME types that should be compressed.
- getMinResponseSize() - Method in class org.springframework.boot.web.server.Compression
-
Return the minimum "Content-Length" value that is required for compression to be performed.
- getName() - Method in class org.springframework.boot.web.server.Cookie
- getOptions() - Method in class org.springframework.boot.web.server.WebServerSslBundle
- getOrder() - Method in class org.springframework.boot.web.server.autoconfigure.reactive.ReactiveWebServerFactoryCustomizer
- getOrder() - Method in class org.springframework.boot.web.server.autoconfigure.servlet.ServletWebServerFactoryCustomizer
- getPartitioned() - Method in class org.springframework.boot.web.server.Cookie
- getPath() - Method in class org.springframework.boot.web.server.Cookie
- getPhase() - Method in class org.springframework.boot.web.server.context.WebServerGracefulShutdownLifecycle
- getPort() - Method in class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
-
The port that the web server listens on.
- getPort() - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties
- getPort() - Method in exception class org.springframework.boot.web.server.PortInUseException
-
Returns the port that was in use.
- getPort() - Method in interface org.springframework.boot.web.server.WebServer
-
Return the port this server is listening on.
- getPortFile(ApplicationContext) - Method in class org.springframework.boot.web.server.context.WebServerPortFileWriter
-
Return the actual port file that should be written for the given application context.
- getProtocol() - Method in class org.springframework.boot.web.server.Ssl
-
Return the SSL protocol to use.
- getProtocol() - Method in class org.springframework.boot.web.server.WebServerSslBundle
- getReactive() - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties
- getRegistered() - Method in class org.springframework.boot.web.server.servlet.Jsp
-
Return whether the JSP servlet is registered.
- getResourceByPath(String) - Method in class org.springframework.boot.web.server.servlet.context.ServletWebServerApplicationContext
- getSameSite() - Method in class org.springframework.boot.web.server.Cookie
- getSameSite(Cookie) - Method in interface org.springframework.boot.web.server.servlet.CookieSameSiteSupplier
-
Get the
Cookie.SameSitevalues that should be used for the givenCookie. - getSecure() - Method in class org.springframework.boot.web.server.Cookie
- getServerHeader() - Method in class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
- getServerHeader() - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties
- getServerNameBundles() - Method in class org.springframework.boot.web.server.Ssl
-
Return the mapping of host names to SSL bundles for SNI configuration.
- getServerNamespace() - Method in interface org.springframework.boot.web.server.context.WebServerApplicationContext
-
Returns the namespace of the web server application context or
nullif no namespace has been set. - getServerNamespace() - Method in class org.springframework.boot.web.server.reactive.context.ReactiveWebServerApplicationContext
- getServerNamespace() - Method in class org.springframework.boot.web.server.servlet.context.ServletWebServerApplicationContext
- getServerNamespace(ApplicationContext) - Static method in interface org.springframework.boot.web.server.context.WebServerApplicationContext
-
Returns the server namespace if the specified context is a
WebServerApplicationContext. - getServerNameSslBundles() - Method in class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
- getServlet() - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties
- getServletConfig() - Method in class org.springframework.boot.web.server.servlet.context.ServletWebServerApplicationContext
- getServletConfig() - Method in class org.springframework.boot.web.server.servlet.context.WebApplicationContextServletContextAwareProcessor
- getServletContext() - Method in class org.springframework.boot.web.server.servlet.context.WebApplicationContextServletContextAwareProcessor
- getSession() - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties.Reactive
- getSession() - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties.Servlet
- getSession() - Method in class org.springframework.boot.web.server.servlet.ServletWebServerSettings
- getSessionStoreDirectory() - Method in class org.springframework.boot.web.server.servlet.Session
- getSettings() - Method in interface org.springframework.boot.web.server.servlet.ConfigurableServletWebServerFactory
- getShutdown() - Method in class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
-
Returns the shutdown configuration that will be applied to the server.
- getShutdown() - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties
- getSource() - Method in class org.springframework.boot.web.server.context.WebServerInitializedEvent
-
Access the source of the event (an
WebServer). - getSsl() - Method in class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
- getSsl() - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties
- getSslBundle() - Method in class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
-
Return the
SslBundlethat should be used with this server. - getSslBundles() - Method in class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
-
Return the configured
SslBundles. - getStaticResourceUrls() - Method in class org.springframework.boot.web.server.servlet.ServletWebServerSettings
- getStoreDir() - Method in class org.springframework.boot.web.server.servlet.Session
-
Return the directory used to store session data.
- getStores() - Method in class org.springframework.boot.web.server.WebServerSslBundle
- getTimeout() - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties.Reactive.Session
- getTimeout() - Method in class org.springframework.boot.web.server.servlet.Session
- getTrackingModes() - Method in class org.springframework.boot.web.server.servlet.Session
-
Return the
session tracking modes. - getTrustCertificate() - Method in class org.springframework.boot.web.server.Ssl
-
Return the location of the trust certificate authority chain in PEM format.
- getTrustCertificatePrivateKey() - Method in class org.springframework.boot.web.server.Ssl
-
Return the location of the private key for the trust certificate in PEM format.
- getTrustStore() - Method in class org.springframework.boot.web.server.Ssl
-
Return the trust store that holds SSL certificates.
- getTrustStorePassword() - Method in class org.springframework.boot.web.server.Ssl
-
Return the password used to access the trust store.
- getTrustStoreProvider() - Method in class org.springframework.boot.web.server.Ssl
-
Return the provider for the trust store.
- getTrustStoreType() - Method in class org.springframework.boot.web.server.Ssl
-
Return the type of the trust store.
- getValidDirectory() - Method in class org.springframework.boot.web.server.servlet.DocumentRoot
-
Returns the absolute document root when it points to a valid directory, logging a warning and returning
nullotherwise. - getValidDirectory(boolean) - Method in class org.springframework.boot.web.server.servlet.SessionStoreDirectory
- getWebApplicationType() - Method in exception class org.springframework.boot.web.server.context.MissingWebServerFactoryBeanException
-
Returns the type of web application for which a
WebServerFactorybean was missing. - getWebListenerClassNames() - Method in class org.springframework.boot.web.server.servlet.ServletWebServerSettings
- getWebServer() - Method in interface org.springframework.boot.web.server.context.WebServerApplicationContext
-
Returns the
WebServerthat was created by the context ornullif the server has not yet been created. - getWebServer() - Method in class org.springframework.boot.web.server.context.WebServerInitializedEvent
-
Access the
WebServer. - getWebServer() - Method in class org.springframework.boot.web.server.reactive.context.ReactiveWebServerApplicationContext
-
Returns the
WebServerthat was created by the context ornullif the server has not yet been created. - getWebServer() - Method in class org.springframework.boot.web.server.servlet.context.ServletWebServerApplicationContext
-
Returns the
WebServerthat was created by the context ornullif the server has not yet been created. - getWebServer(ServletContextInitializer...) - Method in interface org.springframework.boot.web.server.servlet.ServletWebServerFactory
-
Gets a new fully configured but paused
WebServerinstance. - getWebServer(HttpHandler) - Method in interface org.springframework.boot.web.server.reactive.ReactiveWebServerFactory
-
Gets a new fully configured but paused
WebServerinstance. - getWebServerFactory() - Method in class org.springframework.boot.web.server.servlet.context.ServletWebServerApplicationContext
-
Returns the
ServletWebServerFactorythat should be used to create the embeddedWebServer. - getWebServerFactory(String) - Method in class org.springframework.boot.web.server.reactive.context.ReactiveWebServerApplicationContext
- getWebServerFactoryBeanName() - Method in class org.springframework.boot.web.server.reactive.context.ReactiveWebServerApplicationContext
- GRACEFUL - Enum constant in enum class org.springframework.boot.web.server.Shutdown
-
The
WebServershould support graceful shutdown, allowing active requests time to complete. - GRACEFUL_SHUTDOWN_PHASE - Static variable in interface org.springframework.boot.web.server.context.WebServerApplicationContext
-
SmartLifecycle phasein which graceful shutdown of the web server is performed. - GracefulShutdownCallback - Interface in org.springframework.boot.web.server
-
A callback for the result of a graceful shutdown request.
- GracefulShutdownResult - Enum Class in org.springframework.boot.web.server
-
The result of a graceful shutdown request.
H
- hashCode() - Method in class org.springframework.boot.web.server.MimeMappings
- hashCode() - Method in class org.springframework.boot.web.server.MimeMappings.Mapping
- hashCode() - Method in record class org.springframework.boot.web.server.Ssl.ServerNameSslBundle
-
Returns a hash code value for this object.
- hasServerNamespace(ApplicationContext, String) - Static method in interface org.springframework.boot.web.server.context.WebServerApplicationContext
-
Returns
trueif the specified context is aWebServerApplicationContextwith a matching server namespace. - Http2 - Class in org.springframework.boot.web.server
-
Simple server-independent abstraction for HTTP/2 configuration.
- Http2() - Constructor for class org.springframework.boot.web.server.Http2
I
- IDLE - Enum constant in enum class org.springframework.boot.web.server.GracefulShutdownResult
-
The server was idle with no active requests at the end of the grace period.
- ifCausedBy(Exception, Class<E>, Consumer<E>) - Static method in exception class org.springframework.boot.web.server.PortInUseException
-
Perform an action if the given exception was caused by a specific exception type.
- ifPortBindingException(Exception, Consumer<BindException>) - Static method in exception class org.springframework.boot.web.server.PortInUseException
-
Perform an action if the given exception was caused by a "port in use"
BindException. - IMMEDIATE - Enum constant in enum class org.springframework.boot.web.server.GracefulShutdownResult
-
The server was shutdown immediately, ignoring any active requests.
- IMMEDIATE - Enum constant in enum class org.springframework.boot.web.server.Shutdown
-
The
WebServershould shut down immediately. - initialize(ConfigurableApplicationContext) - Method in class org.springframework.boot.web.server.context.ServerPortInfoApplicationContextInitializer
- isEnabled() - Method in class org.springframework.boot.web.server.Http2
-
Return whether to enable HTTP/2 support, if the current environment supports it.
- isEnabled() - Method in class org.springframework.boot.web.server.Ssl
-
Return whether to enable SSL support.
- isEnabled(Ssl) - Static method in class org.springframework.boot.web.server.Ssl
-
Returns if SSL is enabled for the given instance.
- isPauseable() - Method in class org.springframework.boot.web.server.context.WebServerGracefulShutdownLifecycle
- isPersistent() - Method in class org.springframework.boot.web.server.servlet.Session
-
Return whether to persist session data between restarts.
- isRegisterDefaultServlet() - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties.Servlet
- isRegisterDefaultServlet() - Method in class org.springframework.boot.web.server.servlet.ServletWebServerSettings
- isRunning() - Method in class org.springframework.boot.web.server.context.WebServerGracefulShutdownLifecycle
- iterator() - Method in class org.springframework.boot.web.server.MimeMappings
- iterator() - Method in class org.springframework.boot.web.server.servlet.ServletContextInitializers
J
- Jsp - Class in org.springframework.boot.web.server.servlet
-
Configuration for the server's JSP servlet.
- Jsp() - Constructor for class org.springframework.boot.web.server.servlet.Jsp
L
- LAX - Enum constant in enum class org.springframework.boot.web.server.Cookie.SameSite
-
SameSite attribute will be set to Lax.
- lazyCopy(MimeMappings) - Static method in class org.springframework.boot.web.server.MimeMappings
-
Create a new lazy copy of the given mappings that will only copy entries if the mappings are mutated.
- load(Class<?>, String...) - Method in class org.springframework.boot.web.server.servlet.context.XmlServletWebServerApplicationContext
-
Load bean definitions from the given XML resources.
- load(String...) - Method in class org.springframework.boot.web.server.servlet.context.XmlServletWebServerApplicationContext
-
Load bean definitions from the given XML resources.
- load(Resource...) - Method in class org.springframework.boot.web.server.servlet.context.XmlServletWebServerApplicationContext
-
Load bean definitions from the given XML resources.
M
- map(Ssl.ClientAuth, R, R, R) - Static method in enum class org.springframework.boot.web.server.Ssl.ClientAuth
-
Map an optional
Ssl.ClientAuthvalue to a different type. - Mapping(String, String) - Constructor for class org.springframework.boot.web.server.MimeMappings.Mapping
- MimeMappings - Class in org.springframework.boot.web.server
-
Simple server-independent abstraction for mime mappings.
- MimeMappings() - Constructor for class org.springframework.boot.web.server.MimeMappings
-
Create a new empty
MimeMappingsinstance. - MimeMappings(Map<String, String>) - Constructor for class org.springframework.boot.web.server.MimeMappings
-
Create a new
MimeMappingsfrom the specified mappings. - MimeMappings(MimeMappings) - Constructor for class org.springframework.boot.web.server.MimeMappings
-
Create a new
MimeMappingsinstance from the specified mappings. - MimeMappings.Mapping - Class in org.springframework.boot.web.server
-
A single mime mapping.
- MissingWebServerFactoryBeanException - Exception Class in org.springframework.boot.web.server.context
-
Exception thrown when there is no
WebServerFactorybean of the required type defined in aWebServerApplicationContext. - MissingWebServerFactoryBeanException(Class<? extends WebServerApplicationContext>, Class<? extends WebServerFactory>, WebApplicationType) - Constructor for exception class org.springframework.boot.web.server.context.MissingWebServerFactoryBeanException
-
Create a new
MissingWebServerFactoryBeanException.
N
- NATIVE - Enum constant in enum class org.springframework.boot.web.server.autoconfigure.ServerProperties.ForwardHeadersStrategy
-
Use the underlying container's native support for forwarded headers.
- NEED - Enum constant in enum class org.springframework.boot.web.server.Ssl.ClientAuth
-
Client authentication is needed and mandatory.
- NONE - Enum constant in enum class org.springframework.boot.web.server.autoconfigure.ServerProperties.ForwardHeadersStrategy
-
Ignore X-Forwarded-* headers.
- NONE - Enum constant in enum class org.springframework.boot.web.server.Cookie.SameSite
-
SameSite attribute will be set to None.
- NONE - Enum constant in enum class org.springframework.boot.web.server.Ssl.ClientAuth
-
Client authentication is not wanted.
O
- of(String) - Static method in class org.springframework.boot.web.server.servlet.ContextPath
- of(Cookie.SameSite) - Static method in interface org.springframework.boot.web.server.servlet.CookieSameSiteSupplier
-
Return a new
CookieSameSiteSupplierthat always returns the givenCookie.SameSitevalue. - ofLax() - Static method in interface org.springframework.boot.web.server.servlet.CookieSameSiteSupplier
-
Return a new
CookieSameSiteSupplierthat always returnsCookie.SameSite.LAX. - ofNone() - Static method in interface org.springframework.boot.web.server.servlet.CookieSameSiteSupplier
-
Return a new
CookieSameSiteSupplierthat always returnsCookie.SameSite.NONE. - ofStrict() - Static method in interface org.springframework.boot.web.server.servlet.CookieSameSiteSupplier
-
Return a new
CookieSameSiteSupplierthat always returnsCookie.SameSite.STRICT. - OMITTED - Enum constant in enum class org.springframework.boot.web.server.Cookie.SameSite
-
SameSite attribute will be omitted when creating the cookie.
- onApplicationEvent(WebServerInitializedEvent) - Method in class org.springframework.boot.web.server.context.ServerPortInfoApplicationContextInitializer
- onApplicationEvent(WebServerInitializedEvent) - Method in class org.springframework.boot.web.server.context.WebServerPortFileWriter
- onRefresh() - Method in class org.springframework.boot.web.server.reactive.context.ReactiveWebServerApplicationContext
- onRefresh() - Method in class org.springframework.boot.web.server.servlet.context.ServletWebServerApplicationContext
- org.springframework.boot.web.server - package org.springframework.boot.web.server
-
Support for embedded web servers.
- org.springframework.boot.web.server.autoconfigure - package org.springframework.boot.web.server.autoconfigure
-
Classes related to the auto-configuration of a web server.
- org.springframework.boot.web.server.autoconfigure.reactive - package org.springframework.boot.web.server.autoconfigure.reactive
-
Classes related to the auto-configuration of a reactive web server.
- org.springframework.boot.web.server.autoconfigure.servlet - package org.springframework.boot.web.server.autoconfigure.servlet
-
Classes related to the auto-configuration of a servlet web server.
- org.springframework.boot.web.server.context - package org.springframework.boot.web.server.context
-
Web integrations with Spring's
ApplicationContext. - org.springframework.boot.web.server.reactive - package org.springframework.boot.web.server.reactive
-
Reactive web server abstractions.
- org.springframework.boot.web.server.reactive.context - package org.springframework.boot.web.server.reactive.context
-
Reactive web server based integrations with Spring's
ApplicationContext. - org.springframework.boot.web.server.servlet - package org.springframework.boot.web.server.servlet
-
Servlet web server abstractions.
- org.springframework.boot.web.server.servlet.context - package org.springframework.boot.web.server.servlet.context
-
Servlet web server based web integrations with Spring's
WebApplicationContext.
P
- PortInUseException - Exception Class in org.springframework.boot.web.server
-
A
PortInUseExceptionis thrown when a web server fails to start due to a port already being in use. - PortInUseException(int) - Constructor for exception class org.springframework.boot.web.server.PortInUseException
-
Creates a new port in use exception for the given
port. - PortInUseException(int, Throwable) - Constructor for exception class org.springframework.boot.web.server.PortInUseException
-
Creates a new port in use exception for the given
port. - postProcessAfterInitialization(Object, String) - Method in class org.springframework.boot.web.server.WebServerFactoryCustomizerBeanPostProcessor
- postProcessBeanFactory(ConfigurableListableBeanFactory) - Method in class org.springframework.boot.web.server.reactive.context.AnnotationConfigReactiveWebServerApplicationContext
- postProcessBeanFactory(ConfigurableListableBeanFactory) - Method in class org.springframework.boot.web.server.servlet.context.AnnotationConfigServletWebServerApplicationContext
- postProcessBeanFactory(ConfigurableListableBeanFactory) - Method in class org.springframework.boot.web.server.servlet.context.ServletWebServerApplicationContext
-
Register ServletContextAwareProcessor.
- postProcessBeforeInitialization(Object, String) - Method in class org.springframework.boot.web.server.WebServerFactoryCustomizerBeanPostProcessor
- prepareRefresh() - Method in class org.springframework.boot.web.server.reactive.context.AnnotationConfigReactiveWebServerApplicationContext
- prepareRefresh() - Method in class org.springframework.boot.web.server.servlet.context.AnnotationConfigServletWebServerApplicationContext
R
- Reactive() - Constructor for class org.springframework.boot.web.server.autoconfigure.ServerProperties.Reactive
- ReactiveWebServerApplicationContext - Class in org.springframework.boot.web.server.reactive.context
-
A
GenericReactiveWebApplicationContextthat can be used to bootstrap itself from a containedReactiveWebServerFactorybean. - ReactiveWebServerApplicationContext() - Constructor for class org.springframework.boot.web.server.reactive.context.ReactiveWebServerApplicationContext
-
Create a new
ReactiveWebServerApplicationContext. - ReactiveWebServerApplicationContext(DefaultListableBeanFactory) - Constructor for class org.springframework.boot.web.server.reactive.context.ReactiveWebServerApplicationContext
-
Create a new
ReactiveWebServerApplicationContextwith the givenDefaultListableBeanFactory. - ReactiveWebServerConfiguration - Class in org.springframework.boot.web.server.autoconfigure.reactive
-
Configurationfor a reactive web server. - ReactiveWebServerConfiguration() - Constructor for class org.springframework.boot.web.server.autoconfigure.reactive.ReactiveWebServerConfiguration
- ReactiveWebServerConfiguration.BeanPostProcessorsRegistrar - Class in org.springframework.boot.web.server.autoconfigure.reactive
-
Registers a
WebServerFactoryCustomizerBeanPostProcessor. - ReactiveWebServerFactory - Interface in org.springframework.boot.web.server.reactive
-
Factory interface that can be used to create a reactive
WebServer. - reactiveWebServerFactoryCustomizer(ServerProperties, ObjectProvider<SslBundles>) - Method in class org.springframework.boot.web.server.autoconfigure.reactive.ReactiveWebServerConfiguration
- ReactiveWebServerFactoryCustomizer - Class in org.springframework.boot.web.server.autoconfigure.reactive
-
WebServerFactoryCustomizerto applyServerPropertiesto reactive servers. - ReactiveWebServerFactoryCustomizer(ServerProperties) - Constructor for class org.springframework.boot.web.server.autoconfigure.reactive.ReactiveWebServerFactoryCustomizer
-
Create a new
ReactiveWebServerFactoryCustomizerinstance. - ReactiveWebServerFactoryCustomizer(ServerProperties, SslBundles) - Constructor for class org.springframework.boot.web.server.autoconfigure.reactive.ReactiveWebServerFactoryCustomizer
-
Create a new
ReactiveWebServerFactoryCustomizerinstance. - ReactiveWebServerInitializedEvent - Class in org.springframework.boot.web.server.reactive.context
-
Event to be published after the
WebServeris ready. - ReactiveWebServerInitializedEvent(WebServer, ReactiveWebServerApplicationContext) - Constructor for class org.springframework.boot.web.server.reactive.context.ReactiveWebServerInitializedEvent
- refresh() - Method in class org.springframework.boot.web.server.reactive.context.ReactiveWebServerApplicationContext
- refresh() - Method in class org.springframework.boot.web.server.servlet.context.ServletWebServerApplicationContext
- register(Class<?>...) - Method in class org.springframework.boot.web.server.reactive.context.AnnotationConfigReactiveWebServerApplicationContext
-
Register one or more annotated classes to be processed.
- register(Class<?>...) - Method in class org.springframework.boot.web.server.servlet.context.AnnotationConfigServletWebServerApplicationContext
-
Register one or more annotated classes to be processed.
- register(WebListenerRegistry) - Method in interface org.springframework.boot.web.server.servlet.WebListenerRegistrar
-
Register web listeners with the given registry.
- registerBeanDefinitions(AnnotationMetadata, BeanDefinitionRegistry) - Method in class org.springframework.boot.web.server.autoconfigure.reactive.ReactiveWebServerConfiguration.BeanPostProcessorsRegistrar
- remove(String) - Method in class org.springframework.boot.web.server.MimeMappings
-
Remove an existing mapping.
- REQUESTS_ACTIVE - Enum constant in enum class org.springframework.boot.web.server.GracefulShutdownResult
-
Requests remained active at the end of the grace period.
- restore() - Method in class org.springframework.boot.web.server.servlet.context.ServletWebServerApplicationContext.ExistingWebApplicationScopes
S
- scan(String...) - Method in class org.springframework.boot.web.server.reactive.context.AnnotationConfigReactiveWebServerApplicationContext
-
Perform a scan within the specified base packages.
- scan(String...) - Method in class org.springframework.boot.web.server.servlet.context.AnnotationConfigServletWebServerApplicationContext
-
Perform a scan within the specified base packages.
- serverName() - Method in record class org.springframework.boot.web.server.Ssl.ServerNameSslBundle
-
Returns the value of the
serverNamerecord component. - ServerNameSslBundle(String, String) - Constructor for record class org.springframework.boot.web.server.Ssl.ServerNameSslBundle
-
Creates an instance of a
ServerNameSslBundlerecord class. - ServerPortInfoApplicationContextInitializer - Class in org.springframework.boot.web.server.context
-
ApplicationContextInitializerthat setsEnvironmentproperties for the ports thatWebServerservers are actually listening on. - ServerPortInfoApplicationContextInitializer() - Constructor for class org.springframework.boot.web.server.context.ServerPortInfoApplicationContextInitializer
- ServerProperties - Class in org.springframework.boot.web.server.autoconfigure
-
@ConfigurationPropertiesfor a web server (e.g. - ServerProperties() - Constructor for class org.springframework.boot.web.server.autoconfigure.ServerProperties
- ServerProperties.Encoding - Class in org.springframework.boot.web.server.autoconfigure
- ServerProperties.ForwardHeadersStrategy - Enum Class in org.springframework.boot.web.server.autoconfigure
-
Strategies for supporting forward headers.
- ServerProperties.Reactive - Class in org.springframework.boot.web.server.autoconfigure
-
Reactive server properties.
- ServerProperties.Reactive.Session - Class in org.springframework.boot.web.server.autoconfigure
- ServerProperties.Servlet - Class in org.springframework.boot.web.server.autoconfigure
-
Servlet server properties.
- Servlet() - Constructor for class org.springframework.boot.web.server.autoconfigure.ServerProperties.Servlet
- ServletComponentScan - Annotation Interface in org.springframework.boot.web.server.servlet.context
-
Enables scanning for Servlet components (
filters,servlets, andlisteners). - ServletContextInitializers - Class in org.springframework.boot.web.server.servlet
-
The
ServletContextInitializersto apply to a servletWebServer. - ServletWebServerApplicationContext - Class in org.springframework.boot.web.server.servlet.context
-
A
WebApplicationContextthat can be used to bootstrap itself from a containedServletWebServerFactorybean. - ServletWebServerApplicationContext() - Constructor for class org.springframework.boot.web.server.servlet.context.ServletWebServerApplicationContext
-
Create a new
ServletWebServerApplicationContext. - ServletWebServerApplicationContext(DefaultListableBeanFactory) - Constructor for class org.springframework.boot.web.server.servlet.context.ServletWebServerApplicationContext
-
Create a new
ServletWebServerApplicationContextwith the givenDefaultListableBeanFactory. - ServletWebServerApplicationContext.ExistingWebApplicationScopes - Class in org.springframework.boot.web.server.servlet.context
-
Utility class to store and restore any user defined scopes.
- ServletWebServerConfiguration - Class in org.springframework.boot.web.server.autoconfigure.servlet
-
Configurationfor a servlet web server. - ServletWebServerConfiguration() - Constructor for class org.springframework.boot.web.server.autoconfigure.servlet.ServletWebServerConfiguration
- ServletWebServerFactory - Interface in org.springframework.boot.web.server.servlet
-
Factory interface that can be used to create a
WebServer. - ServletWebServerFactoryCustomizer - Class in org.springframework.boot.web.server.autoconfigure.servlet
-
WebServerFactoryCustomizerto applyServerPropertiesandWebListenerRegistrarsto servlet web servers. - ServletWebServerFactoryCustomizer(ServerProperties) - Constructor for class org.springframework.boot.web.server.autoconfigure.servlet.ServletWebServerFactoryCustomizer
- ServletWebServerFactoryCustomizer(ServerProperties, List<WebListenerRegistrar>, List<CookieSameSiteSupplier>, SslBundles) - Constructor for class org.springframework.boot.web.server.autoconfigure.servlet.ServletWebServerFactoryCustomizer
- ServletWebServerInitializedEvent - Class in org.springframework.boot.web.server.servlet.context
-
Event to be published after the
WebServeris ready. - ServletWebServerInitializedEvent(WebServer, ServletWebServerApplicationContext) - Constructor for class org.springframework.boot.web.server.servlet.context.ServletWebServerInitializedEvent
- ServletWebServerSettings - Class in org.springframework.boot.web.server.servlet
-
Settings for a servlet
WebServerto be created by aConfigurableServletWebServerFactory. - ServletWebServerSettings() - Constructor for class org.springframework.boot.web.server.servlet.ServletWebServerSettings
- Session - Class in org.springframework.boot.web.server.servlet
-
Session properties.
- Session() - Constructor for class org.springframework.boot.web.server.autoconfigure.ServerProperties.Reactive.Session
- Session() - Constructor for class org.springframework.boot.web.server.servlet.Session
- Session.SessionTrackingMode - Enum Class in org.springframework.boot.web.server.servlet
-
Available session tracking modes (mirrors
SessionTrackingMode). - SessionStoreDirectory - Class in org.springframework.boot.web.server.servlet
-
Manages a session store directory.
- SessionStoreDirectory() - Constructor for class org.springframework.boot.web.server.servlet.SessionStoreDirectory
- setAddress(InetAddress) - Method in class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
- setAddress(InetAddress) - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties
- setAddress(InetAddress) - Method in interface org.springframework.boot.web.server.ConfigurableWebServerFactory
-
Sets the specific network address that the server should bind to.
- setApplicationDisplayName(String) - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties.Servlet
- setBeanFactory(BeanFactory) - Method in class org.springframework.boot.web.server.autoconfigure.reactive.ReactiveWebServerConfiguration.BeanPostProcessorsRegistrar
- setBeanFactory(BeanFactory) - Method in class org.springframework.boot.web.server.WebServerFactoryCustomizerBeanPostProcessor
- setBeanNameGenerator(BeanNameGenerator) - Method in class org.springframework.boot.web.server.reactive.context.AnnotationConfigReactiveWebServerApplicationContext
-
Provide a custom
BeanNameGeneratorfor use withAnnotatedBeanDefinitionReaderand/orClassPathBeanDefinitionScanner, if any. - setBeanNameGenerator(BeanNameGenerator) - Method in class org.springframework.boot.web.server.servlet.context.AnnotationConfigServletWebServerApplicationContext
-
Provide a custom
BeanNameGeneratorfor use withAnnotatedBeanDefinitionReaderand/orClassPathBeanDefinitionScanner, if any. - setBundle(String) - Method in class org.springframework.boot.web.server.Ssl
-
Set the name of the SSL bundle to use.
- setCertificate(String) - Method in class org.springframework.boot.web.server.Ssl
- setCertificatePrivateKey(String) - Method in class org.springframework.boot.web.server.Ssl
- setCiphers(String[]) - Method in class org.springframework.boot.web.server.Ssl
- setClassName(String) - Method in class org.springframework.boot.web.server.servlet.Jsp
- setClientAuth(Ssl.ClientAuth) - Method in class org.springframework.boot.web.server.Ssl
- setCompression(Compression) - Method in class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
- setCompression(Compression) - Method in interface org.springframework.boot.web.server.ConfigurableWebServerFactory
-
Sets the compression configuration that will be applied to the server's default connector.
- setContextPath(String) - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties.Servlet
- setContextPath(String) - Method in interface org.springframework.boot.web.server.servlet.ConfigurableServletWebServerFactory
-
Sets the context path for the web server.
- setContextPath(ContextPath) - Method in class org.springframework.boot.web.server.servlet.ServletWebServerSettings
- setCookieSameSiteSuppliers(List<? extends CookieSameSiteSupplier>) - Method in interface org.springframework.boot.web.server.servlet.ConfigurableServletWebServerFactory
-
Sets
CookieSameSiteSuppliersthat should be used to obtain theCookie.SameSiteattribute of any added cookie. - setCookieSameSiteSuppliers(List<? extends CookieSameSiteSupplier>) - Method in class org.springframework.boot.web.server.servlet.ServletWebServerSettings
- setDirectory(File) - Method in class org.springframework.boot.web.server.servlet.DocumentRoot
- setDisplayName(String) - Method in class org.springframework.boot.web.server.servlet.ServletWebServerSettings
- setDisplayName(String) - Method in interface org.springframework.boot.web.server.servlet.ConfigurableServletWebServerFactory
-
Sets the display name of the application deployed in the web server.
- setDocumentRoot(File) - Method in interface org.springframework.boot.web.server.servlet.ConfigurableServletWebServerFactory
-
Sets the document root directory which will be used by the web context to serve static files.
- setDocumentRoot(File) - Method in class org.springframework.boot.web.server.servlet.ServletWebServerSettings
- setDomain(String) - Method in class org.springframework.boot.web.server.Cookie
- setEnabled(boolean) - Method in class org.springframework.boot.web.server.Compression
- setEnabled(boolean) - Method in class org.springframework.boot.web.server.Http2
- setEnabled(boolean) - Method in class org.springframework.boot.web.server.Ssl
- setEnabledProtocols(String[]) - Method in class org.springframework.boot.web.server.Ssl
- setEnvironment(ConfigurableEnvironment) - Method in class org.springframework.boot.web.server.reactive.context.AnnotationConfigReactiveWebServerApplicationContext
- setEnvironment(ConfigurableEnvironment) - Method in class org.springframework.boot.web.server.servlet.context.AnnotationConfigServletWebServerApplicationContext
- setEnvironment(ConfigurableEnvironment) - Method in class org.springframework.boot.web.server.servlet.context.XmlServletWebServerApplicationContext
- setErrorPages(Set<? extends ErrorPage>) - Method in class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
- setErrorPages(Set<? extends ErrorPage>) - Method in interface org.springframework.boot.web.server.ConfigurableWebServerFactory
-
Sets the error pages that will be used when handling exceptions.
- setExcludedUserAgents(String[]) - Method in class org.springframework.boot.web.server.Compression
- setForwardHeadersStrategy(ServerProperties.ForwardHeadersStrategy) - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties
- setHttp2(Http2) - Method in class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
- setHttp2(Http2) - Method in interface org.springframework.boot.web.server.ConfigurableWebServerFactory
-
Sets the HTTP/2 configuration that will be applied to the server.
- setHttpOnly(Boolean) - Method in class org.springframework.boot.web.server.Cookie
- setInitializers(List<? extends ServletContextInitializer>) - Method in interface org.springframework.boot.web.server.servlet.ConfigurableServletWebServerFactory
-
Sets
ServletContextInitializerthat should be applied in addition toServletWebServerFactory.getWebServer(ServletContextInitializer...)parameters. - setInitializers(List<? extends ServletContextInitializer>) - Method in class org.springframework.boot.web.server.servlet.ServletWebServerSettings
- setInitParameters(Map<String, String>) - Method in interface org.springframework.boot.web.server.servlet.ConfigurableServletWebServerFactory
-
Sets the init parameters that are applied to the container's
ServletContext. - setInitParameters(Map<String, String>) - Method in class org.springframework.boot.web.server.servlet.Jsp
- setInitParameters(Map<String, String>) - Method in class org.springframework.boot.web.server.servlet.ServletWebServerSettings
- setJsp(Jsp) - Method in interface org.springframework.boot.web.server.servlet.ConfigurableServletWebServerFactory
-
Sets the configuration that will be applied to the server's JSP servlet.
- setJsp(Jsp) - Method in class org.springframework.boot.web.server.servlet.ServletWebServerSettings
- setKeyAlias(String) - Method in class org.springframework.boot.web.server.Ssl
- setKeyPassword(String) - Method in class org.springframework.boot.web.server.Ssl
- setKeyStore(String) - Method in class org.springframework.boot.web.server.Ssl
- setKeyStorePassword(String) - Method in class org.springframework.boot.web.server.Ssl
- setKeyStoreProvider(String) - Method in class org.springframework.boot.web.server.Ssl
- setKeyStoreType(String) - Method in class org.springframework.boot.web.server.Ssl
- setLocaleCharsetMappings(Map<Locale, Charset>) - Method in interface org.springframework.boot.web.server.servlet.ConfigurableServletWebServerFactory
-
Sets the Locale to Charset mappings.
- setLocaleCharsetMappings(Map<Locale, Charset>) - Method in class org.springframework.boot.web.server.servlet.ServletWebServerSettings
- setMapping(Map<Locale, Charset>) - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties.Encoding
- setMaxAge(Duration) - Method in class org.springframework.boot.web.server.Cookie
- setMaxHttpRequestHeaderSize(DataSize) - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties
- setMaxSessions(int) - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties.Reactive.Session
- setMimeMappings(Map<String, String>) - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties
- setMimeMappings(MimeMappings) - Method in interface org.springframework.boot.web.server.servlet.ConfigurableServletWebServerFactory
-
Sets the mime-type mappings.
- setMimeMappings(MimeMappings) - Method in class org.springframework.boot.web.server.servlet.ServletWebServerSettings
- setMimeTypes(String[]) - Method in class org.springframework.boot.web.server.Compression
- setMinResponseSize(DataSize) - Method in class org.springframework.boot.web.server.Compression
- setName(String) - Method in class org.springframework.boot.web.server.Cookie
- setPartitioned(Boolean) - Method in class org.springframework.boot.web.server.Cookie
- setPath(String) - Method in class org.springframework.boot.web.server.Cookie
- setPersistent(boolean) - Method in class org.springframework.boot.web.server.servlet.Session
- setPort(int) - Method in class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
- setPort(int) - Method in interface org.springframework.boot.web.server.ConfigurableWebServerFactory
-
Sets the port that the web server should listen on.
- setPort(Integer) - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties
- setProtocol(String) - Method in class org.springframework.boot.web.server.Ssl
- setRegisterDefaultServlet(boolean) - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties.Servlet
- setRegisterDefaultServlet(boolean) - Method in interface org.springframework.boot.web.server.servlet.ConfigurableServletWebServerFactory
-
Set if the DefaultServlet should be registered.
- setRegisterDefaultServlet(boolean) - Method in class org.springframework.boot.web.server.servlet.ServletWebServerSettings
- setRegistered(boolean) - Method in class org.springframework.boot.web.server.servlet.Jsp
- setSameSite(Cookie.SameSite) - Method in class org.springframework.boot.web.server.Cookie
- setScopeMetadataResolver(ScopeMetadataResolver) - Method in class org.springframework.boot.web.server.reactive.context.AnnotationConfigReactiveWebServerApplicationContext
-
Set the
ScopeMetadataResolverto use for detected bean classes. - setScopeMetadataResolver(ScopeMetadataResolver) - Method in class org.springframework.boot.web.server.servlet.context.AnnotationConfigServletWebServerApplicationContext
-
Set the
ScopeMetadataResolverto use for detected bean classes. - setSecure(Boolean) - Method in class org.springframework.boot.web.server.Cookie
- setServerHeader(String) - Method in class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
- setServerHeader(String) - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties
- setServerHeader(String) - Method in interface org.springframework.boot.web.server.ConfigurableWebServerFactory
-
Sets the server header value.
- setServerNameBundles(List<Ssl.ServerNameSslBundle>) - Method in class org.springframework.boot.web.server.Ssl
- setServerNamespace(String) - Method in interface org.springframework.boot.web.server.context.ConfigurableWebServerApplicationContext
-
Set the server namespace of the context.
- setServerNamespace(String) - Method in class org.springframework.boot.web.server.reactive.context.ReactiveWebServerApplicationContext
- setServerNamespace(String) - Method in class org.springframework.boot.web.server.servlet.context.ServletWebServerApplicationContext
- setServletConfig(ServletConfig) - Method in class org.springframework.boot.web.server.servlet.context.ServletWebServerApplicationContext
- setSession(Session) - Method in interface org.springframework.boot.web.server.servlet.ConfigurableServletWebServerFactory
-
Sets the configuration that will be applied to the container's HTTP session support.
- setSession(Session) - Method in class org.springframework.boot.web.server.servlet.ServletWebServerSettings
- setShutdown(Shutdown) - Method in class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
- setShutdown(Shutdown) - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties
- setShutdown(Shutdown) - Method in interface org.springframework.boot.web.server.ConfigurableWebServerFactory
-
Sets the shutdown configuration that will be applied to the server.
- setSsl(Ssl) - Method in class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
- setSsl(Ssl) - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties
- setSsl(Ssl) - Method in interface org.springframework.boot.web.server.ConfigurableWebServerFactory
-
Sets the SSL configuration that will be applied to the server's default connector.
- setSslBundles(SslBundles) - Method in class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
- setSslBundles(SslBundles) - Method in interface org.springframework.boot.web.server.ConfigurableWebServerFactory
-
Sets the SSL bundles that can be used to configure SSL connections.
- setStoreDir(File) - Method in class org.springframework.boot.web.server.servlet.Session
- setTimeout(Duration) - Method in class org.springframework.boot.web.server.autoconfigure.ServerProperties.Reactive.Session
- setTimeout(Duration) - Method in class org.springframework.boot.web.server.servlet.Session
- setTrackingModes(Set<Session.SessionTrackingMode>) - Method in class org.springframework.boot.web.server.servlet.Session
- setTrustCertificate(String) - Method in class org.springframework.boot.web.server.Ssl
- setTrustCertificatePrivateKey(String) - Method in class org.springframework.boot.web.server.Ssl
- setTrustStore(String) - Method in class org.springframework.boot.web.server.Ssl
- setTrustStorePassword(String) - Method in class org.springframework.boot.web.server.Ssl
- setTrustStoreProvider(String) - Method in class org.springframework.boot.web.server.Ssl
- setTrustStoreType(String) - Method in class org.springframework.boot.web.server.Ssl
- setValidating(boolean) - Method in class org.springframework.boot.web.server.servlet.context.XmlServletWebServerApplicationContext
-
Set whether to use XML validation.
- Shutdown - Enum Class in org.springframework.boot.web.server
-
Configuration for shutting down a
WebServer. - shutdownComplete(GracefulShutdownResult) - Method in interface org.springframework.boot.web.server.GracefulShutdownCallback
-
Graceful shutdown has completed with the given
result. - shutDownGracefully(GracefulShutdownCallback) - Method in interface org.springframework.boot.web.server.WebServer
-
Initiates a graceful shutdown of the web server.
- SMART_LIFECYCLE_PHASE - Static variable in class org.springframework.boot.web.server.context.WebServerGracefulShutdownLifecycle
-
Deprecated, for removal: This API element is subject to removal in a future version.
- Ssl - Class in org.springframework.boot.web.server
-
Simple server-independent abstraction for SSL configuration.
- Ssl() - Constructor for class org.springframework.boot.web.server.Ssl
- SSL - Enum constant in enum class org.springframework.boot.web.server.servlet.Session.SessionTrackingMode
-
Use SSL build-in mechanism to track the session.
- Ssl.ClientAuth - Enum Class in org.springframework.boot.web.server
-
Client authentication types.
- Ssl.ServerNameSslBundle - Record Class in org.springframework.boot.web.server
- start() - Method in class org.springframework.boot.web.server.context.WebServerGracefulShutdownLifecycle
- start() - Method in interface org.springframework.boot.web.server.WebServer
-
Starts the web server.
- START_STOP_LIFECYCLE_PHASE - Static variable in interface org.springframework.boot.web.server.context.WebServerApplicationContext
-
SmartLifecycle phasein which starting and stopping of the web server is performed. - stop() - Method in class org.springframework.boot.web.server.context.WebServerGracefulShutdownLifecycle
- stop() - Method in interface org.springframework.boot.web.server.WebServer
-
Stops the web server.
- stop(Runnable) - Method in class org.springframework.boot.web.server.context.WebServerGracefulShutdownLifecycle
- STRICT - Enum constant in enum class org.springframework.boot.web.server.Cookie.SameSite
-
SameSite attribute will be set to Strict.
T
- throwIfPortBindingException(Exception, IntSupplier) - Static method in exception class org.springframework.boot.web.server.PortInUseException
-
Throw a
PortInUseExceptionif the given exception was caused by a "port in use"BindException. - toString() - Method in class org.springframework.boot.web.server.MimeMappings.Mapping
- toString() - Method in class org.springframework.boot.web.server.servlet.ContextPath
- toString() - Method in record class org.springframework.boot.web.server.Ssl.ServerNameSslBundle
-
Returns a string representation of this record class.
- toString() - Method in class org.springframework.boot.web.server.WebServerSslBundle
U
- unmodifiableMappings(MimeMappings) - Static method in class org.springframework.boot.web.server.MimeMappings
-
Create a new unmodifiable view of the specified mapping.
- URL - Enum constant in enum class org.springframework.boot.web.server.servlet.Session.SessionTrackingMode
-
Rewrite the URL to append a session ID.
V
- value() - Element in annotation interface org.springframework.boot.web.server.servlet.context.ServletComponentScan
-
Alias for the
ServletComponentScan.basePackages()attribute. - valueOf(String) - Static method in enum class org.springframework.boot.web.server.autoconfigure.ServerProperties.ForwardHeadersStrategy
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.boot.web.server.Cookie.SameSite
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.boot.web.server.GracefulShutdownResult
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.boot.web.server.servlet.Session.SessionTrackingMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.boot.web.server.Shutdown
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.boot.web.server.Ssl.ClientAuth
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.springframework.boot.web.server.autoconfigure.ServerProperties.ForwardHeadersStrategy
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.boot.web.server.Cookie.SameSite
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.boot.web.server.GracefulShutdownResult
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.boot.web.server.servlet.Session.SessionTrackingMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.boot.web.server.Shutdown
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.boot.web.server.Ssl.ClientAuth
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- WANT - Enum constant in enum class org.springframework.boot.web.server.Ssl.ClientAuth
-
Client authentication is wanted but not mandatory.
- WebApplicationContextServletContextAwareProcessor - Class in org.springframework.boot.web.server.servlet.context
-
Variant of
ServletContextAwareProcessorfor use with aConfigurableWebApplicationContext. - WebApplicationContextServletContextAwareProcessor(ConfigurableWebApplicationContext) - Constructor for class org.springframework.boot.web.server.servlet.context.WebApplicationContextServletContextAwareProcessor
- WebListenerRegistrar - Interface in org.springframework.boot.web.server.servlet
-
Interface to be implemented by types that register
@WebListeners. - WebListenerRegistry - Interface in org.springframework.boot.web.server.servlet
-
A registry that holds
@WebListeners. - WebServer - Interface in org.springframework.boot.web.server
-
Simple interface that represents a fully configured web server (for example Tomcat, Jetty, Netty).
- WebServerApplicationContext - Interface in org.springframework.boot.web.server.context
-
Interface to be implemented by
application contextsthat create and manage the lifecycle of an embeddedWebServer. - WebServerException - Exception Class in org.springframework.boot.web.server
-
Exceptions thrown by a web server.
- WebServerException(String, Throwable) - Constructor for exception class org.springframework.boot.web.server.WebServerException
- WebServerFactory - Interface in org.springframework.boot.web.server
-
Tagging interface for factories that create a
WebServer. - WebServerFactoryCustomizer<T> - Interface in org.springframework.boot.web.server
-
Strategy interface for customizing
web server factories. - WebServerFactoryCustomizerBeanPostProcessor - Class in org.springframework.boot.web.server
-
BeanPostProcessorthat applies allWebServerFactoryCustomizerbeans from the bean factory toWebServerFactorybeans. - WebServerFactoryCustomizerBeanPostProcessor() - Constructor for class org.springframework.boot.web.server.WebServerFactoryCustomizerBeanPostProcessor
- WebServerGracefulShutdownLifecycle - Class in org.springframework.boot.web.server.context
-
SmartLifecycleto triggerWebServergraceful shutdown. - WebServerGracefulShutdownLifecycle(WebServer) - Constructor for class org.springframework.boot.web.server.context.WebServerGracefulShutdownLifecycle
-
Creates a new
WebServerGracefulShutdownLifecyclethat will gracefully shut down the givenwebServer. - WebServerInitializedEvent - Class in org.springframework.boot.web.server.context
-
Event to be published when the
WebServeris ready. - WebServerInitializedEvent(WebServer) - Constructor for class org.springframework.boot.web.server.context.WebServerInitializedEvent
- WebServerPortFileWriter - Class in org.springframework.boot.web.server.context
-
An
ApplicationListenerthat saves embedded server port and management port into file. - WebServerPortFileWriter() - Constructor for class org.springframework.boot.web.server.context.WebServerPortFileWriter
-
Create a new
WebServerPortFileWriterinstance using the filename 'application.port'. - WebServerPortFileWriter(File) - Constructor for class org.springframework.boot.web.server.context.WebServerPortFileWriter
-
Create a new
WebServerPortFileWriterinstance with a specified file. - WebServerPortFileWriter(String) - Constructor for class org.springframework.boot.web.server.context.WebServerPortFileWriter
-
Create a new
WebServerPortFileWriterinstance with a specified filename. - WebServerSslBundle - Class in org.springframework.boot.web.server
-
SslBundlebacked bySsl. - when(Predicate<Cookie>) - Method in interface org.springframework.boot.web.server.servlet.CookieSameSiteSupplier
-
Limit this supplier so that it's only called if the predicate accepts the Cookie.
- whenHasName(String) - Method in interface org.springframework.boot.web.server.servlet.CookieSameSiteSupplier
-
Limit this supplier so that it's only called if the Cookie has the given name.
- whenHasName(Supplier<String>) - Method in interface org.springframework.boot.web.server.servlet.CookieSameSiteSupplier
-
Limit this supplier so that it's only called if the Cookie has the given name.
- whenHasNameMatching(String) - Method in interface org.springframework.boot.web.server.servlet.CookieSameSiteSupplier
-
Limit this supplier so that it's only called if the Cookie name matches the given regex.
- whenHasNameMatching(Pattern) - Method in interface org.springframework.boot.web.server.servlet.CookieSameSiteSupplier
-
Limit this supplier so that it's only called if the Cookie name matches the given
Pattern.
X
- XmlServletWebServerApplicationContext - Class in org.springframework.boot.web.server.servlet.context
-
ServletWebServerApplicationContextwhich takes its configuration from XML documents, understood by anXmlBeanDefinitionReader. - XmlServletWebServerApplicationContext() - Constructor for class org.springframework.boot.web.server.servlet.context.XmlServletWebServerApplicationContext
-
Create a new
XmlServletWebServerApplicationContextthat needs to be loaded and then manuallyrefreshed. - XmlServletWebServerApplicationContext(Class<?>, String...) - Constructor for class org.springframework.boot.web.server.servlet.context.XmlServletWebServerApplicationContext
-
Create a new
XmlServletWebServerApplicationContext, loading bean definitions from the given resource locations and automatically refreshing the context. - XmlServletWebServerApplicationContext(String...) - Constructor for class org.springframework.boot.web.server.servlet.context.XmlServletWebServerApplicationContext
-
Create a new
XmlServletWebServerApplicationContext, loading bean definitions from the given resource locations and automatically refreshing the context. - XmlServletWebServerApplicationContext(Resource...) - Constructor for class org.springframework.boot.web.server.servlet.context.XmlServletWebServerApplicationContext
-
Create a new
XmlServletWebServerApplicationContext, loading bean definitions from the given resources and automatically refreshing the context.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
WebServerApplicationContext.GRACEFUL_SHUTDOWN_PHASE