Tomcat 10.1.19 · org.apache.tomcat.jdbc.pool.interceptor.SlowQueryReportJmx

Modifier and Type	Field and Description
public static final String	FAILED_QUERY_NOTIFICATION
private static final Log	log Hides org.apache.tomcat.jdbc.pool.interceptor.SlowQueryReport.log.
protected static final ConcurrentHashMap<String, SlowQueryReportJmxMBean>	mbeans
protected volatile NotificationBroadcasterSupport	notifier
protected boolean	notifyPool
protected static final AtomicLong	notifySequence
public static final String	objectNameAttribute
protected ConnectionPool	pool
protected String	poolName
public static final String	SLOW_QUERY_NOTIFICATION
protected static volatile CompositeType	SLOW_QUERY_TYPE

Access	Constructor and Description
public	SlowQueryReportJmx()

Method Summary

Modifier and Type	Method and Description
public void	addNotificationListener(NotificationListener The listener object which will handle the notifications emitted by the broadcaster. listener, NotificationFilter The filter object. If filter is null, no filtering will be performed before handling notifications. filter, Object An opaque object to be sent back to the listener when a notification is emitted. This object cannot be used by the Notification broadcaster object. It should be resent unchanged with the notification to the listener. handback) Implements javax.management.NotificationBroadcaster.addNotificationListener. Adds a listener to this MBean.
protected void	deregisterJmx()
protected static CompositeType	getCompositeType()
public MBeanNotificationInfo[]	getNotificationInfo() Implements javax.management.NotificationBroadcaster.getNotificationInfo. Returns an array indicating, for each notification this MBean may send, the name of the Java class of the notification and the notification type.
public ObjectName	getObjectName(Class<?> clazz, String poolName)
public String	Returns: the name of the pool, unique within the JVM getPoolName() JMX operation - return the name of the pool
public String[]	Returns: - all the names of pools that we have stored data for getPoolNames() JMX operation - return the names of all the pools
public CompositeData[]	Returns: - the slow query report as composite data. getSlowQueriesCD() Implements org.apache.tomcat.jdbc.pool.interceptor.SlowQueryReportJmxMBean.getSlowQueriesCD. JMX operation - returns all the queries we have collected.
public boolean	isNotifyPool()
protected void	notifyJmx(String query, String type)
public void	poolClosed(ConnectionPool - the pool that is being closed. pool) Overrides org.apache.tomcat.jdbc.pool.interceptor.SlowQueryReport.poolClosed. This method is invoked by a connection pool when the pool is closed.
public void	poolStarted(ConnectionPool - the pool that is being closed. pool) Overrides org.apache.tomcat.jdbc.pool.interceptor.SlowQueryReport.poolStarted. This method is invoked by a connection pool when the pool is first started up, usually when the first connection is requested.
protected void	registerJmx()
public void	removeNotificationListener(NotificationListener A listener that was previously added to this MBean. listener) Implements javax.management.NotificationBroadcaster.removeNotificationListener. Removes a listener from this MBean.
public void	removeNotificationListener(NotificationListener A listener that was previously added to this MBean. listener, NotificationFilter The filter that was specified when the listener was added. filter, Object The handback that was specified when the listener was added. handback) Implements javax.management.NotificationEmitter.removeNotificationListener. Removes a listener from this MBean.
protected String	reportFailedQuery(String the query that was executed and failed query, Object[] the arguments to the execution args, String the name of the method used to execute `AbstractCreateStatementInterceptor#isExecute(Method, boolean)` name, long the time the query execution started start, Throwable the exception that happened t) Overrides org.apache.tomcat.jdbc.pool.interceptor.SlowQueryReport.reportFailedQuery. Invoked when a query execution, a call to execute/executeQuery or executeBatch failed.
protected String	reportSlowQuery(String the query that was executed and failed query, Object[] the arguments to the execution args, String the name of the method used to execute `AbstractCreateStatementInterceptor#isExecute(Method, boolean)` name, long the time the query execution started start, long the time the execution took delta) Overrides org.apache.tomcat.jdbc.pool.interceptor.SlowQueryReport.reportSlowQuery. Invoked when a query execution, a call to execute/executeQuery or executeBatch succeeded and was exceeded the timing threshold
public void	reset(ConnectionPool - the connection pool owning the connection parent, PooledConnection - the pooled connection con) Overrides org.apache.tomcat.jdbc.pool.interceptor.SlowQueryReport.reset. no-op for this interceptor.
public void	resetStats() JMX operation - remove all stats for this connection pool
public void	setNotifyPool(boolean notifyPool)
public void	setProperties(Map<String, PoolProperties.InterceptorProperty> The properties properties) Overrides org.apache.tomcat.jdbc.pool.interceptor.SlowQueryReport.setProperties. Called during the creation of an interceptor The properties can be set during the configuration of an interceptor Override this method to perform type casts between string values and object properties

Inherited from org.apache.tomcat.jdbc.pool.interceptor.SlowQueryReport:: closeInvoked getPoolStats getQueryStats isLogFailed isLogSlow prepareCall prepareStatement removeOldest reportQuery setLogFailed setLogSlow setMaxQueries

FAILED_QUERY_NOTIFICATION	back to summary
public static final String FAILED_QUERY_NOTIFICATION

log	back to summary
private static final Log log Hides org.apache.tomcat.jdbc.pool.interceptor.SlowQueryReport.log.

mbeans	back to summary
protected static final ConcurrentHashMap<String, SlowQueryReportJmxMBean> mbeans

notifier	back to summary
protected volatile NotificationBroadcasterSupport notifier

notifyPool	back to summary
protected boolean notifyPool

notifySequence	back to summary
protected static final AtomicLong notifySequence

objectNameAttribute	back to summary
public static final String objectNameAttribute

pool	back to summary
protected ConnectionPool pool

poolName	back to summary
protected String poolName

SLOW_QUERY_NOTIFICATION	back to summary
public static final String SLOW_QUERY_NOTIFICATION

SLOW_QUERY_TYPE	back to summary
protected static volatile CompositeType SLOW_QUERY_TYPE

SlowQueryReportJmx	back to summary
public SlowQueryReportJmx()

Method Detail

addNotificationListener	back to summary
public void addNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback) throws IllegalArgumentException Implements javax.management.NotificationBroadcaster.addNotificationListener. Doc from javax.management.NotificationBroadcaster.addNotificationListener. Adds a listener to this MBean. Parameters listener:NotificationListener The listener object which will handle the notifications emitted by the broadcaster. filter:NotificationFilter The filter object. If filter is null, no filtering will be performed before handling notifications. handback:Object An opaque object to be sent back to the listener when a notification is emitted. This object cannot be used by the Notification broadcaster object. It should be resent unchanged with the notification to the listener. Annotations @Override Exceptions IllegalArgumentException: Listener parameter is null.

addNotificationListener

back to summary

public void addNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback) throws IllegalArgumentException

Implements javax.management.NotificationBroadcaster.addNotificationListener.

Doc from javax.management.NotificationBroadcaster.addNotificationListener.

Adds a listener to this MBean.

Parameters

listener:NotificationListener: The listener object which will handle the notifications emitted by the broadcaster.
filter:NotificationFilter: The filter object. If filter is null, no filtering will be performed before handling notifications.
handback:Object: An opaque object to be sent back to the listener when a notification is emitted. This object cannot be used by the Notification broadcaster object. It should be resent unchanged with the notification to the listener.

Annotations

@Override

Exceptions

IllegalArgumentException:: Listener parameter is null.

deregisterJmx	back to summary
protected void deregisterJmx()

getCompositeType	back to summary
protected static CompositeType getCompositeType()

getNotificationInfo	back to summary
public MBeanNotificationInfo[] getNotificationInfo() Implements javax.management.NotificationBroadcaster.getNotificationInfo. Doc from javax.management.NotificationBroadcaster.getNotificationInfo. Returns an array indicating, for each notification this MBean may send, the name of the Java class of the notification and the notification type. It is not illegal for the MBean to send notifications not described in this array. However, some clients of the MBean server may depend on the array being complete for their correct functioning. Returns:MBeanNotificationInfo[] the array of possible notifications. Annotations @Override

getNotificationInfo

back to summary

public MBeanNotificationInfo[] getNotificationInfo()

Implements javax.management.NotificationBroadcaster.getNotificationInfo.

Doc from javax.management.NotificationBroadcaster.getNotificationInfo.

Returns an array indicating, for each notification this MBean may send, the name of the Java class of the notification and the notification type.

It is not illegal for the MBean to send notifications not described in this array. However, some clients of the MBean server may depend on the array being complete for their correct functioning.

Returns:MBeanNotificationInfo[]

the array of possible notifications.

Annotations

@Override

getObjectName	back to summary
public ObjectName getObjectName(Class<?> clazz, String poolName) throws MalformedObjectNameException

getPoolName	back to summary
public String getPoolName() JMX operation - return the name of the pool Returns:String the name of the pool, unique within the JVM

getPoolName

back to summary

public String getPoolName()

JMX operation - return the name of the pool

Returns:String: the name of the pool, unique within the JVM

getPoolNames	back to summary
public String[] getPoolNames() JMX operation - return the names of all the pools Returns:String[] - all the names of pools that we have stored data for

getPoolNames

back to summary

public String[] getPoolNames()

JMX operation - return the names of all the pools

Returns:String[]: - all the names of pools that we have stored data for

getSlowQueriesCD	back to summary
public CompositeData[] getSlowQueriesCD() throws OpenDataException Implements org.apache.tomcat.jdbc.pool.interceptor.SlowQueryReportJmxMBean.getSlowQueriesCD. JMX operation - returns all the queries we have collected. Returns:CompositeData[] - the slow query report as composite data. Annotations @Override

getSlowQueriesCD

back to summary

public CompositeData[] getSlowQueriesCD() throws OpenDataException

Implements org.apache.tomcat.jdbc.pool.interceptor.SlowQueryReportJmxMBean.getSlowQueriesCD.

JMX operation - returns all the queries we have collected.

Returns:CompositeData[]

- the slow query report as composite data.

Annotations

@Override

isNotifyPool	back to summary
public boolean isNotifyPool()

notifyJmx	back to summary
protected void notifyJmx(String query, String type)

poolClosed	back to summary
public void poolClosed(ConnectionPool pool) Overrides org.apache.tomcat.jdbc.pool.interceptor.SlowQueryReport.poolClosed. Doc from org.apache.tomcat.jdbc.pool.JdbcInterceptor.poolClosed. This method is invoked by a connection pool when the pool is closed. Interceptor classes can override this method if they keep static variables or other tracking means around. This method is only invoked on a single instance of the interceptor, and not on every instance created. Parameters pool:ConnectionPool - the pool that is being closed. Annotations @Override

poolClosed

back to summary

public void poolClosed(ConnectionPool pool)

Overrides org.apache.tomcat.jdbc.pool.interceptor.SlowQueryReport.poolClosed.

Doc from org.apache.tomcat.jdbc.pool.JdbcInterceptor.poolClosed.

This method is invoked by a connection pool when the pool is closed. Interceptor classes can override this method if they keep static variables or other tracking means around. This method is only invoked on a single instance of the interceptor, and not on every instance created.

Parameters

pool:ConnectionPool: - the pool that is being closed.

Annotations

@Override

poolStarted	back to summary
public void poolStarted(ConnectionPool pool) Overrides org.apache.tomcat.jdbc.pool.interceptor.SlowQueryReport.poolStarted. Doc from org.apache.tomcat.jdbc.pool.JdbcInterceptor.poolStarted. This method is invoked by a connection pool when the pool is first started up, usually when the first connection is requested. Interceptor classes can override this method if they keep static variables or other tracking means around. This method is only invoked on a single instance of the interceptor, and not on every instance created. Parameters pool:ConnectionPool - the pool that is being closed. Annotations @Override

poolStarted

back to summary

public void poolStarted(ConnectionPool pool)

Overrides org.apache.tomcat.jdbc.pool.interceptor.SlowQueryReport.poolStarted.

Doc from org.apache.tomcat.jdbc.pool.JdbcInterceptor.poolStarted.

This method is invoked by a connection pool when the pool is first started up, usually when the first connection is requested. Interceptor classes can override this method if they keep static variables or other tracking means around. This method is only invoked on a single instance of the interceptor, and not on every instance created.

Parameters

pool:ConnectionPool: - the pool that is being closed.

Annotations

@Override

registerJmx	back to summary
protected void registerJmx()

removeNotificationListener	back to summary
public void removeNotificationListener(NotificationListener listener) throws ListenerNotFoundException Implements javax.management.NotificationBroadcaster.removeNotificationListener. Doc from javax.management.NotificationBroadcaster.removeNotificationListener. Removes a listener from this MBean. If the listener has been registered with different handback objects or notification filters, all entries corresponding to the listener will be removed. Parameters listener:NotificationListener A listener that was previously added to this MBean. Annotations @Override Exceptions ListenerNotFoundException: The listener is not registered with the MBean.

removeNotificationListener

back to summary

public void removeNotificationListener(NotificationListener listener) throws ListenerNotFoundException

Implements javax.management.NotificationBroadcaster.removeNotificationListener.

Doc from javax.management.NotificationBroadcaster.removeNotificationListener.

Removes a listener from this MBean. If the listener has been registered with different handback objects or notification filters, all entries corresponding to the listener will be removed.

Parameters

listener:NotificationListener: A listener that was previously added to this MBean.

Annotations

@Override

Exceptions

ListenerNotFoundException:: The listener is not registered with the MBean.

removeNotificationListener back to summary

removeNotificationListener	back to summary
public void removeNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback) throws ListenerNotFoundException Implements javax.management.NotificationEmitter.removeNotificationListener. Doc from javax.management.NotificationEmitter.removeNotificationListener. Removes a listener from this MBean. The MBean must have a listener that exactly matches the given `listener`, `filter`, and `handback` parameters. If there is more than one such listener, only one is removed. The `filter` and `handback` parameters may be null if and only if they are null in a listener to be removed. Parameters listener:NotificationListener A listener that was previously added to this MBean. filter:NotificationFilter The filter that was specified when the listener was added. handback:Object The handback that was specified when the listener was added. Annotations @Override Exceptions ListenerNotFoundException: The listener is not registered with the MBean, or it is not registered with the given filter and handback.

public void removeNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback) throws ListenerNotFoundException

Implements javax.management.NotificationEmitter.removeNotificationListener.

Doc from javax.management.NotificationEmitter.removeNotificationListener.

Removes a listener from this MBean. The MBean must have a listener that exactly matches the given listener, filter, and handback parameters. If there is more than one such listener, only one is removed.

The filter and handback parameters may be null if and only if they are null in a listener to be removed.

Parameters

listener:NotificationListener: A listener that was previously added to this MBean.
filter:NotificationFilter: The filter that was specified when the listener was added.
handback:Object: The handback that was specified when the listener was added.

Annotations

@Override

Exceptions

ListenerNotFoundException:: The listener is not registered with the MBean, or it is not registered with the given filter and handback.

reportFailedQuery back to summary

reportFailedQuery	back to summary
protected String reportFailedQuery(String query, Object[] args, String name, long start, Throwable t) Overrides org.apache.tomcat.jdbc.pool.interceptor.SlowQueryReport.reportFailedQuery. Doc from org.apache.tomcat.jdbc.pool.interceptor.AbstractQueryReport.reportFailedQuery. Invoked when a query execution, a call to execute/executeQuery or executeBatch failed. Parameters query:String the query that was executed and failed args:Object[] the arguments to the execution name:String the name of the method used to execute `AbstractCreateStatementInterceptor#isExecute(Method, boolean)` start:long the time the query execution started t:Throwable the exception that happened Returns:String - the SQL that was executed or the string "batch" if it was a batch execution Annotations @Override

protected String reportFailedQuery(String query, Object[] args, String name, long start, Throwable t)

Overrides org.apache.tomcat.jdbc.pool.interceptor.SlowQueryReport.reportFailedQuery.

Doc from org.apache.tomcat.jdbc.pool.interceptor.AbstractQueryReport.reportFailedQuery.

Invoked when a query execution, a call to execute/executeQuery or executeBatch failed.

Parameters

query:String: the query that was executed and failed
args:Object[]: the arguments to the execution
name:String: the name of the method used to execute AbstractCreateStatementInterceptor#isExecute(Method, boolean)
start:long: the time the query execution started
t:Throwable: the exception that happened

Returns:String

- the SQL that was executed or the string "batch" if it was a batch execution

Annotations

@Override

reportSlowQuery back to summary

reportSlowQuery	back to summary
protected String reportSlowQuery(String query, Object[] args, String name, long start, long delta) Overrides org.apache.tomcat.jdbc.pool.interceptor.SlowQueryReport.reportSlowQuery. Doc from org.apache.tomcat.jdbc.pool.interceptor.AbstractQueryReport.reportSlowQuery. Invoked when a query execution, a call to execute/executeQuery or executeBatch succeeded and was exceeded the timing threshold Parameters query:String the query that was executed and failed args:Object[] the arguments to the execution name:String the name of the method used to execute `AbstractCreateStatementInterceptor#isExecute(Method, boolean)` start:long the time the query execution started delta:long the time the execution took Returns:String - the SQL that was executed or the string "batch" if it was a batch execution Annotations @Override

protected String reportSlowQuery(String query, Object[] args, String name, long start, long delta)

Overrides org.apache.tomcat.jdbc.pool.interceptor.SlowQueryReport.reportSlowQuery.

Doc from org.apache.tomcat.jdbc.pool.interceptor.AbstractQueryReport.reportSlowQuery.

Invoked when a query execution, a call to execute/executeQuery or executeBatch succeeded and was exceeded the timing threshold

Parameters

query:String: the query that was executed and failed
args:Object[]: the arguments to the execution
name:String: the name of the method used to execute AbstractCreateStatementInterceptor#isExecute(Method, boolean)
start:long: the time the query execution started
delta:long: the time the execution took

Returns:String

- the SQL that was executed or the string "batch" if it was a batch execution

Annotations

@Override

reset	back to summary
public void reset(ConnectionPool parent, PooledConnection con) Overrides org.apache.tomcat.jdbc.pool.interceptor.SlowQueryReport.reset. Doc from org.apache.tomcat.jdbc.pool.interceptor.AbstractCreateStatementInterceptor.reset. no-op for this interceptor. no state is stored. Parameters parent:ConnectionPool Doc from org.apache.tomcat.jdbc.pool.JdbcInterceptor.reset. - the connection pool owning the connection con:PooledConnection Doc from org.apache.tomcat.jdbc.pool.JdbcInterceptor.reset. - the pooled connection Annotations @Override

reset

back to summary

public void reset(ConnectionPool parent, PooledConnection con)

Overrides org.apache.tomcat.jdbc.pool.interceptor.SlowQueryReport.reset.

Doc from org.apache.tomcat.jdbc.pool.interceptor.AbstractCreateStatementInterceptor.reset.

no-op for this interceptor. no state is stored.

Parameters

parent:ConnectionPool

Doc from org.apache.tomcat.jdbc.pool.JdbcInterceptor.reset.

- the connection pool owning the connection

con:PooledConnection

Doc from org.apache.tomcat.jdbc.pool.JdbcInterceptor.reset.

- the pooled connection

Annotations

@Override

resetStats	back to summary
public void resetStats() JMX operation - remove all stats for this connection pool

setNotifyPool	back to summary
public void setNotifyPool(boolean notifyPool)

setProperties	back to summary
public void setProperties(Map<String, PoolProperties.InterceptorProperty> properties) Overrides org.apache.tomcat.jdbc.pool.interceptor.SlowQueryReport.setProperties. Doc from org.apache.tomcat.jdbc.pool.JdbcInterceptor.setProperties. Called during the creation of an interceptor The properties can be set during the configuration of an interceptor Override this method to perform type casts between string values and object properties Parameters properties:Map<String, PoolProperties.InterceptorProperty> The properties Annotations @Override

setProperties

back to summary

public void setProperties(Map<String, PoolProperties.InterceptorProperty> properties)

Overrides org.apache.tomcat.jdbc.pool.interceptor.SlowQueryReport.setProperties.

Doc from org.apache.tomcat.jdbc.pool.JdbcInterceptor.setProperties.

Called during the creation of an interceptor The properties can be set during the configuration of an interceptor Override this method to perform type casts between string values and object properties

Parameters

properties:Map<String, PoolProperties.InterceptorProperty>: The properties

Annotations

@Override

public Class SlowQueryReportJmx

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail