Package org.opends.server.snmp

Class DsTableMeta

  • All Implemented Interfaces:
    Serializable, NotificationBroadcaster
    public class DsTableMeta
extends com.sun.management.snmp.agent.SnmpMibTable
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 com.sun.management.snmp.agent.SnmpStandardObjectServer objectserver
      Reference to the object server.

      • Fields inherited from class com.sun.management.snmp.agent.SnmpMibTable

        creationEnabled, factory, nodeId, theMib

      • Fields inherited from class com.sun.management.snmp.agent.SnmpMibNode

        noSuchInstanceException, noSuchNameException, noSuchObjectException, varList

    • Constructor Summary

      Constructors 
      Constructor Description
      DsTableMeta​(com.sun.management.snmp.agent.SnmpMib myMib, com.sun.management.snmp.agent.SnmpStandardObjectServer objserv)
      Constructor for the table.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addEntry​(com.sun.management.snmp.SnmpOid rowOid, ObjectName objname, Object entry)  
      void check​(com.sun.management.snmp.agent.SnmpMibSubRequest req, com.sun.management.snmp.SnmpOid rowOid, int depth)  
      protected DsTableEntryMeta createDsTableEntryMetaNode​(String snmpEntryName, String tableName, com.sun.management.snmp.agent.SnmpMib mib, MBeanServer server)
      Factory method for "DsTableEntry" entry metadata class.
      void createNewEntry​(com.sun.management.snmp.agent.SnmpMibSubRequest req, com.sun.management.snmp.SnmpOid rowOid, int depth)  
      void get​(com.sun.management.snmp.agent.SnmpMibSubRequest req, com.sun.management.snmp.SnmpOid rowOid, int depth)  
      long getNextVarEntryId​(com.sun.management.snmp.SnmpOid rowOid, long var, Object data)
      Returns the arc of the next columnar object following "var".
      boolean isReadableEntryId​(com.sun.management.snmp.SnmpOid rowOid, long var, Object data)
      Returns true if "var" identifies a readable scalar object.
      boolean isRegistrationRequired()  
      void registerEntryNode​(com.sun.management.snmp.agent.SnmpMib mib, MBeanServer server)  
      void set​(com.sun.management.snmp.agent.SnmpMibSubRequest req, com.sun.management.snmp.SnmpOid rowOid, int depth)  
      boolean skipEntryVariable​(com.sun.management.snmp.SnmpOid rowOid, long var, Object data, int pduVersion)  
      void validateVarEntryId​(com.sun.management.snmp.SnmpOid rowOid, long var, Object data)
      check that the given "var" identifies a columnar object.

      • Methods inherited from class com.sun.management.snmp.agent.SnmpMibTable

        addEntry, addNotificationListener, beginRowAction, check, checkRemoveTableRow, checkRowStatusChange, contains, endRowAction, get, getBasicEntries, getEntry, getEntryName, getNextOid, getNextOid, getNextVarEntryId, getNotificationInfo, getRowAction, getSize, hasRowStatus, isCreationEnabled, isRowReady, isRowStatus, mapRowStatus, registerEntryFactory, removeEntry, removeEntry, removeEntry, removeNotificationListener, removeTableRow, set, setCreationEnabled, setRowStatus

      • Methods inherited from class com.sun.management.snmp.agent.SnmpMibNode

        getNextIdentifier, getNextVarId, getNextVarId, getRootOid, skipVariable, sort

    • Field Detail

      • objectserver

        protected com.sun.management.snmp.agent.SnmpStandardObjectServer objectserver
        Reference to the object server.

    • Constructor Detail

      • DsTableMeta

        public DsTableMeta​(com.sun.management.snmp.agent.SnmpMib myMib,
                   com.sun.management.snmp.agent.SnmpStandardObjectServer objserv)
        Constructor for the table. Initialize metadata for "DsTableMeta". 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

      • createDsTableEntryMetaNode

        protected DsTableEntryMeta createDsTableEntryMetaNode​(String snmpEntryName,
                                                      String tableName,
                                                      com.sun.management.snmp.agent.SnmpMib mib,
                                                      MBeanServer server)
        Factory method for "DsTableEntry" entry metadata class. You can redefine this method if you need to replace the default generated metadata class with your own customized class.
        Parameters:
        snmpEntryName - Name of the SNMP Entry object (conceptual row) ("DsTableEntry")
        tableName - Name of the table in which the entries are registered ("DsTable")
        mib - The SnmpMib object in which this table is registered
        server - MBeanServer for this table entries (may be null)
        Returns:
        An instance of the metadata class generated for the "DsTableEntry" conceptual row (DsTableEntryMeta)

      • createNewEntry

        public void createNewEntry​(com.sun.management.snmp.agent.SnmpMibSubRequest req,
                           com.sun.management.snmp.SnmpOid rowOid,
                           int depth)
                    throws com.sun.management.snmp.SnmpStatusException
        Specified by:
        createNewEntry in class com.sun.management.snmp.agent.SnmpMibTable
        Throws:
        com.sun.management.snmp.SnmpStatusException

      • isRegistrationRequired

        public boolean isRegistrationRequired()
        Specified by:
        isRegistrationRequired in class com.sun.management.snmp.agent.SnmpMibTable

      • registerEntryNode

        public void registerEntryNode​(com.sun.management.snmp.agent.SnmpMib mib,
                              MBeanServer server)

      • addEntry

        public void addEntry​(com.sun.management.snmp.SnmpOid rowOid,
                     ObjectName objname,
                     Object entry)
              throws com.sun.management.snmp.SnmpStatusException
        Overrides:
        addEntry in class com.sun.management.snmp.agent.SnmpMibTable
        Throws:
        com.sun.management.snmp.SnmpStatusException

      • get

        public void get​(com.sun.management.snmp.agent.SnmpMibSubRequest req,
                com.sun.management.snmp.SnmpOid rowOid,
                int depth)
         throws com.sun.management.snmp.SnmpStatusException
        Specified by:
        get in class com.sun.management.snmp.agent.SnmpMibTable
        Throws:
        com.sun.management.snmp.SnmpStatusException

      • set

        public void set​(com.sun.management.snmp.agent.SnmpMibSubRequest req,
                com.sun.management.snmp.SnmpOid rowOid,
                int depth)
         throws com.sun.management.snmp.SnmpStatusException
        Specified by:
        set in class com.sun.management.snmp.agent.SnmpMibTable
        Throws:
        com.sun.management.snmp.SnmpStatusException

      • check

        public void check​(com.sun.management.snmp.agent.SnmpMibSubRequest req,
                  com.sun.management.snmp.SnmpOid rowOid,
                  int depth)
           throws com.sun.management.snmp.SnmpStatusException
        Specified by:
        check in class com.sun.management.snmp.agent.SnmpMibTable
        Throws:
        com.sun.management.snmp.SnmpStatusException

      • validateVarEntryId

        public void validateVarEntryId​(com.sun.management.snmp.SnmpOid rowOid,
                               long var,
                               Object data)
                        throws com.sun.management.snmp.SnmpStatusException
        check that the given "var" identifies a columnar object.
        Specified by:
        validateVarEntryId in class com.sun.management.snmp.agent.SnmpMibTable
        Throws:
        com.sun.management.snmp.SnmpStatusException

      • isReadableEntryId

        public boolean isReadableEntryId​(com.sun.management.snmp.SnmpOid rowOid,
                                 long var,
                                 Object data)
                          throws com.sun.management.snmp.SnmpStatusException
        Returns true if "var" identifies a readable scalar object.
        Specified by:
        isReadableEntryId in class com.sun.management.snmp.agent.SnmpMibTable
        Throws:
        com.sun.management.snmp.SnmpStatusException

      • getNextVarEntryId

        public long getNextVarEntryId​(com.sun.management.snmp.SnmpOid rowOid,
                              long var,
                              Object data)
                       throws com.sun.management.snmp.SnmpStatusException
        Returns the arc of the next columnar object following "var".
        Specified by:
        getNextVarEntryId in class com.sun.management.snmp.agent.SnmpMibTable
        Throws:
        com.sun.management.snmp.SnmpStatusException

      • skipEntryVariable

        public boolean skipEntryVariable​(com.sun.management.snmp.SnmpOid rowOid,
                                 long var,
                                 Object data,
                                 int pduVersion)
        Overrides:
        skipEntryVariable in class com.sun.management.snmp.agent.SnmpMibTable