|
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
Defines the common part to all monitor MBeans. A monitor MBean monitors values of an attribute common to a set of observed MBeans. The observed attribute is monitored at intervals specified by the granularity period. A gauge value (derived gauge) is derived from the values of the observed attribute.
Field Summary | |
protected int |
alreadyNotified
Deprecated. equivalent to alreadyNotifieds [0]. |
protected int[] |
alreadyNotifieds
Selected monitor errors that have already been notified. |
protected static int |
capacityIncrement
The amount by which the capacity of the monitor arrays are automatically incremented when their size becomes greater than their capacity. |
protected String |
dbgTag
Deprecated. No replacement. |
protected int |
elementCount
The number of valid components in the vector of observed objects. |
protected static int |
OBSERVED_ATTRIBUTE_ERROR_NOTIFIED
Flag denoting that a notification has occurred after changing the observed attribute. |
protected static int |
OBSERVED_ATTRIBUTE_TYPE_ERROR_NOTIFIED
Flag denoting that a notification has occurred after changing the observed object or the observed attribute. |
protected static int |
OBSERVED_OBJECT_ERROR_NOTIFIED
Flag denoting that a notification has occurred after changing the observed object. |
protected static int |
RESET_FLAGS_ALREADY_NOTIFIED
This flag is used to reset the alreadyNotifieds monitor attribute. |
protected static int |
RUNTIME_ERROR_NOTIFIED
Flag denoting that a notification has occurred after changing the observed object or the observed attribute. |
protected MBeanServer |
server
Reference on the MBean server. |
Constructor Summary | |
Monitor()
|
Method Summary | |
void |
addObservedObject(ObjectName object)
Adds the specified object in the set of observed MBeans, if this object is not already present. |
boolean |
containsObservedObject(ObjectName object)
Tests whether the specified object is in the set of observed MBeans. |
long |
getGranularityPeriod()
Gets the granularity period (in milliseconds). |
String |
getObservedAttribute()
Gets the attribute being observed. |
ObjectName |
getObservedObject()
Deprecated. As of JMX 1.2, replaced by getObservedObjects() |
ObjectName[] |
getObservedObjects()
Returns an array containing the objects being observed. |
boolean |
isActive()
Tests whether the monitor MBean is active. |
void |
postDeregister()
Allows the monitor MBean to perform any operations needed after having been unregistered by the MBean server. |
void |
postRegister(Boolean registrationDone)
Allows the monitor MBean to perform any operations needed after having been registered in the MBean server or after the registration has failed. |
void |
preDeregister()
Allows the monitor MBean to perform any operations it needs before being unregistered by the MBean server. |
ObjectName |
preRegister(MBeanServer server,
ObjectName name)
Allows the monitor MBean to perform any operations it needs before being registered in the MBean server. |
void |
removeObservedObject(ObjectName object)
Removes the specified object from the set of observed MBeans. |
void |
setGranularityPeriod(long period)
Sets the granularity period (in milliseconds). |
void |
setObservedAttribute(String attribute)
Sets the attribute to observe. |
void |
setObservedObject(ObjectName object)
Deprecated. As of JMX 1.2, replaced by addObservedObject(javax.management.ObjectName) |
abstract void |
start()
Starts the monitor. |
abstract void |
stop()
Stops the monitor. |
Methods inherited from class javax.management.NotificationBroadcasterSupport |
addNotificationListener, getNotificationInfo, handleNotification, removeNotificationListener, removeNotificationListener, sendNotification |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static final int capacityIncrement
protected int elementCount
protected int alreadyNotified
alreadyNotifieds
[0].
protected int[] alreadyNotifieds
Selected monitor errors that have already been notified.
Each element in this array corresponds to an observed object
in the vector. It contains a bit mask of the flags OBSERVED_OBJECT_ERROR_NOTIFIED
etc, indicating whether the
corresponding notification has already been sent for the MBean
being monitored.
protected MBeanServer server
protected static final int RESET_FLAGS_ALREADY_NOTIFIED
alreadyNotifieds
monitor attribute.
protected static final int OBSERVED_OBJECT_ERROR_NOTIFIED
protected static final int OBSERVED_ATTRIBUTE_ERROR_NOTIFIED
protected static final int OBSERVED_ATTRIBUTE_TYPE_ERROR_NOTIFIED
protected static final int RUNTIME_ERROR_NOTIFIED
protected String dbgTag
Constructor Detail |
public Monitor()
Method Detail |
public ObjectName preRegister(MBeanServer server, ObjectName name) throws Exception
Initializes the reference to the MBean server.
preRegister
in interface MBeanRegistration
server
- The MBean server in which the monitor MBean will be registered.name
- The object name of the monitor MBean.
Exception
public void postRegister(Boolean registrationDone)
Not used in this context.
postRegister
in interface MBeanRegistration
registrationDone
- Indicates whether or not the MBean has
been successfully registered in the MBean server. The value
false means that the registration phase has failed.public void preDeregister() throws Exception
Stops the monitor.
preDeregister
in interface MBeanRegistration
Exception
public void postDeregister()
Not used in this context.
postDeregister
in interface MBeanRegistration
public abstract void start()
start
in interface MonitorMBean
public abstract void stop()
stop
in interface MonitorMBean
public ObjectName getObservedObject()
getObservedObjects()
null
if there is no such object.
getObservedObject
in interface MonitorMBean
setObservedObject(ObjectName)
public void setObservedObject(ObjectName object) throws IllegalArgumentException
addObservedObject(javax.management.ObjectName)
setObservedObject
in interface MonitorMBean
object
- The object to observe.
IllegalArgumentException
- The specified
object is null.getObservedObject()
public void addObservedObject(ObjectName object) throws IllegalArgumentException
addObservedObject
in interface MonitorMBean
object
- The object to observe.
IllegalArgumentException
- The specified object is null.public void removeObservedObject(ObjectName object)
removeObservedObject
in interface MonitorMBean
object
- The object to remove.public boolean containsObservedObject(ObjectName object)
containsObservedObject
in interface MonitorMBean
object
- The object to check.
true
if the specified object is present, false
otherwise.public ObjectName[] getObservedObjects()
getObservedObjects
in interface MonitorMBean
public String getObservedAttribute()
getObservedAttribute
in interface MonitorMBean
setObservedAttribute(java.lang.String)
public void setObservedAttribute(String attribute) throws IllegalArgumentException
setObservedAttribute
in interface MonitorMBean
attribute
- The attribute to observe.
IllegalArgumentException
- The specified
attribute is null.getObservedAttribute()
public long getGranularityPeriod()
getGranularityPeriod
in interface MonitorMBean
setGranularityPeriod(long)
public void setGranularityPeriod(long period) throws IllegalArgumentException
setGranularityPeriod
in interface MonitorMBean
period
- The granularity period value.
IllegalArgumentException
- The granularity
period is less than or equal to zero.getGranularityPeriod()
public boolean isActive()
start
method is called.
It becomes inactive when the stop
method is called.
isActive
in interface MonitorMBean
true
if the monitor MBean is active, false
otherwise.
|
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.