1 /*

     2  * Copyright (c) 1999, 2007, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    25 

    26 package javax.management.monitor;

    27 

    28 // jmx imports

    29 //

    30 import javax.management.ObjectName;

    31 

    32 /**

    33  * Exposes the remote management interface of the string monitor MBean.

    34  *

    35  *

    36  * @since 1.5

    37  */

    38 public interface StringMonitorMBean extends MonitorMBean {

    39 

    40     // GETTERS AND SETTERS

    41     //--------------------

    42 

    43     /**

    44      * Gets the derived gauge.

    45      *

    46      * @return The derived gauge.

    47      * @deprecated As of JMX 1.2, replaced by {@link #getDerivedGauge(ObjectName)}

    48      */

    49     @Deprecated

    50     public String getDerivedGauge();

    51 

    52     /**

    53      * Gets the derived gauge timestamp.

    54      *

    55      * @return The derived gauge timestamp.

    56      * @deprecated As of JMX 1.2, replaced by {@link #getDerivedGaugeTimeStamp(ObjectName)}

    57      */

    58     @Deprecated

    59     public long getDerivedGaugeTimeStamp();

    60 

    61     /**

    62      * Gets the derived gauge for the specified MBean.

    63      *

    64      * @param object the MBean for which the derived gauge is to be returned

    65      * @return The derived gauge for the specified MBean if this MBean is in the

    66      *         set of observed MBeans, or <code>null</code> otherwise.

    67      *

    68      */

    69     public String getDerivedGauge(ObjectName object);

    70 

    71     /**

    72      * Gets the derived gauge timestamp for the specified MBean.

    73      *

    74      * @param object the MBean for which the derived gauge timestamp is to be returned

    75      * @return The derived gauge timestamp for the specified MBean if this MBean

    76      *         is in the set of observed MBeans, or <code>null</code> otherwise.

    77      *

    78      */

    79     public long getDerivedGaugeTimeStamp(ObjectName object);

    80 

    81     /**

    82      * Gets the string to compare with the observed attribute.

    83      *

    84      * @return The string value.

    85      *

    86      * @see #setStringToCompare

    87      */

    88     public String getStringToCompare();

    89 

    90     /**

    91      * Sets the string to compare with the observed attribute.

    92      *

    93      * @param value The string value.

    94      * @exception java.lang.IllegalArgumentException The specified

    95      * string to compare is null.

    96      *

    97      * @see #getStringToCompare

    98      */

    99     public void setStringToCompare(String value) throws java.lang.IllegalArgumentException;

   100 

   101     /**

   102      * Gets the matching notification's on/off switch value.

   103      *

   104      * @return <CODE>true</CODE> if the string monitor notifies when

   105      * matching, <CODE>false</CODE> otherwise.

   106      *

   107      * @see #setNotifyMatch

   108      */

   109     public boolean getNotifyMatch();

   110 

   111     /**

   112      * Sets the matching notification's on/off switch value.

   113      *

   114      * @param value The matching notification's on/off switch value.

   115      *

   116      * @see #getNotifyMatch

   117      */

   118     public void setNotifyMatch(boolean value);

   119 

   120     /**

   121      * Gets the differing notification's on/off switch value.

   122      *

   123      * @return <CODE>true</CODE> if the string monitor notifies when

   124      * differing, <CODE>false</CODE> otherwise.

   125      *

   126      * @see #setNotifyDiffer

   127      */

   128     public boolean getNotifyDiffer();

   129 

   130     /**

   131      * Sets the differing notification's on/off switch value.

   132      *

   133      * @param value The differing notification's on/off switch value.

   134      *

   135      * @see #getNotifyDiffer

   136      */

   137     public void setNotifyDiffer(boolean value);

   138 }