feat(gql-status-object): make GQL Status Object GA (#1669)

This update makes GQL Status Object GA and deprecates Notification.

Author: injectives

driver/src/main/java/org/neo4j/driver/Config.java

@@ -40,7 +40,6 @@
 import org.neo4j.driver.net.ServerAddressResolver;
 import org.neo4j.driver.util.Experimental;
 import org.neo4j.driver.util.Immutable;
-import org.neo4j.driver.util.Preview;
 import org.neo4j.driver.util.Resource;
 
 /**
@@ -144,6 +143,7 @@ public final class Config implements Serializable {
     /**
      * The notification config.
      */
+    @SuppressWarnings("deprecation")
     private final NotificationConfig notificationConfig;
     /**
      * The {@link MetricsAdapter}.
@@ -325,7 +325,10 @@ public long fetchSize() {
      *
      * @return the notification config
      * @since 5.7
+     * @deprecated superseded by {@link Config#minimumNotificationSeverity()} and
+     * {@link Config#disabledNotificationClassifications()}.
      */
+    @Deprecated
     public NotificationConfig notificationConfig() {
         return notificationConfig;
     }
@@ -336,7 +339,6 @@ public NotificationConfig notificationConfig() {
      * @return an {@link Optional} of minimum {@link NotificationSeverity} or an empty {@link Optional} if it is not set
      * @since 5.22.0
      */
-    @Preview(name = "GQL-status object")
     public Optional<NotificationSeverity> minimumNotificationSeverity() {
         return Optional.ofNullable(((InternalNotificationConfig) notificationConfig).minimumSeverity());
     }
@@ -346,7 +348,6 @@ public Optional<NotificationSeverity> minimumNotificationSeverity() {
      * @return the {@link Set} of disabled {@link NotificationClassification}
      * @since 5.22.0
      */
-    @Preview(name = "GQL-status object")
     public Set<NotificationClassification> disabledNotificationClassifications() {
         var disabledCategories = ((InternalNotificationConfig) notificationConfig).disabledCategories();
         return disabledCategories != null
@@ -428,6 +429,7 @@ public static final class ConfigBuilder {
         private long fetchSize = 1000;
         private int eventLoopThreads = 0;
 
+        @SuppressWarnings("deprecation")
         private NotificationConfig notificationConfig = NotificationConfig.defaultConfig();
 
         private boolean telemetryDisabled = false;
@@ -824,7 +826,11 @@ public ConfigBuilder withUserAgent(String userAgent) {
          * @param notificationConfig the notification config
          * @return this builder
          * @since 5.7
+         * @deprecated superseded by {@link ConfigBuilder#withMinimumNotificationSeverity(NotificationSeverity)} and
+         * {@link ConfigBuilder#withDisabledNotificationClassifications(Set)}.
          */
+        @SuppressWarnings("DeprecatedIsStillUsed")
+        @Deprecated
         public ConfigBuilder withNotificationConfig(NotificationConfig notificationConfig) {
             this.notificationConfig = Objects.requireNonNull(notificationConfig, "notificationConfig must not be null");
             return this;
@@ -837,7 +843,7 @@ public ConfigBuilder withNotificationConfig(NotificationConfig notificationConfi
          * @return this builder
          * @since 5.22.0
          */
-        @Preview(name = "GQL-status object")
+        @SuppressWarnings("deprecation")
         public ConfigBuilder withMinimumNotificationSeverity(NotificationSeverity minimumNotificationSeverity) {
             if (minimumNotificationSeverity == null) {
                 notificationConfig = NotificationConfig.disableAllConfig();
@@ -854,7 +860,7 @@ public ConfigBuilder withMinimumNotificationSeverity(NotificationSeverity minimu
          * @return this builder
          * @since 5.22.0
          */
-        @Preview(name = "GQL-status object")
+        @SuppressWarnings("deprecation")
         public ConfigBuilder withDisabledNotificationClassifications(
                 Set<NotificationClassification> disabledNotificationClassifications) {
             var disabledCategories = disabledNotificationClassifications == null

driver/src/main/java/org/neo4j/driver/NotificationCategory.java

@@ -22,7 +22,9 @@
  * Notification category.
  *
  * @since 5.7
+ * @deprecated superseded by {@link NotificationClassification}.
  */
+@Deprecated
 public sealed interface NotificationCategory extends Serializable permits NotificationClassification {
     /**
      * A hint category.

driver/src/main/java/org/neo4j/driver/NotificationClassification.java

@@ -16,14 +16,12 @@
  */
 package org.neo4j.driver;
 
-import org.neo4j.driver.util.Preview;
-
 /**
  * Notification classification.
  *
  * @since 5.22.0
  */
-@Preview(name = "GQL-status object")
+@SuppressWarnings("deprecation")
 public enum NotificationClassification implements NotificationCategory {
     /**
      * A hint category.
@@ -94,6 +92,7 @@ public enum NotificationClassification implements NotificationCategory {
      * <p>
      * Please note that this category was added to a later server version. Therefore, a compatible server version is
      * required to use it.
+     *
      * @since 5.24.0
      */
     SCHEMA

driver/src/main/java/org/neo4j/driver/NotificationConfig.java

@@ -18,6 +18,7 @@
 
 import java.io.Serializable;
 import java.util.Set;
+import org.neo4j.driver.Config.ConfigBuilder;
 import org.neo4j.driver.internal.InternalNotificationConfig;
 import org.neo4j.driver.internal.InternalNotificationSeverity;
 import org.neo4j.driver.summary.ResultSummary;
@@ -37,8 +38,13 @@
  *
  * @since 5.7
  * @see ResultSummary#notifications()
- * @see org.neo4j.driver.summary.Notification
+ * @deprecated superseded by e org.neo4j.driver.summary.Notification
+ * {@link ConfigBuilder#withMinimumNotificationSeverity(NotificationSeverity)},
+ * {@link ConfigBuilder#withDisabledNotificationClassifications(Set)},
+ * {@link SessionConfig.Builder#withMinimumNotificationSeverity(NotificationSeverity)} and
+ * {@link SessionConfig.Builder#withDisabledNotificationClassifications(Set)}.
  */
+@Deprecated
 public sealed interface NotificationConfig extends Serializable permits InternalNotificationConfig {
     /**
      * Returns a default notification configuration.

driver/src/main/java/org/neo4j/driver/NotificationSeverity.java

@@ -21,7 +21,6 @@
 import java.io.Serializable;
 import org.neo4j.driver.Config.ConfigBuilder;
 import org.neo4j.driver.internal.InternalNotificationSeverity;
-import org.neo4j.driver.util.Preview;
 
 /**
  * Notification severity level.
@@ -44,6 +43,5 @@ public sealed interface NotificationSeverity extends Serializable, Comparable<No
      * @see ConfigBuilder#withMinimumNotificationSeverity(NotificationSeverity)
      * @see SessionConfig.Builder#withMinimumNotificationSeverity(NotificationSeverity)
      */
-    @Preview(name = "GQL-status object")
     NotificationSeverity OFF = new InternalNotificationSeverity(Type.OFF, Integer.MAX_VALUE);
 }

driver/src/main/java/org/neo4j/driver/SessionConfig.java

@@ -31,7 +31,6 @@
 import org.neo4j.driver.exceptions.UnsupportedFeatureException;
 import org.neo4j.driver.internal.InternalNotificationConfig;
 import org.neo4j.driver.reactive.ReactiveSession;
-import org.neo4j.driver.util.Preview;
 
 /**
  * The session configurations used to configure a session.
@@ -70,6 +69,7 @@ public final class SessionConfig implements Serializable {
     /**
      * The notification config.
      */
+    @SuppressWarnings("deprecation")
     private final NotificationConfig notificationConfig;
 
     private SessionConfig(Builder builder) {
@@ -171,7 +171,10 @@ public Optional<BookmarkManager> bookmarkManager() {
      * Returns notification config.
      * @return the notification config
      * @since 5.7
+     * @deprecated superseded by {@link SessionConfig#minimumNotificationSeverity()} and
+     * {@link SessionConfig#disabledNotificationClassifications()}.
      */
+    @Deprecated
     public NotificationConfig notificationConfig() {
         return notificationConfig;
     }
@@ -182,7 +185,6 @@ public NotificationConfig notificationConfig() {
      * @return an {@link Optional} of minimum {@link NotificationSeverity} or an empty {@link Optional} if it is not set
      * @since 5.22.0
      */
-    @Preview(name = "GQL-status object")
     public Optional<NotificationSeverity> minimumNotificationSeverity() {
         return Optional.ofNullable(((InternalNotificationConfig) notificationConfig).minimumSeverity());
     }
@@ -192,7 +194,6 @@ public Optional<NotificationSeverity> minimumNotificationSeverity() {
      * @return the {@link Set} of disabled {@link NotificationClassification}
      * @since 5.22.0
      */
-    @Preview(name = "GQL-status object")
     public Set<NotificationClassification> disabledNotificationClassifications() {
         var disabledCategories = ((InternalNotificationConfig) notificationConfig).disabledCategories();
         return disabledCategories != null
@@ -247,6 +248,7 @@ public static final class Builder {
         private String impersonatedUser = null;
         private BookmarkManager bookmarkManager;
 
+        @SuppressWarnings("deprecation")
         private NotificationConfig notificationConfig = NotificationConfig.defaultConfig();
 
         private Builder() {}
@@ -428,7 +430,11 @@ public Builder withBookmarkManager(BookmarkManager bookmarkManager) {
          * @param notificationConfig the notification config
          * @return this builder
          * @since 5.7
+         * @deprecated superseded by {@link SessionConfig.Builder#withMinimumNotificationSeverity(NotificationSeverity)} and
+         * {@link SessionConfig.Builder#withDisabledNotificationClassifications(Set)}.
          */
+        @SuppressWarnings("DeprecatedIsStillUsed")
+        @Deprecated
         public Builder withNotificationConfig(NotificationConfig notificationConfig) {
             this.notificationConfig = Objects.requireNonNull(notificationConfig, "notificationConfig must not be null");
             return this;
@@ -441,7 +447,7 @@ public Builder withNotificationConfig(NotificationConfig notificationConfig) {
          * @return this builder
          * @since 5.22.0
          */
-        @Preview(name = "GQL-status object")
+        @SuppressWarnings("deprecation")
         public Builder withMinimumNotificationSeverity(NotificationSeverity minimumNotificationSeverity) {
             if (minimumNotificationSeverity == null) {
                 notificationConfig = NotificationConfig.disableAllConfig();
@@ -458,7 +464,7 @@ public Builder withMinimumNotificationSeverity(NotificationSeverity minimumNotif
          * @return this builder
          * @since 5.22.0
          */
-        @Preview(name = "GQL-status object")
+        @SuppressWarnings("deprecation")
         public Builder withDisabledNotificationClassifications(
                 Set<NotificationClassification> disabledNotificationClassifications) {
             var disabledCategories = disabledNotificationClassifications == null

driver/src/main/java/org/neo4j/driver/internal/GqlNotificationConfig.java

@@ -29,7 +29,7 @@ public static GqlNotificationConfig defaultConfig() {
         return new GqlNotificationConfig(null, null);
     }
 
-    public static GqlNotificationConfig from(NotificationConfig notificationConfig) {
+    public static GqlNotificationConfig from(@SuppressWarnings("deprecation") NotificationConfig notificationConfig) {
         Objects.requireNonNull(notificationConfig);
         var config = (InternalNotificationConfig) notificationConfig;
         var disabledClassifications = config.disabledCategories() != null

driver/src/main/java/org/neo4j/driver/internal/InternalNotificationConfig.java

@@ -22,6 +22,7 @@
 import org.neo4j.driver.NotificationConfig;
 import org.neo4j.driver.NotificationSeverity;
 
+@SuppressWarnings("deprecation")
 public record InternalNotificationConfig(
         NotificationSeverity minimumSeverity, Set<NotificationCategory> disabledCategories)
         implements NotificationConfig {

driver/src/main/java/org/neo4j/driver/internal/NotificationConfigMapper.java

@@ -22,6 +22,7 @@
 import org.neo4j.bolt.connection.NotificationSeverity;
 import org.neo4j.driver.NotificationCategory;
 
+@SuppressWarnings("deprecation")
 public class NotificationConfigMapper {
     public static NotificationConfig map(org.neo4j.driver.NotificationConfig config) {
         var original = (InternalNotificationConfig) config;

driver/src/main/java/org/neo4j/driver/internal/SessionFactoryImpl.java

@@ -73,6 +73,7 @@ public class SessionFactoryImpl implements SessionFactory {
         this.homeDatabaseCache = Objects.requireNonNull(homeDatabaseCache);
     }
 
+    @SuppressWarnings("deprecation")
     @Override
     public NetworkSession newInstance(
             SessionConfig sessionConfig, AuthToken overrideAuthToken, boolean telemetryDisabled) {
@@ -149,7 +150,7 @@ private NetworkSession createSession(
             String impersonatedUser,
             @SuppressWarnings("deprecation") Logging logging,
             BookmarkManager bookmarkManager,
-            NotificationConfig notificationConfig,
+            @SuppressWarnings("deprecation") NotificationConfig notificationConfig,
             AuthToken authToken,
             boolean telemetryDisabled,
             AuthTokenManager authTokenManager,