|
XMOJO 5 API Docs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.management.NotificationBroadcasterSupport | +--javax.management.monitor.Monitor
This class is the base class for all types of monitor mbeans.Defines the common part to all monitor MBeans. Using Monitor MBeans, the observed attribute of another MBean (the observed MBean) 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
Selected monitor errors that have already been notified |
protected java.lang.String |
dgbTag
|
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 or the observed attribute. |
protected static int |
RESET_FLAGS_ALREADY_NOTIFIED
This flag is used to reset the alreadyNotified 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()
Default constructor |
Method Summary | |
long |
getGranularityPeriod()
This method gets the granularity period (in milliseconds). |
MBeanNotificationInfo[] |
getNotificationInfo()
This method returns a NotificationInfo object containing the name of the Java class of the notification and the notification types sent by the counter monitor. |
java.lang.String |
getObservedAttribute()
This method gets the name of the attribute being observed. |
ObjectName |
getObservedObject()
This method gets the object name of the object being observed. |
boolean |
isActive()
This method tests whether the monitor MBean is active. |
void |
postDeregister()
This method allows the monitor MBean to perform any operations needed after having been de-registered by the MBean server. |
void |
postRegister(java.lang.Boolean registrationDone)
This method 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()
This method allows the monitor MBean to perform any operations it needs before being de-registered by the MBean server. |
ObjectName |
preRegister(MBeanServer server,
ObjectName name)
This method allows the monitor MBean to perform any operations it needs before being registered in the MBean server. |
void |
setGranularityPeriod(long period)
This method sets the granularity period (in milliseconds). |
void |
setObservedAttribute(java.lang.String attribute)
This method sets the attribute being observed. |
void |
setObservedObject(ObjectName object)
This method sets the object name of the object being observed. |
abstract void |
start()
This method starts the monitor. |
abstract void |
stop()
This method stops the monitor. |
Methods inherited from class javax.management.NotificationBroadcasterSupport |
addNotificationListener, removeNotificationListener, sendNotification |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected int alreadyNotified
protected static int OBSERVED_ATTRIBUTE_ERROR_NOTIFIED
protected static int OBSERVED_ATTRIBUTE_TYPE_ERROR_NOTIFIED
protected static int OBSERVED_OBJECT_ERROR_NOTIFIED
protected static int RESET_FLAGS_ALREADY_NOTIFIED
protected static int RUNTIME_ERROR_NOTIFIED
protected MBeanServer server
preRegister(MBeanServer server, ObjectName name)
protected java.lang.String dgbTag
Constructor Detail |
public Monitor()
Method Detail |
public long getGranularityPeriod()
getGranularityPeriod
in interface MonitorMBean
public void setGranularityPeriod(long period) throws java.lang.IllegalArgumentException
setGranularityPeriod
in interface MonitorMBean
period
- the granularity period value.java.lang.IllegalArgumentException
- - The granularity period
is less than or equal to zero.public java.lang.String getObservedAttribute()
getObservedAttribute
in interface MonitorMBean
public void setObservedAttribute(java.lang.String attribute) throws java.lang.IllegalArgumentException
setObservedAttribute
in interface MonitorMBean
attribute
- The attribute to be observed.public ObjectName getObservedObject()
getObservedObject
in interface MonitorMBean
public void setObservedObject(ObjectName object) throws java.lang.IllegalArgumentException
setObservedObject
in interface MonitorMBean
object
- The ObjectName of the object to be observed.IllegalArgumentException.
- public boolean isActive()
isActive
in interface MonitorMBean
public void postDeregister()
postDeregister
in interface MBeanRegistration
public void postRegister(java.lang.Boolean registrationDone)
postRegister
in interface MBeanRegistration
javax.management.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 ObjectName preRegister(MBeanServer server, ObjectName name) throws java.lang.Exception
preRegister
in interface MBeanRegistration
server
- - The MBean server in which the monitor MBean will be registered.name
- - The object name of the monitor MBean.-
- java.lang.Exception.public void preDeregister() throws java.lang.Exception
preDeregister
in interface MBeanRegistration
This
- operation throws java.lang.Exceptionpublic abstract void start()
start
in interface MonitorMBean
public abstract void stop()
stop
in interface MonitorMBean
public MBeanNotificationInfo[] getNotificationInfo()
getNotificationInfo
in class NotificationBroadcasterSupport
|
XMOJO 5 API Docs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |