Package org.neo4j.dbms.api

Interface Neo4jDatabaseManagementServiceBuilder

All Known Implementing Classes:

DatabaseManagementServiceBuilder, EnterpriseDatabaseManagementServiceBuilder

public interface Neo4jDatabaseManagementServiceBuilder

Constructs a DatabaseManagementService.

See Also:

• DatabaseManagementService
• DatabaseEventListener

Method Summary

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

Method Details

build

DatabaseManagementService build()

Construct the service matching the configuration in this builder.

Returns:

a DatabaseManagementService from the provided configuration.

addDatabaseListener

Neo4jDatabaseManagementServiceBuilder addDatabaseListener(DatabaseEventListener databaseEventListener)

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

Parameters:

databaseEventListener - the event listener to be invoked on events.

Returns:

the builder.

setUserLogProvider

Neo4jDatabaseManagementServiceBuilder setUserLogProvider(LogProvider userLogProvider)

Set a specific log provider for the service.

Parameters:

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

Returns:

the builder.

setConfig

<T> Neo4jDatabaseManagementServiceBuilder setConfig(Setting<T> setting,
 T value)

Configure a specific setting.

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

Neo4jDatabaseManagementServiceBuilder setConfig(Map<Setting<?>,Object> config)

Configure a set of different settings.

Parameters:

config - a map with settings to configure.

Returns:

the builder.

loadPropertiesFromFile

Neo4jDatabaseManagementServiceBuilder loadPropertiesFromFile(Path path)

Read configuration from a file.

The settings will be applied in order and can be used in conjunction with 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.

Parameters:

path - to a file containing neo4j configuration statements.

Returns:

the builder.