Class PerfLogManagerImpl

java.lang.Object

org.tquadrat.foundation.perflog.internal.PerfLogManagerImpl

All Implemented Interfaces:

AutoCloseable, PerfLogManager

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

The implementation for the interface PerfLogManager.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.25.0

UML Diagram

⁠

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

⁠

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final record	PerfLogManagerImpl.Janitor	The janitor that takes care of the housekeeping for an instance of PerfLogManager in case that was not properly closed.

Field Summary

Fields

Modifier and Type	Field	Description
private final Cleaner.Cleanable	m_Cleanable	The Cleaner.Cleanable for this instance.
private static final Cleaner	m_Cleaner	The cleaner that is used to finalise instances of PerfLogManagerImpl.
private static final AtomicInteger	m_InstanceCounter	The instance counter that is used for the thread names in createTimeoutMonitor(UncaughtExceptionHandler).
private boolean	m_IsActive	The flag the indicates whether this manager is (still) active.
private final PerfLogManagerImpl.Janitor	m_Janitor	The caretaker for this instance.
private final PerfLogMBean	m_MBean	The proxy for the PerfLogMBean.
private final ScheduledExecutorService	m_TimeoutScheduler	The timeout scheduler for this manager.
private static final MathContext	MATH_CONTEXT	The instance of MathContext that is used by registerTimeoutMonitor(PerformanceTrackerImpl) to calculate the timeout waiting period from the given TimeValue.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PerfLogManagerImpl(boolean ignored, MBeanServer mbeanServer, ObjectName objectName, Thread.UncaughtExceptionHandler uncaughtExceptionHandler)	Creates a new instance of PerfLogManagerImpl.
	PerfLogManagerImpl(MBeanServer mbeanServer, ObjectName objectName)	Creates a new instance of PerfLogManagerImpl.
	PerfLogManagerImpl(MBeanServer mbeanServer, ObjectName objectName, Thread.UncaughtExceptionHandler uncaughtExceptionHandler)	Creates a new instance of PerfLogManagerImpl.

Method Summary

Modifier and Type	Method	Description
private final boolean	checkActive()	Checks whether this performance logging manager is still active.
final void	close()
private static final PerfLogMBean	connectToMBean(MBeanServer mbeanServer, ObjectName objectName)	Establishes the connection with the PerfLogMBean on the given MBean server and returns a proxy for it.
final Optional<PerformanceTracker>	createPerformanceTracker(PerformanceSectionName name)	Creates a performance tracker for the PerformanceSection with the given name.
private final ScheduledExecutorService	createTimeoutMonitor(Thread.UncaughtExceptionHandler uncaughtExceptionHandler)	Creates the ScheduledExecutorService instance that is used as the timeout monitor and registers it for the housekeeping.
final PerfLogMBean	getMBean()	Provides a reference to the internal instance of PerfLogMBean.
final Optional<PerformanceSection>	getPerformanceSection(PerformanceSectionName name)	Returns the performance section specified by the given name.
void	loadPerformanceSectionDefinitions(Iterable<PerformanceSection> definitions)	Loads the Performance Section definitions.
final ScheduledFuture<?>	registerTimeoutMonitor(PerformanceTrackerImpl tracker)	Registers a timeout monitor from a performance tracker.
final void	sendReport(PerformanceTrackerImpl tracker, String message, Throwable cause)	Sends a performance report to the PerfLogMBean.

Methods inherited from class Object

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

Methods inherited from interface PerfLogManager

createPerformanceTracker, loadPerformanceSectionDefinitions

Field Details

m_Cleanable

private final Cleaner.Cleanable m_Cleanable

The Cleaner.Cleanable for this instance.

m_InstanceCounter

private static final AtomicInteger m_InstanceCounter

The instance counter that is used for the thread names in createTimeoutMonitor(UncaughtExceptionHandler).

m_IsActive

private boolean m_IsActive

The flag the indicates whether this manager is (still) active.

m_Janitor

private final PerfLogManagerImpl.Janitor m_Janitor

The caretaker for this instance.

m_MBean

private final PerfLogMBean m_MBean

The proxy for the PerfLogMBean.

m_TimeoutScheduler

private final ScheduledExecutorService m_TimeoutScheduler

The timeout scheduler for this manager.

m_Cleaner

private static final Cleaner m_Cleaner

The cleaner that is used to finalise instances of PerfLogManagerImpl.

MATH_CONTEXT

private static final MathContext MATH_CONTEXT

The instance of MathContext that is used by registerTimeoutMonitor(PerformanceTrackerImpl) to calculate the timeout waiting period from the given TimeValue.

Constructor Details

PerfLogManagerImpl

public PerfLogManagerImpl(MBeanServer mbeanServer,
 ObjectName objectName)

Creates a new instance of PerfLogManagerImpl.

Parameters:

mbeanServer - The MBean server that is used.

objectName - The name of the PerfLogMBean.

PerfLogManagerImpl

public PerfLogManagerImpl(MBeanServer mbeanServer,
 ObjectName objectName,
 Thread.UncaughtExceptionHandler uncaughtExceptionHandler)

Creates a new instance of PerfLogManagerImpl.

Parameters:

mbeanServer - The MBean server that is used.

objectName - The name of the PerfLogMBean.

uncaughtExceptionHandler - The implementation of Thread.UncaughtExceptionHandler that is used for the timeout monitoring thread.

PerfLogManagerImpl

private PerfLogManagerImpl(boolean ignored,
 MBeanServer mbeanServer,
 ObjectName objectName,
 Thread.UncaughtExceptionHandler uncaughtExceptionHandler)

Creates a new instance of PerfLogManagerImpl.

Parameters:

ignored - Discriminator

mbeanServer - The MBean server that is used.

objectName - The name of the PerfLogMBean.

uncaughtExceptionHandler - The implementation of Thread.UncaughtExceptionHandler that is used for the timeout monitoring thread.

Method Details

checkActive

private final boolean checkActive()
                           throws IllegalStateException

Checks whether this performance logging manager is still active. Throws an IllegalStateException if not.

Returns:

true if the manager is still active.

Throws:

IllegalStateException - close() was already called on this instance.

close

public final void close()

After close() is called, calls to other methods of this instance may result in an IllegalStateException to be thrown.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface PerfLogManager

connectToMBean

private static final PerfLogMBean connectToMBean(MBeanServer mbeanServer,
 ObjectName objectName)

Establishes the connection with the PerfLogMBean on the given MBean server and returns a proxy for it.

If the MBean had not been registered yet, this method will register it first.

Parameters:

mbeanServer - The MBean server that is used.

objectName - The name for the MBean.

Returns:

A proxy for PerfLogMBean.

createPerformanceTracker

public final Optional<PerformanceTracker> createPerformanceTracker(PerformanceSectionName name)

Creates a performance tracker for the PerformanceSection with the given name.

The return value will be empty if the performance section is currently ignored.

If there is currently no performance section defined with the given name, one will be created with default values.

Specified by:

createPerformanceTracker in interface PerfLogManager

Parameters:

name - The name of the performance section.

Returns:

An instance of Optional that holds the new tracker.

createTimeoutMonitor

private final ScheduledExecutorService createTimeoutMonitor(Thread.UncaughtExceptionHandler uncaughtExceptionHandler)

Creates the ScheduledExecutorService instance that is used as the timeout monitor and registers it for the housekeeping.

Parameters:

uncaughtExceptionHandler - The implementation of Thread.UncaughtExceptionHandler that is used for the timeout monitoring threads.

Returns:

The timeout monitor.

getMBean

public final PerfLogMBean getMBean()

Provides a reference to the internal instance of PerfLogMBean.

Notes:

• This is the proxy, but not the MBean itself.
• The API is not limited to the OpenMBean API that is published to a remote client.

Returns:

The reference to the MBean.

getPerformanceSection

public final Optional<PerformanceSection> getPerformanceSection(PerformanceSectionName name)

Returns the performance section specified by the given name.

Delegates to PerfLogMBean.getPerformanceSection(PerformanceSectionName)

Specified by:

getPerformanceSection in interface PerfLogManager

Parameters:

name - The name of the performance section.

Returns:

An instance of Optional that holds the retrieved performance section.

loadPerformanceSectionDefinitions

public void loadPerformanceSectionDefinitions(Iterable<PerformanceSection> definitions)

Loads the Performance Section definitions.

Because these definitions are stored globally in the Performance Logging and Monitorin MBean, they need to be loaded only once. But overwriting them does not harm, other than performance.

Each instance of PerfLogManager shares the same instances of PerformanceSection.

Specified by:

loadPerformanceSectionDefinitions in interface PerfLogManager

Parameters:

definitions - The definitions for the performance sections.

registerTimeoutMonitor

public final ScheduledFuture<?> registerTimeoutMonitor(PerformanceTrackerImpl tracker)
                                                throws IllegalStateException

Registers a timeout monitor from a performance tracker.

Parameters:

tracker - The performance tracker to register.

Returns:

The timeout monitor; will be null if the given tracker is not active, or the performance section for that tracker does not define a timeout value.

Throws:

IllegalStateException - close() was already called on this instance.

sendReport

public final void sendReport(PerformanceTrackerImpl tracker,
 String message,
 Throwable cause)
                      throws IllegalStateException

Sends a performance report to the PerfLogMBean.

Parameters:

tracker - The tracker that collected the performance data.

message - The message describing the reason for the abort of the tracker; can be null.

cause - The exception that caused the abort; can be null.

Throws:

IllegalStateException - close() was already called on this instance.