org.snmp4j.agent.mo.jmx
Class JMXSimpleArrayIndexSupport

java.lang.Object
  org.snmp4j.agent.mo.jmx.JMXSimpleArrayIndexSupport

All Implemented Interfaces:

JMXIndexSupport

public class JMXSimpleArrayIndexSupport
extends java.lang.Object
implements JMXIndexSupport

The JMXSimpleArrayIndexSupport provides index support for SNMP indexes that are directly related to index values of an array provided through a MBean.

This class returns instances of JMXArrayIndexKey as row identifiers and expect instances of the same as row identifiers to be mapped to a SNMP index value.

Version:

1.0

Author:

Frank Fock

Constructor Summary

JMXSimpleArrayIndexSupport()

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 JMXIndexSupport.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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JMXSimpleArrayIndexSupport

public JMXSimpleArrayIndexSupport()

Method Detail

getRowIdentifier

public java.lang.Object getRowIdentifier(java.lang.Object nativeRowId,
                                         int nativeIndex)

Description copied from interface: JMXIndexSupport

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).

Specified by:

getRowIdentifier in interface JMXIndexSupport

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

public org.snmp4j.smi.OID mapToIndex(java.lang.Object rowIdentifier)

Description copied from interface: JMXIndexSupport

Maps a row identifier (i.e., an Object returned by JMXIndexSupport.getRowIdentifier(java.lang.Object, int)) to a row index.

Specified by:

mapToIndex in interface JMXIndexSupport

Parameters:

rowIdentifier - an Object describing a row index.

Returns:

a row index OID.

mapToRowMBean

public javax.management.ObjectName mapToRowMBean(java.lang.Object rowIdentifier)

Description copied from interface: JMXIndexSupport

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.

Specified by:

mapToRowMBean in interface JMXIndexSupport

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.

mapToRowIdentifier

public java.lang.Object mapToRowIdentifier(org.snmp4j.smi.OID rowIndex)

Description copied from interface: JMXIndexSupport

Maps a row index OID to an object describing a row index internally.

Specified by:

mapToRowIdentifier in interface JMXIndexSupport

Parameters:

rowIndex - a row index OID.

Returns:

an Object describing a row index.