AbstractConfigurableWebServerFactory (spring-boot 2.7.14)

java.lang.Object
- org.springframework.boot.web.server.AbstractConfigurableWebServerFactory

All Implemented Interfaces:

ConfigurableWebServerFactory, ErrorPageRegistry, WebServerFactory

Direct Known Subclasses:

AbstractReactiveWebServerFactory, AbstractServletWebServerFactory
```
public abstract class AbstractConfigurableWebServerFactory
extends java.lang.Object
implements ConfigurableWebServerFactory
```
Abstract base class for ConfigurableWebServerFactory implementations.

Since:

2.0.0

Constructor Summary

Constructors
Constructor and Description
`AbstractConfigurableWebServerFactory()` Create a new `AbstractConfigurableWebServerFactory` instance.
`AbstractConfigurableWebServerFactory(int port)` Create a new `AbstractConfigurableWebServerFactory` instance with the specified port.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addErrorPages(ErrorPage... errorPages)` Adds error pages that will be used when handling exceptions.
`protected java.io.File`	`createTempDir(java.lang.String prefix)` Return the absolute temp dir for given web server.
`java.net.InetAddress`	`getAddress()` Return the address that the web server binds to.
`Compression`	`getCompression()`
`java.util.Set<ErrorPage>`	`getErrorPages()` Returns a mutable set of `ErrorPages` that will be used when handling exceptions.
`Http2`	`getHttp2()`
`SslStoreProvider`	`getOrCreateSslStoreProvider()` Return the provided `SslStoreProvider` or create one using `Ssl` properties.
`int`	`getPort()` The port that the web server listens on.
`java.lang.String`	`getServerHeader()`
`Shutdown`	`getShutdown()` Returns the shutdown configuration that will be applied to the server.
`Ssl`	`getSsl()`
`SslStoreProvider`	`getSslStoreProvider()`
`void`	`setAddress(java.net.InetAddress address)` Sets the specific network address that the server should bind to.
`void`	`setCompression(Compression compression)` Sets the compression configuration that will be applied to the server's default connector.
`void`	`setErrorPages(java.util.Set<? extends ErrorPage> errorPages)` Sets the error pages that will be used when handling exceptions.
`void`	`setHttp2(Http2 http2)` Sets the HTTP/2 configuration that will be applied to the server.
`void`	`setPort(int port)` Sets the port that the web server should listen on.
`void`	`setServerHeader(java.lang.String serverHeader)` Sets the server header value.
`void`	`setShutdown(Shutdown shutdown)` Sets the shutdown configuration that will be applied to the server.
`void`	`setSsl(Ssl ssl)` Sets the SSL configuration that will be applied to the server's default connector.
`void`	`setSslStoreProvider(SslStoreProvider sslStoreProvider)` Sets a provider that will be used to obtain SSL stores.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractConfigurableWebServerFactory
```
public AbstractConfigurableWebServerFactory()
```
    Create a new AbstractConfigurableWebServerFactory instance.
  - AbstractConfigurableWebServerFactory
```
public AbstractConfigurableWebServerFactory(int port)
```
    Create a new AbstractConfigurableWebServerFactory instance with the specified port.
    
    Parameters:
    
    port - the port number for the web server
- Method Detail
  - getPort
```
public int getPort()
```
    The port that the web server listens on.
    
    Returns:
    
    the port
  - setPort
```
public void setPort(int port)
```
    Description copied from interface: ConfigurableWebServerFactory
    
    Sets the port that the web server should listen on. If not specified port '8080' will be used. Use port -1 to disable auto-start (i.e. start the web application context but not have it listen to any port).
    
    Specified by:
    
    setPort in interface ConfigurableWebServerFactory
    
    Parameters:
    
    port - the port to set
  - getAddress
```
public java.net.InetAddress getAddress()
```
    Return the address that the web server binds to.
    
    Returns:
    
    the address
  - setAddress
```
public void setAddress(java.net.InetAddress address)
```
    Description copied from interface: ConfigurableWebServerFactory
    
    Sets the specific network address that the server should bind to.
    
    Specified by:
    
    setAddress in interface ConfigurableWebServerFactory
    
    Parameters:
    
    address - the address to set (defaults to null)
  - getErrorPages
```
public java.util.Set<ErrorPage> getErrorPages()
```
    Returns a mutable set of ErrorPages that will be used when handling exceptions.
    
    Returns:
    
    the error pages
  - setErrorPages
```
public void setErrorPages(java.util.Set<? extends ErrorPage> errorPages)
```
    Description copied from interface: ConfigurableWebServerFactory
    
    Sets the error pages that will be used when handling exceptions.
    
    Specified by:
    
    setErrorPages in interface ConfigurableWebServerFactory
    
    Parameters:
    
    errorPages - the error pages
  - addErrorPages
```
public void addErrorPages(ErrorPage... errorPages)
```
    Description copied from interface: ErrorPageRegistry
    
    Adds error pages that will be used when handling exceptions.
    
    Specified by:
    
    addErrorPages in interface ErrorPageRegistry
    
    Parameters:
    
    errorPages - the error pages
  - getSsl
```
public Ssl getSsl()
```
  - setSsl
```
public void setSsl(Ssl ssl)
```
    Description copied from interface: ConfigurableWebServerFactory
    
    Sets the SSL configuration that will be applied to the server's default connector.
    
    Specified by:
    
    setSsl in interface ConfigurableWebServerFactory
    
    Parameters:
    
    ssl - the SSL configuration
  - getSslStoreProvider
```
public SslStoreProvider getSslStoreProvider()
```
  - setSslStoreProvider
```
public void setSslStoreProvider(SslStoreProvider sslStoreProvider)
```
    Description copied from interface: ConfigurableWebServerFactory
    
    Sets a provider that will be used to obtain SSL stores.
    
    Specified by:
    
    setSslStoreProvider in interface ConfigurableWebServerFactory
    
    Parameters:
    
    sslStoreProvider - the SSL store provider
  - getHttp2
```
public Http2 getHttp2()
```
  - setHttp2
```
public void setHttp2(Http2 http2)
```
    Description copied from interface: ConfigurableWebServerFactory
    
    Sets the HTTP/2 configuration that will be applied to the server.
    
    Specified by:
    
    setHttp2 in interface ConfigurableWebServerFactory
    
    Parameters:
    
    http2 - the HTTP/2 configuration
  - getCompression
```
public Compression getCompression()
```
  - setCompression
```
public void setCompression(Compression compression)
```
    Description copied from interface: ConfigurableWebServerFactory
    
    Sets the compression configuration that will be applied to the server's default connector.
    
    Specified by:
    
    setCompression in interface ConfigurableWebServerFactory
    
    Parameters:
    
    compression - the compression configuration
  - getServerHeader
```
public java.lang.String getServerHeader()
```
  - setServerHeader
```
public void setServerHeader(java.lang.String serverHeader)
```
    Description copied from interface: ConfigurableWebServerFactory
    
    Sets the server header value.
    
    Specified by:
    
    setServerHeader in interface ConfigurableWebServerFactory
    
    Parameters:
    
    serverHeader - the server header value
  - setShutdown
```
public void setShutdown(Shutdown shutdown)
```
    Description copied from interface: ConfigurableWebServerFactory
    
    Sets the shutdown configuration that will be applied to the server.
    
    Specified by:
    
    setShutdown in interface ConfigurableWebServerFactory
    
    Parameters:
    
    shutdown - the shutdown configuration
  - getShutdown
```
public Shutdown getShutdown()
```
    Returns the shutdown configuration that will be applied to the server.
    
    Returns:
    
    the shutdown configuration
    
    Since:
    
    2.3.0
  - getOrCreateSslStoreProvider
```
public final SslStoreProvider getOrCreateSslStoreProvider()
```
    Return the provided SslStoreProvider or create one using Ssl properties.
    
    Returns:
    
    the SslStoreProvider
  - createTempDir
```
protected final java.io.File createTempDir(java.lang.String prefix)
```
    Return the absolute temp dir for given web server.
    
    Parameters:
    
    prefix - server name
    
    Returns:
    
    the temp dir for given server.

Class AbstractConfigurableWebServerFactory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractConfigurableWebServerFactory

AbstractConfigurableWebServerFactory

Method Detail

getPort

setPort

getAddress

setAddress

getErrorPages

setErrorPages

addErrorPages

getSsl

setSsl

getSslStoreProvider

setSslStoreProvider

getHttp2

setHttp2

getCompression

setCompression

getServerHeader

setServerHeader

setShutdown

getShutdown

getOrCreateSslStoreProvider

createTempDir