Add nullability annotations to module/spring-boot-web-server

See gh-46587

Author: mhalbritter

documentation/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/howto/webserver/configure/MyTomcatWebServerCustomizer.kt

@@ -16,14 +16,14 @@
 
 package org.springframework.boot.docs.howto.webserver.configure
 
-import org.springframework.boot.web.server.WebServerFactoryCustomizer
 import org.springframework.boot.tomcat.servlet.TomcatServletWebServerFactory
+import org.springframework.boot.web.server.WebServerFactoryCustomizer
 import org.springframework.stereotype.Component
 
 @Component
-class MyTomcatWebServerCustomizer : WebServerFactoryCustomizer<TomcatServletWebServerFactory?> {
+class MyTomcatWebServerCustomizer : WebServerFactoryCustomizer<TomcatServletWebServerFactory> {
 
-	override fun customize(factory: TomcatServletWebServerFactory?) {
+	override fun customize(factory: TomcatServletWebServerFactory) {
 		// customize the factory here
 	}
 

module/spring-boot-web-server/src/main/java/org/springframework/boot/web/server/AbstractConfigurableWebServerFactory.java

@@ -26,6 +26,8 @@
 import java.util.Set;
 import java.util.stream.Collectors;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.boot.ssl.SslBundle;
 import org.springframework.boot.ssl.SslBundles;
 import org.springframework.boot.web.error.ErrorPage;
@@ -49,19 +51,19 @@ public abstract class AbstractConfigurableWebServerFactory implements Configurab
 
 	private int port = 8080;
 
-	private InetAddress address;
+	private @Nullable InetAddress address;
 
 	private Set<ErrorPage> errorPages = new LinkedHashSet<>();
 
-	private Ssl ssl;
+	private @Nullable Ssl ssl;
 
-	private SslBundles sslBundles;
+	private @Nullable SslBundles sslBundles;
 
-	private Http2 http2;
+	private @Nullable Http2 http2;
 
-	private Compression compression;
+	private @Nullable Compression compression;
 
-	private String serverHeader;
+	private @Nullable String serverHeader;
 
 	private Shutdown shutdown = Shutdown.IMMEDIATE;
 
@@ -97,12 +99,12 @@ public void setPort(int port) {
 	 * Return the address that the web server binds to.
 	 * @return the address
 	 */
-	public InetAddress getAddress() {
+	public @Nullable InetAddress getAddress() {
 		return this.address;
 	}
 
 	@Override
-	public void setAddress(InetAddress address) {
+	public void setAddress(@Nullable InetAddress address) {
 		this.address = address;
 	}
 
@@ -127,12 +129,12 @@ public void addErrorPages(ErrorPage... errorPages) {
 		this.errorPages.addAll(Arrays.asList(errorPages));
 	}
 
-	public Ssl getSsl() {
+	public @Nullable Ssl getSsl() {
 		return this.ssl;
 	}
 
 	@Override
-	public void setSsl(Ssl ssl) {
+	public void setSsl(@Nullable Ssl ssl) {
 		this.ssl = ssl;
 	}
 
@@ -141,39 +143,39 @@ public void setSsl(Ssl ssl) {
 	 * @return the {@link SslBundles} or {@code null}
 	 * @since 3.2.0
 	 */
-	public SslBundles getSslBundles() {
+	public @Nullable SslBundles getSslBundles() {
 		return this.sslBundles;
 	}
 
 	@Override
-	public void setSslBundles(SslBundles sslBundles) {
+	public void setSslBundles(@Nullable SslBundles sslBundles) {
 		this.sslBundles = sslBundles;
 	}
 
-	public Http2 getHttp2() {
+	public @Nullable Http2 getHttp2() {
 		return this.http2;
 	}
 
 	@Override
-	public void setHttp2(Http2 http2) {
+	public void setHttp2(@Nullable Http2 http2) {
 		this.http2 = http2;
 	}
 
-	public Compression getCompression() {
+	public @Nullable Compression getCompression() {
 		return this.compression;
 	}
 
 	@Override
-	public void setCompression(Compression compression) {
+	public void setCompression(@Nullable Compression compression) {
 		this.compression = compression;
 	}
 
-	public String getServerHeader() {
+	public @Nullable String getServerHeader() {
 		return this.serverHeader;
 	}
 
 	@Override
-	public void setServerHeader(String serverHeader) {
+	public void setServerHeader(@Nullable String serverHeader) {
 		this.serverHeader = serverHeader;
 	}
 
@@ -200,10 +202,13 @@ protected final SslBundle getSslBundle() {
 	}
 
 	protected final Map<String, SslBundle> getServerNameSslBundles() {
+		Assert.state(this.ssl != null, "'ssl' must not be null");
 		return this.ssl.getServerNameBundles()
 			.stream()
-			.collect(Collectors.toMap(ServerNameSslBundle::serverName,
-					(serverNameSslBundle) -> this.sslBundles.getBundle(serverNameSslBundle.bundle())));
+			.collect(Collectors.toMap(ServerNameSslBundle::serverName, (serverNameSslBundle) -> {
+				Assert.state(this.sslBundles != null, "'sslBundles' must not be null");
+				return this.sslBundles.getBundle(serverNameSslBundle.bundle());
+			}));
 	}
 
 	/**

module/spring-boot-web-server/src/main/java/org/springframework/boot/web/server/Compression.java

@@ -16,6 +16,8 @@
 
 package org.springframework.boot.web.server;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.boot.context.properties.ConfigurationPropertiesSource;
 import org.springframework.util.unit.DataSize;
 
@@ -44,7 +46,7 @@ public class Compression {
 	/**
 	 * Comma-separated list of user agents for which responses should not be compressed.
 	 */
-	private String[] excludedUserAgents = null;
+	private String @Nullable [] excludedUserAgents;
 
 	/**
 	 * Minimum "Content-Length" value that is required for compression to be performed.
@@ -75,11 +77,11 @@ public void setMimeTypes(String[] mimeTypes) {
 		this.mimeTypes = mimeTypes;
 	}
 
-	public String[] getExcludedUserAgents() {
+	public String @Nullable [] getExcludedUserAgents() {
 		return this.excludedUserAgents;
 	}
 
-	public void setExcludedUserAgents(String[] excludedUserAgents) {
+	public void setExcludedUserAgents(String @Nullable [] excludedUserAgents) {
 		this.excludedUserAgents = excludedUserAgents;
 	}
 

module/spring-boot-web-server/src/main/java/org/springframework/boot/web/server/ConfigurableWebServerFactory.java

@@ -19,6 +19,8 @@
 import java.net.InetAddress;
 import java.util.Set;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.boot.ssl.SslBundles;
 import org.springframework.boot.web.error.ErrorPage;
 import org.springframework.boot.web.error.ErrorPageRegistry;
@@ -46,7 +48,7 @@ public interface ConfigurableWebServerFactory extends WebServerFactory, ErrorPag
 	 * Sets the specific network address that the server should bind to.
 	 * @param address the address to set (defaults to {@code null})
 	 */
-	void setAddress(InetAddress address);
+	void setAddress(@Nullable InetAddress address);
 
 	/**
 	 * Sets the error pages that will be used when handling exceptions.
@@ -58,33 +60,33 @@ public interface ConfigurableWebServerFactory extends WebServerFactory, ErrorPag
 	 * Sets the SSL configuration that will be applied to the server's default connector.
 	 * @param ssl the SSL configuration
 	 */
-	void setSsl(Ssl ssl);
+	void setSsl(@Nullable Ssl ssl);
 
 	/**
 	 * Sets the SSL bundles that can be used to configure SSL connections.
 	 * @param sslBundles the SSL bundles
 	 * @since 3.1.0
 	 */
-	void setSslBundles(SslBundles sslBundles);
+	void setSslBundles(@Nullable SslBundles sslBundles);
 
 	/**
 	 * Sets the HTTP/2 configuration that will be applied to the server.
 	 * @param http2 the HTTP/2 configuration
 	 */
-	void setHttp2(Http2 http2);
+	void setHttp2(@Nullable Http2 http2);
 
 	/**
 	 * Sets the compression configuration that will be applied to the server's default
 	 * connector.
 	 * @param compression the compression configuration
 	 */
-	void setCompression(Compression compression);
+	void setCompression(@Nullable Compression compression);
 
 	/**
 	 * Sets the server header value.
 	 * @param serverHeader the server header value
 	 */
-	void setServerHeader(String serverHeader);
+	void setServerHeader(@Nullable String serverHeader);
 
 	/**
 	 * Sets the shutdown configuration that will be applied to the server.

module/spring-boot-web-server/src/main/java/org/springframework/boot/web/server/Cookie.java

@@ -19,6 +19,8 @@
 import java.time.Duration;
 import java.time.temporal.ChronoUnit;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.boot.context.properties.ConfigurationPropertiesSource;
 import org.springframework.boot.convert.DurationUnit;
 
@@ -37,32 +39,32 @@ public class Cookie {
 	/**
 	 * Name for the cookie.
 	 */
-	private String name;
+	private @Nullable String name;
 
 	/**
 	 * Domain for the cookie.
 	 */
-	private String domain;
+	private @Nullable String domain;
 
 	/**
 	 * Path of the cookie.
 	 */
-	private String path;
+	private @Nullable String path;
 
 	/**
 	 * Whether to use "HttpOnly" cookies for the cookie.
 	 */
-	private Boolean httpOnly;
+	private @Nullable Boolean httpOnly;
 
 	/**
 	 * Whether to always mark the cookie as secure.
 	 */
-	private Boolean secure;
+	private @Nullable Boolean secure;
 
 	/**
 	 * Whether the generated cookie carries the Partitioned attribute.
 	 */
-	private Boolean partitioned;
+	private @Nullable Boolean partitioned;
 
 	/**
 	 * Maximum age of the cookie. If a duration suffix is not specified, seconds will be
@@ -71,74 +73,74 @@ public class Cookie {
 	 * means no "Max-Age".
 	 */
 	@DurationUnit(ChronoUnit.SECONDS)
-	private Duration maxAge;
+	private @Nullable Duration maxAge;
 
 	/**
 	 * SameSite setting for the cookie.
 	 */
-	private SameSite sameSite;
+	private @Nullable SameSite sameSite;
 
-	public String getName() {
+	public @Nullable String getName() {
 		return this.name;
 	}
 
-	public void setName(String name) {
+	public void setName(@Nullable String name) {
 		this.name = name;
 	}
 
-	public String getDomain() {
+	public @Nullable String getDomain() {
 		return this.domain;
 	}
 
-	public void setDomain(String domain) {
+	public void setDomain(@Nullable String domain) {
 		this.domain = domain;
 	}
 
-	public String getPath() {
+	public @Nullable String getPath() {
 		return this.path;
 	}
 
-	public void setPath(String path) {
+	public void setPath(@Nullable String path) {
 		this.path = path;
 	}
 
-	public Boolean getHttpOnly() {
+	public @Nullable Boolean getHttpOnly() {
 		return this.httpOnly;
 	}
 
-	public void setHttpOnly(Boolean httpOnly) {
+	public void setHttpOnly(@Nullable Boolean httpOnly) {
 		this.httpOnly = httpOnly;
 	}
 
-	public Boolean getSecure() {
+	public @Nullable Boolean getSecure() {
 		return this.secure;
 	}
 
-	public void setSecure(Boolean secure) {
+	public void setSecure(@Nullable Boolean secure) {
 		this.secure = secure;
 	}
 
-	public Duration getMaxAge() {
+	public @Nullable Duration getMaxAge() {
 		return this.maxAge;
 	}
 
-	public void setMaxAge(Duration maxAge) {
+	public void setMaxAge(@Nullable Duration maxAge) {
 		this.maxAge = maxAge;
 	}
 
-	public SameSite getSameSite() {
+	public @Nullable SameSite getSameSite() {
 		return this.sameSite;
 	}
 
-	public void setSameSite(SameSite sameSite) {
+	public void setSameSite(@Nullable SameSite sameSite) {
 		this.sameSite = sameSite;
 	}
 
-	public Boolean getPartitioned() {
+	public @Nullable Boolean getPartitioned() {
 		return this.partitioned;
 	}
 
-	public void setPartitioned(Boolean partitioned) {
+	public void setPartitioned(@Nullable Boolean partitioned) {
 		this.partitioned = partitioned;
 	}
 
@@ -170,13 +172,13 @@ public enum SameSite {
 		 */
 		STRICT("Strict");
 
-		private final String attributeValue;
+		private @Nullable final String attributeValue;
 
-		SameSite(String attributeValue) {
+		SameSite(@Nullable String attributeValue) {
 			this.attributeValue = attributeValue;
 		}
 
-		public String attributeValue() {
+		public @Nullable String attributeValue() {
 			return this.attributeValue;
 		}