javax.management.monitor
class StringMonitor

java.lang.Object javax.management.NotificationBroadcasterSupport javax.management.monitor.Monitor javax.management.monitor.StringMonitor

All Implemented Interfaces:

MBeanRegistration, NotificationEmitter, MonitorMBean, StringMonitorMBean

Most common way to construct:

StringMonitor sm = new StringMonitor();

Based on 21 examples

public class StringMonitor
extends Monitor
implements StringMonitorMBean

Defines a monitor MBean designed to observe the values of a string attribute.

A string monitor sends notifications as follows:

• if the attribute value matches the string to compare value, a {@link MonitorNotification#STRING_TO_COMPARE_VALUE_MATCHED match notification} is sent. The notify match flag must be set to true.
  Subsequent matchings of the string to compare values do not cause further notifications unless the attribute value differs from the string to compare value.
• if the attribute value differs from the string to compare value, a {@link MonitorNotification#STRING_TO_COMPARE_VALUE_DIFFERED differ notification} is sent. The notify differ flag must be set to true.
  Subsequent differences from the string to compare value do not cause further notifications unless the attribute value matches the string to compare value.

StringMonitor

public StringMonitor()

Default constructor.

getDerivedGauge

public synchronized String getDerivedGauge()

Returns the derived gauge of the first object in the set of observed MBeans.

Returns:

The derived gauge.

getDerivedGauge

public synchronized String getDerivedGauge(ObjectName object)

Gets the derived gauge of the specified object, if this object is contained in the set of observed MBeans, or null otherwise.

Overrides:

getDerivedGauge in class Monitor

Parameters:

object - the name of the MBean whose derived gauge is required.

Returns:

The derived gauge of the specified object.

getDerivedGaugeTimeStamp

public synchronized long getDerivedGaugeTimeStamp()

Gets the derived gauge timestamp of the first object in the set of observed MBeans.

Returns:

The derived gauge timestamp.

getDerivedGaugeTimeStamp

public synchronized long getDerivedGaugeTimeStamp(ObjectName object)

Gets the derived gauge timestamp of the specified object, if this object is contained in the set of observed MBeans, or 0 otherwise.

Overrides:

getDerivedGaugeTimeStamp in class Monitor

Parameters:

object - the name of the object whose derived gauge timestamp is to be returned.

Returns:

The derived gauge timestamp of the specified object.

getNotificationInfo

public MBeanNotificationInfo[] getNotificationInfo()

Returns a NotificationInfo object containing the name of the Java class of the notification and the notification types sent by the string monitor.

Overrides:

getNotificationInfo in class NotificationBroadcasterSupport

getNotifyDiffer

public synchronized boolean getNotifyDiffer()

Gets the differing notification's on/off switch value common to all observed MBeans.

Returns:

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

getNotifyMatch

public synchronized boolean getNotifyMatch()

Gets the matching notification's on/off switch value common to all observed MBeans.

Returns:

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

getStringToCompare

public synchronized String getStringToCompare()

Gets the string to compare with the observed attribute common to all observed MBeans.

Returns:

The string value.

setNotifyDiffer

public synchronized void setNotifyDiffer(boolean value)

Sets the differing notification's on/off switch value common to all observed MBeans.

Parameters:

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

setNotifyMatch

public synchronized void setNotifyMatch(boolean value)

Sets the matching notification's on/off switch value common to all observed MBeans.

Parameters:

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

setStringToCompare

public synchronized void setStringToCompare(String value)
                                     throws IllegalArgumentException

Sets the string to compare with the observed attribute common to all observed MBeans.

Parameters:

value - The string value.

Throws:

IllegalArgumentException - The specified string to compare is null.

start

public synchronized void start()

Starts the string monitor.

Overrides:

start in class Monitor

stop

public synchronized void stop()

Stops the string monitor.

Overrides:

stop in class Monitor