org.javasimon.jdbc4.jmx

Interface JdbcMXBean

All Known Implementing Classes:

JdbcMXBeanImpl

public interface JdbcMXBean

Interface of JDBC management bean (MXBean).

JDBC MXBean provides management operations for monitoring JDBC driver and operations to retrieve gathered statistics from special JDBC hierarchy of Simons.
This JDBC hierarchy of Simon is well known and specified in JDBC javadoc (org.javasimon.jdbc4). There is prefix of this hierarchy that is associated with one instance of monitored JDBC driver. Typically, there is only one driver instance used in application, because of connection to one type of database. If application is connected to different types of database (i.e. oracle and mysql), there is possibility to differentiate each used driver by specifying Simon hierarchy prefix for driver.
Jdbc mxbean has prefix associated with it. It's is initialized through mxbean implementation class constructor (JdbcMXBeanImpl.JdbcMXBeanImpl(org.javasimon.Manager, String)) or later through setter (setPrefix(String)). Then is also possible to register Jdbc mxbean for each prefix.

Monitoring of the JDBC driver is enabled only if Java Simon JDBC proxy driver is used over original JDBC driver (eg. Oracle, PostgreSQL, MySQL etc.). For more details how to do that, please look at Driver a package org.javasimon.jdbc4 javadoc.

Since:

2

Author:

Radovan Sninsky, Richard "Virgo" Richter

See Also:

JdbcMXBeanImpl

Method Summary

Modifier and Type	Method and Description
JdbcObjectInfo	connectionsStat() Retrieves summary data about JDBC connection objects.
void	disableMonitoring() Disables monitoring (gathering statistics) by associated JDBC Simon hierarchy, see (org.javasimon.jdbc).
void	enableMonitoring() Enables monitoring (gathering statistics) by associated JDBC Simon hierarchy, see (org.javasimon.jdbc).
String	getPrefix() Returns actual prefix associated with mxbean.
String[]	getSqlCommands() Returns SQL command types (select, insert, delete, etc).
StopwatchSample	getSqlCommandStat(String cmd) Retrieves summary data about all executed SQL commands of eneterd type (for instance summary data of all executed selects).
String[]	getSqls(String cmd) Returns hashs of different SQL commands of one type (select, insert, delete, etc).
StopwatchSample	getSqlStat(String sql) Retrieves summary data about all same executed SQLs (for instance summary data of all executed select * from foo where bar => 0).
boolean	isMonitoringEnabled() Returns state of monitoring JDBC driver.
JdbcObjectInfo	resultsetsStat() Retrieves summary data about JDBC result set objects.
void	setPrefix(String value) Sets custom prefix of JDBC Simon hierarchy, see more JdbcMXBean.
JdbcObjectInfo	statementsStat() Retrieves summary data about JDBC statement objects.

Method Detail

getPrefix

String getPrefix()

Returns actual prefix associated with mxbean.

Returns:

actual prefix

setPrefix

void setPrefix(String value)

Sets custom prefix of JDBC Simon hierarchy, see more JdbcMXBean.

Parameters:

value - new prefix

enableMonitoring

void enableMonitoring()

Enables monitoring (gathering statistics) by associated JDBC Simon hierarchy, see (org.javasimon.jdbc). Works if SimonManager is enabled, look SimonManager.isEnabled().

disableMonitoring

void disableMonitoring()

Disables monitoring (gathering statistics) by associated JDBC Simon hierarchy, see (org.javasimon.jdbc). If SimonManager is already disabled has no effect, look SimonManager.disable().

isMonitoringEnabled

boolean isMonitoringEnabled()

Returns state of monitoring JDBC driver.

Returns:

true if associated prefix is enabled; otherwise false

connectionsStat

JdbcObjectInfo connectionsStat()

Retrieves summary data about JDBC connection objects.

Returns:

value object JdbcObjectInfo

statementsStat

JdbcObjectInfo statementsStat()

Retrieves summary data about JDBC statement objects.

Returns:

value object JdbcObjectInfo

resultsetsStat

JdbcObjectInfo resultsetsStat()

Retrieves summary data about JDBC result set objects.

Returns:

value object JdbcObjectInfo

getSqlCommands

String[] getSqlCommands()

Returns SQL command types (select, insert, delete, etc). If client application uses DDL commands like create, alter and other, those are included too. Special case are batch-es, they are referenced as batch.

Returns:

list of string (references to used SQL command types in monitored (simoned) application)

See Also:

getSqlCommandStat(String), getSqls(String)

getSqlCommandStat

StopwatchSample getSqlCommandStat(String cmd)

Retrieves summary data about all executed SQL commands of eneterd type (for instance summary data of all executed selects).

Parameters:

cmd - SQL command type

Returns:

populated object StopwatchSample, or null if entered sql command type has no associated javasimon (it means, no sql of this type was executed yet, for instance no update was executed yet)

See Also:

connectionsStat()

getSqls

String[] getSqls(String cmd)

Returns hashs of different SQL commands of one type (select, insert, delete, etc). Each hash represent one sql command with (and its many executions).

Parameters:

cmd - cmd SQL command type (select, insert, delete, etc)

Returns:

list of string (hash references to used SQL command in monitored (simoned) application)

See Also:

getSqlCommands(), getSqlStat(String)

getSqlStat

StopwatchSample getSqlStat(String sql)

Retrieves summary data about all same executed SQLs (for instance summary data of all executed select * from foo where bar => 0).

Parameters:

sql - hash code of sql command

Returns:

populated object StopwatchSample, or null if entered sql has no associated javasimon (it means, no sql like this was executed yet, for instance no update was executed yet)

See Also:

getSqls(String)