001: /**
002: * The XMOJO Project 5
003: * Copyright © 2003 XMOJO.org. All rights reserved.
004:
005: * NO WARRANTY
006:
007: * BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR
008: * THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
009: * OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
010: * PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
011: * OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
012: * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
013: * TO THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE
014: * LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
015: * REPAIR OR CORRECTION.
016:
017: * IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL
018: * ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE
019: * THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
020: * GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
021: * USE OR INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF
022: * DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
023: * PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE),
024: * EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
025: * SUCH DAMAGES.
026: **/package javax.management.monitor;
027:
028: /**
029: * This interface exposes the remote management interface of the counter monitor MBean.
030: */
031: public abstract interface CounterMonitorMBean extends MonitorMBean {
032: /**
033: * This method gets the value of the derived gauge.
034: *
035: * @return An instance of java.lang.Number giving the value of the derived gauge.
036: */
037: public Number getDerivedGauge();
038:
039: /**
040: * This method gets the value of the derived gauge time stamp.It is the
041: * time when the notification is triggered nearest to the milliseconds.
042: *
043: * @return The value of the derived gauge time Stamp.
044: */
045: public long getDerivedGaugeTimeStamp();
046:
047: /**
048: * This method gets the difference mode flag value.
049: *
050: * @return true if the flag is on , false otherwise.
051: */
052: public boolean getDifferenceMode();
053:
054: /**
055: * This method sets the difference mode flag value.
056: *
057: * @param true if the difference mode is used, false otherwise.
058: */
059: public void setDifferenceMode(boolean value);
060:
061: /**
062: * This method gets the modulus value.
063: *
064: * @return An instance of java.lang.Number giving the modulus value.
065: */
066: public Number getModulus();
067:
068: /**
069: * This method sets the modulus value .
070: *
071: * @param value An instance of java.lang.Number which is the modulus value.
072: *
073: * @exception java.lang.IllegalArgumentException - The specified modulus is
074: * null or the modulus value is less than zero.
075: */
076: public void setModulus(Number value)
077: throws IllegalArgumentException;
078:
079: /**
080: * This method gets the notification's on/off switch value.
081: *
082: * @return true if the counter monitor notifies when exceeding the
083: * threshold, false otherwise.
084: */
085: public boolean getNotify();
086:
087: /**
088: * This method sets the notification's on/off switch value.
089: *
090: * @param value The notification's on/off switch value.
091: */
092: public void setNotify(boolean value);
093:
094: /**
095: * This method gets offset value .
096: *
097: * @return An instance of java.lang.Number giving the offset value .
098: */
099: public Number getOffset();
100:
101: /**
102: * This method sets the offset value .
103: *
104: * @param value The offset value.
105: */
106: public void setOffset(Number value) throws IllegalArgumentException;
107:
108: /**
109: * This method gets the threshold value .
110: *
111: * @return An instance of java.lang.Number giving the threshold .
112: */
113: public Number getThreshold();
114:
115: /**
116: * This method sets the threshold value .
117: *
118: * @param value The Threshold Value.
119: *
120: * @exception java.lang.IllegalArgumentException - The specified threshold
121: * is null or the threshold value is less than zero.
122: */
123: public void setThreshold(Number value)
124: throws IllegalArgumentException;
125: }
|