Class PerfLogClientBase

java.lang.Object

org.tquadrat.foundation.perflog.client.PerfLogClientBase

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

PerfLogClientSupport

@ClassVersion(sourceVersion="$Id: PerfLogClientBase.java 1258 2026-06-04 18:33:06Z tquadrat $")
@API(status=MAINTAINED,
     since="0.25.0")
public abstract class PerfLogClientBase
extends Object
implements AutoCloseable

The abstract base class for a client for the Foundation Performance Logging and Monitoring. Basically, this is a recipient for the Notification messages that are sent each time a performance section was left.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.25.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.perflog.client.PerfLogClientBase"

⁠

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final record	PerfLogClientBase.Janitor	The janitor that takes care of the housekeeping for an instance of PerfLogClientBase in case that was not properly closed.
private static final record	PerfLogClientBase.PerfLogNotificationListener	The implementation of NotificationListener that receives the notifications from the MBean.

Field Summary

Fields

Modifier and Type	Field	Description
private 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 PerfLogClientBase.
private PerfLogClientBase.Janitor	m_Janitor	The caretaker for this instance.
private final BlockingQueue<String>	m_Messages	The messages.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PerfLogClientBase()	Creates a new instance of PerfLogClientBase.

Method Summary

Modifier and Type	Method	Description
final void	close()
final void	connect(boolean forceFlag)	Establishes the connection to the MBean and starts the listening.
final void	connect(MBeanServer mbeanServer, boolean forceFlag)	Establishes the connection to the MBean and starts the listening.
private static final PerfLogMBean	connectToMBean(MBeanServer mbeanServer, ObjectName objectName, boolean forceFlag)	Establishes the connection with the PerfLogMBean on the given MBean server and returns a proxy for it.
protected final BlockingQueue<String>	getQueue()	Returns a reference to the internal message queue.

Methods inherited from class Object

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

Field Details

m_Cleanable

private Cleaner.Cleanable m_Cleanable

The Cleaner.Cleanable for this instance.

m_Janitor

private PerfLogClientBase.Janitor m_Janitor

The caretaker for this instance.

m_Messages

private final BlockingQueue<String> m_Messages

The messages.

m_Cleaner

private static final Cleaner m_Cleaner

The cleaner that is used to finalise instances of PerfLogClientBase.

Constructor Details

PerfLogClientBase

protected PerfLogClientBase()

Creates a new instance of PerfLogClientBase.

Method Details

close

public final void close()

Specified by:

close in interface AutoCloseable

connect

public final void connect(boolean forceFlag)
                   throws IllegalStateException,
InstanceNotFoundException

Establishes the connection to the MBean and starts the listening.

Parameters:

forceFlag - true if the MBean should be registered in case it is not yet registered, false otherwise.

Throws:

IllegalStateException - The connection is already established.

InstanceNotFoundException - forceFlag is false, the PerfLogMBean is not registered, and the notification listener cannot connect to it.

connect

public final void connect(MBeanServer mbeanServer,
 boolean forceFlag)
                   throws IllegalStateException,
InstanceNotFoundException

Establishes the connection to the MBean and starts the listening.

Parameters:

mbeanServer - The MBean server that holds the MBean.

forceFlag - true if the MBean should be registered in case it is not yet registered, false otherwise.

Throws:

IllegalStateException - The connection is already established.

InstanceNotFoundException - forceFlag is false, the PerfLogMBean is not registered, and the notification listener cannot connect to it.

connectToMBean

private static final PerfLogMBean connectToMBean(MBeanServer mbeanServer,
 ObjectName objectName,
 boolean forceFlag)
                                          throws InstanceNotFoundException

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

If the MBean is not registered an exception is thrown.

Parameters:

mbeanServer - The MBean server that is used.

objectName - The name for the MBean.

forceFlag - true if the MBean should be registered in case it is not yet registered, false otherwise. PerfLogMBean.

Returns:

The MBean that we connected to.

Throws:

InstanceNotFoundException - forceFlag is false and the MBean is not registered in the given MBean server.

getQueue

protected final BlockingQueue<String> getQueue()

Returns a reference to the internal message queue.

Returns:

The message queue.