Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Java™ Platform Standard Ed. 6
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## javax.management.monitor
Interface MonitorMBean

All Known Subinterfaces:
  CounterMonitorMBean, GaugeMonitorMBean, StringMonitorMBean

All Known Implementing Classes:
  CounterMonitor, GaugeMonitor, Monitor, StringMonitor

    public interface MonitorMBean

Exposes the remote management interface of monitor MBeans.

Since:
  1.5

Method Summary
`void` | `addObservedObject(ObjectName object)` Adds the specified object in the set of observed MBeans.
`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 if the monitor MBean is active.
`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)`
`void` | `start()` Starts the monitor.
`void` | `stop()` Stops the monitor.

Method Detail

### start

    void start()

  Starts the monitor.

### stop

    void stop()

  Stops the monitor.

### addObservedObject

    void addObservedObject(ObjectName object)
                           throws IllegalArgumentException

  Adds the specified object in the set of observed MBeans.

  Parameters:
    `object` - The object to observe.
  Throws:
    `IllegalArgumentException` - the specified object is null.

### removeObservedObject

    void removeObservedObject(ObjectName object)

  Removes the specified object from the set of observed MBeans.

  Parameters:
    `object` - The object to remove.

### containsObservedObject

    boolean containsObservedObject(ObjectName object)

  Tests whether the specified object is in the set of observed MBeans.

  Parameters:
    `object` - The object to check.
  Returns:
    `true` if the specified object is in the set, `false` otherwise.

### getObservedObjects

    ObjectName[] getObservedObjects()

  Returns an array containing the objects being observed.

  Returns:
    The objects being observed.

### getObservedObject

    @Deprecated
    ObjectName getObservedObject()

  Deprecated. As of JMX 1.2, replaced by `getObservedObjects()`

  Gets the object name of the object being observed.

  Returns:
    The object being observed.
  See Also:
    `setObservedObject(javax.management.ObjectName)`

### setObservedObject

    @Deprecated
    void setObservedObject(ObjectName object)

  Deprecated. As of JMX 1.2, replaced by `addObservedObject(javax.management.ObjectName)`

  Sets the object to observe identified by its object name.

  Parameters:
    `object` - The object to observe.
  See Also:
    `getObservedObject()`

### getObservedAttribute

    String getObservedAttribute()

  Gets the attribute being observed.

  Returns:
    The attribute being observed.
  See Also:
    `setObservedAttribute(java.lang.String)`

### setObservedAttribute

    void setObservedAttribute(String attribute)

  Sets the attribute to observe.

  Parameters:
    `attribute` - The attribute to observe.
  See Also:
    `getObservedAttribute()`

### getGranularityPeriod

    long getGranularityPeriod()

  Gets the granularity period (in milliseconds).

  Returns:
    The granularity period.
  See Also:
    `setGranularityPeriod(long)`

### setGranularityPeriod

    void setGranularityPeriod(long period)
                              throws IllegalArgumentException

  Sets the granularity period (in milliseconds).

  Parameters:
    `period` - The granularity period.
  Throws:
    `IllegalArgumentException` - The granularity period is less than or equal to zero.
  See Also:
    `getGranularityPeriod()`

### isActive

    boolean isActive()

  Tests if 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:
    `true` if the monitor MBean is active, `false` otherwise.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Java™ Platform Standard Ed. 6
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright 2009 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.