KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > management > monitor > GaugeMonitorMBean


1 /*
2  * @(#)GaugeMonitorMBean.java 4.25 04/05/18
3  *
4  * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
5  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
6  */
7
8 package javax.management.monitor;
9
10 // jmx imports
11 //
12 import javax.management.ObjectName JavaDoc;
13
14 /**
15  * Exposes the remote management interface of the gauge monitor MBean.
16  *
17  * @version 4.25 05/18/04
18  * @author Sun Microsystems, Inc
19  *
20  * @since 1.5
21  */
22 public interface GaugeMonitorMBean extends MonitorMBean JavaDoc {
23     
24     // GETTERS AND SETTERS
25 //--------------------
26
27     /**
28      * Gets the derived gauge.
29      *
30      * @return The derived gauge.
31      * @deprecated As of JMX 1.2, replaced by {@link #getDerivedGauge(ObjectName)}
32      */
33     @Deprecated JavaDoc
34     public Number JavaDoc getDerivedGauge();
35     
36     /**
37      * Gets the derived gauge timestamp.
38      *
39      * @return The derived gauge timestamp.
40      * @deprecated As of JMX 1.2, replaced by {@link #getDerivedGaugeTimeStamp(ObjectName)}
41      */
42     @Deprecated JavaDoc
43     public long getDerivedGaugeTimeStamp();
44     
45     /**
46      * Gets the derived gauge for the specified MBean.
47      *
48      * @param object the MBean for which the derived gauge is to be returned
49      * @return The derived gauge for the specified MBean if this MBean is in the
50      * set of observed MBeans, or <code>null</code> otherwise.
51      *
52      * @since.unbundled JMX 1.2
53      */
54     public Number JavaDoc getDerivedGauge(ObjectName JavaDoc object);
55     
56     /**
57      * Gets the derived gauge timestamp for the specified MBean.
58      *
59      * @param object the MBean for which the derived gauge timestamp is to be returned
60      * @return The derived gauge timestamp for the specified MBean if this MBean
61      * is in the set of observed MBeans, or <code>null</code> otherwise.
62      *
63      * @since.unbundled JMX 1.2
64      */
65     public long getDerivedGaugeTimeStamp(ObjectName JavaDoc object);
66     
67     /**
68      * Gets the high threshold value.
69      *
70      * @return The high threshold value.
71      */
72     public Number JavaDoc getHighThreshold();
73
74     /**
75      * Gets the low threshold value.
76      *
77      * @return The low threshold value.
78      */
79     public Number JavaDoc getLowThreshold();
80
81     /**
82      * Sets the high and the low threshold values.
83      *
84      * @param highValue The high threshold value.
85      * @param lowValue The low threshold value.
86      * @exception java.lang.IllegalArgumentException The specified high/low threshold is null
87      * or the low threshold is greater than the high threshold
88      * or the high threshold and the low threshold are not of the same type.
89      */
90     public void setThresholds(Number JavaDoc highValue, Number JavaDoc lowValue) throws java.lang.IllegalArgumentException JavaDoc;
91     
92     /**
93      * Gets the high notification's on/off switch value.
94      *
95      * @return <CODE>true</CODE> if the gauge monitor notifies when
96      * exceeding the high threshold, <CODE>false</CODE> otherwise.
97      *
98      * @see #setNotifyHigh
99      */
100     public boolean getNotifyHigh();
101
102     /**
103      * Sets the high notification's on/off switch value.
104      *
105      * @param value The high notification's on/off switch value.
106      *
107      * @see #getNotifyHigh
108      */
109     public void setNotifyHigh(boolean value);
110
111     /**
112      * Gets the low notification's on/off switch value.
113      *
114      * @return <CODE>true</CODE> if the gauge monitor notifies when
115      * exceeding the low threshold, <CODE>false</CODE> otherwise.
116      *
117      * @see #setNotifyLow
118      */
119     public boolean getNotifyLow();
120
121     /**
122      * Sets the low notification's on/off switch value.
123      *
124      * @param value The low notification's on/off switch value.
125      *
126      * @see #getNotifyLow
127      */
128     public void setNotifyLow(boolean value);
129
130     /**
131      * Gets the difference mode flag value.
132      *
133      * @return <CODE>true</CODE> if the difference mode is used,
134      * <CODE>false</CODE> otherwise.
135      *
136      * @see #setDifferenceMode
137      */
138     public boolean getDifferenceMode();
139
140     /**
141      * Sets the difference mode flag value.
142      *
143      * @param value The difference mode flag value.
144      *
145      * @see #getDifferenceMode
146      */
147     public void setDifferenceMode(boolean value);
148 }
149
Popular Tags