snmp
Class SNMPv2BulkRequestPDU

java.lang.Object
  snmp.SNMPObject
      snmp.SNMPSequence
          snmp.SNMPv2BulkRequestPDU

public class SNMPv2BulkRequestPDU

extends SNMPSequence

The SNMPv2BulkRequestPDU class represents an SNMPv2 Bulk Request PDU from RFC 1905, as indicated below. This forms the payload of an SNMPv2 Bulk Request message. -- protocol data units 3. Definitions SNMPv2-PDU DEFINITIONS ::= BEGIN IMPORTS ObjectName, ObjectSyntax, Integer32 FROM SNMPv2-SMI; -- protocol data units PDUs ::= CHOICE { get-request GetRequest-PDU, get-next-request GetNextRequest-PDU, get-bulk-request GetBulkRequest-PDU, response Response-PDU, set-request SetRequest-PDU, inform-request InformRequest-PDU, snmpV2-trap SNMPv2-Trap-PDU } -- PDUs GetRequest-PDU ::= [0] IMPLICIT PDU GetNextRequest-PDU ::= [1] IMPLICIT PDU Response-PDU ::= [2] IMPLICIT PDU SetRequest-PDU ::= [3] IMPLICIT PDU -- [4] is obsolete GetBulkRequest-PDU ::= [5] IMPLICIT BulkPDU InformRequest-PDU ::= [6] IMPLICIT PDU SNMPv2-Trap-PDU ::= [7] IMPLICIT PDU max-bindings INTEGER ::= 2147483647 BulkPDU ::= -- MUST be identical in SEQUENCE { -- structure to PDU request-id Integer32, non-repeaters INTEGER (0..max-bindings), max-repetitions INTEGER (0..max-bindings), variable-bindings VarBindList -- values are ignored }

Field Summary

Fields inherited from class snmp.SNMPSequence

sequence, tag

Constructor Summary

protected	SNMPv2BulkRequestPDU(byte[] enc, byte pduType) Create a new PDU of the specified type from the supplied BER encoding.
	SNMPv2BulkRequestPDU(int requestID, int nonRepeaters, int maxRepetitions, SNMPSequence varList) Create a new PDU of the specified type, with given request ID, non-repeaters, and max-repetitions fields, and containing the supplied SNMP sequence as data.

Method Summary

int	getMaxRepetitions() A utility method that returns the max-repetitions field for this PDU.
int	getNonRepeaters() A utility method that extracts the non-repeaters field for this PDU.
byte	getPDUType() A utility method that returns the PDU type of this PDU.
int	getRequestID() A utility method that extracts the request ID number from this PDU.
SNMPSequence	getVarBindList() A utility method that extracts the variable binding list from the pdu.

Methods inherited from class snmp.SNMPSequence

addSNMPObject, extractFromBEREncoding, getBEREncoding, getSNMPObjectAt, getValue, insertSNMPObjectAt, setValue, size, toString

Methods inherited from class snmp.SNMPObject

equals, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SNMPv2BulkRequestPDU

public SNMPv2BulkRequestPDU(int requestID,
                            int nonRepeaters,
                            int maxRepetitions,
                            SNMPSequence varList)
                     throws SNMPBadValueException

Create a new PDU of the specified type, with given request ID, non-repeaters, and max-repetitions fields, and containing the supplied SNMP sequence as data.

SNMPv2BulkRequestPDU

protected SNMPv2BulkRequestPDU(byte[] enc,
                               byte pduType)
                        throws SNMPBadValueException

Create a new PDU of the specified type from the supplied BER encoding.

Throws:

SNMPBadValueException - Indicates invalid SNMP Bulk PDU encoding supplied in enc.

Method Detail

getVarBindList

public SNMPSequence getVarBindList()

A utility method that extracts the variable binding list from the pdu. Useful for retrieving the set of (object identifier, value) pairs returned in response to a request to an SNMP device. The variable binding list is just an SNMP sequence containing the identifier, value pairs.

See Also:

SNMPVarBindList

getRequestID

public int getRequestID()

A utility method that extracts the request ID number from this PDU.

getNonRepeaters

public int getNonRepeaters()

A utility method that extracts the non-repeaters field for this PDU.

getMaxRepetitions

public int getMaxRepetitions()

A utility method that returns the max-repetitions field for this PDU.

getPDUType

public byte getPDUType()

A utility method that returns the PDU type of this PDU.