XMOJO 5 API Docs

javax.management.monitor
Interface MonitorMBean

All Known Subinterfaces:
CounterMonitorMBean, GaugeMonitorMBean, StringMonitorMBean
All Known Implementing Classes:
Monitor

public interface MonitorMBean

This interface exposes the remote management interface of monitor MBeans.


Method Summary
 long getGranularityPeriod()
          This method gets the granularity period (in milliseconds).
 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 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.
 void start()
          This method starts the monitor.
 void stop()
          This method stops the monitor.
 

Method Detail

getGranularityPeriod

public long getGranularityPeriod()
This method gets the granularity period (in milliseconds).
Returns:
long value representing the value of the granularity period (in milliseconds).

setGranularityPeriod

public void setGranularityPeriod(long period)
                          throws java.lang.IllegalArgumentException
This method sets the granularity period (in milliseconds).
Parameters:
period - the granularity period value.
Throws:
java.lang.IllegalArgumentException - - The granularity period is less than or equal to zero.

getObservedAttribute

public java.lang.String getObservedAttribute()
This method gets the name of the attribute being observed.
Returns:
String The name of the attribute that is being observed.

setObservedAttribute

public void setObservedAttribute(java.lang.String attribute)
This method sets the attribute being observed.
Parameters:
attribute - The attribute to be observed.

getObservedObject

public ObjectName getObservedObject()
This method gets the object name of the object being observed.
Returns:
The ObjectName of the object being observed.

setObservedObject

public void setObservedObject(ObjectName object)
This method sets the object name of the object being observed.
Parameters:
object - The ObjectName of the object to be observed.

isActive

public boolean isActive()
This method tests whether the monitor MBean is active. A monitor MBean is marked active when the start method is called. It becomes inactive when the stop method is called.
Returns:
boolean value indicating whether the MBean is active or not.

start

public void start()
This method starts the monitor.

stop

public void stop()
This method stops the monitor.

XMOJO 5 API Docs

Copyright ©2003 XMOJO.org. All Rights Reserved.