当前页面: 在线文档首页 > JBoss 4.0.1 sp1 jmx API Documentation 英文版文档

GaugeMonitor (JBoss/JMX API) - JBoss 4.0.1 sp1 jmx API Documentation 英文版文档

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.management.monitor
Class GaugeMonitor

java.lang.Object
  javax.management.NotificationBroadcasterSupport
      javax.management.monitor.Monitor
          javax.management.monitor.GaugeMonitor

All Implemented Interfaces:: GaugeMonitorMBean, MBeanRegistration, MonitorMBean, NotificationBroadcaster, NotificationEmitter

public class GaugeMonitor
extends Monitor
implements GaugeMonitorMBean

The gauge monitor service.

Version:: $Revision: 1.8 $
Author:: Adrian Brock

Field Summary

Fields inherited from class javax.management.monitor.Monitor

alreadyNotified, alreadyNotifieds, capacityIncrement, dbgTag, elementCount, OBSERVED_ATTRIBUTE_ERROR_NOTIFIED, OBSERVED_ATTRIBUTE_TYPE_ERROR_NOTIFIED, OBSERVED_OBJECT_ERROR_NOTIFIED, RESET_FLAGS_ALREADY_NOTIFIED, RUNTIME_ERROR_NOTIFIED, server

Constructor Summary

GaugeMonitor()
          Default Constructor

Method Summary

Number getDerivedGauge()
          Retrieves the derived gauge.

Number getDerivedGauge(ObjectName name)
          Retrieves the derived gauge.

long getDerivedGaugeTimeStamp()
          Retrieves the derived gauge timestamp.

long getDerivedGaugeTimeStamp(ObjectName name)
          Retrieves the derived gauge timestamp.

boolean getDifferenceMode()
          Retrieves the difference mode flag.

Number getHighThreshold()
          Retrieves the high threshold.

Number getLowThreshold()
          Retrieves the low threshold.

MBeanNotificationInfo[] getNotificationInfo()
          Returns the notification metadata associated with the MBean.

boolean getNotifyHigh()
          Retrieves the high notify on/off switch.

boolean getNotifyLow()
          Retrieves the low notify on/off switch.

void setDifferenceMode(boolean value)
          Sets the difference mode flag.

void setNotifyHigh(boolean value)
          Sets the high notify on/off switch.

void setNotifyLow(boolean value)
          Sets the low notify on/off switch.

void setThresholds(Number highValue, Number lowValue)
          Sets the high and low threshold.

void start()
          Starts the monitor.

void stop()
          Stops the monitor.

Methods inherited from class javax.management.monitor.Monitor

addObservedObject, containsObservedObject, getGranularityPeriod, getObservedAttribute, getObservedObject, getObservedObjects, isActive, postDeregister, postRegister, preDeregister, preRegister, removeObservedObject, setGranularityPeriod, setObservedAttribute, setObservedObject, toString

Methods inherited from class javax.management.NotificationBroadcasterSupport

addNotificationListener, handleNotification, removeNotificationListener, removeNotificationListener, sendNotification

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.management.monitor.MonitorMBean

addObservedObject, containsObservedObject, getGranularityPeriod, getObservedAttribute, getObservedObject, getObservedObjects, isActive, removeObservedObject, setGranularityPeriod, setObservedAttribute, setObservedObject

Constructor Detail

GaugeMonitor

public GaugeMonitor()

Default Constructor

Method Detail

getNotificationInfo

public MBeanNotificationInfo[] getNotificationInfo()

Description copied from interface: NotificationBroadcaster

Returns the notification metadata associated with the MBean.

Specified by:: getNotificationInfo in interface NotificationBroadcaster
Overrides:: getNotificationInfo in class NotificationBroadcasterSupport

getDerivedGauge

public Number getDerivedGauge()

Description copied from interface: GaugeMonitorMBean

Retrieves the derived gauge.

Specified by:: getDerivedGauge in interface GaugeMonitorMBean

Returns:: the derived gauge.

getDerivedGauge

public Number getDerivedGauge(ObjectName name)

Description copied from interface: GaugeMonitorMBean

Retrieves the derived gauge.

Specified by:: getDerivedGauge in interface GaugeMonitorMBean

Parameters:: name - the object name of the mbean.
Returns:: the derived gauge.

getDerivedGaugeTimeStamp

public long getDerivedGaugeTimeStamp()

Description copied from interface: GaugeMonitorMBean

Retrieves the derived gauge timestamp.

Specified by:: getDerivedGaugeTimeStamp in interface GaugeMonitorMBean

Returns:: the derived gauge timestamp.

getDerivedGaugeTimeStamp

public long getDerivedGaugeTimeStamp(ObjectName name)

Description copied from interface: GaugeMonitorMBean

Retrieves the derived gauge timestamp.

Specified by:: getDerivedGaugeTimeStamp in interface GaugeMonitorMBean

Parameters:: name - the object name of the mbean.
Returns:: the derived gauge timestamp.

getDifferenceMode

public boolean getDifferenceMode()

Description copied from interface: GaugeMonitorMBean

Retrieves the difference mode flag.

Specified by:: getDifferenceMode in interface GaugeMonitorMBean

Returns:: true when in difference mode, false otherwise.

setDifferenceMode

public void setDifferenceMode(boolean value)

Description copied from interface: GaugeMonitorMBean

Sets the difference mode flag.

Specified by:: setDifferenceMode in interface GaugeMonitorMBean

getNotifyHigh

public boolean getNotifyHigh()

Description copied from interface: GaugeMonitorMBean

Retrieves the high notify on/off switch.

Specified by:: getNotifyHigh in interface GaugeMonitorMBean

Returns:: true if high notifications occur, false otherwise.

setNotifyHigh

public void setNotifyHigh(boolean value)

Description copied from interface: GaugeMonitorMBean

Sets the high notify on/off switch.

Specified by:: setNotifyHigh in interface GaugeMonitorMBean

Parameters:: value - pass true for high notifications, false otherwise.

getNotifyLow

public boolean getNotifyLow()

Description copied from interface: GaugeMonitorMBean

Retrieves the low notify on/off switch.

Specified by:: getNotifyLow in interface GaugeMonitorMBean

Returns:: true if low notifications occur, false otherwise.

setNotifyLow

public void setNotifyLow(boolean value)

Description copied from interface: GaugeMonitorMBean

Sets the low notify on/off switch.

Specified by:: setNotifyLow in interface GaugeMonitorMBean

Parameters:: value - pass true for low notifications, false otherwise.

getHighThreshold

public Number getHighThreshold()

Description copied from interface: GaugeMonitorMBean

Retrieves the high threshold. REVIEW: zero threshold

Specified by:: getHighThreshold in interface GaugeMonitorMBean

Returns:: the high threshold value, zero means no threshold.

getLowThreshold

public Number getLowThreshold()

Description copied from interface: GaugeMonitorMBean

Retrieves the low threshold. REVIEW: zero threshold

Specified by:: getLowThreshold in interface GaugeMonitorMBean

Returns:: the low threshold value, zero means no threshold.

setThresholds

public void setThresholds(Number highValue,
                          Number lowValue)
                   throws IllegalArgumentException

Description copied from interface: GaugeMonitorMBean

Sets the high and low threshold. REVIEW: zero threshold

Specified by:: setThresholds in interface GaugeMonitorMBean

Parameters:: highValue - the high threshold value, pass zero for no high threshold.; lowValue - the low threshold value, pass zero for no low threshold.
Throws:: IllegalArgumentException - when either threshold is null or the high threshold is lower than the low threshold or the. thresholds have different types.

start

public void start()

Description copied from interface: MonitorMBean

Starts the monitor.

Specified by:: start in interface MonitorMBean
Specified by:: start in class Monitor

stop

public void stop()

Description copied from interface: MonitorMBean

Stops the monitor.

Specified by:: stop in interface MonitorMBean
Specified by:: stop in class Monitor

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Copyright © 2002 JBoss Group, LLC. All Rights Reserved.