org.neo4j.driver.NotificationConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-java-driver Show documentation
Access to the Neo4j graph database through Java
There is a newer version: 5.27.0
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [https://neo4j.com]
 *
 * 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.io.Serializable;
import java.util.Set;
import org.neo4j.driver.internal.InternalNotificationConfig;
import org.neo4j.driver.internal.InternalNotificationSeverity;
import org.neo4j.driver.summary.ResultSummary;
import org.neo4j.driver.util.Preview;

/**
 * A notification configuration defining what notifications should be supplied by the server.
 * 
 * There are currently 2 optional settings that may be activated:
 * 

 *     Minimum notification severity - sets a baseline severity for notifications, similar to the logging levels.
 *     A set of disabled notification categories - explicitly disables a set of notification categories.
 * 
 * 
 * By default, both options are not activated.
 * 

 * Disabling categories or severities allows the server to skip analysis for those, which can speed up query execution.
 *
 * @since 5.7
 * @see ResultSummary#notifications()
 * @see org.neo4j.driver.summary.Notification
 */
@Preview(name = "GQL-status object")
public sealed interface NotificationConfig extends Serializable permits InternalNotificationConfig {
    /**
     * Returns a default notification configuration.
     * 
     * The default configuration has no settings activated, meaning the resulting behaviour depends on an upstream
     * context. For instance, when this config is set on the session level, the resulting behaviour depends on the
     * driver's config. Likewise, when this config is set on the driver level, the resulting behaviour depends on the
     * server.
     *
     * @return the default config
     */
    static NotificationConfig defaultConfig() {
        return new InternalNotificationConfig(null, null);
    }

    /**
     * A config that disables all notifications.
     *
     * @return the config that disables all notifications
     */
    static NotificationConfig disableAllConfig() {
        return new InternalNotificationConfig(InternalNotificationSeverity.OFF, null);
    }

    /**
     * Returns a config that sets a minimum severity level for notifications.
     *
     * @param minimumSeverity the minimum severity level
     * @return the config
     */
    NotificationConfig enableMinimumSeverity(NotificationSeverity minimumSeverity);

    /**
     * Returns a config that disables a set of notification categories.
     *
     * @param disabledCategories the categories to disable, an empty set means no categories are disabled
     * @return the config
     */
    NotificationConfig disableCategories(Set disabledCategories);
}