blackboard.platform.monitor.db
Interface ConnectionMonitorService

All Superinterfaces:

MonitorService<ConnectionMonitor>

public interface ConnectionMonitorService
extends MonitorService<ConnectionMonitor>

The ConnectionMonitorService class offers methods to obtain ConnectionMonitor monitors, as well as information about the currently defined connection pools within the system.

Since:

Bb 9.1

Method Summary

java.util.List<java.lang.String>	getDatabaseNames() Returns the names of all databases in the system.
java.util.List<DatabaseInfo>	getDatabases() Returns information about all databases in the system.
ConnectionMonitor	getMonitor(java.lang.String databaseName) Returns the ConnectionMonitor for the specified database name.

Method Detail

getDatabaseNames

java.util.List<java.lang.String> getDatabaseNames()

Returns the names of all databases in the system. As of now, this does not apply to any of the Xythos databases.

Returns:

A list of database names.

getDatabases

java.util.List<DatabaseInfo> getDatabases()

Returns information about all databases in the system. As of now, this does not apply to any of the Xythos databases.

Returns:

A list of database information

getMonitor

ConnectionMonitor getMonitor(java.lang.String databaseName)
                             throws java.lang.IllegalArgumentException

Returns the ConnectionMonitor for the specified database name. In order to get a list of valid database names, use getDatabaseNames().

Parameters:

databaseName - The database name for which to retrieve a monitor.

Returns:

A database connection monitor.

Throws:

java.lang.IllegalArgumentException - If the specified database name did not correspond to a valid database.