blob: e21408751b9be1fd227d273c3d350449c884ea99 [file] [log] [blame]
J. Duke319a3b92007-12-01 00:00:00 +00001/*
2 * Copyright 2003 Sun Microsystems, Inc. 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.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
20 * CA 95054 USA or visit www.sun.com if you need additional information or
21 * have any questions.
22 */
23
24/**
25 * This is the management interface explicitly defined for the
26 * "SimpleStandard" standard MBean.
27 * The "SimpleStandard" standard MBean implements this interface
28 * in order to be manageable through a JMX agent.
29 *
30 * The "SimpleStandardMBean" interface shows how to expose for management:
31 * - a read/write attribute (named "State") through its getter and setter
32 * methods,
33 * - a read-only attribute (named "NbChanges") through its getter method,
34 * - an operation (named "reset").
35 */
36public interface SimpleStandardMBean {
37
38 /**
39 * Getter: set the "State" attribute of the "SimpleStandard" standard
40 * MBean.
41 *
42 * @return the current value of the "State" attribute.
43 */
44 public String getState();
45
46 /**
47 * Setter: set the "State" attribute of the "SimpleStandard" standard
48 * MBean.
49 *
50 * @param <VAR>s</VAR> the new value of the "State" attribute.
51 */
52 public void setState(String s);
53
54 /**
55 * Getter: get the "NbChanges" attribute of the "SimpleStandard" standard
56 * MBean.
57 *
58 * @return the current value of the "NbChanges" attribute.
59 */
60 public int getNbChanges();
61
62 /**
63 * Operation: reset to their initial values the "State" and "NbChanges"
64 * attributes of the "SimpleStandard" standard MBean.
65 */
66 public void reset();
67}