GH-11248: Make METADATA_VALUE NOT NULL in JdbcMetadataStore schemas

spring-integration-jdbc/src/main/java/org/springframework/integration/jdbc/metadata/JdbcMetadataStore.java

@@ -42,6 +42,12 @@
  * <code>org/springframework/integration/jdbc/schema-*.sql</code>,
  * where <code>*</code> is the target database type.
  * <p>
+ * The {@code METADATA_VALUE} column is {@code NOT NULL}. Values passed to
+ * {@link #put(String, String)} and {@link #putIfAbsent(String, String)} must be non-null;
+ * a {@code null} value cannot be stored and is rejected by the API.
+ * Existing databases created with older schema scripts should migrate the column to
+ * {@code NOT NULL} (and remove any rows with a {@code null} value) when upgrading.
+ * <p>
  * The transaction management is required to use this {@link ConcurrentMetadataStore}.
  * <p>
  * This class implements {@link SmartLifecycle} and calls
@@ -54,6 +60,7 @@
  * @author Artem Bilan
  * @author Gary Russell
  * @author Sanghun Lee
+ * @author Burak Kalayci
  *
  * @since 5.0
  */

spring-integration-jdbc/src/main/resources/org/springframework/integration/jdbc/schema-db2.sql

@@ -55,7 +55,7 @@ CREATE INDEX INT_CHANNEL_MSG_DELETE_IDX ON INT_CHANNEL_MESSAGE (REGION, GROUP_KE
 
 CREATE TABLE INT_METADATA_STORE  (
 	METADATA_KEY VARCHAR(255) NOT NULL,
-	METADATA_VALUE VARCHAR(4000),
+	METADATA_VALUE VARCHAR(4000) NOT NULL,
 	REGION VARCHAR(100) NOT NULL,
 	constraint INT_METADATA_STORE_PK primary key (METADATA_KEY, REGION)
 );

spring-integration-jdbc/src/main/resources/org/springframework/integration/jdbc/schema-derby.sql

@@ -55,7 +55,7 @@ CREATE INDEX INT_CHANNEL_MSG_DELETE_IDX ON INT_CHANNEL_MESSAGE (REGION, GROUP_KE
 
 CREATE TABLE INT_METADATA_STORE  (
 	METADATA_KEY VARCHAR(255) NOT NULL,
-	METADATA_VALUE VARCHAR(4000),
+	METADATA_VALUE VARCHAR(4000) NOT NULL,
 	REGION VARCHAR(100) NOT NULL,
 	constraint INT_METADATA_STORE_PK primary key (METADATA_KEY, REGION)
 );

spring-integration-jdbc/src/main/resources/org/springframework/integration/jdbc/schema-h2.sql

@@ -55,7 +55,7 @@ CREATE INDEX INT_CHANNEL_MSG_DELETE_IDX ON INT_CHANNEL_MESSAGE (REGION, GROUP_KE
 
 CREATE TABLE INT_METADATA_STORE  (
 	METADATA_KEY VARCHAR(255) NOT NULL,
-	METADATA_VALUE VARCHAR(4000),
+	METADATA_VALUE VARCHAR(4000) NOT NULL,
 	REGION VARCHAR(100) NOT NULL,
 	constraint INT_METADATA_STORE_PK primary key (METADATA_KEY, REGION)
 );

spring-integration-jdbc/src/main/resources/org/springframework/integration/jdbc/schema-hsqldb.sql

@@ -55,7 +55,7 @@ CREATE INDEX INT_CHANNEL_MSG_DELETE_IDX ON INT_CHANNEL_MESSAGE (REGION, GROUP_KE
 
 CREATE TABLE INT_METADATA_STORE  (
 	METADATA_KEY VARCHAR(255) NOT NULL,
-	METADATA_VALUE VARCHAR(4000),
+	METADATA_VALUE VARCHAR(4000) NOT NULL,
 	REGION VARCHAR(100) NOT NULL,
 	constraint INT_METADATA_STORE_PK primary key (METADATA_KEY, REGION)
 );

spring-integration-jdbc/src/main/resources/org/springframework/integration/jdbc/schema-mysql.sql

@@ -55,7 +55,7 @@ CREATE INDEX INT_CHANNEL_MSG_DELETE_IDX ON INT_CHANNEL_MESSAGE (REGION, GROUP_KE
 
 CREATE TABLE INT_METADATA_STORE  (
 	METADATA_KEY VARCHAR(255) NOT NULL,
-	METADATA_VALUE VARCHAR(4000),
+	METADATA_VALUE VARCHAR(4000) NOT NULL,
 	REGION VARCHAR(100) NOT NULL,
 	constraint INT_METADATA_STORE_PK primary key (METADATA_KEY, REGION)
 ) ENGINE=InnoDB;

spring-integration-jdbc/src/main/resources/org/springframework/integration/jdbc/schema-oracle.sql

@@ -54,7 +54,7 @@ CREATE INDEX INT_CHANNEL_MSG_DELETE_IDX ON INT_CHANNEL_MESSAGE (REGION, GROUP_KE
 
 CREATE TABLE INT_METADATA_STORE  (
 	METADATA_KEY VARCHAR2(255) NOT NULL,
-	METADATA_VALUE VARCHAR2(4000),
+	METADATA_VALUE VARCHAR2(4000) NOT NULL,
 	REGION VARCHAR2(100) NOT NULL,
 	constraint INT_METADATA_STORE_PK primary key (METADATA_KEY, REGION)
 );

spring-integration-jdbc/src/main/resources/org/springframework/integration/jdbc/schema-postgresql.sql

@@ -55,7 +55,7 @@ CREATE INDEX INT_CHANNEL_MSG_DELETE_IDX ON INT_CHANNEL_MESSAGE (REGION, GROUP_KE
 
 CREATE TABLE INT_METADATA_STORE  (
 	METADATA_KEY VARCHAR(255) NOT NULL,
-	METADATA_VALUE VARCHAR(4000),
+	METADATA_VALUE VARCHAR(4000) NOT NULL,
 	REGION VARCHAR(100) NOT NULL,
 	constraint INT_METADATA_STORE_PK primary key (METADATA_KEY, REGION)
 );

spring-integration-jdbc/src/main/resources/org/springframework/integration/jdbc/schema-sqlserver.sql

@@ -55,7 +55,7 @@ CREATE INDEX INT_CHANNEL_MSG_DELETE_IDX ON INT_CHANNEL_MESSAGE (REGION, GROUP_KE
 
 CREATE TABLE INT_METADATA_STORE  (
 	METADATA_KEY NVARCHAR(255) NOT NULL,
-	METADATA_VALUE NVARCHAR(4000),
+	METADATA_VALUE NVARCHAR(4000) NOT NULL,
 	REGION NVARCHAR(100) NOT NULL,
 	constraint INT_METADATA_STORE_PK primary key (METADATA_KEY, REGION)
 );

spring-integration-jdbc/src/main/resources/org/springframework/integration/jdbc/schema-sybase.sql

@@ -55,7 +55,7 @@ CREATE INDEX INT_CHANNEL_MSG_DELETE_IDX ON INT_CHANNEL_MESSAGE (REGION, GROUP_KE
 
 CREATE TABLE INT_METADATA_STORE  (
 	METADATA_KEY VARCHAR(255) NOT NULL,
-	METADATA_VALUE VARCHAR(4000),
+	METADATA_VALUE VARCHAR(4000) NOT NULL,
 	REGION VARCHAR(100) NOT NULL,
 	constraint INT_METADATA_STORE_PK primary key (METADATA_KEY, REGION)
 ) LOCK DATAROWS;

spring-integration-jdbc/src/test/java/org/springframework/integration/jdbc/metadata/JdbcMetadataStoreTests.java

@@ -26,7 +26,9 @@
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.ApplicationContextException;
+import org.springframework.dao.DataIntegrityViolationException;
 import org.springframework.integration.test.util.TestUtils;
+import org.springframework.jdbc.core.JdbcTemplate;
 import org.springframework.test.annotation.DirtiesContext;
 import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
 import org.springframework.transaction.annotation.Transactional;
@@ -37,6 +39,7 @@
 /**
  * @author Bojan Vukasovic
  * @author Artem Bilan
+ * @author Burak Kalayci
  *
  * @since 5.0
  */
@@ -124,4 +127,27 @@ void noTableThrowsExceptionOnStart() {
 		}
 	}
 
+	@Test
+	void metadataValueColumnRejectsNull() {
+		JdbcTemplate jdbcTemplate = new JdbcTemplate(this.dataSource);
+		assertThatExceptionOfType(DataIntegrityViolationException.class)
+				.isThrownBy(() -> jdbcTemplate.update(
+						"INSERT INTO INT_METADATA_STORE(METADATA_KEY, METADATA_VALUE, REGION) VALUES (?, ?, ?)",
+						"nullValued", null, "DEFAULT"));
+	}
+
+	@Test
+	void putIfAbsentRejectsNullValue() {
+		assertThatExceptionOfType(IllegalArgumentException.class)
+				.isThrownBy(() -> this.metadataStore.putIfAbsent("testKey", null))
+				.withMessageContaining("value");
+	}
+
+	@Test
+	void putRejectsNullValue() {
+		assertThatExceptionOfType(IllegalArgumentException.class)
+				.isThrownBy(() -> this.metadataStore.put("testKey", null))
+				.withMessageContaining("value");
+	}
+
 }

src/reference/antora/modules/ROOT/pages/jdbc/metadata-store.adoc

@@ -29,7 +29,7 @@ For example, the following listing shows the H2 DDL for the metadata table:
 ----
 CREATE TABLE INT_METADATA_STORE  (
 	METADATA_KEY VARCHAR(255) NOT NULL,
-	METADATA_VALUE VARCHAR(4000),
+	METADATA_VALUE VARCHAR(4000) NOT NULL,
 	REGION VARCHAR(100) NOT NULL,
 	constraint INT_METADATA_STORE_PK primary key (METADATA_KEY, REGION)
 );

src/reference/antora/modules/ROOT/pages/whats-new.adoc

@@ -30,3 +30,10 @@ The `wait-for-confirm` option on the outbound channel adapter now also works wit
 When the message has no correlation data, the send is performed within the scope of a `RabbitTemplate.invoke()` operation and `waitForConfirmsOrDie()` is used.
 A warning is now logged when the option is set but the connection factory supports no publisher confirms at all.
 See xref:amqp/outbound-channel-adapter.adoc[] for more information.
+
+[[x7.2-jdbc-changes]]
+=== JDBC Support Changes
+
+The `METADATA_VALUE` column in the `JdbcMetadataStore` schema scripts is now `NOT NULL`.
+Existing databases created with older scripts should remove any null-valued rows and alter the column to `NOT NULL` when upgrading.
+See xref:jdbc/metadata-store.adoc[] for more information.