Package org.opends.server.snmp

Class TableDsTable

java.lang.Object

com.sun.management.snmp.agent.SnmpTableSupport

org.opends.server.snmp.TableDsTable

All Implemented Interfaces:

com.sun.management.snmp.agent.SnmpTableCallbackHandler, com.sun.management.snmp.agent.SnmpTableEntryFactory, Serializable

public class TableDsTable
extends com.sun.management.snmp.agent.SnmpTableSupport
implements Serializable

The class is used for implementing the "DsTable" group. The group is defined with the following oid: 1.3.6.1.2.1.66.1.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected MBeanServer	server	Reference to the MBean server.

Fields inherited from class com.sun.management.snmp.agent.SnmpTableSupport

entries, meta, theMib

Constructor Summary

Constructors

Constructor	Description
TableDsTable(com.sun.management.snmp.agent.SnmpMib myMib)	Constructor for the table.
TableDsTable(com.sun.management.snmp.agent.SnmpMib myMib, MBeanServer server)	Constructor for the table.

Method Summary

Modifier and Type	Method	Description
void	addEntry(DsTableEntryMBean entry)	Add a new entry to the table.
void	addEntry(DsTableEntryMBean entry, ObjectName name)	Add a new entry to the table.
ObjectName	buildNameFromIndex(com.sun.management.snmp.agent.SnmpIndex index)
com.sun.management.snmp.SnmpOid	buildOidFromIndex(com.sun.management.snmp.agent.SnmpIndex index)	Build index for "DsTableEntry".
com.sun.management.snmp.SnmpOid	buildOidFromIndexVal(Integer aApplIndex)	Build index for "DsTableEntry".
com.sun.management.snmp.agent.SnmpIndex	buildSnmpIndex(long[] index, int start)	Build index for "DsTableEntry".
com.sun.management.snmp.agent.SnmpIndex	buildSnmpIndex(DsTableEntryMBean entry)	Build index for "DsTableEntry".
Object	createDsTableEntryMBean(com.sun.management.snmp.agent.SnmpMibSubRequest req, com.sun.management.snmp.SnmpOid rowOid, int depth, ObjectName entryObjName, com.sun.management.snmp.agent.SnmpMibTable meta, Integer aApplIndex)	Factory method for "DsTableEntry" entry MBean class.
void	createNewEntry(com.sun.management.snmp.agent.SnmpMibSubRequest req, com.sun.management.snmp.SnmpOid rowOid, int depth, com.sun.management.snmp.agent.SnmpMibTable meta)
DsTableEntryMBean[]	getEntries()	Return the entries stored in the table.
protected com.sun.management.snmp.agent.SnmpMibTable	getRegisteredTableMeta(com.sun.management.snmp.agent.SnmpMib mib)
void	removeEntry(DsTableEntryMBean entry)	Remove the specified entry from the table.
void	removeEntryCb(int pos, com.sun.management.snmp.SnmpOid row, ObjectName name, Object entry, com.sun.management.snmp.agent.SnmpMibTable meta)

Methods inherited from class com.sun.management.snmp.agent.SnmpTableSupport

addEntry, addEntry, addEntryCb, addNotificationListener, allocateTable, bindWithTableMeta, buildSnmpIndex, getBasicEntries, getEntry, getNotificationInfo, getSize, isCreationEnabled, isRegistrationRequired, removeEntry, removeNotificationListener, setCreationEnabled

Methods inherited from class java.lang.Object

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

Field Detail

server

protected MBeanServer server

Reference to the MBean server.

Constructor Detail

TableDsTable

public TableDsTable(com.sun.management.snmp.agent.SnmpMib myMib)

Constructor for the table. Initialize metadata for "TableDsTable". The reference on the MBean server is not updated so the entries created through an SNMP SET will not be registered in Java DMK.

TableDsTable

public TableDsTable(com.sun.management.snmp.agent.SnmpMib myMib,
                    MBeanServer server)

Constructor for the table. Initialize metadata for "TableDsTable". The reference on the MBean server is updated so the entries created through an SNMP SET will be AUTOMATICALLY REGISTERED in Java DMK.

Method Detail

createNewEntry

public void createNewEntry(com.sun.management.snmp.agent.SnmpMibSubRequest req,
                           com.sun.management.snmp.SnmpOid rowOid,
                           int depth,
                           com.sun.management.snmp.agent.SnmpMibTable meta)
                    throws com.sun.management.snmp.SnmpStatusException

Specified by:

createNewEntry in interface com.sun.management.snmp.agent.SnmpTableEntryFactory

Specified by:

createNewEntry in class com.sun.management.snmp.agent.SnmpTableSupport

Throws:

com.sun.management.snmp.SnmpStatusException

getRegisteredTableMeta

protected com.sun.management.snmp.agent.SnmpMibTable getRegisteredTableMeta(com.sun.management.snmp.agent.SnmpMib mib)

Specified by:

getRegisteredTableMeta in class com.sun.management.snmp.agent.SnmpTableSupport

removeEntryCb

public void removeEntryCb(int pos,
                          com.sun.management.snmp.SnmpOid row,
                          ObjectName name,
                          Object entry,
                          com.sun.management.snmp.agent.SnmpMibTable meta)
                   throws com.sun.management.snmp.SnmpStatusException

Specified by:

removeEntryCb in interface com.sun.management.snmp.agent.SnmpTableCallbackHandler

Overrides:

removeEntryCb in class com.sun.management.snmp.agent.SnmpTableSupport

Throws:

com.sun.management.snmp.SnmpStatusException

addEntry

public void addEntry(DsTableEntryMBean entry)
              throws com.sun.management.snmp.SnmpStatusException

Add a new entry to the table. If the associated metadata requires ObjectNames a new ObjectName will be generated using "buildNameFromIndex". This method calls "addEntry" from "SnmpTableSupport". See the "SnmpTableSupport" Javadoc API for more details.

Throws:

com.sun.management.snmp.SnmpStatusException

addEntry

public void addEntry(DsTableEntryMBean entry,
                     ObjectName name)
              throws com.sun.management.snmp.SnmpStatusException

Add a new entry to the table. This method calls "addEntry" from "SnmpTableSupport". See the "SnmpTableSupport" Javadoc API for more details.

Throws:

com.sun.management.snmp.SnmpStatusException

getEntries

public DsTableEntryMBean[] getEntries()

Return the entries stored in the table. This method calls "getBasicEntries" from "SnmpTableSupport". See the "SnmpTableSupport" Javadoc API for more details.

removeEntry

public void removeEntry(DsTableEntryMBean entry)
                 throws com.sun.management.snmp.SnmpStatusException

Remove the specified entry from the table. This method calls "removeEntry" from "SnmpTableSupport". See the "SnmpTableSupport" Javadoc API for more details.

Throws:

com.sun.management.snmp.SnmpStatusException

buildNameFromIndex

public ObjectName buildNameFromIndex(com.sun.management.snmp.agent.SnmpIndex index)
                              throws com.sun.management.snmp.SnmpStatusException

Specified by:

buildNameFromIndex in class com.sun.management.snmp.agent.SnmpTableSupport

Throws:

com.sun.management.snmp.SnmpStatusException

buildSnmpIndex

public com.sun.management.snmp.agent.SnmpIndex buildSnmpIndex(DsTableEntryMBean entry)
                                                       throws com.sun.management.snmp.SnmpStatusException

Build index for "DsTableEntry".

Throws:

com.sun.management.snmp.SnmpStatusException

buildOidFromIndex

public com.sun.management.snmp.SnmpOid buildOidFromIndex(com.sun.management.snmp.agent.SnmpIndex index)
                                                  throws com.sun.management.snmp.SnmpStatusException

Build index for "DsTableEntry".

Specified by:

buildOidFromIndex in class com.sun.management.snmp.agent.SnmpTableSupport

Throws:

com.sun.management.snmp.SnmpStatusException

buildOidFromIndexVal

public com.sun.management.snmp.SnmpOid buildOidFromIndexVal(Integer aApplIndex)
                                                     throws com.sun.management.snmp.SnmpStatusException

Build index for "DsTableEntry".

Throws:

com.sun.management.snmp.SnmpStatusException

buildSnmpIndex

public com.sun.management.snmp.agent.SnmpIndex buildSnmpIndex(long[] index,
                                                              int start)
                                                       throws com.sun.management.snmp.SnmpStatusException

Build index for "DsTableEntry".

Specified by:

buildSnmpIndex in class com.sun.management.snmp.agent.SnmpTableSupport

Throws:

com.sun.management.snmp.SnmpStatusException

createDsTableEntryMBean

public Object createDsTableEntryMBean(com.sun.management.snmp.agent.SnmpMibSubRequest req,
                                      com.sun.management.snmp.SnmpOid rowOid,
                                      int depth,
                                      ObjectName entryObjName,
                                      com.sun.management.snmp.agent.SnmpMibTable meta,
                                      Integer aApplIndex)
                               throws com.sun.management.snmp.SnmpStatusException

Factory method for "DsTableEntry" entry MBean class. You can redefine this method if you need to replace the default generated MBean class with your own customized class.

Returns:

An instance of the MBean class generated for the "DsTableEntry" conceptual row. Note that when using standard metadata, the returned object must implement the "DsTableEntryMBean" interface.

Throws:

com.sun.management.snmp.SnmpStatusException