blob: b2fd6345ba2554eb6b9dd5c63fbc27a972fd0246 [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 * build @BUILD_TAG_PLACEHOLDER@
26 *
27 * @COPYRIGHT_MINI_LEGAL_NOTICE_PLACEHOLDER@
28 */
29
30/**
31 * This is the management interface explicitly defined for the
32 * "SimpleStandard" standard MBean.
33 *
34 * The "SimpleStandard" standard MBean implements this interface
35 * in order to be manageable through a JMX agent.
36 *
37 * The "SimpleStandardMBean" interface shows how to expose for management:
38 * - a read/write attribute (named "State") through its getter and setter
39 * methods,
40 * - a read-only attribute (named "NbChanges") through its getter method,
41 * - an operation (named "reset").
42 */
43public interface SimpleStandardMBean {
44
45 /**
46 * Getter: set the "State" attribute of the "SimpleStandard" standard
47 * MBean.
48 *
49 * @return the current value of the "State" attribute.
50 */
51 public String getState();
52
53 /**
54 * Setter: set the "State" attribute of the "SimpleStandard" standard
55 * MBean.
56 *
57 * @param <VAR>s</VAR> the new value of the "State" attribute.
58 */
59 public void setState(String s);
60
61 /**
62 * Getter: get the "NbChanges" attribute of the "SimpleStandard" standard
63 * MBean.
64 *
65 * @return the current value of the "NbChanges" attribute.
66 */
67 public int getNbChanges();
68
69 /**
70 * Operation: reset to their initial values the "State" and "NbChanges"
71 * attributes of the "SimpleStandard" standard MBean.
72 */
73 public void reset();
74}