CounterStatisticMonitorMBean


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   * CounterStatisticMonitorMBean.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  ;
35  
36  /**
37   * Exposes the remote management interface of the counter statistic 
38   * monitor MBean. Used for JDK version greater than 1.5.
39   *
40   * @author      Sun Microsystems, Inc
41   */
42  public interface CounterStatisticMonitorMBean 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  
54      public Number   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  
63      public long getDerivedGaugeTimeStamp();
64      
65      /**
66       * Gets the threshold value.
67       *
68       * @return The threshold value.
69       *
70       * @see #setThreshold(Number)
71       *
72       * @deprecated As of JMX 1.2, replaced by {@link #getThreshold(ObjectName)}
73       */
74      @Deprecated  
75      public Number   getThreshold(); 
76  
77      /**
78       * Sets the threshold value.
79       *
80       * @see #getThreshold()
81       *
82       * @param value The threshold value.
83       * @exception java.lang.IllegalArgumentException The specified threshold is null or the threshold value is less than zero.
84       * @deprecated As of JMX 1.2, replaced by {@link #setInitThreshold}
85       */
86      @Deprecated  
87      public void setThreshold(Number   value) throws java.lang.IllegalArgumentException  ; 
88  
89      /**
90       * Gets the derived gauge for the specified MBean.
91       *
92       * @param object the MBean for which the derived gauge is to be returned
93       * @return The derived gauge for the specified MBean if this MBean is in the
94       *         set of observed MBeans, or <code>null</code> otherwise.
95       *
96       * @since.unbundled JMX 1.2
97       */
98      public Number   getDerivedGauge(ObjectName   object);
99      
100     /**
101      * Gets the derived gauge timestamp for the specified MBean.
102      *
103      * @param object the MBean for which the derived gauge timestamp is to be returned
104      * @return The derived gauge timestamp for the specified MBean if this MBean
105      *         is in the set of observed MBeans, or <code>null</code> otherwise.
106      *
107      * @since.unbundled JMX 1.2
108      */
109     public long getDerivedGaugeTimeStamp(ObjectName   object);
110     
111     /**
112      * Gets the threshold value for the specified MBean.
113      *
114      * @param object the MBean for which the threshold value is to be returned
115      * @return The threshold value for the specified MBean if this MBean
116      *         is in the set of observed MBeans, or <code>null</code> otherwise.
117      *
118      * @see #setThreshold
119      *
120      * @since.unbundled JMX 1.2
121      */
122     public Number   getThreshold(ObjectName   object); 
123 
124     /**
125      * Gets the initial threshold value common to all observed objects.
126      *
127      * @return The initial threshold value.
128      *
129      * @see #setInitThreshold
130      *
131      * @since.unbundled JMX 1.2
132      */
133     public Number   getInitThreshold();
134     
135     /**
136      * Sets the initial threshold value common to all observed MBeans.
137      *
138      * @param value The initial threshold value.
139      * @exception java.lang.IllegalArgumentException The specified
140      * threshold is null or the threshold value is less than zero.
141      *
142      * @see #getInitThreshold
143      *
144      * @since.unbundled JMX 1.2
145      */
146     public void setInitThreshold(Number   value) throws java.lang.IllegalArgumentException  ;
147 
148     /**
149      * Gets the offset value.
150      *
151      * @see #setOffset(Number)
152      *
153      * @return The offset value.
154      */
155     public Number   getOffset(); 
156 
157     /**
158      * Sets the offset value.
159      *
160      * @param value The offset value.
161      * @exception java.lang.IllegalArgumentException The specified
162      * offset is null or the offset value is less than zero.
163      *
164      * @see #getOffset()
165      */
166     public void setOffset(Number   value) throws java.lang.IllegalArgumentException  ; 
167 
168     /**
169      * Gets the modulus value.
170      *
171      * @return The modulus value.
172      *
173      * @see #setModulus
174      */
175     public Number   getModulus(); 
176 
177     /**
178      * Sets the modulus value.
179      *
180      * @param value The modulus value.
181      * @exception java.lang.IllegalArgumentException The specified
182      * modulus is null or the modulus value is less than zero.
183      *
184      * @see #getModulus
185      */
186     public void setModulus(Number   value) throws java.lang.IllegalArgumentException  ; 
187     
188     /**
189      * Gets the notification's on/off switch value.
190      *
191      * @return <CODE>true</CODE> if the counter monitor notifies when
192      * exceeding the threshold, <CODE>false</CODE> otherwise.
193      *
194      * @see #setNotify
195      */
196     public boolean getNotify(); 
197 
198     /**
199      * Sets the notification's on/off switch value.
200      *
201      * @param value The notification's on/off switch value.
202      *
203      * @see #getNotify
204      */
205     public void setNotify(boolean value); 
206 
207     /**
208      * Gets the difference mode flag value.
209      *
210      * @return <CODE>true</CODE> if the difference mode is used,
211      * <CODE>false</CODE> otherwise.
212      *
213      * @see #setDifferenceMode
214      */
215     public boolean getDifferenceMode(); 
216 
217     /**
218      * Sets the difference mode flag value.
219      *
220      * @param value The difference mode flag value.
221      *
222      * @see #getDifferenceMode
223      */
224     public void setDifferenceMode(boolean value); 
225 }
226
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags