Class StringMonitor

  • All Implemented Interfaces:
    MBeanRegistration, MonitorMBean, StringMonitorMBean, NotificationBroadcaster, NotificationEmitter

    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 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 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.

    Since:
    1.5
    • Constructor Detail

      • StringMonitor

        public StringMonitor()
        Default constructor.
    • Method Detail

      • stop

        public void stop()
        Stops the string monitor.
        Specified by:
        stop in interface MonitorMBean
        Specified by:
        stop in class Monitor
      • getDerivedGauge

        public 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.
        Specified by:
        getDerivedGauge in interface StringMonitorMBean
        Parameters:
        object - the name of the MBean whose derived gauge is required.
        Returns:
        The derived gauge of the specified object.
      • getDerivedGaugeTimeStamp

        public 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.
        Specified by:
        getDerivedGaugeTimeStamp in interface StringMonitorMBean
        Parameters:
        object - the name of the object whose derived gauge timestamp is to be returned.
        Returns:
        The derived gauge timestamp of the specified object.
      • getNotifyMatch

        public boolean getNotifyMatch()
        Gets the matching notification's on/off switch value common to all observed MBeans.
        Specified by:
        getNotifyMatch in interface StringMonitorMBean
        Returns:
        true if the string monitor notifies when matching the string to compare, false otherwise.
        See Also:
        setNotifyMatch(boolean)
      • setNotifyMatch

        public void setNotifyMatch​(boolean value)
        Sets the matching notification's on/off switch value common to all observed MBeans.
        Specified by:
        setNotifyMatch in interface StringMonitorMBean
        Parameters:
        value - The matching notification's on/off switch value.
        See Also:
        getNotifyMatch()
      • getNotifyDiffer

        public boolean getNotifyDiffer()
        Gets the differing notification's on/off switch value common to all observed MBeans.
        Specified by:
        getNotifyDiffer in interface StringMonitorMBean
        Returns:
        true if the string monitor notifies when differing from the string to compare, false otherwise.
        See Also:
        setNotifyDiffer(boolean)
      • setNotifyDiffer

        public void setNotifyDiffer​(boolean value)
        Sets the differing notification's on/off switch value common to all observed MBeans.
        Specified by:
        setNotifyDiffer in interface StringMonitorMBean
        Parameters:
        value - The differing notification's on/off switch value.
        See Also:
        getNotifyDiffer()
      • 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.
        Specified by:
        getNotificationInfo in interface NotificationBroadcaster
        Returns:
        the array of possible notifications.