org.neo4j.server.configuration.ServerSettings Maven / Gradle / Ivy
/*
* Copyright (c) 2002-2016 "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 maximum_request_header_size =
setting( "unsupported.dbms.max_http_request_header_size", INTEGER, "20480" );
@Description("Maximum response header size")
@Internal
Setting maximum_response_header_size =
setting( "unsupported.dbms.max_http_response_header_size", INTEGER, "20480" );
@Description("Comma-seperated list of custom security rules for Neo4j to use.")
Setting> security_rules = setting( "dbms.security.http_authorization_classes", STRING_LIST, EMPTY );
@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.")
class HttpConnector extends GraphDatabaseSettings.Connector
{
@Description("Enable TLS for this connector")
public final Setting encryption;
@Description("Address the connector should bind to")
public final Setting address;
public HttpConnector()
{
this( "(http-connector-key)" );
}
public HttpConnector( String key )
{
super( key, ConnectorType.HTTP.name() );
address = group.scope( setting( "address", HOSTNAME_PORT, "localhost:7474" ) );
encryption = group.scope( setting( "encryption", options( Encryption.class ), Encryption.NONE.name() ) );
}
public enum Encryption
{
NONE, TLS
}
}
static HttpConnector httpConnector( String key )
{
return new HttpConnector( key );
}
static Optional httpConnector( Config config, HttpConnector.Encryption encryption )
{
return config
.view( enumerate( GraphDatabaseSettings.Connector.class ) )
.map( HttpConnector::new )
.filter( ( connConfig ) -> {
return config.get( connConfig.type ) == HTTP
&& config.get( connConfig.enabled )
&& config.get( connConfig.encryption ) == encryption;
} )
.findFirst();
}
@Description( "Number of Neo4j worker threads, your OS might enforce a lower limit than the maximum value " +
"specified here." )
Setting webserver_max_threads = setting( "dbms.threads.worker_count", INTEGER,
"" + Math.min( Runtime.getRuntime().availableProcessors(), 500 ),
range( 1, JettyThreadCalculator.MAX_THREADS ) );
@Description("If execution time limiting is enabled in the database, this configures the maximum request execution time.")
@Internal
Setting webserver_limit_execution_time =
setting( "unsupported.dbms.executiontime_limit.time", DURATION, NO_DEFAULT );
@Internal
Setting> console_module_engines = setting(
"unsupported.dbms.console_module.engines", STRING_LIST, "SHELL" );
@Description("Comma-separated list of = for unmanaged extensions.")
Setting> third_party_packages = setting( "dbms.unmanaged_extension_classes",
new Function>()
{
@Override
public List apply( String value )
{
String[] list = value.split( Settings.SEPARATOR );
List result = new ArrayList<>();
for ( String item : list )
{
item = item.trim();
if ( !item.equals( "" ) )
{
result.add( createThirdPartyJaxRsPackage( item ) );
}
}
return result;
}
@Override
public String toString()
{
return "a comma-seperated list of = strings";
}
private ThirdPartyJaxRsPackage createThirdPartyJaxRsPackage( String packageAndMoutpoint )
{
String[] parts = packageAndMoutpoint.split( "=" );
if ( parts.length != 2 )
{
throw new IllegalArgumentException( "config for " + ServerSettings.third_party_packages.name()
+ " is wrong: " + packageAndMoutpoint );
}
String pkg = parts[0];
String mountPoint = parts[1];
return new ThirdPartyJaxRsPackage( pkg, mountPoint );
}
},
EMPTY );
@Description( "Directory for storing certificates to be used by Neo4j for TLS connections" )
Setting certificates_directory = BoltKernelExtension.Settings.certificates_directory;
@Internal
@Description("Path to the X.509 public certificate to be used by Neo4j for TLS connections")
Setting tls_certificate_file = BoltKernelExtension.Settings.tls_certificate_file;
@Internal
@Description("Path to the X.509 private key to be used by Neo4j for TLS connections")
Setting tls_key_file = BoltKernelExtension.Settings.tls_key_file;
@Description("Enable HTTP request logging.")
Setting http_logging_enabled = setting( "dbms.logs.http.enabled", BOOLEAN, FALSE );
@Description("Number of HTTP logs to keep.")
Setting http_logging_rotation_keep_number = setting("dbms.logs.http.rotation.keep_number", INTEGER, "5");
@Description("Size of each HTTP log that is kept.")
Setting http_logging_rotation_size = setting("dbms.logs.http.rotation.size", BYTES, "20m", min(0L), max( Long.MAX_VALUE ) );
@SuppressWarnings("unused") // used only in the startup scripts
@Description("Enable GC Logging")
Setting gc_logging_enabled = setting("dbms.logs.gc.enabled", BOOLEAN, FALSE);
@SuppressWarnings("unused") // used only in the startup scripts
@Description("GC Logging Options")
Setting gc_logging_options = setting("dbms.logs.gc.options", STRING, "" +
"-XX:+PrintGCDetails -XX:+PrintGCDateStamps -XX:+PrintGCApplicationStoppedTime " +
"-XX:+PrintPromotionFailure -XX:+PrintTenuringDistribution");
@SuppressWarnings("unused") // used only in the startup scripts
@Description("Number of GC logs to keep.")
Setting gc_logging_rotation_keep_number = setting("dbms.logs.gc.rotation.keep_number", INTEGER, "5");
@SuppressWarnings("unused") // used only in the startup scripts
@Description("Size of each GC log that is kept.")
Setting gc_logging_rotation_size = setting("dbms.logs.gc.rotation.size", BYTES, "20m", min(0L), max( Long.MAX_VALUE ) );
@SuppressWarnings("unused") // used only in the startup scripts
@Description("Path of the run directory")
Setting run_directory = pathSetting( "dbms.directories.run", "run" );
@SuppressWarnings("unused") // used only in the startup scripts
@Description("Path of the lib directory")
Setting lib_directory = pathSetting( "dbms.directories.lib", "lib" );
@Description("Timeout for idle transactions.")
Setting transaction_timeout = setting( "dbms.transaction_timeout", DURATION, "60s" );
@Internal
Setting rest_api_path = setting( "unsupported.dbms.uris.rest", NORMALIZED_RELATIVE_URI, "/db/data" );
@Internal
Setting management_api_path = setting( "unsupported.dbms.uris.management",
NORMALIZED_RELATIVE_URI, "/db/manage" );
@Internal
Setting browser_path = setting( "unsupported.dbms.uris.browser", Settings.URI, "/browser/" );
@Internal
Setting script_sandboxing_enabled = setting("unsupported.dbms.security.script_sandboxing_enabled",
BOOLEAN, TRUE );
@Internal
Setting wadl_enabled = setting( "unsupported.dbms.wadl_generation_enabled", BOOLEAN,
FALSE );
@Internal
Setting console_module_enabled = setting( "unsupported.dbms.console_module.enabled", BOOLEAN, TRUE );
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy