CounterMonitorMBean


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