Class PerfLogRemoteImpl

java.lang.Object

org.tquadrat.foundation.perflog.remote.internal.PerfLogRemoteImpl

All Implemented Interfaces:

AutoCloseable, PerfLogRemote

@ClassVersion(sourceVersion="$Id: PerfLogRemoteImpl.java 1229 2026-05-04 19:11:41Z tquadrat $")
@API(status=INTERNAL,
     since="0.25.0")
public final class PerfLogRemoteImpl
extends Object
implements PerfLogRemote

The implementation of PerfLogRemote.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: PerfLogRemoteImpl.java 1229 2026-05-04 19:11:41Z tquadrat $

Since:

0.25.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.perflog.remote.internal.PerfLogRemoteImpl"

⁠

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final record	PerfLogRemoteImpl.Janitor	The janitor that takes care of the housekeeping for an instance of PerfLogRemote 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 PerfLogRemoteImpl.
private final MBeanServerConnection	m_Connection	The connection to the MBean.
private boolean	m_IsActive	The flag the indicates whether this remote is (still) active.
private final PerfLogRemoteImpl.Janitor	m_Janitor	The caretaker for this instance.
private static final ObjectName	m_ObjectName	The object name for the Performance Logging MBean.

Fields inherited from interface PerfLogRemote

DOMAIN_NAME, JSONField_Aborted, JSONField_AbortedRuns, JSONField_Cause, JSONField_CompletedRuns, JSONField_Context, JSONField_ElapsedTime, JSONField_Error, JSONField_ExceededThreshold, JSONField_FirstStart, JSONField_LastUpdated, JSONField_Message, JSONField_Section, JSONField_SectionDescription, JSONField_SectionIgnored, JSONField_SectionName, JSONField_SectionStatistics, JSONField_SectionThreshold, JSONField_SectionThresholdOnlyReport, JSONField_SectionTimeout, JSONField_StartTime, JSONField_Success, JSONField_ThresholdExceededRuns, JSONField_TimedOut, JSONField_TimedOutRuns, JSONField_Unit, JSONField_Value, MBEAN_TYPE, NOTIFICATION_Type

Constructor Summary

Constructors

Constructor	Description
PerfLogRemoteImpl(JMXServiceURL url, NotificationListener listener)	Creates a new instance of PerfLogRemoteImpl.

Method Summary

Modifier and Type	Method	Description
private final boolean	checkActive()	Checks whether this performance logging remote is still active.
final void	close()
static final PerfLogRemoteImpl	connect(JMXServiceURL url, NotificationListener listener)	Connects to the Performance Logging MBean specified through the given JMXServiceURL and the ObjectName returned by getPerfLogMBeanObjectName().
final MBeanInfo	getMBeanInfo()	Returns the MBeanInfo for the performance logging MBean.
static final ObjectName	getPerfLogMBeanObjectName()	Returns the ObjectName for the Performance Logging MBean.
String	getPerformanceSection(String name)	Returns the status for the given performance section.
final String[]	getPerformanceSections()	Returns a list of the currently defined performance sections.

Methods inherited from class Object

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

Field Details

m_Cleanable

private final Cleaner.Cleanable m_Cleanable

The Cleaner.Cleanable for this instance.

m_Connection

private final MBeanServerConnection m_Connection

The connection to the MBean.

m_IsActive

private boolean m_IsActive

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

m_Janitor

private final PerfLogRemoteImpl.Janitor m_Janitor

The caretaker for this instance.

m_Cleaner

private static final Cleaner m_Cleaner

The cleaner that is used to finalise instances of PerfLogRemoteImpl.

m_ObjectName

private static final ObjectName m_ObjectName

The object name for the Performance Logging MBean.

Constructor Details

PerfLogRemoteImpl

public PerfLogRemoteImpl(JMXServiceURL url,
 NotificationListener listener)
                  throws InstanceNotFoundException,
IOException

Creates a new instance of PerfLogRemoteImpl.

Parameters:

url - The service URL for the connection to the MBean server.

listener - The notification listener that receives the performance messages.

Throws:

IOException - Unable to connect to the MBean server.

InstanceNotFoundException - There is no performance logging MBean registered on the MBean server.

Method Details

checkActive

private final boolean checkActive()
                           throws IllegalStateException

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

Returns:

true if the instance is still active.

Throws:

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

close

public final void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface PerfLogRemote

connect

public static final PerfLogRemoteImpl connect(JMXServiceURL url,
 NotificationListener listener)
                                       throws InstanceNotFoundException,
IOException

Connects to the Performance Logging MBean specified through the given JMXServiceURL and the ObjectName returned by getPerfLogMBeanObjectName().

Parameters:

url - The JMX service URL.

listener - The notification listener.

Returns:

A new instance of PerFlogRemote.

Throws:

IOException - Unable to connect to the MBean server.

InstanceNotFoundException - There is no performance logging MBean registered on the MBean server.

getMBeanInfo

public final MBeanInfo getMBeanInfo()
                             throws IllegalStateException,
ReflectionException,
InstanceNotFoundException,
IntrospectionException,
IOException

Returns the MBeanInfo for the performance logging MBean.

Specified by:

getMBeanInfo in interface PerfLogRemote

Returns:

The MBeanInfo.

Throws:

IllegalStateException - The instance was already closed.

ReflectionException - An exception occurred when trying to invoke the method getMBeanInfo() of a Dynamic MBean.

InstanceNotFoundException - The MBean specified was not found.

IntrospectionException - An exception occurred during introspection.

IOException - A communication problem occurred when talking to the MBean server.

getPerfLogMBeanObjectName

public static final ObjectName getPerfLogMBeanObjectName()

Returns the ObjectName for the Performance Logging MBean.

Returns:

The object name for the MBean.

getPerformanceSection

public String getPerformanceSection(String name)
                             throws IllegalStateException,
ReflectionException,
InstanceNotFoundException,
MBeanException,
IOException

Returns the status for the given performance section.

Specified by:

getPerformanceSection in interface PerfLogRemote

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.

Throws:

IllegalStateException - The instance was already closed.

ReflectionException - An exception occurred when trying to invoke the method getAttribute() of a Dynamic MBean.

InstanceNotFoundException - The MBean specified was not found.

MBeanException - Wraps an exception thrown by the MBean method.

IOException - A communication problem occurred when talking to the MBean server.

getPerformanceSections

public final String[] getPerformanceSections()
                                      throws IllegalStateException,
ReflectionException,
AttributeNotFoundException,
InstanceNotFoundException,
MBeanException,
IOException

Returns a list of the currently defined performance sections.

Specified by:

getPerformanceSections in interface PerfLogRemote

Returns:

The list of the performance section names.

Throws:

IllegalStateException - The instance was already closed.

ReflectionException - An exception occurred when trying to invoke the method getAttribute() of a Dynamic MBean.

AttributeNotFoundException - The attribute was missing.

InstanceNotFoundException - The MBean specified was not found.

MBeanException - Wraps an exception thrown by the MBean method.

IOException - A communication problem occurred when talking to the MBean server.