org.objectweb.cjdbc.common.jmx.mbeans
Interface DataCollectorMBean

All Known Implementing Classes:

DataCollector

public interface DataCollectorMBean

DataCollector interface to used via JMX. This interface defines the entry point to collect dynamic data for all c-jdbc components.

Author:

Nicolas Modrzyk

Method Summary

boolean	hasVirtualDatabase(java.lang.String name) Try to see if a virtual database exists from its name
java.lang.String[][]	retrieveBackendsData() Get the current list of backends data for all databases
java.lang.String[][]	retrieveBackendsData(java.lang.String virtualDatabasename) Get the current list of backends data
java.lang.String[][]	retrieveCacheData() Get the current cache content for all databases
java.lang.String[][]	retrieveCacheData(java.lang.String virtualDatabasename) Get the current cache content
java.lang.String[][]	retrieveCacheStatsData() Get the current cache stats content for all databases
java.lang.String[][]	retrieveCacheStatsData(java.lang.String virtualDatabasename) Get the current cache stats content
java.lang.String[][]	retrieveClientsData() Get the current list of current users and associated data for all databases
java.lang.String[][]	retrieveClientsData(java.lang.String virtualDatabasename) Get the current list of current users and associated data
java.lang.String[][]	retrieveControllerLoadData() Get general information on the load of the controller.
long	retrieveData(AbstractDataCollector collector) Get some data information on a fine grain approach
AbstractDataCollector	retrieveDataCollectorInstance(int dataType, java.lang.String targetName, java.lang.String virtualDbName) Get starting point for exchanging data on a particular target
java.lang.String[][]	retrieveRecoveryLogData(java.lang.String databaseName) Gets content data of the recovery log
java.lang.String[][]	retrieveSchedulerData(java.lang.String virtualDatabasename) Retrive information about the scheduler, like number of pending requests, number of writes executed and number of read executed
java.lang.String[][]	retrieveSQLStats() Get the current SQL statistics for all databases
java.lang.String[][]	retrieveSQLStats(java.lang.String virtualDatabasename) Get the current SQL statistics
java.lang.String[][]	retrieveVirtualDatabasesData() Get dynamic data of the different virtual databases, like pending connections size, currentNb of threads and number of active threads.

Method Detail

retrieveControllerLoadData

public java.lang.String[][] retrieveControllerLoadData()
                                                throws DataCollectorException

Get general information on the load of the controller. Get the number of threads and total memory used up

Returns:

array of strings

Throws:

DataCollectorException - if collection of information fails

retrieveVirtualDatabasesData

public java.lang.String[][] retrieveVirtualDatabasesData()
                                                  throws DataCollectorException

Get dynamic data of the different virtual databases, like pending connections size, currentNb of threads and number of active threads.

Returns:

array of strings

Throws:

DataCollectorException - if collection of information fails

hasVirtualDatabase

public boolean hasVirtualDatabase(java.lang.String name)

Try to see if a virtual database exists from its name

Parameters:

name - of the virtual database

Returns:

true if exists, false otherwise

retrieveSQLStats

public java.lang.String[][] retrieveSQLStats()
                                      throws DataCollectorException

Get the current SQL statistics for all databases

Returns:

the statistics

Throws:

DataCollectorException - if collection of information fails

retrieveCacheData

public java.lang.String[][] retrieveCacheData()
                                       throws DataCollectorException

Get the current cache content for all databases

Returns:

the cache content

Throws:

DataCollectorException - if collection of information fails

retrieveCacheStatsData

public java.lang.String[][] retrieveCacheStatsData()
                                            throws DataCollectorException

Get the current cache stats content for all databases

Returns:

the cache stats content

Throws:

DataCollectorException - if collection of information fails

retrieveBackendsData

public java.lang.String[][] retrieveBackendsData()
                                          throws DataCollectorException

Get the current list of backends data for all databases

Returns:

the backend list content

Throws:

DataCollectorException - if collection of information fails

retrieveClientsData

public java.lang.String[][] retrieveClientsData()
                                         throws DataCollectorException

Get the current list of current users and associated data for all databases

Returns:

data on users

Throws:

DataCollectorException - if collection of information fails

retrieveSQLStats

public java.lang.String[][] retrieveSQLStats(java.lang.String virtualDatabasename)
                                      throws DataCollectorException

Get the current SQL statistics

Parameters:

virtualDatabasename - of the database to get the data from

Returns:

the statistics

Throws:

DataCollectorException - if collection of information fails

retrieveCacheData

public java.lang.String[][] retrieveCacheData(java.lang.String virtualDatabasename)
                                       throws DataCollectorException

Get the current cache content

Parameters:

virtualDatabasename - of the database to get the data from

Returns:

the cache content

Throws:

DataCollectorException - if collection of information fails

retrieveCacheStatsData

public java.lang.String[][] retrieveCacheStatsData(java.lang.String virtualDatabasename)
                                            throws DataCollectorException

Get the current cache stats content

Parameters:

virtualDatabasename - of the database to get the data from

Returns:

the cache stats content

Throws:

DataCollectorException - if collection of information fails

retrieveBackendsData

public java.lang.String[][] retrieveBackendsData(java.lang.String virtualDatabasename)
                                          throws DataCollectorException

Get the current list of backends data

Parameters:

virtualDatabasename - of the database to get the data from

Returns:

the backend list content

Throws:

DataCollectorException - if collection of information fails

retrieveSchedulerData

public java.lang.String[][] retrieveSchedulerData(java.lang.String virtualDatabasename)
                                           throws DataCollectorException

Retrive information about the scheduler, like number of pending requests, number of writes executed and number of read executed

Parameters:

virtualDatabasename - of the database to get the data from

Returns:

data on the associated scheduler

Throws:

DataCollectorException - if collection of data fails

retrieveClientsData

public java.lang.String[][] retrieveClientsData(java.lang.String virtualDatabasename)
                                         throws DataCollectorException

Get the current list of current users and associated data

Parameters:

virtualDatabasename - of the database to get the data from

Returns:

data on users

Throws:

DataCollectorException - if collection of information fails

retrieveData

public long retrieveData(AbstractDataCollector collector)
                  throws DataCollectorException

Get some data information on a fine grain approach

Parameters:

collector - for the data to be accessed

Returns:

long value of the data

Throws:

DataCollectorException - if collection of information fails

retrieveDataCollectorInstance

public AbstractDataCollector retrieveDataCollectorInstance(int dataType,
                                                           java.lang.String targetName,
                                                           java.lang.String virtualDbName)
                                                    throws DataCollectorException

Get starting point for exchanging data on a particular target

Parameters:

dataType - as given in the DataCollection interface

targetName - if needed (like backendname,clientName ...)

virtualDbName - if needed

Returns:

collector instance

Throws:

DataCollectorException - if fails to get proper collector instance

See Also:

DataCollection

retrieveRecoveryLogData

public java.lang.String[][] retrieveRecoveryLogData(java.lang.String databaseName)
                                             throws DataCollectorException

Gets content data of the recovery log

Parameters:

databaseName - the virtual database name

Returns:

data on the recovery log

Throws:

DataCollectorException - if collection of information fails