KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > enterprise > admin > selfmanagement > event > GaugeStatisticMonitorMBean


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the License). You may not use this file except in
5  * compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9  * glassfish/bootstrap/legal/CDDLv1.0.txt.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * Header Notice in each file and include the License file
15  * at glassfish/bootstrap/legal/CDDLv1.0.txt.
16  * If applicable, add the following below the CDDL Header,
17  * with the fields enclosed by brackets [] replaced by
18  * you own identifying information:
19  * "Portions Copyrighted [year] [name of copyright owner]"
20  *
21  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22  */
23
24 /*
25  * GaugeStatisticMonitorMBean.java
26  *
27  * Created on July 11, 2005 3:00 PM
28  */
29
30 package com.sun.enterprise.admin.selfmanagement.event;
31
32 // jmx imports
33 //
34 import javax.management.ObjectName JavaDoc;
35
36 /**
37  * Exposes the remote management interface of the gauge statistic
38  * monitor MBean. Used for JDK version greater than 1.5.
39  *
40  * @author Sun Microsystems, Inc
41  */
42 public interface GaugeStatisticMonitorMBean extends StatisticMonitorMBean {
43     
44     // GETTERS AND SETTERS
45 //--------------------
46
47     /**
48      * Gets the derived gauge.
49      *
50      * @return The derived gauge.
51      * @deprecated As of JMX 1.2, replaced by {@link #getDerivedGauge(ObjectName)}
52      */
53     @Deprecated JavaDoc
54     public Number JavaDoc getDerivedGauge();
55     
56     /**
57      * Gets the derived gauge timestamp.
58      *
59      * @return The derived gauge timestamp.
60      * @deprecated As of JMX 1.2, replaced by {@link #getDerivedGaugeTimeStamp(ObjectName)}
61      */
62     @Deprecated JavaDoc
63     public long getDerivedGaugeTimeStamp();
64     
65     /**
66      * Gets the derived gauge for the specified MBean.
67      *
68      * @param object the MBean for which the derived gauge is to be returned
69      * @return The derived gauge for the specified MBean if this MBean is in the
70      * set of observed MBeans, or <code>null</code> otherwise.
71      *
72      * @since.unbundled JMX 1.2
73      */
74     public Number JavaDoc getDerivedGauge(ObjectName JavaDoc object);
75     
76     /**
77      * Gets the derived gauge timestamp for the specified MBean.
78      *
79      * @param object the MBean for which the derived gauge timestamp is to be returned
80      * @return The derived gauge timestamp for the specified MBean if this MBean
81      * is in the set of observed MBeans, or <code>null</code> otherwise.
82      *
83      * @since.unbundled JMX 1.2
84      */
85     public long getDerivedGaugeTimeStamp(ObjectName JavaDoc object);
86     
87     /**
88      * Gets the high threshold value.
89      *
90      * @return The high threshold value.
91      */
92     public Number JavaDoc getHighThreshold();
93
94     /**
95      * Gets the low threshold value.
96      *
97      * @return The low threshold value.
98      */
99     public Number JavaDoc getLowThreshold();
100
101     /**
102      * Sets the high and the low threshold values.
103      *
104      * @param highValue The high threshold value.
105      * @param lowValue The low threshold value.
106      * @exception java.lang.IllegalArgumentException The specified high/low threshold is null
107      * or the low threshold is greater than the high threshold
108      * or the high threshold and the low threshold are not of the same type.
109      */
110     public void setThresholds(Number JavaDoc highValue, Number JavaDoc lowValue) throws java.lang.IllegalArgumentException JavaDoc;
111     
112     /**
113      * Gets the high notification's on/off switch value.
114      *
115      * @return <CODE>true</CODE> if the gauge monitor notifies when
116      * exceeding the high threshold, <CODE>false</CODE> otherwise.
117      *
118      * @see #setNotifyHigh
119      */
120     public boolean getNotifyHigh();
121
122     /**
123      * Sets the high notification's on/off switch value.
124      *
125      * @param value The high notification's on/off switch value.
126      *
127      * @see #getNotifyHigh
128      */
129     public void setNotifyHigh(boolean value);
130
131     /**
132      * Gets the low notification's on/off switch value.
133      *
134      * @return <CODE>true</CODE> if the gauge monitor notifies when
135      * exceeding the low threshold, <CODE>false</CODE> otherwise.
136      *
137      * @see #setNotifyLow
138      */
139     public boolean getNotifyLow();
140
141     /**
142      * Sets the low notification's on/off switch value.
143      *
144      * @param value The low notification's on/off switch value.
145      *
146      * @see #getNotifyLow
147      */
148     public void setNotifyLow(boolean value);
149
150     /**
151      * Gets the difference mode flag value.
152      *
153      * @return <CODE>true</CODE> if the difference mode is used,
154      * <CODE>false</CODE> otherwise.
155      *
156      * @see #setDifferenceMode
157      */
158     public boolean getDifferenceMode();
159
160     /**
161      * Sets the difference mode flag value.
162      *
163      * @param value The difference mode flag value.
164      *
165      * @see #getDifferenceMode
166      */
167     public void setDifferenceMode(boolean value);
168 }
169
Popular Tags