AdventNet: Class SnmpPDU

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.adventnet.snmp.snmp2
Class SnmpPDU

java.lang.Object
  |
  +--com.adventnet.snmp.snmp2.SnmpPDU

All Implemented Interfaces:: java.io.Serializable

public class SnmpPDU
extends java.lang.Object
implements java.io.Serializable

The SnmpPDU class represents the SNMP PDU used in protocol operations.

Any SNMP operation can be performed using this class.

The following should be set on it before performing any SNMP operation:
1. The SNMP command. It may be SnmpAPI.GET_REQ_MSG or SnmpAPI.SET_REQ_MSG or SnmpAPI.GETNEXT_REQ_MSG
2. The SnmpVarBinds that should be present in this PDU.
3. The network communication variables such as remoteHost and remotePort ( in case of UDP ). This is not needed if it is already present in SnmpSession. But it is always good to set it on pdu rather than on SnmpSession.

The following code snippet will give a clear idea of how to do a SNMP operation using this class:
This code snippet does a simple SNMP GET request for the oid ".1.3.6.1.2.1.1.1.0", to the host "remoteHost" and port "remotePort".

SnmpPDU pdu = new SnmpPDU();
pdu.setCommand(SnmpAPI.GET_REQ_MSG);
pdu.addNull(new SnmpOID(".1.3.6.1.2.1.1.1.0"));

If the under lying protocol that is used is UDP, then an instance of UDPProtocolOptions should be instantiated to set the remotePort and remoteHost variables.
Note: By default AdventNet SNMP Stack uses UDP as the underlying protocol.
If SAS is used for communications, then an instance of SASProtocolOptions should be instantiated to set the remotePort and remoteHost.

UDPProtocolOptions opt = new UDPProtocolOptions();
opt.setRemoteHost(remoteHost);
opt.setRemotePort(remotePort);
pdu.setProtocolOptions(opt);

SnmpPDU response_pdu = session.syncSend(pdu);

When a PDU is re-used, ensure the reqid field is set properly. If reqid is set non-zero, the API leaves it as it is. If it is 0, then the API assigns a unique reqid, to ensure no conflict with other requests. So, if you do not want to manage the reqids yourself, set it to 0 before each request. With SnmpSession.syncSend() you don't need to store the value for later reference. With SnmpSession.send(), the reqid assigned is returned, and you will need it later to check up on the response.

The SnmpPDU is encapsulated in a message, where the message could be SNMPv1, SNMPv2c or an SNMPv3 message. Applications do not have to be aware of the message classes Snmp3Message and SnmpMessage and they can work with the SnmpPDU alone, to be able to interact with peers. The SnmpPDU provides a getMsg( ) method to access the SnmpMessage associated with it. Similarly when a SnmpPDU is instantiated, it instantiates the appropriate message object along with it. Applications must not instantiate Snmp3Message and SnmpMessage objects and should always use SnmpPDU.

The SnmpPDU provides most of the communication parameters' related methods that are available with the SnmpSession. Wherever the value of the parameter is set in the pdu, it overrides the value in the session.

See Also:: Serialized Form

Constructor Summary

SnmpPDU()
          Creates a new SnmpPDU instance.

Method Summary

void addNull(SnmpOID oid)
          This method will add a vairable binding which contains this SnmpOID and a placeholder ( NULL ) as the value.

void addVariableBinding(int index, SnmpVarBind varbind)
          Adds SNMP variable at specified index in PDUs list of variable bindings.

void addVariableBinding(SnmpVarBind varbind)
          Adds SNMP variable at the end of PDU's list of variable bindings.

SnmpPDU copy()
          Makes a copy of entire SnmpPDU including the SnmpMessage it encapsulates.

SnmpPDU copyWithoutVarbinds()


boolean decode()
          Decodes the remainder of the PDU.

void fix()
          Fixes PDU to eliminate erred variable binding, determined by errindex

java.net.InetAddress getAddress()
          Deprecated. use the following instead.
UDPProtocolOptions opt = (UDPProtocolOptions)SnmpPDU.getProtocolOptions();
InetAddress address = opt.getRemoteAddress();

java.lang.String getAgentAddr()
          Gets the address of object generating trap in String foramt.

java.net.InetAddress getAgentAddress()
          Gets address of object generating trap.

int getClientID()
          This method will return the id for the source which sent this pdu

byte getCommand()
          Gets command type of this PDU.

java.lang.String getCommunity()
          Gets community string received/sent.

byte[] getContextID()
          Gets context ID sent/received with this PDU.

byte[] getContextName()
          Gets the context name sent/received with this PDU.

byte[] getData()
          Gets encoded data to be sent, or received.

int getEncodedLength(SnmpSession session)
          Returns the length of the encoded pdu.

SnmpOID getEnterprise()
          Gets the enterprise OID.

int getErrindex()
          Gets error index of this PDU.

java.lang.String getError()
          Gets error information as a String, with offending varbind if any.

int getErrstat()
          Gets error status of this PDU.

int getMaxRepetitions()
          GetsMax-Repetitions value of this PDU.

SnmpMessage getMsg()
          Returns the SnmpMessage instance for this pdu.

int getNonRepeaters()
          Gets Non-Repeaters value of this PDU.

SnmpOID getObjectID(int index)
          Gets the specified SNMP ObjectID from PDUs list of variable bindings.

ProtocolOptions getProtocolOptions()
          This method will return the transport mechanism's protocol options

java.lang.String getRemoteHost()
          Deprecated. use the following instead.
UDPProtocolOptions opt = (UDPProtocolOptions)SnmpPDU.getProtocolOptions();
String remoteHost = opt.getRemoteHost();

int getRemotePort()
          Deprecated. use the following instead.
UDPProtocolOptions opt = (UDPProtocolOptions)SnmpPDU.getProtocolOptions();
int remotePort = opt.getRemotePort();

int getReqid()
          Gets request id of this PDU.

int getRetries()
          Gets number of retries for this PDU before timeout.

long getRoundTripDelay()
          Returns round-trip delay if received response PDU

int getSecurityModel()
          Gets the securityModel associated with this PDU.

int getSpecificType()
          Gets specific trap type.

int getTimeout()
          Gets the timeout value.

SnmpOID getTrapOID()
          This method returns the trap-oid for this SNMPv2 trap-pdu.

int getTrapType()
          Gets the generic type of the trap.

long getUpTime()
          Gets the timeStamp of the object which has generated the trap.

byte[] getUserName()
          Gets the principal on whose behalf SNMPv3 requests are made.

SnmpVar getVariable(int index)
          Gets specified SNMP variable from PDUs list of variables.

SnmpVarBind getVariableBinding(int index)
          Gets specified variable binding from PDUs list of variable bindings.

java.util.Vector getVariableBindings()
          Gets list of SnmpVarBind objects as a vector.

int getVersion()
          Gets snmp Version number in PDU.

java.lang.String getWriteCommunity()
          Gets writeCommunity string received/sent.

boolean isBroadCastEnabled()
          This method says whether this pdu is a broadCastpdu or not.

java.lang.String printVarBinds()
          Returns String of all variable bindings with Tags, e.g.

void removeVariableBinding(int index)
          Removes SNMP variable binding at specified index in PDUs list of variable bindings.

void removeVariableBinding(SnmpVarBind varbind)
          Removes specified SNMP variable binding from PDUs list of variable bindings.

void setAddress(java.net.InetAddress address)
          Deprecated. use the following instead.
UDPProtocolOptions opt = (UDPProtocolOptions)SnmpPDU.getProtocolOptions();
opt.setRemoteAddress(address);

void setAgentAddr(java.lang.String agentaddr)
          sets the agent address as a string.

void setAgentAddress(java.net.InetAddress addr)
          Sets Address of object generating trap.

void setBroadCastEnable(boolean bool)
          Calling this method with a "true" value will indicate that this pdu is a broadcast pdu.

void setClientID(int id)
          This method will indicate the id for source which sent this pdu

void setCommand(byte type)
          Sets command type of this PDU.

void setCommunity(java.lang.String t)
          Sets community string received/sent.

void setCommunityEncoding(java.lang.String enc)
          Sets the encoding to use for community string.

void setContextID(byte[] id)
          Sets context ID associated with the PDU.

void setContextName(byte[] name)
          Sets the context name associated with the PDU

void setData(byte[] b)
          Sets encoded data to be sent, or received.

void setDNSLookup(boolean lookup)
          Deprecated. since no lookup will be done unnecessarily.

void setEnterprise(SnmpOID oid)
          Sets the enterprise OID.

void setErrindex(int index)
          Sets Error index for this PDU.

void setErrstat(int stat)
          Set Error status for this PDU.

void setMaxRepetitions(int max_rep)
          Sets Max-Repetitions value for this PDU.

void setNonRepeaters(int non_rep)
          Sets Non-Repeaters value for this PDU.

void setProtocolOptions(ProtocolOptions tParam)
          This sets the transport mechanism's protocol options.

void setReEncode(boolean reEncode)
          Controls ASN.1 encoding (default true).

void setRemoteHost(java.lang.String host)
          Deprecated. use the following instead.
UDPProtocolOptions opt = (UDPProtocolOptions)SnmpPDU.getProtocolOptions();
opt.setRemoteHost(host);

void setRemotePort(int port)
          Deprecated. use the following instead.
UDPProtocolOptions opt = (UDPProtocolOptions)SnmpPDU.getProtocolOptions();
opt.setRemotePort(port);

void setReqid(int id)
          Sets Request id for this PDU.

void setRetries(int N)
          Sets number of retries for this PDU before timeout.

void setSecurityModel(int model)
          Sets the securityModel to be associated with the PDU.

void setSpecificType(int type)
          Sets Specific trap type.

void setTimeout(int t)
          Sets the timeout value.

void setTrapType(int type)
          Sets the generic type of the Trap.

void setUpTime(long uptime)
          Sets the timeStamp of the object which has to generate the trap.

void setUserName(byte[] name)
          Sets the principal on whose behalf SNMPv3 requests are to be made.

void setVariable(int index, SnmpVar var)
          Sets SNMP variable at specified index in PDUs list of variables, to value var.

void setVersion(int v)
          Sets snmp Version number in PDU.

void setWriteCommunity(java.lang.String t)
          Sets writeCommunity string received/sent.

Methods inherited from class java.lang.Object

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

Constructor Detail

SnmpPDU

public SnmpPDU()

Creates a new SnmpPDU instance. It also instantiates the SnmpMessage it encapsulates.

Method Detail

isBroadCastEnabled

public boolean isBroadCastEnabled()

This method says whether this pdu is a broadCastpdu or not.

Returns:: the boolean which says whether this pdu is a broadCastpdu or not.

setBroadCastEnable

public void setBroadCastEnable(boolean bool)

Calling this method with a "true" value will indicate that this pdu is a broadcast pdu.

Parameters:: bool - the boolean value which says, whether this pdu is a broadCast pdu or not.

getMsg

public SnmpMessage getMsg()

Returns the SnmpMessage instance for this pdu.