|
JavaTM 2 Platform Ent. Ed. v1.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.management.NotificationBroadcasterSupport
javax.management.monitor.Monitor
javax.management.monitor.StringMonitor
Defines a monitor MBean designed to observe the values of a string attribute.
A string monitor sends notifications as follows:
match notification
is sent.
The notify match flag must be set to true
.
differ notification
is sent.
The notify differ flag must be set to true
.
Field Summary |
Fields inherited from class javax.management.monitor.Monitor |
alreadyNotified, alreadyNotifieds, capacityIncrement, dbgTag, elementCount, OBSERVED_ATTRIBUTE_ERROR_NOTIFIED, OBSERVED_ATTRIBUTE_TYPE_ERROR_NOTIFIED, OBSERVED_OBJECT_ERROR_NOTIFIED, RESET_FLAGS_ALREADY_NOTIFIED, RUNTIME_ERROR_NOTIFIED, server |
Constructor Summary | |
StringMonitor()
Default constructor. |
Method Summary | |
String |
getDerivedGauge()
Deprecated. As of JMX 1.2, replaced by getDerivedGauge(ObjectName) |
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. |
long |
getDerivedGaugeTimeStamp()
Deprecated. As of JMX 1.2, replaced by getDerivedGaugeTimeStamp(ObjectName) |
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 null otherwise. |
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. |
boolean |
getNotifyDiffer()
Gets the differing notification's on/off switch value common to all observed MBeans. |
boolean |
getNotifyMatch()
Gets the matching notification's on/off switch value common to all observed MBeans. |
String |
getStringToCompare()
Gets the string to compare with the observed attribute common to all observed MBeans. |
void |
setGranularityPeriod(long period)
Sets the granularity period (in milliseconds). |
void |
setNotifyDiffer(boolean value)
Sets the differing notification's on/off switch value common to all observed MBeans. |
void |
setNotifyMatch(boolean value)
Sets the matching notification's on/off switch value common to all observed MBeans. |
void |
setStringToCompare(String value)
Sets the string to compare with the observed attribute common to all observed MBeans. |
void |
start()
Starts the string monitor. |
void |
stop()
Stops the string monitor. |
Methods inherited from class javax.management.monitor.Monitor |
addObservedObject, containsObservedObject, getGranularityPeriod, getObservedAttribute, getObservedObject, getObservedObjects, isActive, postDeregister, postRegister, preDeregister, preRegister, removeObservedObject, setObservedAttribute, setObservedObject |
Methods inherited from class javax.management.NotificationBroadcasterSupport |
addNotificationListener, handleNotification, removeNotificationListener, removeNotificationListener, sendNotification |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface javax.management.monitor.MonitorMBean |
addObservedObject, containsObservedObject, getGranularityPeriod, getObservedAttribute, getObservedObject, getObservedObjects, isActive, removeObservedObject, setObservedAttribute, setObservedObject |
Constructor Detail |
public StringMonitor()
Method Detail |
public void start()
start
in interface MonitorMBean
start
in class Monitor
public void stop()
stop
in interface MonitorMBean
stop
in class Monitor
public void setGranularityPeriod(long period) throws IllegalArgumentException
setGranularityPeriod
in interface MonitorMBean
setGranularityPeriod
in class Monitor
period
- The granularity period value.
IllegalArgumentException
- The granularity
period is less than or equal to zero.Monitor.setGranularityPeriod(long)
public String getDerivedGauge(ObjectName object)
null
otherwise.
getDerivedGauge
in interface StringMonitorMBean
object
- the name of the MBean whose derived gauge is required.
public long getDerivedGaugeTimeStamp(ObjectName object)
null
otherwise.
getDerivedGaugeTimeStamp
in interface StringMonitorMBean
object
- the name of the MBean whose derived gauge
timestamp is required.
public String getDerivedGauge()
getDerivedGauge(ObjectName)
getDerivedGauge
in interface StringMonitorMBean
public long getDerivedGaugeTimeStamp()
getDerivedGaugeTimeStamp(ObjectName)
getDerivedGaugeTimeStamp
in interface StringMonitorMBean
public String getStringToCompare()
getStringToCompare
in interface StringMonitorMBean
setStringToCompare(java.lang.String)
public void setStringToCompare(String value) throws IllegalArgumentException
setStringToCompare
in interface StringMonitorMBean
value
- The string value.
IllegalArgumentException
- The specified
string to compare is null.getStringToCompare()
public boolean getNotifyMatch()
getNotifyMatch
in interface StringMonitorMBean
true
if the string monitor notifies when
matching the string to compare, false
otherwise.setNotifyMatch(boolean)
public void setNotifyMatch(boolean value)
setNotifyMatch
in interface StringMonitorMBean
value
- The matching notification's on/off switch value.getNotifyMatch()
public boolean getNotifyDiffer()
getNotifyDiffer
in interface StringMonitorMBean
true
if the string monitor notifies when
differing from the string to compare, false
otherwise.setNotifyDiffer(boolean)
public void setNotifyDiffer(boolean value)
setNotifyDiffer
in interface StringMonitorMBean
value
- The differing notification's on/off switch value.getNotifyDiffer()
public MBeanNotificationInfo[] getNotificationInfo()
NotificationInfo
object containing the
name of the Java class of the notification
and the notification types sent by the string monitor.
getNotificationInfo
in interface NotificationBroadcaster
getNotificationInfo
in class NotificationBroadcasterSupport
|
JavaTM 2 Platform Ent. Ed. v1.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright 2003 Sun Microsystems, Inc. All rights reserved.