Package org.neo4j.dbms.api

Class DatabaseManagementServiceBuilder

java.lang.Object

org.neo4j.dbms.api.DatabaseManagementServiceBuilder

All Implemented Interfaces:

Neo4jDatabaseManagementServiceBuilder

public final class DatabaseManagementServiceBuilder
extends Object
implements Neo4jDatabaseManagementServiceBuilder

Creates a DatabaseManagementService with Community Edition features.

Constructor Summary

Constructors

Constructor	Description
DatabaseManagementServiceBuilder(Path homeDirectory)

Method Summary

Modifier and Type	Method	Description
DatabaseManagementServiceBuilder	addDatabaseListener(DatabaseEventListener databaseEventListener)	Attach an event listener for database lifecycle events.
DatabaseManagementService	build()	Construct the service matching the configuration in this builder.
DatabaseManagementServiceBuilder	loadPropertiesFromFile(Path path)	Read configuration from a file.
DatabaseManagementServiceBuilder	setConfig(Map<Setting<?>,Object> config)	Configure a set of different settings.
<T> DatabaseManagementServiceBuilder	setConfig(Setting<T> setting, T value)	Configure a specific setting.
DatabaseManagementServiceBuilder	setUserLogProvider(LogProvider userLogProvider)	Set a specific log provider for the service.

Constructor Details

DatabaseManagementServiceBuilder

public DatabaseManagementServiceBuilder(Path homeDirectory)

Method Details

build

public DatabaseManagementService build()

Description copied from interface: Neo4jDatabaseManagementServiceBuilder

Construct the service matching the configuration in this builder.

Specified by:

build in interface Neo4jDatabaseManagementServiceBuilder

Returns:

a DatabaseManagementService from the provided configuration.

addDatabaseListener

public DatabaseManagementServiceBuilder addDatabaseListener(DatabaseEventListener databaseEventListener)

Description copied from interface: Neo4jDatabaseManagementServiceBuilder

Attach an event listener for database lifecycle events. For database specific event, see DatabaseManagementService.registerTransactionEventListener(String, TransactionEventListener)

Specified by:

addDatabaseListener in interface Neo4jDatabaseManagementServiceBuilder

Parameters:

databaseEventListener - the event listener to be invoked on events.

Returns:

the builder.

setUserLogProvider

public DatabaseManagementServiceBuilder setUserLogProvider(LogProvider userLogProvider)

Description copied from interface: Neo4jDatabaseManagementServiceBuilder

Set a specific log provider for the service.

Specified by:

setUserLogProvider in interface Neo4jDatabaseManagementServiceBuilder

Parameters:

userLogProvider - a log provider that will handle logging of user events/messages.

Returns:

the builder.

setConfig

public <T> DatabaseManagementServiceBuilder setConfig(Setting<T> setting,
 T value)

Description copied from interface: Neo4jDatabaseManagementServiceBuilder

Configure a specific setting.

Specified by:

setConfig in interface Neo4jDatabaseManagementServiceBuilder

Type Parameters:

T - the type of the value.

Parameters:

setting - the setting to configure a value for.

value - the value to set the provided setting to. Passing null will revert it back to the default value.

Returns:

the builder.

setConfig

public DatabaseManagementServiceBuilder setConfig(Map<Setting<?>,Object> config)

Description copied from interface: Neo4jDatabaseManagementServiceBuilder

Configure a set of different settings.

Specified by:

setConfig in interface Neo4jDatabaseManagementServiceBuilder

Parameters:

config - a map with settings to configure.

Returns:

the builder.

loadPropertiesFromFile

public DatabaseManagementServiceBuilder loadPropertiesFromFile(Path path)

Description copied from interface: Neo4jDatabaseManagementServiceBuilder

Read configuration from a file.

The settings will be applied in order and can be used in conjunction with Neo4jDatabaseManagementServiceBuilder.setConfig(Setting, Object). For example, settings configured before calling this method will be overridden if present in the file, and any setting applied after will override the values read before.

Specified by:

loadPropertiesFromFile in interface Neo4jDatabaseManagementServiceBuilder

Parameters:

path - to a file containing neo4j configuration statements.

Returns:

the builder.