com.adventnet.snmp.mibs
Class MibMacro

java.lang.Object
  |
  +--com.adventnet.snmp.mibs.MibMacro

class MibMacro
extends java.lang.Object
implements java.io.Serializable, com.adventnet.snmp.mibs.mibparser.MIBConstants

The MibMacro class is used to parse the use of OBJECT-TYPE and TRAP-TYPE macros in a MIB module.

Each instance of this class corresponds to a macro definition in a module. The MACRO definition parser (constructor) is really unimplemented, and may never be. Only supports specific MACROs, i.e. OBJECT-TYPE and TRAP-TYPE, which are both hardcoded, so MACRO definitions are ignored except for the name. The instance name corresponds to the specific macro, e.g. OBJECT-TYPE.

API users will not use this class directly. Most of the read routines can be understood only if you have the corresponding MIBFormat specification document. The document is available for no fee on demand.

See Also:
Serialized Form

Fields inherited from interface com.adventnet.snmp.mibs.mibparser.MIBConstants
ACCESS_ACCESSIBLE_FOR_NOTIFY, ACCESS_NOT_ACCESSIBLE, ACCESS_NOT_IMPLEMENTED, ACCESS_READ_CREATE, ACCESS_READ_ONLY, ACCESS_READ_WRITE, ACCESS_WRITE_ONLY, accessStr, AGENT_CAPABILITIES, alphaStr, BITSTRING, COUNTER, COUNTER32, COUNTER64, GAUGE, GAUGE32, INTEGER, INTEGER32, IPADDRESS, macroStr, MODULE_COMPLIANCE, MODULE_IDENTITY, NETWORKADDRESS, NOTIFICATION_GROUP, NOTIFICATION_TYPE, NULL, numericStr, OBJECT_GROUP, OBJECT_IDENTIFIER, OBJECT_IDENTITY, OBJECT_TYPE, OCTETSTRING, OPAQUE, SEQUENCE, STATUS_CURRENT, STATUS_DEPRECATED, STATUS_MANDATORY, STATUS_OBSOLETE, STATUS_OPTIONAL, statusStr, TEXTUAL_CONVENTION, TIMETICKS, TRAP_TYPE, UNSIGNED32
 
Constructor Summary
(package private) MibMacro()
           
 
Method Summary
 MibModuleCompliance mcReadElements(java.io.DataInputStream inp, MibNode node, MibModule module, ModuleCompliance mcom)
           
 MibModuleCompliance mcReadElements(com.adventnet.snmp.mibs.mibparser.MCModule synoid, MibNode node, MibModule module, ModuleCompliance mcom)
           
 void mGrpReadElements(java.io.DataInputStream inp, MibNode node, MibModule module, MibModuleCompliance mComp, ModuleComplianceModule mcm)
           
 void mGrpReadElements(com.adventnet.snmp.mibs.mibparser.ModuleGroup synoid, MibNode node, MibModule module, MibModuleCompliance mComp, ModuleComplianceModule mcm)
           
(package private)  void readAgentCapabilitiesSyntax(java.io.DataInputStream inp, MibNode node, MibModule module)
           
(package private)  void readAgentCapabilitiesSyntax(com.adventnet.snmp.mibs.mibparser.SyntaxAgentCapabilities synoid, MibNode node, MibModule module)
           
(package private)  void readElements(java.io.DataInputStream inp, int type, MibNode node, MibModule module)
          Reads in the macro types and updates the Node elements
(package private)  void readElements(com.adventnet.snmp.mibs.mibparser.SyntaxOID synoid, int type, MibNode node, MibModule module)
           
(package private)  void readModuleComplianceSyntax(java.io.DataInputStream inp, MibNode node, MibModule module)
           
(package private)  void readModuleComplianceSyntax(com.adventnet.snmp.mibs.mibparser.SyntaxModuleCompliance synoid, MibNode node, MibModule module)
           
(package private)  void readModuleIdentitySyntax(java.io.DataInputStream inp, MibNode node, MibModule module)
           
(package private)  void readModuleIdentitySyntax(com.adventnet.snmp.mibs.mibparser.SyntaxModuleIdentity synoid, MibNode node, MibModule module)
           
(package private)  void readNotificationGroupSyntax(java.io.DataInputStream inp, MibNode node, MibModule module)
           
(package private)  void readNotificationGroupSyntax(com.adventnet.snmp.mibs.mibparser.SyntaxNotificationGroup synoid, MibNode node, MibModule module)
           
(package private)  void readNotificationTypeSyntax(java.io.DataInputStream inp, MibNode node, MibModule module)
           
(package private)  void readNotificationTypeSyntax(com.adventnet.snmp.mibs.mibparser.SyntaxNotification synoid, MibNode node, MibModule module)
           
(package private)  void readOBIDComments(java.io.DataInputStream inp, MibNode node, MibModule module)
           
(package private)  void readOBIDComments(com.adventnet.snmp.mibs.mibparser.SyntaxOID synoid, MibNode node, MibModule module)
           
(package private)  void readObjectGroupSyntax(java.io.DataInputStream inp, MibNode node, MibModule module)
           
(package private)  void readObjectGroupSyntax(com.adventnet.snmp.mibs.mibparser.SyntaxObjectGroup synoid, MibNode node, MibModule module)
           
(package private)  void readObjectIdentitySyntax(java.io.DataInputStream inp, MibNode node, MibModule module)
           
(package private)  void readObjectIdentitySyntax(com.adventnet.snmp.mibs.mibparser.SyntaxObjectIdentity synoid, MibNode node, MibModule module)
           
(package private)  void readObjectTypeSyntax(java.io.DataInputStream inp, MibNode node, MibModule module)
          Reads in the object-type syntax and populates the node elements
(package private)  void readObjectTypeSyntax(com.adventnet.snmp.mibs.mibparser.SyntaxObjectType synoid, MibNode node, MibModule module)
           
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MibMacro

MibMacro()
Method Detail

readElements

void readElements(java.io.DataInputStream inp,
                  int type,
                  MibNode node,
                  MibModule module)
            throws java.io.IOException
Reads in the macro types and updates the Node elements
Parameters:
inp - the InputStream corresponding to the compiled MIB data
type - the macro type as defined in MIBConstants.
node - the MibNode corresponding to this macro.
Since:
2.1

readElements

void readElements(com.adventnet.snmp.mibs.mibparser.SyntaxOID synoid,
                  int type,
                  MibNode node,
                  MibModule module)

readOBIDComments

void readOBIDComments(java.io.DataInputStream inp,
                      MibNode node,
                      MibModule module)
                throws java.io.IOException

readOBIDComments

void readOBIDComments(com.adventnet.snmp.mibs.mibparser.SyntaxOID synoid,
                      MibNode node,
                      MibModule module)

readObjectTypeSyntax

void readObjectTypeSyntax(java.io.DataInputStream inp,
                          MibNode node,
                          MibModule module)
                    throws java.io.IOException
Reads in the object-type syntax and populates the node elements
Since:
2.1

readObjectTypeSyntax

void readObjectTypeSyntax(com.adventnet.snmp.mibs.mibparser.SyntaxObjectType synoid,
                          MibNode node,
                          MibModule module)

readObjectIdentitySyntax

void readObjectIdentitySyntax(java.io.DataInputStream inp,
                              MibNode node,
                              MibModule module)
                        throws java.io.IOException

readObjectIdentitySyntax

void readObjectIdentitySyntax(com.adventnet.snmp.mibs.mibparser.SyntaxObjectIdentity synoid,
                              MibNode node,
                              MibModule module)

readModuleIdentitySyntax

void readModuleIdentitySyntax(java.io.DataInputStream inp,
                              MibNode node,
                              MibModule module)
                        throws java.io.IOException

readModuleIdentitySyntax

void readModuleIdentitySyntax(com.adventnet.snmp.mibs.mibparser.SyntaxModuleIdentity synoid,
                              MibNode node,
                              MibModule module)

readNotificationTypeSyntax

void readNotificationTypeSyntax(java.io.DataInputStream inp,
                                MibNode node,
                                MibModule module)
                          throws java.io.IOException

readNotificationTypeSyntax

void readNotificationTypeSyntax(com.adventnet.snmp.mibs.mibparser.SyntaxNotification synoid,
                                MibNode node,
                                MibModule module)

readAgentCapabilitiesSyntax

void readAgentCapabilitiesSyntax(java.io.DataInputStream inp,
                                 MibNode node,
                                 MibModule module)
                           throws java.io.IOException

readAgentCapabilitiesSyntax

void readAgentCapabilitiesSyntax(com.adventnet.snmp.mibs.mibparser.SyntaxAgentCapabilities synoid,
                                 MibNode node,
                                 MibModule module)

readObjectGroupSyntax

void readObjectGroupSyntax(com.adventnet.snmp.mibs.mibparser.SyntaxObjectGroup synoid,
                           MibNode node,
                           MibModule module)

readObjectGroupSyntax

void readObjectGroupSyntax(java.io.DataInputStream inp,
                           MibNode node,
                           MibModule module)
                     throws java.io.IOException

readNotificationGroupSyntax

void readNotificationGroupSyntax(java.io.DataInputStream inp,
                                 MibNode node,
                                 MibModule module)
                           throws java.io.IOException

readNotificationGroupSyntax

void readNotificationGroupSyntax(com.adventnet.snmp.mibs.mibparser.SyntaxNotificationGroup synoid,
                                 MibNode node,
                                 MibModule module)

readModuleComplianceSyntax

void readModuleComplianceSyntax(java.io.DataInputStream inp,
                                MibNode node,
                                MibModule module)
                          throws java.io.IOException

readModuleComplianceSyntax

void readModuleComplianceSyntax(com.adventnet.snmp.mibs.mibparser.SyntaxModuleCompliance synoid,
                                MibNode node,
                                MibModule module)

mcReadElements

public MibModuleCompliance mcReadElements(java.io.DataInputStream inp,
                                          MibNode node,
                                          MibModule module,
                                          ModuleCompliance mcom)
                                   throws java.io.IOException

mcReadElements

public MibModuleCompliance mcReadElements(com.adventnet.snmp.mibs.mibparser.MCModule synoid,
                                          MibNode node,
                                          MibModule module,
                                          ModuleCompliance mcom)

mGrpReadElements

public void mGrpReadElements(java.io.DataInputStream inp,
                             MibNode node,
                             MibModule module,
                             MibModuleCompliance mComp,
                             ModuleComplianceModule mcm)
                      throws java.io.IOException

mGrpReadElements

public void mGrpReadElements(com.adventnet.snmp.mibs.mibparser.ModuleGroup synoid,
                             MibNode node,
                             MibModule module,
                             MibModuleCompliance mComp,
                             ModuleComplianceModule mcm)