org.snmp4j.agent.mo.jmx
Interface JMXIndexSupport

All Known Implementing Classes:
AbstractSyntheticJMXIndexSupport, JMXSimpleArrayIndexSupport

public interface JMXIndexSupport

The JMXIndexSupport provides a mapping between an Object and a SNMP index OID. Optionally, the Object can also be mapped directly to a MBean instance identified by an ObjectName.

Version:
1.0
Author:
Frank Fock

Method Summary
 java.lang.Object getRowIdentifier(java.lang.Object nativeRowId, int nativeIndex)
          Maps a native object identifying a row or alternatively the row's index into an internal array (e.g., an array returned by a MBean method).
 org.snmp4j.smi.OID mapToIndex(java.lang.Object rowIdentifier)
          Maps a row identifier (i.e., an Object returned by getRowIdentifier(java.lang.Object, int)) to a row index.
 java.lang.Object mapToRowIdentifier(org.snmp4j.smi.OID rowIndex)
          Maps a row index OID to an object describing a row index internally.
 javax.management.ObjectName mapToRowMBean(java.lang.Object rowIdentifier)
          Maps a row identifier to a MBean object name.
 

Method Detail

getRowIdentifier

java.lang.Object getRowIdentifier(java.lang.Object nativeRowId,
                                  int nativeIndex)
Maps a native object identifying a row or alternatively the row's index into an internal array (e.g., an array returned by a MBean method).

Parameters:
nativeRowId - an Object identifying a row.
nativeIndex - optionally the index of the row into an internal array.
Returns:
a key Object that can be directly mapped to a row index OID.

mapToIndex

org.snmp4j.smi.OID mapToIndex(java.lang.Object rowIdentifier)
Maps a row identifier (i.e., an Object returned by getRowIdentifier(java.lang.Object, int)) to a row index.

Parameters:
rowIdentifier - an Object describing a row index.
Returns:
a row index OID.

mapToRowIdentifier

java.lang.Object mapToRowIdentifier(org.snmp4j.smi.OID rowIndex)
Maps a row index OID to an object describing a row index internally.

Parameters:
rowIndex - a row index OID.
Returns:
an Object describing a row index.

mapToRowMBean

javax.management.ObjectName mapToRowMBean(java.lang.Object rowIdentifier)
Maps a row identifier to a MBean object name. If a row cannot be accessed directly via an index, for example, because the rows are mapped from a list or array, then null is returned.

Parameters:
rowIdentifier - the row identifier which may be also a native index value into an array or list of MBean attribute values.
Returns:
ObjectName the object name of the MBean representing the row identified by rowIdentifier. If rowIdentifier is a Integer and null is returned, the caller should use the rowIdentifier value as index into the value list.

Copyright 2006-2007 Frank Fock (SNMP4J.org)