Class PerfLogMBeanImpl

java.lang.Object

javax.management.StandardMBean

org.tquadrat.foundation.perflog.internal.PerfLogMBeanImpl

All Implemented Interfaces:

DynamicMBean, MBeanRegistration, NotificationBroadcaster, NotificationEmitter, PerfLogMBean

@ClassVersion(sourceVersion="$Id: PerfLogMBeanImpl.java 1258 2026-06-04 18:33:06Z tquadrat $")
@API(status=INTERNAL,
     since="0.25.0")
public class PerfLogMBeanImpl
extends StandardMBean
implements PerfLogMBean

The implementation of the interface PerfLogMBean.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: PerfLogMBeanImpl.java 1258 2026-06-04 18:33:06Z tquadrat $

Since:

0.25.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.perflog.internal.PerfLogMBeanImpl"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final List<String>	m_Exceptions	The last 10 exceptions that caused notification threads to abort.
private final JSONBuilder	m_JSONBuilder	The instance of JSONBuilder used by this MBean.
private final NotificationBroadcasterSupport	m_NotificationBroadcasterSupport	The implementation of NotificationEmitter that is utilised by this MBean instance.
private final AtomicLong	m_NotificationSequenceNumber	The sequence number for the notifications.
private final AutoLock	m_PerfRegistryReadGuard	The guard for read operations on the performance section registry.
private final AutoLock	m_PerfRegistryWriteGuard	The guard for write operations on the performance section registry.
private final Map<PerformanceSectionName, PerformanceSectionInfo>	m_PerfSectionRegistry	The registry for the performance section info instances.
private final ExecutorService	m_ThreadPool	The thread pool that is used to send the notifications.

Fields inherited from interface PerfLogMBean

DESCRIPTION, NOTIFICATION_Description

Constructor Summary

Constructors

Constructor	Description
PerfLogMBeanImpl()	Creates a new instance of PerfLogMBeanImpl.

Method Summary

Modifier and Type	Method	Description
private final void	addErrorToJSON(JSONObject object, String message)	Adds an error message to the given JSONObject.
final void	addNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback)
final void	addPerformanceSection(PerformanceSection definition)	Adds the definition for a performance section.
private final void	addSuccessToJSON(JSONObject object, String message)	Adds a success message to the given JSONObject.
private final OpenMBeanAttributeInfo[]	buildAttributeInfoList()	Builds the attribute info list for getMBeanInfo().
private final MBeanNotificationInfo[]	buildNotificationInfoList()	Builds the notifications info list for getMBeanInfo().
private final OpenMBeanOperationInfo[]	buildOperationInfoList()	Builds the operation info list for getMBeanInfo().
String	disablePerformanceSection(String name)	Disables the performance section.
String	enablePerformanceSection(String name)	Enables the performance section.
final MBeanInfo	getMBeanInfo()	Get the MBeanInfo for this MBean.
final String[]	getNotificationExceptions()	Returns the exceptions that caused a notification thread to abort.
final MBeanNotificationInfo[]	getNotificationInfo()
final long	getNotificationSequenceNumber()	Returns the notification sequence number.
final Optional<PerformanceSection>	getPerformanceSection(PerformanceSectionName name)	Returns the performance section specified by the given name.
final String[]	getPerformanceSections()	Returns a list of the currently defined performance sections.
final void	postDeregister()
final void	receivePerformanceReport(PerformanceReport report)	Takes the performance report and transfers it further.
final void	removeNotificationListener(NotificationListener listener)
final void	removeNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback)
final PerformanceSection	retrievePerformanceSection(PerformanceSectionName name)	Retrieves the performance section for the given name.
final String	showPerformanceSection(String name)	Shows the performance section status.
private final void	uncaughtExceptionHandler(Thread t, Throwable e)	This method is invoked when the given thread terminates due to the given uncaught exception.

Methods inherited from class StandardMBean

cacheMBeanInfo, getAttribute, getAttributes, getCachedMBeanInfo, getClassName, getConstructors, getDescription, getDescription, getDescription, getDescription, getDescription, getDescription, getDescription, getImpact, getImplementation, getImplementationClass, getMBeanInterface, getParameterName, getParameterName, invoke, postRegister, preDeregister, preRegister, setAttribute, setAttributes, setImplementation

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

m_Exceptions

private final List<String> m_Exceptions

The last 10 exceptions that caused notification threads to abort.

m_JSONBuilder

private final JSONBuilder m_JSONBuilder

The instance of JSONBuilder used by this MBean.

m_NotificationSequenceNumber

private final AtomicLong m_NotificationSequenceNumber

The sequence number for the notifications. The initial value will be the current time in seconds since the beginning of the epoche, rounded down to ten seconds and multiplied with 10k.

m_NotificationBroadcasterSupport

private final NotificationBroadcasterSupport m_NotificationBroadcasterSupport

The implementation of NotificationEmitter that is utilised by this MBean instance.

m_PerfSectionRegistry

private final Map<PerformanceSectionName, PerformanceSectionInfo> m_PerfSectionRegistry

The registry for the performance section info instances.

The key for the map is the name of the performance section.

m_PerfRegistryReadGuard

private final AutoLock m_PerfRegistryReadGuard

The guard for read operations on the performance section registry.

m_PerfRegistryWriteGuard

private final AutoLock m_PerfRegistryWriteGuard

The guard for write operations on the performance section registry.

m_ThreadPool

private final ExecutorService m_ThreadPool

The thread pool that is used to send the notifications.

See Also:

• m_NotificationBroadcasterSupport

Constructor Details

PerfLogMBeanImpl

public PerfLogMBeanImpl()

Creates a new instance of PerfLogMBeanImpl.

Method Details

addErrorToJSON

private final void addErrorToJSON(JSONObject object,
 String message)

Adds an error message to the given JSONObject.

Parameters:

object - The JSON object.

message - The error message.

addSuccessToJSON

private final void addSuccessToJSON(JSONObject object,
 String message)

Adds a success message to the given JSONObject.

Parameters:

object - The JSON object.

message - The error message.

addNotificationListener

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

Specified by:

addNotificationListener in interface NotificationBroadcaster

addPerformanceSection

public final void addPerformanceSection(PerformanceSection definition)

Adds the definition for a performance section.

Specified by:

addPerformanceSection in interface PerfLogMBean

Parameters:

definition - The definition for the performance section.

buildAttributeInfoList

private final OpenMBeanAttributeInfo[] buildAttributeInfoList()

Builds the attribute info list for getMBeanInfo().

Returns:

The attribute info list.

buildNotificationInfoList

private final MBeanNotificationInfo[] buildNotificationInfoList()

Builds the notifications info list for getMBeanInfo().

Returns:

The notifications info list.

buildOperationInfoList

private final OpenMBeanOperationInfo[] buildOperationInfoList()

Builds the operation info list for getMBeanInfo().

Returns:

The operation info list.

disablePerformanceSection

public String disablePerformanceSection(String name)

Disables the performance section.

This is an operation for the MBean.

Specified by:

disablePerformanceSection in interface PerfLogMBean

Parameters:

name - The name of the performance section.

Returns:

A message indicating success or failure of the operation, as a JSON String.

enablePerformanceSection

public String enablePerformanceSection(String name)

Enables the performance section.

This is an operation for the MBean.

Specified by:

enablePerformanceSection in interface PerfLogMBean

Parameters:

name - The name of the performance section.

Returns:

A message indicating success or failure of the operation, as a JSON String.

getNotificationExceptions

public final String[] getNotificationExceptions()

Returns the exceptions that caused a notification thread to abort.

Specified by:

getNotificationExceptions in interface PerfLogMBean

Returns:

A list of exceptions that let a notification thread go down.

getMBeanInfo

public final MBeanInfo getMBeanInfo()

Get the MBeanInfo for this MBean. That is in fact an instance of OpenMBeanInfoSupport as an implementation of OpenMBeanInfo. This identifies this MBean as an Open MBean.

This method implements DynamicMBean.getMBeanInfo() and overwrites the implementation from StandardMBean.

This method first calls StandardMBean.getCachedMBeanInfo() in order to retrieve the cached MBeanInfo for this MBean, if any. If the result from this call is not null, it will be returned.

Otherwise, this method builds a MBeanInfo for this MBean from scratch.

Finally, it calls cacheMBeanInfo() in order to cache the new MBeanInfo for subsequent calls.

Specified by:

getMBeanInfo in interface DynamicMBean

Overrides:

getMBeanInfo in class StandardMBean

Returns:

The cached MBeanInfo for this MBean, if not null, or a newly built MBeanInfo if none was cached.

getNotificationInfo

public final MBeanNotificationInfo[] getNotificationInfo()

Specified by:

getNotificationInfo in interface NotificationBroadcaster

getNotificationSequenceNumber

public final long getNotificationSequenceNumber()

Returns the notification sequence number.

Specified by:

getNotificationSequenceNumber in interface PerfLogMBean

Returns:

The last used sequence number.

getPerformanceSection

public final Optional<PerformanceSection> getPerformanceSection(PerformanceSectionName name)

Returns the performance section specified by the given name.

Specified by:

getPerformanceSection in interface PerfLogMBean

Parameters:

name - The name of the performance section.

Returns:

An instance of Optional that holds the retrieved performance section.

getPerformanceSections

public final String[] getPerformanceSections()

Returns a list of the currently defined performance sections.

This is an attribute for the MBean.

Specified by:

getPerformanceSections in interface PerfLogMBean

Returns:

The list of the performance section names.

postDeregister

public final void postDeregister()

Specified by:

postDeregister in interface MBeanRegistration

Overrides:

postDeregister in class StandardMBean

receivePerformanceReport

public final void receivePerformanceReport(PerformanceReport report)

Takes the performance report and transfers it further.

Finally, this method sends a notification.

If an Executor was specified in the constructor for the NotificationBroadcasterSupport instance, it will be given one task per selected listener to deliver the notification to that listener.

Specified by:

receivePerformanceReport in interface PerfLogMBean

Parameters:

report - The performance report.

removeNotificationListener

public final void removeNotificationListener(NotificationListener listener)
                                      throws ListenerNotFoundException

Specified by:

removeNotificationListener in interface NotificationBroadcaster

Throws:

ListenerNotFoundException

removeNotificationListener

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

Specified by:

removeNotificationListener in interface NotificationEmitter

Throws:

ListenerNotFoundException

retrievePerformanceSection

public final PerformanceSection retrievePerformanceSection(PerformanceSectionName name)

Retrieves the performance section for the given name.

If there is no performance section for the given name, a new one is created, with the threshold and the timeout disabled. Obviously, it should not be ignored.

Specified by:

retrievePerformanceSection in interface PerfLogMBean

Parameters:

name - The name of the performance section.

Returns:

The performance section; will never be null.

showPerformanceSection

public final String showPerformanceSection(String name)

Shows the performance section status.

This is an operation for the MBean.

Specified by:

showPerformanceSection in interface PerfLogMBean

Parameters:

name - The name of the performance section.

Returns:

The status of the performance section, or a message indicating what failed in case of error, as a JSON String.

uncaughtExceptionHandler

private final void uncaughtExceptionHandler(Thread t,
 Throwable e)

This method is invoked when the given thread terminates due to the given uncaught exception.

Any exception thrown by this method will be ignored by the Java Virtual Machine.

This Thread.UncaughtExceptionHandler will be assigned to the ThreadFactory used by the thread pool for the NotificationBroadcasterSupport instance.

Parameters:

t - The thread.

e - The exception.

See Also:

• Thread.UncaughtExceptionHandler.uncaughtException(Thread,Throwable)