StringStatisticMonitorMBean


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   * StringStatisticMonitorMBean.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 string statistic 
38   * monitor MBean. Used for JDK version greater than 1.5.
39   *
40   * @author      Sun Microsystems, Inc
41   */
42  public interface StringStatisticMonitorMBean 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 String   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 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 String   getDerivedGauge(ObjectName   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   object);
86      
87      /**
88       * Gets the string to compare with the observed attribute.
89       *
90       * @return The string value.
91       *
92       * @see #setStringToCompare
93       */
94      public String   getStringToCompare(); 
95  
96      /**
97       * Sets the string to compare with the observed attribute.
98       *
99       * @param value The string value.
100      * @exception java.lang.IllegalArgumentException The specified
101      * string to compare is null.
102      *
103      * @see #getStringToCompare
104      */
105     public void setStringToCompare(String   value) throws java.lang.IllegalArgumentException  ; 
106     
107     /**
108      * Gets the matching notification's on/off switch value.
109      *
110      * @return <CODE>true</CODE> if the string monitor notifies when
111      * matching, <CODE>false</CODE> otherwise.
112      *
113      * @see #setNotifyMatch
114      */
115     public boolean getNotifyMatch(); 
116 
117     /**
118      * Sets the matching notification's on/off switch value.
119      *
120      * @param value The matching notification's on/off switch value.
121      *
122      * @see #getNotifyMatch
123      */
124     public void setNotifyMatch(boolean value); 
125 
126     /**
127      * Gets the differing notification's on/off switch value.
128      *
129      * @return <CODE>true</CODE> if the string monitor notifies when
130      * differing, <CODE>false</CODE> otherwise.
131      *
132      * @see #setNotifyDiffer
133      */
134     public boolean getNotifyDiffer(); 
135 
136     /**
137      * Sets the differing notification's on/off switch value.
138      *
139      * @param value The differing notification's on/off switch value.
140      *
141      * @see #getNotifyDiffer
142      */
143     public void setNotifyDiffer(boolean value); 
144 }
145
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags