org.snmp4j.agent.mo.jmx
Interface JMXTableSupport

All Known Subinterfaces:
JMXMutableTableSupport
All Known Implementing Classes:
AbstractJMXTableSupport, MBeanAttributeMOTableSupport

public interface JMXTableSupport

The JMXTableSupport defines the necessary interface to map tabular JMX data to a SNMP4J-Agent table model. The interface takes care of mapping JMX row identifiers to SNMP table indexes and vice versa.

Version:
1.0
Author:
Frank Fock

Method Summary
 org.snmp4j.smi.OID getLastIndex(org.snmp4j.smi.OID tableOID)
          Gets the last SNMP index currently supported by the specified table.
 int getRow(org.snmp4j.smi.OID tableOID, org.snmp4j.agent.mo.MOTableRow row)
          Gets the row values for the specified row.
 int getRowCount(org.snmp4j.smi.OID tableOID)
          Returns the number of rows of the specified table.
 org.snmp4j.smi.OID mapToIndex(org.snmp4j.smi.OID tableOID, java.lang.Object nativeRowID, int nativeIndex)
          Maps a native MBean row identifier object or index to a SNMP table index OID.
 java.lang.Object mapToRowId(org.snmp4j.smi.OID tableOID, org.snmp4j.smi.OID rowIndex)
          Maps a SNMP row index to a native row identifier object.
 java.util.Iterator rowIdIterator(org.snmp4j.smi.OID tableOID)
          Returns an Iterator over the row identifiers of the table.
 java.util.Iterator rowIdTailIterator(org.snmp4j.smi.OID tableOID, java.lang.Object firstRowId)
          Returns a tail iterator over the row identifiers of the table.
 int setRow(org.snmp4j.smi.OID tableOID, org.snmp4j.agent.mo.MOTableRow row, int column)
          Sets the value of a column (cell) of a row from the corresponding SNMP conceptual row.
 

Method Detail

mapToIndex

org.snmp4j.smi.OID mapToIndex(org.snmp4j.smi.OID tableOID,
                              java.lang.Object nativeRowID,
                              int nativeIndex)
Maps a native MBean row identifier object or index to a SNMP table index OID.

Parameters:
tableOID - the OID of the table ManagedObject (including the .1 of the entry object) for which indexes are mapped.
nativeRowID - the native row ID object which identifies the row. If null then nativeIndex identifies the row.
nativeIndex - the native enumerating index if rows are not identified by an object.
Returns:
the SNMP row index OID (suffix).

mapToRowId

java.lang.Object mapToRowId(org.snmp4j.smi.OID tableOID,
                            org.snmp4j.smi.OID rowIndex)
Maps a SNMP row index to a native row identifier object.

Parameters:
tableOID - the OID of the table ManagedObject (including the .1 of the entry object) for which indexes are mapped.
rowIndex - a SNMP row index of the table specified by tableOID.
Returns:
a native row identifier.

rowIdIterator

java.util.Iterator rowIdIterator(org.snmp4j.smi.OID tableOID)
Returns an Iterator over the row identifiers of the table.

Parameters:
tableOID - the OID of the table ManagedObject (including the .1 of the entry object) for which indexes are mapped.
Returns:
an Iterator of row identifiers.

rowIdTailIterator

java.util.Iterator rowIdTailIterator(org.snmp4j.smi.OID tableOID,
                                     java.lang.Object firstRowId)
Returns a tail iterator over the row identifiers of the table.

Parameters:
tableOID - the OID of the table ManagedObject (including the .1 of the entry object) for which indexes are mapped.
firstRowId - the lower bound (including) of the row identifiers to return.
Returns:
an Iterator of row identifiers.

getLastIndex

org.snmp4j.smi.OID getLastIndex(org.snmp4j.smi.OID tableOID)
Gets the last SNMP index currently supported by the specified table.

Parameters:
tableOID - the OID of the table ManagedObject (including the .1 of the entry object) for which indexes are mapped.
Returns:
the last SNMP row index of the specified table.

getRowCount

int getRowCount(org.snmp4j.smi.OID tableOID)
Returns the number of rows of the specified table.

Parameters:
tableOID - the OID of the table ManagedObject (including the .1 of the entry object) for which indexes are mapped.
Returns:
the number of rows in the table.

getRow

int getRow(org.snmp4j.smi.OID tableOID,
           org.snmp4j.agent.mo.MOTableRow row)
Gets the row values for the specified row.

Parameters:
tableOID - the OID of the table ManagedObject (including the .1 of the entry object) for which indexes are mapped.
row - a MOTableRow instance which will be modified to hold the SNMP values of the row specified by row's index value.
Returns:
a SNMP error status that indicates whether to operation succeeded or not.

setRow

int setRow(org.snmp4j.smi.OID tableOID,
           org.snmp4j.agent.mo.MOTableRow row,
           int column)
Sets the value of a column (cell) of a row from the corresponding SNMP conceptual row.

Parameters:
tableOID - the OID of the table ManagedObject (including the .1 of the entry object) for which indexes are mapped.
row - a MOTableRow instance that identifies the target row by its row index (indirectly) and that contains the SNMP values that replace the corresponding native values.
column - the zero-based column index to set.
Returns:
a SNMP error status that indicates whether to operation succeeded or not.

Copyright 2006-2007 Frank Fock (SNMP4J.org)