Initial

Author: injectives

driver/clirr-ignored-differences.xml

@@ -433,4 +433,28 @@
         <method>org.neo4j.driver.BookmarkManager queryTaskBookmarkManager()</method>
     </difference>
 
+    <difference>
+        <className>org/neo4j/driver/summary/Notification</className>
+        <differenceType>7012</differenceType>
+        <method>java.util.Optional severityLevel()</method>
+    </difference>
+
+    <difference>
+        <className>org/neo4j/driver/summary/Notification</className>
+        <differenceType>7012</differenceType>
+        <method>java.util.Optional rawSeverityLevel()</method>
+    </difference>
+
+    <difference>
+        <className>org/neo4j/driver/summary/Notification</className>
+        <differenceType>7012</differenceType>
+        <method>java.util.Optional category()</method>
+    </difference>
+
+    <difference>
+        <className>org/neo4j/driver/summary/Notification</className>
+        <differenceType>7012</differenceType>
+        <method>java.util.Optional rawCategory()</method>
+    </difference>
+
 </differences>

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

@@ -30,6 +30,8 @@
 import java.util.Collections;
 import java.util.List;
 import java.util.Objects;
+import java.util.Optional;
+import java.util.Set;
 import java.util.concurrent.TimeUnit;
 import java.util.logging.Level;
 import org.neo4j.driver.internal.SecuritySettings;
@@ -143,6 +145,14 @@ public final class Config implements Serializable {
      * The user_agent configured for this driver.
      */
     private final String userAgent;
+    /**
+     * The minimum notification severity level.
+     */
+    private NotificationSeveritySetting minNotificationSeverity;
+    /**
+     * The disabled notification categories.
+     */
+    private Set<NotificationCategorySetting> disabledNotificationCategories;
     /**
      * The {@link MetricsAdapter}.
      */
@@ -166,6 +176,8 @@ private Config(ConfigBuilder builder) {
         this.maxTransactionRetryTimeMillis = builder.maxTransactionRetryTimeMillis;
         this.resolver = builder.resolver;
         this.fetchSize = builder.fetchSize;
+        this.minNotificationSeverity = builder.minNotificationSeverity;
+        this.disabledNotificationCategories = builder.disabledNotificationCategories;
 
         this.eventLoopThreads = builder.eventLoopThreads;
         this.metricsAdapter = builder.metricsAdapter;
@@ -311,6 +323,26 @@ public long fetchSize() {
         return fetchSize;
     }
 
+    /**
+     * Returns minimum notification severity level.
+     *
+     * @return the minimum notification severity level
+     * @since 5.7
+     */
+    public NotificationSeveritySetting notificationsMinimumSeverityLevelSeverity() {
+        return minNotificationSeverity;
+    }
+
+    /**
+     * Returns disabled notification categories.
+     *
+     * @return the disabled notification categories
+     * @since 5.7
+     */
+    public Optional<DisabledNotificationCategories> notificationsDisabledCategories() {
+        return Optional.ofNullable(disabledNotificationCategories).map(DisabledNotificationCategories::new);
+    }
+
     /**
      * Returns the number of {@link io.netty.channel.EventLoop} threads.
      * @return the number of threads
@@ -362,6 +394,8 @@ public static final class ConfigBuilder {
         private ServerAddressResolver resolver;
         private MetricsAdapter metricsAdapter = MetricsAdapter.DEV_NULL;
         private long fetchSize = FetchSizeUtil.DEFAULT_FETCH_SIZE;
+        private NotificationSeveritySetting minNotificationSeverity = NotificationSeveritySetting.INHERIT;
+        private Set<NotificationCategorySetting> disabledNotificationCategories = null;
         private int eventLoopThreads = 0;
 
         private ConfigBuilder() {}
@@ -757,6 +791,49 @@ public ConfigBuilder withUserAgent(String userAgent) {
             return this;
         }
 
+        /**
+         * Sets minimum notification severity level that is used by the server when supplying the notifications.
+         * <p>
+         * By default, it is set to {@link NotificationSeveritySetting#INHERIT}.
+         *
+         * @param severity the minimum severity level
+         * @return this builder
+         * @see org.neo4j.driver.summary.Notification
+         * @since 5.7
+         */
+        public ConfigBuilder withMinimumNotificationSeverity(NotificationSeveritySetting severity) {
+            this.minNotificationSeverity = Objects.requireNonNull(severity, "severity must not be null");
+            return this;
+        }
+
+        /**
+         * Sets notification categories that will be disabled by the server when supplying the notifications.
+         * <p>
+         * By default, this has no explicit value. The server determines the behaviour.
+         *
+         * @param categories the set of disabled notification categories
+         * @return this builder
+         * @see org.neo4j.driver.summary.Notification
+         * @since 5.7
+         */
+        public ConfigBuilder withDisabledNotificationCategories(Set<NotificationCategorySetting> categories) {
+            this.disabledNotificationCategories =
+                    Set.copyOf(Objects.requireNonNull(categories, "categories must not be null"));
+            return this;
+        }
+
+        /**
+         * Unsets disabled notification categories.
+         *
+         * @return this builder
+         * @see org.neo4j.driver.summary.Notification
+         * @since 5.7
+         */
+        public ConfigBuilder withInheritedDisabledNotificationCategories() {
+            this.disabledNotificationCategories = null;
+            return this;
+        }
+
         /**
          * Extracts the driver version from the driver jar MANIFEST.MF file.
          */

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

@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.neo4j.driver;
+
+import java.util.Set;
+
+/**
+ * Disabled notification categories.
+ *
+ * @param categories the disabled categories
+ * @since 5.7
+ */
+public record DisabledNotificationCategories(Set<NotificationCategorySetting> categories) {}

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

@@ -0,0 +1,66 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.neo4j.driver;
+
+import org.neo4j.driver.summary.Notification;
+
+/**
+ * {@link Notification} categories that are used in {@link Config} and {@link SessionConfig}.
+ *
+ * @since 5.7
+ */
+public enum NotificationCategorySetting {
+    /**
+     * A hint category.
+     * <p>
+     * For instance, the given hint cannot be satisfied.
+     */
+    HINT,
+    /**
+     * An unrecognized category.
+     * <p>
+     * For instance, the query or command mentions entities that are unknown to the system.
+     */
+    UNRECOGNIZED,
+    /**
+     * An unsupported category.
+     * <p>
+     * For instance, the query/command is trying to use features that are not supported by the current system or using
+     * features that are experimental and should not be used in production.
+     */
+    UNSUPPORTED,
+    /**
+     * A performance category.
+     * <p>
+     * For instance, the query uses costly operations and might be slow.
+     */
+    PERFORMANCE,
+    /**
+     * A deprecation category.
+     * <p>
+     * For instance, the query/command use deprecated features that should be replaced.
+     */
+    DEPRECATION,
+    /**
+     * A generic category.
+     * <p>
+     * For instance, notifications that are not part of a more specific class.
+     */
+    GENERIC
+}

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

@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.neo4j.driver;
+
+import org.neo4j.driver.summary.Notification;
+
+/**
+ * {@link Notification} severity levels that are used in {@link Config} and {@link SessionConfig}.
+ *
+ * @since 5.7
+ */
+public enum NotificationSeveritySetting {
+    /**
+     * A warning severity level.
+     */
+    WARNING,
+    /**
+     * An information severity level.
+     */
+    INFORMATION,
+    /**
+     * A special value indicating that severity level is inherited from an upstream configuration.
+     * <p>
+     * For instance, if this is set on the {@link org.neo4j.driver.SessionConfig}, then the value is inherited from the
+     * driver's {@link org.neo4j.driver.Config}. Likewise, if this is set on the driver's
+     * {@link org.neo4j.driver.Config}, then the value is effectively inherited from the server.
+     */
+    INHERIT,
+    /**
+     * A special value that turns off all notifications.
+     */
+    OFF
+}