wt.jmx.core.mbeans
Interface SummaryMBean

All Superinterfaces:

InfoMBean, SelfEmailingMBean

public interface SummaryMBean
extends InfoMBean

Provides configurable periodic "summary" logging of JMX attributes

Supported API: true

Extendable: true

Method Summary

String	getCustomDelegateFactoryClass() Name of custom delegate factory class; must implement SummaryDelegateFactory Supported API: true
String	getFormatString() Low-level (java.util.Formatter) log format string; if specified, overrides UseShortFormat and SeparatorString Supported API: true
int	getIntervalSeconds() Interval, in seconds, at which logging will be done Supported API: true
String	getLoggerLevel() Logging level; valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified); must be INFO (or DEBUG when LogAsDebug is true) for log messages to be produced Supported API: true
String	getLoggerName() Name of logger to which this bean logs Supported API: true
String	getSeparatorString() Item separator string used in log format Supported API: true
boolean	isGCFirst() Whether a garbage collection should be explicitly performed immediately to querying the JMX attributes to log Supported API: true
boolean	isLogAsDebug() Whether log messages should be generated as DEBUG or INFO level messages; see also LoggerLevel Supported API: true
boolean	isUseShortFormat() Whether short format (which contains only attribute values, not names) is used for logging Supported API: true
void	remove() Disable this summary and remove it from the management console Supported API: true
void	setCustomDelegateFactoryClass(String customDelegateFactoryClassname) Name of custom delegate factory class; must implement SummaryDelegateFactory
void	setFormatString(String formatString) Low-level (java.util.Formatter) log format string; if specified, overrides UseShortFormat and SeparatorString Supported API: true
void	setGCFirst(boolean gcFirst) Whether a garbage collection should be explicitly performed immediately to querying the JMX attributes to log Supported API: true
void	setIntervalSeconds(int intervalSeconds) Interval, in seconds, at which logging will be done Supported API: true
void	setLogAsDebug(boolean logAsDebug) Whether log messages should be generated as DEBUG or INFO level messages; see also LoggerLevel Supported API: true
void	setLoggerLevel(String level) Logging level; valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified); must be INFO (or DEBUG when LogAsDebug is true) for log messages to be produced Supported API: true
void	setSeparatorString(String separatorString) Item separator string used in log format Supported API: true
void	setUseShortFormat(boolean useShortFormat) Whether short format (which contains only attribute values, not names) is used for logging Supported API: true

Methods inherited from interface wt.jmx.core.mbeans.InfoMBean

addInfoItem, changeInfoItemDisplayName, getInfoItemsAsOpenData, getInfoItemsAsStrings, getInfoItemsPreview, insertInfoItem, removeInfoItem, removeInfoItems

Methods inherited from interface wt.jmx.core.mbeans.SelfEmailingMBean

emailThisMBean

Method Detail

isLogAsDebug

boolean isLogAsDebug()

Whether log messages should be generated as DEBUG or INFO level messages; see also LoggerLevel

Supported API: true

setLogAsDebug

void setLogAsDebug(boolean logAsDebug)

Whether log messages should be generated as DEBUG or INFO level messages; see also LoggerLevel

Supported API: true

getLoggerName

String getLoggerName()

Name of logger to which this bean logs

Supported API: true

getLoggerLevel

String getLoggerLevel()

Logging level; valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified); must be INFO (or DEBUG when LogAsDebug is true) for log messages to be produced

Supported API: true

setLoggerLevel

void setLoggerLevel(String level)

Logging level; valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified); must be INFO (or DEBUG when LogAsDebug is true) for log messages to be produced

Supported API: true

getIntervalSeconds

int getIntervalSeconds()

Interval, in seconds, at which logging will be done

Supported API: true

setIntervalSeconds

void setIntervalSeconds(int intervalSeconds)

Interval, in seconds, at which logging will be done

Supported API: true

isGCFirst

boolean isGCFirst()

Whether a garbage collection should be explicitly performed immediately to querying the JMX attributes to log

Supported API: true

setGCFirst

void setGCFirst(boolean gcFirst)

Whether a garbage collection should be explicitly performed immediately to querying the JMX attributes to log

Supported API: true

isUseShortFormat

boolean isUseShortFormat()

Whether short format (which contains only attribute values, not names) is used for logging

Supported API: true

setUseShortFormat

void setUseShortFormat(boolean useShortFormat)

Whether short format (which contains only attribute values, not names) is used for logging

Supported API: true

getSeparatorString

String getSeparatorString()

Item separator string used in log format

Supported API: true

setSeparatorString

void setSeparatorString(String separatorString)

Item separator string used in log format

Supported API: true

getFormatString

String getFormatString()

Low-level (java.util.Formatter) log format string; if specified, overrides UseShortFormat and SeparatorString

Supported API: true

setFormatString

void setFormatString(String formatString)

Low-level (java.util.Formatter) log format string; if specified, overrides UseShortFormat and SeparatorString

Supported API: true

getCustomDelegateFactoryClass

String getCustomDelegateFactoryClass()

Name of custom delegate factory class; must implement SummaryDelegateFactory

Supported API: true

setCustomDelegateFactoryClass

void setCustomDelegateFactoryClass(String customDelegateFactoryClassname)
                                   throws ClassCastException,
                                          ClassNotFoundException,
                                          IllegalAccessException,
                                          InstantiationException

Name of custom delegate factory class; must implement SummaryDelegateFactory

If the class indicated by 'customDelegateFactoryClassname' extends SelfAwareMBean, then an instance of the class will be registered and managed as a child of this MBean.

Supported API: true

Throws:

ClassCastException

ClassNotFoundException

IllegalAccessException

InstantiationException

remove

void remove()

Disable this summary and remove it from the management console

Supported API: true