Package com.neo4j.dbms.api

Class EnterpriseDatabaseManagementService

java.lang.Object

com.neo4j.dbms.api.EnterpriseDatabaseManagementService

All Implemented Interfaces:

DatabaseManagementService

public class EnterpriseDatabaseManagementService
extends Object
implements DatabaseManagementService

Constructor Summary

Constructors

Constructor	Description
EnterpriseDatabaseManagementService(DatabaseManagementService delegate)

Method Summary

Modifier and Type	Method	Description
void	createDatabase(String databaseName, Configuration databaseSpecificSettings)	Create a new database.
GraphDatabaseService	database(String databaseName)	Retrieve a database service by name.
void	dropDatabase(String databaseName)	Drop a database by name.
boolean	isWritable(String databaseName)	Returns the availability of the database for write operations.
List<String>	listDatabases()
void	registerDatabaseEventListener(DatabaseEventListener listener)	Registers listener as a listener for database events.
void	registerTransactionEventListener(String databaseName, TransactionEventListener<?> listener)	Registers listener as a listener for transaction events which are generated from different places in the lifecycle of each transaction in particular database.
void	shutdown()	Shutdown database server.
void	shutdownDatabase(String databaseName)	Shutdown database with provided name.
void	startDatabase(String databaseName)	Starts a already existing database.
void	unregisterDatabaseEventListener(DatabaseEventListener listener)	Unregisters listener from the list of database event handlers.
void	unregisterTransactionEventListener(String databaseName, TransactionEventListener<?> listener)	Unregisters listener from the list of transaction event listeners.

Methods inherited from interface org.neo4j.dbms.api.DatabaseManagementService

createDatabase

Constructor Details

EnterpriseDatabaseManagementService

public EnterpriseDatabaseManagementService(DatabaseManagementService delegate)

Method Details

isWritable

public boolean isWritable(String databaseName)

Returns the availability of the database for write operations.

Parameters:

databaseName - name of the database.

Returns:

true if the database accepts writes, false otherwise.

Throws:

DatabaseNotFoundException - if no database service with the given name is found.

database

public GraphDatabaseService database(String databaseName)
                              throws DatabaseNotFoundException

Description copied from interface: DatabaseManagementService

Retrieve a database service by name.

Specified by:

database in interface DatabaseManagementService

Parameters:

databaseName - name of the database.

Returns:

the database service with the provided name

Throws:

DatabaseNotFoundException - if no database service with the given name is found.

createDatabase

public void createDatabase(String databaseName,
 Configuration databaseSpecificSettings)
                    throws DatabaseExistsException

Description copied from interface: DatabaseManagementService

Create a new database.

Specified by:

createDatabase in interface DatabaseManagementService

Parameters:

databaseName - name of the database.

databaseSpecificSettings - settings that are specific to this database. Only a sub-set of settings are supported TODO.

Throws:

DatabaseExistsException - if a database with the provided name already exists

dropDatabase

public void dropDatabase(String databaseName)
                  throws DatabaseNotFoundException

Description copied from interface: DatabaseManagementService

Drop a database by name. All data stored in the database will be deleted as well.

Specified by:

dropDatabase in interface DatabaseManagementService

Parameters:

databaseName - name of the database to drop.

Throws:

DatabaseNotFoundException - if no database with the given name is found.

startDatabase

public void startDatabase(String databaseName)
                   throws DatabaseNotFoundException

Description copied from interface: DatabaseManagementService

Starts a already existing database.

Specified by:

startDatabase in interface DatabaseManagementService

Parameters:

databaseName - name of the database to start.

Throws:

DatabaseNotFoundException - if no database with the given name is found.

shutdownDatabase

public void shutdownDatabase(String databaseName)
                      throws DatabaseNotFoundException

Description copied from interface: DatabaseManagementService

Shutdown database with provided name.

Specified by:

shutdownDatabase in interface DatabaseManagementService

Parameters:

databaseName - name of the database.

Throws:

DatabaseNotFoundException - if no database with the given name is found.

listDatabases

public List<String> listDatabases()

Specified by:

listDatabases in interface DatabaseManagementService

Returns:

an alphabetically sorted list of all database names this database server manages.

registerDatabaseEventListener

public void registerDatabaseEventListener(DatabaseEventListener listener)

Description copied from interface: DatabaseManagementService

Registers listener as a listener for database events. If the specified listener instance has already been registered this method will do nothing.

Specified by:

registerDatabaseEventListener in interface DatabaseManagementService

Parameters:

listener - the listener to receive events about different states in the database lifecycle.

unregisterDatabaseEventListener

public void unregisterDatabaseEventListener(DatabaseEventListener listener)

Description copied from interface: DatabaseManagementService

Unregisters listener from the list of database event handlers. If listener hasn't been registered with DatabaseManagementService.registerDatabaseEventListener(DatabaseEventListener) prior to calling this method an IllegalStateException will be thrown. After a successful call to this method the listener will no longer receive any database events.

Specified by:

unregisterDatabaseEventListener in interface DatabaseManagementService

Parameters:

listener - the listener to receive events about database lifecycle.

registerTransactionEventListener

public void registerTransactionEventListener(String databaseName,
 TransactionEventListener<?> listener)

Description copied from interface: DatabaseManagementService

Registers listener as a listener for transaction events which are generated from different places in the lifecycle of each transaction in particular database. To guarantee that the handler gets all events properly it shouldn't be registered when the application is running (i.e. in the middle of one or more transactions). If the specified handler instance has already been registered this method will do nothing.

Specified by:

registerTransactionEventListener in interface DatabaseManagementService

Parameters:

databaseName - name of the database to listener transactions

listener - the listener to receive events about different states in transaction lifecycle.

unregisterTransactionEventListener

public void unregisterTransactionEventListener(String databaseName,
 TransactionEventListener<?> listener)

Description copied from interface: DatabaseManagementService

Unregisters listener from the list of transaction event listeners. If handler hasn't been registered with DatabaseManagementService.registerTransactionEventListener(String, TransactionEventListener) prior to calling this method an IllegalStateException will be thrown. After a successful call to this method the listener will no longer receive any transaction events.

Specified by:

unregisterTransactionEventListener in interface DatabaseManagementService

Parameters:

databaseName - name of the database to listener transactions

listener - the listener to receive events about different states in transaction lifecycles.

shutdown

public void shutdown()

Description copied from interface: DatabaseManagementService

Shutdown database server.

Specified by:

shutdown in interface DatabaseManagementService