StringMonitorMBean


1   /*
2    * @(#)StringMonitorMBean.java  4.24 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 string monitor MBean.
16   *
17   * @version     4.24     05/18/04
18   * @author      Sun Microsystems, Inc
19   *
20   * @since 1.5
21   */
22  public interface StringMonitorMBean 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 String   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 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 String   getDerivedGauge(ObjectName   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   object);
66      
67      /**
68       * Gets the string to compare with the observed attribute.
69       *
70       * @return The string value.
71       *
72       * @see #setStringToCompare
73       */
74      public String   getStringToCompare(); 
75  
76      /**
77       * Sets the string to compare with the observed attribute.
78       *
79       * @param value The string value.
80       * @exception java.lang.IllegalArgumentException The specified
81       * string to compare is null.
82       *
83       * @see #getStringToCompare
84       */
85      public void setStringToCompare(String   value) throws java.lang.IllegalArgumentException  ; 
86      
87      /**
88       * Gets the matching notification's on/off switch value.
89       *
90       * @return <CODE>true</CODE> if the string monitor notifies when
91       * matching, <CODE>false</CODE> otherwise.
92       *
93       * @see #setNotifyMatch
94       */
95      public boolean getNotifyMatch(); 
96  
97      /**
98       * Sets the matching notification's on/off switch value.
99       *
100      * @param value The matching notification's on/off switch value.
101      *
102      * @see #getNotifyMatch
103      */
104     public void setNotifyMatch(boolean value); 
105 
106     /**
107      * Gets the differing notification's on/off switch value.
108      *
109      * @return <CODE>true</CODE> if the string monitor notifies when
110      * differing, <CODE>false</CODE> otherwise.
111      *
112      * @see #setNotifyDiffer
113      */
114     public boolean getNotifyDiffer(); 
115 
116     /**
117      * Sets the differing notification's on/off switch value.
118      *
119      * @param value The differing notification's on/off switch value.
120      *
121      * @see #getNotifyDiffer
122      */
123     public void setNotifyDiffer(boolean value); 
124 }
125
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags