org.neo4j.server.configuration.ClientConnectorSettings Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of neo4j-dbms Show documentation
This component provides management functionality and product surface for Neo4j instances.
There is a newer version: 5.23.0
/*
 * Copyright (c) 2002-2018 "Neo Technology,"
 * Network Engine for Objects in Lund AB [http://neotechnology.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.server.configuration;

import java.util.List;
import java.util.Optional;
import java.util.stream.Collectors;

import org.neo4j.graphdb.config.Setting;
import org.neo4j.graphdb.factory.Description;
import org.neo4j.graphdb.factory.GraphDatabaseSettings;
import org.neo4j.helpers.AdvertisedSocketAddress;
import org.neo4j.helpers.ListenSocketAddress;
import org.neo4j.kernel.configuration.Config;

import static java.util.Collections.singletonList;

import static org.neo4j.graphdb.factory.GraphDatabaseSettings.Connector.ConnectorType.HTTP;
import static org.neo4j.kernel.configuration.GroupSettingSupport.enumerate;
import static org.neo4j.kernel.configuration.Settings.NO_DEFAULT;
import static org.neo4j.kernel.configuration.Settings.advertisedAddress;
import static org.neo4j.kernel.configuration.Settings.legacyFallback;
import static org.neo4j.kernel.configuration.Settings.listenAddress;
import static org.neo4j.kernel.configuration.Settings.options;
import static org.neo4j.kernel.configuration.Settings.setting;

public class ClientConnectorSettings
{
    public static HttpConnector httpConnector( String key )
    {
        return new HttpConnector( key, HttpConnector.Encryption.NONE );
    }

    public static Optional httpConnector( Config config, HttpConnector.Encryption encryption )
    {
        List httpConnectors = config
                .view( enumerate( GraphDatabaseSettings.Connector.class ) )
                .map( ( key ) -> new HttpConnector( key, encryption ) )
                .filter( ( connConfig ) -> connConfig.group.groupKey.equals( encryption.uriScheme ) ||
                        (config.get( connConfig.type ) == HTTP && config.get( connConfig.encryption ) == encryption) )
                .collect( Collectors.toList() );
        if ( httpConnectors.isEmpty() )
        {
            httpConnectors = singletonList( new HttpConnector( encryption ) );
        }

        return httpConnectors.stream()
                .filter( ( connConfig ) -> config.get( connConfig.enabled ) )
                .findFirst();
    }

    @Description("Configuration options for HTTP connectors. " +
            "\"(http-connector-key)\" is a placeholder for a unique name for the connector, for instance " +
            "\"http-public\" or some other name that describes what the connector is for.")
    public static class HttpConnector extends GraphDatabaseSettings.Connector
    {
        @Description("Enable TLS for this connector")
        public final Setting encryption;

        @Description( "Address the connector should bind to. " +
                "This setting is deprecated and will be replaced by `+listen_address+`" )
        public final Setting address;

        @Description( "Address the connector should bind to" )
        public final Setting listen_address;

        @Description( "Advertised address for this connector" )
        public final Setting advertised_address;

        public HttpConnector()
        {
            this( Encryption.NONE );
        }

        public HttpConnector( Encryption encryptionLevel )
        {
            this( "(http-connector-key)", encryptionLevel );
        }

        public HttpConnector( String key, Encryption encryptionLevel )
        {
            super( key, null );
            encryption = group.scope( setting( "encryption", options( HttpConnector.Encryption.class ), NO_DEFAULT ) );
            Setting legacyAddressSetting = listenAddress( "address", encryptionLevel.defaultPort );
            Setting listenAddressSetting = legacyFallback( legacyAddressSetting,
                    listenAddress( "listen_address", encryptionLevel.defaultPort ) );

            this.address = group.scope( legacyAddressSetting );
            this.listen_address = group.scope( listenAddressSetting );
            this.advertised_address = group.scope( advertisedAddress( "advertised_address", listenAddressSetting ) );
        }

        public enum Encryption
        {
            NONE( "http", 7474 ), TLS( "https", 7473 );

            final String uriScheme;
            final int defaultPort;

            Encryption( String uriScheme, int defaultPort )
            {
                this.uriScheme = uriScheme;
                this.defaultPort = defaultPort;
            }
        }
    }
}