KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*_############################################################################
2   _##
3   _## SNMP4J-AgentJMX - JMXNotificationIndexSupport.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.OID;
25
26 /**
27  * Notification objects can refer to scalar and tabular data. Whereas for scalar
28  * data the OID of the instance is constant, the index portion of the instance
29  * identifier of tabular data may vary from notification to notification.
30  * <p>
31  * This interface provides the means needed by a {@link MBeanNotificationInfo}
32  * instance to send a notification referring to tabular data.
33  *
34  * @author Frank Fock
35  * @version 1.0
36  */
37 public interface JMXNotificationIndexSupport {
38
39   /**
40    * Initialize the index support instance with the MBean notification object.
41    * @param notificationUserObject
42    * an Object that contains or refers to the payload data of the
43    * notification.
44    */
45   void intialize(Object JavaDoc notificationUserObject);
46
47   /**
48    * Gets the index portion for the object with the specified index in the
49    * notification.
50    * @param objectIndex
51    * a zero based index into the SNMP notification objects.
52    * @return OID
53    * a row index for the n-th notification object.
54    */
55   OID getIndex(int objectIndex);
56
57 }
58
Popular Tags