org.neo4j.configuration.connectors.BoltConnectorInternalSettings Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-configuration Show documentation
Code responsible for parsing the Neo4j configuration.
There is a newer version: 5.26.0
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.configuration.connectors;

import java.nio.file.Path;
import java.time.Duration;

import org.neo4j.annotations.service.ServiceProvider;
import org.neo4j.configuration.Description;
import org.neo4j.configuration.Internal;
import org.neo4j.configuration.SettingsDeclaration;
import org.neo4j.graphdb.config.Setting;
import org.neo4j.io.ByteUnit;

import static java.time.Duration.ofMinutes;
import static java.time.Duration.ofSeconds;
import static org.neo4j.configuration.SettingImpl.newBuilder;
import static org.neo4j.configuration.SettingValueParsers.BOOL;
import static org.neo4j.configuration.SettingValueParsers.BYTES;
import static org.neo4j.configuration.SettingValueParsers.DURATION;
import static org.neo4j.configuration.SettingValueParsers.INT;
import static org.neo4j.configuration.SettingValueParsers.PATH;
import static org.neo4j.configuration.SettingValueParsers.ofEnum;

@ServiceProvider
public final class BoltConnectorInternalSettings implements SettingsDeclaration
{
    public static final String LOOPBACK_NAME = "bolt-loopback";
    public static final int DEFAULT_LOOPBACK_CONNECTOR_PORT = 7689;

    @Internal
    @Description( "The queue size of the thread pool bound to this connector (-1 for unbounded, 0 for direct handoff, > 0 for bounded)" )
    public static final Setting unsupported_thread_pool_queue_size =
            newBuilder( "dbms.connector.bolt.unsupported_thread_pool_queue_size", INT, 0 ).build();

    @Internal
    @Description( "Enable TCP keep alive probes on this connector" )
    public static final Setting tcp_keep_alive = newBuilder( "dbms.connector.bolt.tcp_keep_alive", BOOL, true ).build();

    @Internal
    @Description( "The maximum time to wait for a user to finish authentication before closing the connection." )
    public static final Setting unsupported_bolt_unauth_connection_timeout =
            newBuilder( "dbms.connector.bolt.unsupported_unauth_connection_timeout", DURATION, ofSeconds( 30 ) ).build();

    @Internal
    @Description( "The maximum inbound message size in bytes are allowed before a connection is authenticated." )
    public static final Setting unsupported_bolt_unauth_connection_max_inbound_bytes =
            newBuilder( "dbms.connector.bolt.unsupported_unauth_max_inbound_bytes", BYTES, ByteUnit.kibiBytes( 8 ) ).build();

    @Internal
    @Description( "The absolute path of the file for use with the Unix Domain Socket based loopback interface. " +
                  "This file must be specified and will be created at runtime and deleted on shutdown." )
    public static final Setting unsupported_loopback_listen_file =
            newBuilder( "unsupported.dbms.loopback_file", PATH, null ).build();

    @Internal
    @Description( "Whether or not to delete an existing file for use with the Unix Domain Socket based loopback interface. " +
                  "This improves the handling of the case where a previous hard shutdown was unable to delete the file." )
    public static final Setting unsupported_loopback_delete =
            newBuilder( "unsupported.dbms.loopback_delete", BOOL, false ).build();

    @Internal
    @Description( "Enable or disable the bolt loopback connector. " +
                  "A user successfully authenticated over this will execute all queries with no security restrictions. " +
                  "This includes overriding the `" + "unsupported.dbms.block_create_drop_database" + "`, " +
                  "`" + "unsupported.dbms.block_start_stop_database" + "` and `" + "unsupported.dbms.upgrade_restriction_enabled" + "` settings." )
    public static final Setting enable_loopback_auth =
            newBuilder( "unsupported.dbms.loopback_enabled", BOOL, false ).build();
}