FileDocCategorySizeDatePackage
MonitorMBean.javaAPI DocJava SE 5 API3815Fri Aug 26 14:57:36 BST 2005javax.management.monitor

MonitorMBean

public interface MonitorMBean
Exposes the remote management interface of monitor MBeans.
version
4.23 05/18/04
author
Sun Microsystems, Inc
since
1.5

Fields Summary
Constructors Summary
Methods Summary
public voidaddObservedObject(javax.management.ObjectName object)
Adds the specified object in the set of observed MBeans.

param
object The object to observe.
exception
java.lang.IllegalArgumentException the specified object is null.
since.unbundled
JMX 1.2

public booleancontainsObservedObject(javax.management.ObjectName object)
Tests whether the specified object is in the set of observed MBeans.

param
object The object to check.
return
true if the specified object is in the set, false otherwise.
since.unbundled
JMX 1.2

public longgetGranularityPeriod()
Gets the granularity period (in milliseconds).

return
The granularity period.
see
#setGranularityPeriod

public java.lang.StringgetObservedAttribute()
Gets the attribute being observed.

return
The attribute being observed.
see
#setObservedAttribute

public javax.management.ObjectNamegetObservedObject()
Gets the object name of the object being observed.

return
The object being observed.
see
#setObservedObject
deprecated
As of JMX 1.2, replaced by {@link #getObservedObjects}

public javax.management.ObjectName[]getObservedObjects()
Returns an array containing the objects being observed.

return
The objects being observed.
since.unbundled
JMX 1.2

public booleanisActive()
Tests if the monitor MBean is active. A monitor MBean is marked active when the {@link #start start} method is called. It becomes inactive when the {@link #stop stop} method is called.

return
true if the monitor MBean is active, false otherwise.

public voidremoveObservedObject(javax.management.ObjectName object)
Removes the specified object from the set of observed MBeans.

param
object The object to remove.
since.unbundled
JMX 1.2

public voidsetGranularityPeriod(long period)
Sets the granularity period (in milliseconds).

param
period The granularity period.
exception
java.lang.IllegalArgumentException The granularity period is less than or equal to zero.
see
#getGranularityPeriod

public voidsetObservedAttribute(java.lang.String attribute)
Sets the attribute to observe.

param
attribute The attribute to observe.
see
#getObservedAttribute

public voidsetObservedObject(javax.management.ObjectName object)
Sets the object to observe identified by its object name.

param
object The object to observe.
see
#getObservedObject
deprecated
As of JMX 1.2, replaced by {@link #addObservedObject}

public voidstart()
Starts the monitor.

public voidstop()
Stops the monitor.