snmp
Class SNMPv1TrapPDU

java.lang.Object
  snmp.SNMPObject
      snmp.SNMPSequence
          snmp.SNMPv1TrapPDU

public class SNMPv1TrapPDU

extends SNMPSequence

The SNMPTrapPDU class represents an SNMPv1 Trap PDU from RFC 1157, as indicated below. This forms the payload of an SNMP Trap message. -- protocol data units PDUs ::= CHOICE { get-request GetRequest-PDU, get-next-request GetNextRequest-PDU, get-response GetResponse-PDU, set-request SetRequest-PDU, trap Trap-PDU } -- PDUs GetRequest-PDU ::= [0] IMPLICIT PDU GetNextRequest-PDU ::= [1] IMPLICIT PDU GetResponse-PDU ::= [2] IMPLICIT PDU SetRequest-PDU ::= [3] IMPLICIT PDU PDU ::= SEQUENCE { request-id INTEGER, error-status -- sometimes ignored INTEGER { noError(0), tooBig(1), noSuchName(2), badValue(3), readOnly(4), genErr(5) }, error-index -- sometimes ignored INTEGER, variable-bindings -- values are sometimes ignored VarBindList } Trap-PDU ::= [4] IMPLICIT SEQUENCE { enterprise -- type of object generating -- trap, see sysObjectID in [5] OBJECT IDENTIFIER, agent-addr -- address of object generating NetworkAddress, -- trap generic-trap -- generic trap type INTEGER { coldStart(0), warmStart(1), linkDown(2), linkUp(3), authenticationFailure(4), egpNeighborLoss(5), enterpriseSpecific(6) }, specific-trap -- specific code, present even INTEGER, -- if generic-trap is not -- enterpriseSpecific time-stamp -- time elapsed between the last TimeTicks, -- (re)initialization of the network -- entity and the generation of the trap variable-bindings -- "interesting" information VarBindList } -- variable bindings VarBind ::= SEQUENCE { name ObjectName, value ObjectSyntax } VarBindList ::= SEQUENCE OF VarBind END

Field Summary

Fields inherited from class snmp.SNMPSequence

sequence, tag

Constructor Summary

protected	SNMPv1TrapPDU(byte[] enc) Create a new PDU of the specified type from the supplied BER encoding.
	SNMPv1TrapPDU(SNMPObjectIdentifier enterpriseOID, SNMPIPAddress agentAddress, int genericTrap, int specificTrap, SNMPTimeTicks timestamp) Create a new Trap PDU of the specified type, with given request ID, error status, and error index, and containing an empty SNMP sequence (VarBindList) as additional data.
	SNMPv1TrapPDU(SNMPObjectIdentifier enterpriseOID, SNMPIPAddress agentAddress, int genericTrap, int specificTrap, SNMPTimeTicks timestamp, SNMPSequence varList) Create a new Trap PDU of the specified type, with given request ID, error status, and error index, and containing the supplied SNMP sequence as data.

Method Summary

SNMPIPAddress	getAgentAddress() A utility method that extracts the sending agent address this PDU.
SNMPObjectIdentifier	getEnterpriseOID() A utility method that extracts the enterprise OID from this PDU.
int	getGenericTrap() A utility method that returns the generic trap code for this PDU.
int	getSpecificTrap() A utility method that returns the specific trap code for this PDU.
long	getTimestamp() A utility method that returns the timestamp for 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

SNMPv1TrapPDU

public SNMPv1TrapPDU(SNMPObjectIdentifier enterpriseOID,
                     SNMPIPAddress agentAddress,
                     int genericTrap,
                     int specificTrap,
                     SNMPTimeTicks timestamp,
                     SNMPSequence varList)
              throws SNMPBadValueException

Create a new Trap PDU of the specified type, with given request ID, error status, and error index, and containing the supplied SNMP sequence as data.

SNMPv1TrapPDU

public SNMPv1TrapPDU(SNMPObjectIdentifier enterpriseOID,
                     SNMPIPAddress agentAddress,
                     int genericTrap,
                     int specificTrap,
                     SNMPTimeTicks timestamp)
              throws SNMPBadValueException

Create a new Trap PDU of the specified type, with given request ID, error status, and error index, and containing an empty SNMP sequence (VarBindList) as additional data.

SNMPv1TrapPDU

protected SNMPv1TrapPDU(byte[] enc)
                 throws SNMPBadValueException

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

Throws:

SNMPBadValueException - Indicates invalid SNMP 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

getEnterpriseOID

public SNMPObjectIdentifier getEnterpriseOID()

A utility method that extracts the enterprise OID from this PDU.

getAgentAddress

public SNMPIPAddress getAgentAddress()

A utility method that extracts the sending agent address this PDU.

getGenericTrap

public int getGenericTrap()

A utility method that returns the generic trap code for this PDU.

getSpecificTrap

public int getSpecificTrap()

A utility method that returns the specific trap code for this PDU.

getTimestamp

public long getTimestamp()

A utility method that returns the timestamp for this PDU.