Add nullability annotations to module/spring-boot-couchbase

See gh-46587

Author: mhalbritter

module/spring-boot-couchbase/src/main/java/org/springframework/boot/couchbase/autoconfigure/CouchbaseAutoConfiguration.java

@@ -20,6 +20,9 @@
 import java.io.InputStream;
 import java.security.GeneralSecurityException;
 import java.security.KeyStore;
+import java.security.PrivateKey;
+import java.security.cert.X509Certificate;
+import java.util.List;
 
 import javax.net.ssl.TrustManagerFactory;
 
@@ -33,6 +36,7 @@
 import com.couchbase.client.java.env.ClusterEnvironment.Builder;
 import com.couchbase.client.java.json.JsonValueModule;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.beans.factory.ObjectProvider;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
@@ -115,8 +119,12 @@ Authenticator couchbaseAuthenticator(CouchbaseConnectionDetails connectionDetail
 		if (pem.getCertificates() != null) {
 			PemSslStoreDetails details = new PemSslStoreDetails(null, pem.getCertificates(), pem.getPrivateKey());
 			PemSslStore store = PemSslStore.load(details);
-			return CertificateAuthenticator.fromKey(store.privateKey(), pem.getPrivateKeyPassword(),
-					store.certificates());
+			Assert.state(store != null, "Unable to load key and certificates");
+			PrivateKey key = store.privateKey();
+			List<X509Certificate> certificates = store.certificates();
+			Assert.state(key != null, "No key found");
+			Assert.state(certificates != null, "No certificates found");
+			return CertificateAuthenticator.fromKey(key, pem.getPrivateKeyPassword(), certificates);
 		}
 		Jks jks = this.properties.getAuthentication().getJks();
 		if (jks.getLocation() != null) {
@@ -239,30 +247,32 @@ static final class PropertiesCouchbaseConnectionDetails implements CouchbaseConn
 
 		private final CouchbaseProperties properties;
 
-		private final SslBundles sslBundles;
+		private final @Nullable SslBundles sslBundles;
 
-		PropertiesCouchbaseConnectionDetails(CouchbaseProperties properties, SslBundles sslBundles) {
+		PropertiesCouchbaseConnectionDetails(CouchbaseProperties properties, @Nullable SslBundles sslBundles) {
 			this.properties = properties;
 			this.sslBundles = sslBundles;
 		}
 
 		@Override
 		public String getConnectionString() {
-			return this.properties.getConnectionString();
+			String connectionString = this.properties.getConnectionString();
+			Assert.state(connectionString != null, "'connectionString' must not be null");
+			return connectionString;
 		}
 
 		@Override
-		public String getUsername() {
+		public @Nullable String getUsername() {
 			return this.properties.getUsername();
 		}
 
 		@Override
-		public String getPassword() {
+		public @Nullable String getPassword() {
 			return this.properties.getPassword();
 		}
 
 		@Override
-		public SslBundle getSslBundle() {
+		public @Nullable SslBundle getSslBundle() {
 			Ssl ssl = this.properties.getEnv().getSsl();
 			if (!ssl.getEnabled()) {
 				return null;

module/spring-boot-couchbase/src/main/java/org/springframework/boot/couchbase/autoconfigure/CouchbaseConnectionDetails.java

@@ -16,6 +16,8 @@
 
 package org.springframework.boot.couchbase.autoconfigure;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.boot.autoconfigure.service.connection.ConnectionDetails;
 import org.springframework.boot.ssl.SslBundle;
 
@@ -39,19 +41,19 @@ public interface CouchbaseConnectionDetails extends ConnectionDetails {
 	 * Cluster username.
 	 * @return the cluster username
 	 */
-	String getUsername();
+	@Nullable String getUsername();
 
 	/**
 	 * Cluster password.
 	 * @return the cluster password
 	 */
-	String getPassword();
+	@Nullable String getPassword();
 
 	/**
 	 * SSL bundle to use.
 	 * @return the SSL bundle to use
 	 */
-	default SslBundle getSslBundle() {
+	default @Nullable SslBundle getSslBundle() {
 		return null;
 	}
 

module/spring-boot-couchbase/src/main/java/org/springframework/boot/couchbase/autoconfigure/CouchbaseProperties.java

@@ -18,6 +18,8 @@
 
 import java.time.Duration;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.util.StringUtils;
 
@@ -38,43 +40,43 @@ public class CouchbaseProperties {
 	/**
 	 * Connection string used to locate the Couchbase cluster.
 	 */
-	private String connectionString;
+	private @Nullable String connectionString;
 
 	/**
 	 * Cluster username.
 	 */
-	private String username;
+	private @Nullable String username;
 
 	/**
 	 * Cluster password.
 	 */
-	private String password;
+	private @Nullable String password;
 
 	private final Authentication authentication = new Authentication();
 
 	private final Env env = new Env();
 
-	public String getConnectionString() {
+	public @Nullable String getConnectionString() {
 		return this.connectionString;
 	}
 
-	public void setConnectionString(String connectionString) {
+	public void setConnectionString(@Nullable String connectionString) {
 		this.connectionString = connectionString;
 	}
 
-	public String getUsername() {
+	public @Nullable String getUsername() {
 		return this.username;
 	}
 
-	public void setUsername(String username) {
+	public void setUsername(@Nullable String username) {
 		this.username = username;
 	}
 
-	public String getPassword() {
+	public @Nullable String getPassword() {
 		return this.password;
 	}
 
-	public void setPassword(String password) {
+	public void setPassword(@Nullable String password) {
 		this.password = password;
 	}
 
@@ -105,39 +107,39 @@ public static class Pem {
 			/**
 			 * PEM-formatted certificates for certificate-based cluster authentication.
 			 */
-			private String certificates;
+			private @Nullable String certificates;
 
 			/**
 			 * PEM-formatted private key for certificate-based cluster authentication.
 			 */
-			private String privateKey;
+			private @Nullable String privateKey;
 
 			/**
 			 * Private key password for certificate-based cluster authentication.
 			 */
-			private String privateKeyPassword;
+			private @Nullable String privateKeyPassword;
 
-			public String getCertificates() {
+			public @Nullable String getCertificates() {
 				return this.certificates;
 			}
 
-			public void setCertificates(String certificates) {
+			public void setCertificates(@Nullable String certificates) {
 				this.certificates = certificates;
 			}
 
-			public String getPrivateKey() {
+			public @Nullable String getPrivateKey() {
 				return this.privateKey;
 			}
 
-			public void setPrivateKey(String privateKey) {
+			public void setPrivateKey(@Nullable String privateKey) {
 				this.privateKey = privateKey;
 			}
 
-			public String getPrivateKeyPassword() {
+			public @Nullable String getPrivateKeyPassword() {
 				return this.privateKeyPassword;
 			}
 
-			public void setPrivateKeyPassword(String privateKeyPassword) {
+			public void setPrivateKeyPassword(@Nullable String privateKeyPassword) {
 				this.privateKeyPassword = privateKeyPassword;
 			}
 
@@ -148,26 +150,26 @@ public static class Jks {
 			/**
 			 * Java KeyStore location for certificate-based cluster authentication.
 			 */
-			private String location;
+			private @Nullable String location;
 
 			/**
 			 * Java KeyStore password for certificate-based cluster authentication.
 			 */
-			private String password;
+			private @Nullable String password;
 
-			public String getLocation() {
+			public @Nullable String getLocation() {
 				return this.location;
 			}
 
-			public void setLocation(String location) {
+			public void setLocation(@Nullable String location) {
 				this.location = location;
 			}
 
-			public String getPassword() {
+			public @Nullable String getPassword() {
 				return this.password;
 			}
 
-			public void setPassword(String password) {
+			public void setPassword(@Nullable String password) {
 				this.password = password;
 			}
 
@@ -247,12 +249,12 @@ public static class Ssl {
 		 * Whether to enable SSL support. Enabled automatically if a "bundle" is provided
 		 * unless specified otherwise.
 		 */
-		private Boolean enabled;
+		private @Nullable Boolean enabled;
 
 		/**
 		 * SSL bundle name.
 		 */
-		private String bundle;
+		private @Nullable String bundle;
 
 		public Boolean getEnabled() {
 			return (this.enabled != null) ? this.enabled : StringUtils.hasText(this.bundle);
@@ -262,11 +264,11 @@ public void setEnabled(Boolean enabled) {
 			this.enabled = enabled;
 		}
 
-		public String getBundle() {
+		public @Nullable String getBundle() {
 			return this.bundle;
 		}
 
-		public void setBundle(String bundle) {
+		public void setBundle(@Nullable String bundle) {
 			this.bundle = bundle;
 		}
 

module/spring-boot-couchbase/src/main/java/org/springframework/boot/couchbase/autoconfigure/health/package-info.java

@@ -17,4 +17,7 @@
 /**
  * Auto-configuration for Couchbase health.
  */
+@NullMarked
 package org.springframework.boot.couchbase.autoconfigure.health;
+
+import org.jspecify.annotations.NullMarked;

module/spring-boot-couchbase/src/main/java/org/springframework/boot/couchbase/autoconfigure/package-info.java

@@ -17,4 +17,7 @@
 /**
  * Auto-configuration for Couchbase.
  */
+@NullMarked
 package org.springframework.boot.couchbase.autoconfigure;
+
+import org.jspecify.annotations.NullMarked;

module/spring-boot-couchbase/src/main/java/org/springframework/boot/couchbase/health/package-info.java

@@ -17,4 +17,7 @@
 /**
  * Health integration for Couchbase.
  */
+@NullMarked
 package org.springframework.boot.couchbase.health;
+
+import org.jspecify.annotations.NullMarked;

module/spring-boot-couchbase/src/main/java/org/springframework/boot/couchbase/testcontainers/CouchbaseContainerConnectionDetailsFactory.java

@@ -16,6 +16,7 @@
 
 package org.springframework.boot.couchbase.testcontainers;
 
+import org.jspecify.annotations.Nullable;
 import org.testcontainers.couchbase.CouchbaseContainer;
 
 import org.springframework.boot.couchbase.autoconfigure.CouchbaseConnectionDetails;
@@ -68,7 +69,7 @@ public String getConnectionString() {
 		}
 
 		@Override
-		public SslBundle getSslBundle() {
+		public @Nullable SslBundle getSslBundle() {
 			return super.getSslBundle();
 		}
 

module/spring-boot-couchbase/src/main/java/org/springframework/boot/couchbase/testcontainers/package-info.java

@@ -17,4 +17,7 @@
 /**
  * Support for testcontainers Couchbase service connections.
  */
+@NullMarked
 package org.springframework.boot.couchbase.testcontainers;
+
+import org.jspecify.annotations.NullMarked;