Interface PerfLogRemote

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

PerfLogRemoteImpl

@ClassVersion(sourceVersion="$Id: PerfLogRemote.java 1229 2026-05-04 19:11:41Z tquadrat $")
@API(status=STABLE,
     since="0.25.0")
public sealed interface PerfLogRemote
extends AutoCloseable
permits PerfLogRemoteImpl

The declaration of a remote client for the Foundation Performance Logging and Monitoring.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.25.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.perflog.remote.PerfLogRemote"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DOMAIN_NAME	The domain name part of the ObjectName identifying the Performance Logging MBean in the MBean server: "org.tquadrat.foundation.PerfLog"
static final String	JSONField_Aborted	The name of the JSON boolean that holds the aborted flag: "Aborted".
static final String	JSONField_AbortedRuns	The name of the JSON Number that holds the number of aborted runs for the performance section: "Aborted".
static final String	JSONField_Cause	The name of the JSON String that holds the cause for the abort of a performance section: "Cause".
static final String	JSONField_CompletedRuns	The name of the JSON Number that holds the number of completed runs for the performance section: "Completed".
static final String	JSONField_Context	The name of the JSON Object that holds the performance section context: "Context".
static final String	JSONField_ElapsedTime	The name of the JSON Object that holds the elapsed time: "ElapsedTime".
static final String	JSONField_Error	The name of the JSON Object that holds an error message: "Error".
static final String	JSONField_ExceededThreshold	The name of the JSON boolean that holds threshold exceeded flag: "ExceededThreshold".
static final String	JSONField_FirstStart	The name of the JSON String that holds the time of the first start of the performance section: "FirstStart".
static final String	JSONField_LastUpdated	The name of the JSON String that holds the time when the performance section was last updated: "LastUpdated".
static final String	JSONField_Message	The name of the JSON String that holds the text of an error message: "Message".
static final String	JSONField_Section	The name of the JSON Object that holds the data from the performance section: "PerformanceSection".
static final String	JSONField_SectionDescription	The name of the JSON String that holds the description of the performance section: "Description".
static final String	JSONField_SectionIgnored	The name of the JSON Boolean that holds the flag indicating whether the performance section is currently ignored: "Ignored".
static final String	JSONField_SectionName	The name of the JSON String that holds the name of the performance section: "Name".
static final String	JSONField_SectionStatistics	The name of the JSON Object that holds the execution statistics of the performance section: "Statistics".
static final String	JSONField_SectionThreshold	The name of the JSON Object that holds the threshold time from the performance section: "Threshold".
static final String	JSONField_SectionThresholdOnlyReport	The name of the JSON boolean that holds the flag indicating whether a report should be sent only when the threshold was exceeded: "ThresholdOnlyReport".
static final String	JSONField_SectionTimeout	The name of the JSON Object that holds the timeout time from the performance section: "Timeout".
static final String	JSONField_StartTime	The name of the JSON String that holds the time when the performance section was entered: "StartTime".
static final String	JSONField_Success	The name of the JSON Object that holds a success message: "Success".
static final String	JSONField_ThresholdExceededRuns	The name of the JSON Number that holds the number of performance section runs where the threshold was exceeded: "ThresholdExceeded".
static final String	JSONField_TimedOut	The name of the JSON boolean that holds timed out flag: "TimedOut".
static final String	JSONField_TimedOutRuns	The name of the JSON Number that holds the number of performance section runs that timed out: "TimedOut".
static final String	JSONField_Unit	The name of the JSON String that holds the unit for the dimension from a dimensioned value: "Unit".
static final String	JSONField_Value	The name of the JSON Number that holds the value from a dimensioned value: "Value".
static final String	MBEAN_TYPE	The type for the ObjectName identifying the Performance Logging MBean in the MBean server: "PerformanceLogging".
static final String	NOTIFICATION_Type	The type for the Notification instances emitted by Performance Logging MBean: "org.tquadrat.foundation.perflog.SectionExec".

Method Summary

Modifier and Type	Method	Description
void	close()
static PerfLogRemote	connect(int registryPort, NotificationListener listener)	Connects to the Performance Logging MBean specified through the given port number and the ObjectName returned by getPerfLogMBeanObjectName().
static PerfLogRemote	connect(String hostName, int registryPort, int dataPort, NotificationListener listener)	Connects to the Performance Logging MBean specified through the given host name, port numbers and the ObjectName returned by getPerfLogMBeanObjectName().
MBeanInfo	getMBeanInfo()	Returns the MBeanInfo for the performance logging MBean.
static ObjectName	getPerfLogMBeanObjectName()	Returns the ObjectName for the Performance Logging MBean.
String	getPerformanceSection(String name)	Returns the status for the given performance section.
String[]	getPerformanceSections()	Returns a list of the currently defined performance sections.

Field Details

DOMAIN_NAME

static final String DOMAIN_NAME

The domain name part of the ObjectName identifying the Performance Logging MBean in the MBean server: "org.tquadrat.foundation.PerfLog".

See Also:

• Constant Field Values

JSONField_Aborted

static final String JSONField_Aborted

The name of the JSON boolean that holds the aborted flag: "Aborted".

See Also:

• Constant Field Values

JSONField_AbortedRuns

static final String JSONField_AbortedRuns

The name of the JSON Number that holds the number of aborted runs for the performance section: "Aborted".

See Also:

• Constant Field Values

JSONField_Cause

static final String JSONField_Cause

The name of the JSON String that holds the cause for the abort of a performance section: "Cause".

See Also:

• Constant Field Values

JSONField_CompletedRuns

static final String JSONField_CompletedRuns

The name of the JSON Number that holds the number of completed runs for the performance section: "Completed".

See Also:

• Constant Field Values

JSONField_Context

static final String JSONField_Context

The name of the JSON Object that holds the performance section context: "Context".

See Also:

• Constant Field Values

JSONField_ElapsedTime

static final String JSONField_ElapsedTime

The name of the JSON Object that holds the elapsed time: "ElapsedTime".

See Also:

• Constant Field Values

JSONField_Error

static final String JSONField_Error

The name of the JSON Object that holds an error message: "Error".

See Also:

• Constant Field Values

JSONField_ExceededThreshold

static final String JSONField_ExceededThreshold

The name of the JSON boolean that holds threshold exceeded flag: "ExceededThreshold".

See Also:

• Constant Field Values

JSONField_FirstStart

static final String JSONField_FirstStart

The name of the JSON String that holds the time of the first start of the performance section: "FirstStart".

See Also:

• Constant Field Values

JSONField_LastUpdated

static final String JSONField_LastUpdated

The name of the JSON String that holds the time when the performance section was last updated: "LastUpdated".

See Also:

• Constant Field Values

JSONField_Message

static final String JSONField_Message

The name of the JSON String that holds the text of an error message: "Message".

See Also:

• Constant Field Values

JSONField_Section

static final String JSONField_Section

The name of the JSON Object that holds the data from the performance section: "PerformanceSection".

See Also:

• Constant Field Values

JSONField_SectionDescription

static final String JSONField_SectionDescription

The name of the JSON String that holds the description of the performance section: "Description".

See Also:

• Constant Field Values

JSONField_SectionIgnored

static final String JSONField_SectionIgnored

The name of the JSON Boolean that holds the flag indicating whether the performance section is currently ignored: "Ignored".

See Also:

• Constant Field Values

JSONField_SectionName

static final String JSONField_SectionName

The name of the JSON String that holds the name of the performance section: "Name".

See Also:

• Constant Field Values

JSONField_SectionStatistics

static final String JSONField_SectionStatistics

The name of the JSON Object that holds the execution statistics of the performance section: "Statistics".

See Also:

• Constant Field Values

JSONField_SectionThreshold

static final String JSONField_SectionThreshold

The name of the JSON Object that holds the threshold time from the performance section: "Threshold".

See Also:

• Constant Field Values

JSONField_SectionThresholdOnlyReport

static final String JSONField_SectionThresholdOnlyReport

The name of the JSON boolean that holds the flag indicating whether a report should be sent only when the threshold was exceeded: "ThresholdOnlyReport".

See Also:

• Constant Field Values

JSONField_SectionTimeout

static final String JSONField_SectionTimeout

The name of the JSON Object that holds the timeout time from the performance section: "Timeout".

See Also:

• Constant Field Values

JSONField_StartTime

static final String JSONField_StartTime

The name of the JSON String that holds the time when the performance section was entered: "StartTime".

See Also:

• Constant Field Values

JSONField_Success

static final String JSONField_Success

The name of the JSON Object that holds a success message: "Success".

See Also:

• Constant Field Values

JSONField_ThresholdExceededRuns

static final String JSONField_ThresholdExceededRuns

The name of the JSON Number that holds the number of performance section runs where the threshold was exceeded: "ThresholdExceeded".

See Also:

• Constant Field Values

JSONField_TimedOut

static final String JSONField_TimedOut

The name of the JSON boolean that holds timed out flag: "TimedOut".

See Also:

• Constant Field Values

JSONField_TimedOutRuns

static final String JSONField_TimedOutRuns

The name of the JSON Number that holds the number of performance section runs that timed out: "TimedOut".

See Also:

• Constant Field Values

JSONField_Unit

static final String JSONField_Unit

The name of the JSON String that holds the unit for the dimension from a dimensioned value: "Unit".

See Also:

• JSONField_SectionThreshold
• JSONField_SectionTimeout
• Constant Field Values

JSONField_Value

static final String JSONField_Value

The name of the JSON Number that holds the value from a dimensioned value: "Value".

See Also:

• JSONField_SectionThreshold
• JSONField_SectionTimeout
• Constant Field Values

MBEAN_TYPE

static final String MBEAN_TYPE

The type for the ObjectName identifying the Performance Logging MBean in the MBean server: "PerformanceLogging".

See Also:

• Constant Field Values

NOTIFICATION_Type

static final String NOTIFICATION_Type

The type for the Notification instances emitted by Performance Logging MBean: "org.tquadrat.foundation.perflog.SectionExec".

See Also:

• Constant Field Values

Method Details

close

void close()

Specified by:

close in interface AutoCloseable

connect

static PerfLogRemote connect(int registryPort,
 NotificationListener listener)
                      throws InstanceNotFoundException,
IOException

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

This method creates a local connection (both processes are running on the same machine).

Parameters:

registryPort - The number of the registry port.

listener - The notification listener.

Returns:

The PerfLogRemote instance that manages the connection to the performance logging MBean.

Throws:

IOException - Unable to connect to the MBean server.

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

connect

static PerfLogRemote connect(String hostName,
 int registryPort,
 int dataPort,
 NotificationListener listener)
                      throws IOException,
InstanceNotFoundException

Connects to the Performance Logging MBean specified through the given host name, port numbers and the ObjectName returned by getPerfLogMBeanObjectName().

This method creates a remote connection (both processes are probably running on different machines).

Parameters:

hostName - The host name.

registryPort - The number of the registry port.

dataPort - The number of the data port; can be the same as the registry port.

listener - The notification listener.

Returns:

The PerfLogRemote instance that manages the connection to the performance logging MBean.

Throws:

MalformedURLException - It is not possible to compose a valid JMXServiceURL with the given hostName.

IOException - Unable to connect to the MBean server.

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

getMBeanInfo

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

Returns the MBeanInfo for the performance logging MBean.

Returns:

The MBeanInfo.

Throws:

IllegalStateException - The instance was already closed.

IntrospectionException - An exception occurred during introspection.

InstanceNotFoundException - The MBean specified was not found.

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

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

getPerfLogMBeanObjectName

static ObjectName getPerfLogMBeanObjectName()

Returns the ObjectName for the Performance Logging MBean.

Returns:

The object name for the MBean.

getPerformanceSection

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

Returns the status for the given performance section.

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.

MBeanException - Wraps an exception thrown by the MBean method.

InstanceNotFoundException - The MBean specified was not found.

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

getPerformanceSections

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

Returns a list of the currently defined performance sections.

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.

MBeanException - Wraps an exception thrown by the MBean method.

InstanceNotFoundException - The MBean specified was not found.

AttributeNotFoundException - The attribute was missing.

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