01: /**
02: * The XMOJO Project 5
03: * Copyright © 2003 XMOJO.org. All rights reserved.
04:
05: * NO WARRANTY
06:
07: * BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR
08: * THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
09: * OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
10: * PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
11: * OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
12: * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
13: * TO THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE
14: * LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
15: * REPAIR OR CORRECTION.
16:
17: * IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL
18: * ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE
19: * THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
20: * GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
21: * USE OR INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF
22: * DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
23: * PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE),
24: * EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
25: * SUCH DAMAGES.
26: **/package javax.management.monitor;
27:
28: import javax.management.ObjectName;
29:
30: /**
31: * This interface exposes the remote management interface of monitor MBeans.
32: */
33: public abstract interface MonitorMBean {
34: /**
35: * This method gets the granularity period (in milliseconds).
36: *
37: * @return long value representing the value of the granularity period
38: * (in milliseconds).
39: */
40: public long getGranularityPeriod();
41:
42: /**
43: * This method sets the granularity period (in milliseconds).
44: *
45: * @param period the granularity period value.
46: *
47: * @exception java.lang.IllegalArgumentException - The granularity period
48: * is less than or equal to zero.
49: */
50: public void setGranularityPeriod(long period)
51: throws IllegalArgumentException;
52:
53: /**
54: * This method gets the name of the attribute being observed.
55: *
56: * @return String The name of the attribute that is being observed.
57: */
58: public String getObservedAttribute();
59:
60: /**
61: * This method sets the attribute being observed.
62: *
63: * @param attribute The attribute to be observed.
64: */
65: public void setObservedAttribute(String attribute);
66:
67: /**
68: * This method gets the object name of the object being observed.
69: *
70: * @return The ObjectName of the object being observed.
71: */
72: public ObjectName getObservedObject();
73:
74: /**
75: * This method sets the object name of the object being observed.
76: *
77: * @param object The ObjectName of the object to be observed.
78: */
79: public void setObservedObject(ObjectName object);
80:
81: /**
82: * This method tests whether the monitor MBean is active. A monitor MBean
83: * is marked active when the start method is called. It becomes inactive
84: * when the stop method is called.
85: *
86: * @return boolean value indicating whether the MBean is active or not.
87: */
88: public boolean isActive();
89:
90: /**
91: * This method starts the monitor.
92: */
93: public void start();
94:
95: /**
96: * This method stops the monitor.
97: */
98: public void stop();
99: }
|