javax.management.monitor
Interface StringMonitorMBean

All Known Implementing Classes:

StringMonitor

public interface StringMonitorMBean

extends MonitorMBean

This interface exposes the remote management interface of the string monitor MBean.

Method Summary

java.lang.String	getDerivedGauge() Deprecated. Replaced by getDerivedGauge(ObjectName)
java.lang.String	getDerivedGauge(ObjectName object) This method gets the derived gauge for the specified MBean.
long	getDerivedGaugeTimeStamp() Deprecated. Replaced by getDerivedGaugeTimeStamp(ObjectName)
long	getDerivedGaugeTimeStamp(ObjectName object) This method gets the derived gauge timestamp for the specified MBean.
boolean	getNotifyDiffer() This method sets the differing notification's on/off switch value.
boolean	getNotifyMatch() This method gets the matching notification's on/off switch value.
java.lang.String	getStringToCompare() This method gets the string to compare with the observed attribute.
void	setNotifyDiffer(boolean value) This method sets the differing notification's on/off switch value.
void	setNotifyMatch(boolean value) This method sets the matching notification's on/off switch value.
void	setStringToCompare(java.lang.String value) This method sets the string to compare with the observed attribute.

Methods inherited from interface javax.management.monitor.MonitorMBean

addObservedObject, containsObservedObject, getGranularityPeriod, getObservedAttribute, getObservedObject, getObservedObjects, isActive, removeObservedObject, setGranularityPeriod, setObservedAttribute, setObservedObject, start, stop

Method Detail

getDerivedGauge

public java.lang.String getDerivedGauge()

Deprecated. Replaced by getDerivedGauge(ObjectName)

This method gets the value of the derived gauge. The derived gauge is either the exact value of the observed attribute , or the difference between the two consecutive observed values of the attribute.

Returns:

An instance of java.lang.String giving the value of the derived gauge.

getDerivedGaugeTimeStamp

public long getDerivedGaugeTimeStamp()

Deprecated. Replaced by getDerivedGaugeTimeStamp(ObjectName)

This method gets the value of the derived gauge time stamp. The derived gauge time stamp is the value(in the nearest miliseconds) when the notification was triggered.

Returns:

long value representing the time the notification was triggered.

getDerivedGauge

public java.lang.String getDerivedGauge(ObjectName object)

This method gets the derived gauge for the specified MBean.

Parameters:

object - the MBean for which the derived gauge is to be returned

Returns:

The derived gauge for the specified MBean if this MBean is in the set of observed MBeans, or null otherwise.

getDerivedGaugeTimeStamp

public long getDerivedGaugeTimeStamp(ObjectName object)

This method gets the derived gauge timestamp for the specified MBean.

Parameters:

object - the MBean for which the derived gauge timestamp is to be returned

Returns:

The derived gauge timestamp for the specified MBean if this MBean is in the set of observed MBeans, or null otherwise.

getNotifyDiffer

public boolean getNotifyDiffer()

This method sets the differing notification's on/off switch value.

Returns:

true if the string monitor notifies when differing, false otherwise.

See Also:

setNotifyDiffer(boolean)

setNotifyDiffer

public void setNotifyDiffer(boolean value)

This method sets the differing notification's on/off switch value.

Parameters:

value - - The differing notification's on/off switch value.

See Also:

getNotifyDiffer()

getNotifyMatch

public boolean getNotifyMatch()

This method gets the matching notification's on/off switch value.

Returns:

true if the string monitor notifies when matching, false otherwise.

See Also:

setNotifyMatch(boolean)

setNotifyMatch

public void setNotifyMatch(boolean value)

This method sets the matching notification's on/off switch value.

Parameters:

value - - The matching notification's on/off switch value.

See Also:

getNotifyMatch()

getStringToCompare

public java.lang.String getStringToCompare()

This method gets the string to compare with the observed attribute.

Returns:

the String to be compared.

See Also:

setStringToCompare(java.lang.String)

setStringToCompare

public void setStringToCompare(java.lang.String value)
                        throws java.lang.IllegalArgumentException

This method sets the string to compare with the observed attribute.

Parameters:

value - The String Value to be compared.

Throws:

java.lang.IllegalArgumentException - The specified string to compare is null.

See Also:

getStringToCompare()