KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > snmp4j > agent > mo > jmx > JMXColumnSupport


1 /*_############################################################################
2   _##
3   _## SNMP4J-AgentJMX - JMXColumnSupport.java
4   _##
5   _## Copyright (C) 2006-2007 Frank Fock (SNMP4J.org)
6   _##
7   _## This program is free software; you can redistribute it and/or modify
8   _## it under the terms of the GNU General Public License version 2 as
9   _## published by the Free Software Foundation.
10   _##
11   _## This program is distributed in the hope that it will be useful,
12   _## but WITHOUT ANY WARRANTY; without even the implied warranty of
13   _## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14   _## GNU General Public License for more details.
15   _##
16   _## You should have received a copy of the GNU General Public License
17   _## along with this program; if not, write to the Free Software
18   _## Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
19   _## MA 02110-1301 USA
20   _##
21   _##########################################################################*/
22 package org.snmp4j.agent.mo.jmx;
23
24 import org.snmp4j.smi.Variable;
25 import javax.management.ObjectName JavaDoc;
26
27 /**
28  * The <code>JMXColumnSupport</code> is an interface to map MBean values to
29  * SNMP table columns and vice versa.
30  *
31  * @author Frank Fock
32  * @version 1.0
33  */
34 public interface JMXColumnSupport {
35
36   /**
37    * Gets the actual value for the specified object instance and type.
38    * @param mBean
39    * the name of the MBean instance representing the row object.
40    * @param columnIndex
41    * the zero-based column index.
42    * @param value
43    * the instance to hold the return value.
44    * @return
45    * zero on success or a SNMP error status value if fetching the value
46    * fails.
47    */
48   int getColumnValue(ObjectName JavaDoc mBean, int columnIndex, Variable value);
49
50   /**
51    * Sets the value of the specified object instance and type.
52    * @param mBean
53    * the name of the MBean instance representing the row object.
54    * @param columnIndex
55    * the zero-based column index.
56    * @param value
57    * the instance's new value.
58    * @return
59    * zero on success or a SNMP error status value if setting the value
60    * fails.
61    */
62   int setColumnValue(ObjectName JavaDoc mBean, int columnIndex, Variable value);
63
64   /**
65    * Checks the value of the specified object instance and type.
66    * @param mBean
67    * the name of the MBean instance representing the row object.
68    * @param columnIndex
69    * the zero-based column index.
70    * @param value
71    * the instance's new value.
72    * @return
73    * zero on success or a SNMP error status value if setting the value
74    * fails.
75    */
76   int checkColumnValue(ObjectName JavaDoc mBean, int columnIndex, Variable value);
77
78 }
79
Popular Tags