org.snmp4j.agent.mo.jmx

Class MBeanAttributeKeyProvider

java.lang.Object

org.snmp4j.agent.mo.jmx.MBeanMOInfo

org.snmp4j.agent.mo.jmx.MBeanAttributeMOInfo

org.snmp4j.agent.mo.jmx.MBeanAttributeKeyProvider

Direct Known Subclasses:

MBeanArrayIndexKeyProvider, MBeanInvokationKeyProvider

public class MBeanAttributeKeyProvider
extends MBeanAttributeMOInfo

The MBeanAttributeKeyProvider provides the row keys of a conceptual table from a MBean attribute. The keys are returned in the same order as provided by the MBean attribute by default. If the keysNeedSorting is set, keys are returned always in their natural order.

Version:

1.0

Author:

Frank Fock

Field Summary

Fields inherited from class org.snmp4j.agent.mo.jmx.MBeanAttributeMOInfo

attribute

Constructor Summary

Constructors

Constructor and Description
MBeanAttributeKeyProvider(ObjectName name, TypedAttribute attribute) Creates a key provider with a MBean name and a attribute description.
MBeanAttributeKeyProvider(ObjectName name, TypedAttribute attribute, boolean keysNeedSorting) Creates a key provider with a MBean name and an attribute description.
MBeanAttributeKeyProvider(ObjectName name, TypedAttribute attribute, boolean keysNeedSorting, MBeanAttributeKeyProvider subKeyProvider, String[] keyAttributes) Creates a key provider with a MBean name and an attribute description.

Method Summary

Methods

Modifier and Type	Method and Description
static List<Integer>	asList(int[] a)
static List<Long>	asList(long[] a)
protected Object	combineKeys(Object key, Object subKey)
protected Iterator	createTailIterator(Iterator it, int indexPos)
protected Object	getKey(MBeanServerConnection server, ObjectName row)
int	getKeyCount(MBeanServerConnection server) Returns the number of row keys available.
protected List	getKeys(MBeanServerConnection server, ObjectName keyProviderInstance)
Object	getRowValues(MBeanServerConnection server, Object indexObject)
protected ObjectName	getSubKeyProviderObjectName(Object key) Determine the object name for the MBean instance that provides sub key elements through the subKeyProvider.
Iterator	keyIterator(MBeanServerConnection server) Returns an iterator on the keys provided by this MBean attribute.
Iterator	keyTailIterator(MBeanServerConnection server, Object firstRowId) Returns an iterator on the keys provided by this MBean attribute starting from the supplied row key.

Methods inherited from class org.snmp4j.agent.mo.jmx.MBeanAttributeMOInfo

getAttribute, getAttribute, getAttribute, getAttributeName, getAttributeType, setAttribute, setAttribute

Methods inherited from class org.snmp4j.agent.mo.jmx.MBeanMOInfo

getMBeanNames, getObjectName

Methods inherited from class java.lang.Object

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

Constructor Detail

MBeanAttributeKeyProvider

public MBeanAttributeKeyProvider(ObjectName name,
                         TypedAttribute attribute)

Creates a key provider with a MBean name and a attribute description.

Parameters:

name - a MBean's ObjectName.

attribute - the description of an attribute of the MBean identified by name.

MBeanAttributeKeyProvider

public MBeanAttributeKeyProvider(ObjectName name,
                         TypedAttribute attribute,
                         boolean keysNeedSorting)

Creates a key provider with a MBean name and an attribute description.

Parameters:

name - a MBean's ObjectName.

attribute - the description of an attribute of the MBean identified by name.

keysNeedSorting - if true keys will be sorted by their natural order.

MBeanAttributeKeyProvider

public MBeanAttributeKeyProvider(ObjectName name,
                         TypedAttribute attribute,
                         boolean keysNeedSorting,
                         MBeanAttributeKeyProvider subKeyProvider,
                         String[] keyAttributes)

Creates a key provider with a MBean name and an attribute description.

Parameters:

name - a MBean's ObjectName.

attribute - the description of an attribute of the MBean identified by name.

keysNeedSorting - if true keys will be sorted by their natural order.

subKeyProvider - if not null, this key provider is called per key provided by this provider in order to form a combined key.

keyAttributes - if attribute is null this parameter has to be specified to identify the key attributes that build the key object for the MBean instances under name.

Method Detail

keyIterator

public Iterator keyIterator(MBeanServerConnection server)
                     throws IOException,
                            MBeanException,
                            AttributeNotFoundException,
                            InstanceNotFoundException,
                            ReflectionException

Returns an iterator on the keys provided by this MBean attribute.

Parameters:

server - the MBeanServerConnection to be used to access the MBean.

Returns:

Iterator an iterator providing the keys returned by the key provider attribute.

Throws:

IOException

MBeanException

AttributeNotFoundException

InstanceNotFoundException

ReflectionException

getSubKeyProviderObjectName

protected ObjectName getSubKeyProviderObjectName(Object key)
                                          throws MalformedObjectNameException

Determine the object name for the MBean instance that provides sub key elements through the subKeyProvider. The subKeyProvider's object name will be

Parameters:

key - Object

Returns:

ObjectName

Throws:

MalformedObjectNameException

asList

public static List<Integer> asList(int[] a)

asList

public static List<Long> asList(long[] a)

keyTailIterator

public Iterator keyTailIterator(MBeanServerConnection server,
                       Object firstRowId)
                         throws IOException,
                                MBeanException,
                                AttributeNotFoundException,
                                InstanceNotFoundException,
                                ReflectionException

Returns an iterator on the keys provided by this MBean attribute starting from the supplied row key.

Parameters:

server - the MBeanServerConnection to be used to access the MBean.

firstRowId - the lower bound (including) row key for the iterator.

Returns:

Iterator an iterator providing the keys returned by the key provider attribute.

Throws:

IOException

MBeanException

AttributeNotFoundException

InstanceNotFoundException

ReflectionException

createTailIterator

protected Iterator createTailIterator(Iterator it,
                          int indexPos)

getKeyCount

public int getKeyCount(MBeanServerConnection server)
                throws IOException,
                       MBeanException,
                       AttributeNotFoundException,
                       InstanceNotFoundException,
                       ReflectionException

Returns the number of row keys available.

Parameters:

server - the MBeanServerConnection to be used to access the MBean.

Returns:

the number of keys.

Throws:

IOException

MBeanException

AttributeNotFoundException

InstanceNotFoundException

ReflectionException

getRowValues

public Object getRowValues(MBeanServerConnection server,
                  Object indexObject)
                    throws IOException,
                           MBeanException,
                           AttributeNotFoundException,
                           InstanceNotFoundException,
                           ReflectionException

Throws:

IOException

MBeanException

AttributeNotFoundException

InstanceNotFoundException

ReflectionException

getKeys

protected List getKeys(MBeanServerConnection server,
           ObjectName keyProviderInstance)
                throws IOException,
                       MBeanException,
                       AttributeNotFoundException,
                       InstanceNotFoundException,
                       ReflectionException

Throws:

IOException

MBeanException

AttributeNotFoundException

InstanceNotFoundException

ReflectionException

combineKeys

protected Object combineKeys(Object key,
                 Object subKey)

getKey

protected Object getKey(MBeanServerConnection server,
            ObjectName row)
                 throws IOException,
                        ReflectionException,
                        InstanceNotFoundException

Throws:

IOException

ReflectionException

InstanceNotFoundException