File Doc Category Size Date Package
SnmpPduFactory.java API Doc Java SE 5 API 2866 Fri Aug 26 14:55:04 BST 2005 com.sun.jmx.snmp

SnmpPduFactory

public interface SnmpPduFactory

Defines the interface of the object in charge of encoding and decoding SNMP packets.

You will not usually need to use this interface, except if you decide to replace the default implementation SnmpPduFactoryBER.

An SnmpPduFactory object is attached to an {@link com.sun.jmx.snmp.daemon.SnmpAdaptorServer SNMP protocol adaptor} or an {@link com.sun.jmx.snmp.SnmpPeer SnmpPeer}. It is used each time an SNMP packet needs to be encoded or decoded.
{@link com.sun.jmx.snmp.SnmpPduFactoryBER SnmpPduFactoryBER} is the default implementation. It simply applies the standard ASN.1 encoding and decoding on the bytes of the SNMP packet.

It's possible to implement your own SnmpPduFactory object and to add authentication and/or encryption to the default encoding/decoding process.

This API is a Sun Microsystems internal API and is subject to change without notice.

see: SnmpPduFactory
see: SnmpPduPacket
see: SnmpMessage
version: 1.8 08/13/98
author: Sun Microsystems, Inc

Fields Summary
Constructors Summary
Methods Summary
public SnmpPdu decodeSnmpPdu(SnmpMsg msg)
Decodes the specified SnmpMsg and returns the resulting SnmpPdu. If this method returns null, the message will be considered unsafe and will be dropped.
param
msg The SnmpMsg to be decoded.
return
Null or a fully initialized SnmpPdu.
exception
SnmpStatusException If the encoding is invalid.
since
1.5
public SnmpMsg encodeSnmpPdu(SnmpPdu p, int maxDataLength)
Encodes the specified SnmpPdu and returns the resulting SnmpMsg. If this method returns null, the specified SnmpPdu will be dropped and the current SNMP request will be aborted.
param
p The SnmpPdu to be encoded.
param
maxDataLength The size limit of the resulting encoding.
return
Null or a fully encoded SnmpMsg.
exception
SnmpStatusException If pdu contains illegal values and cannot be encoded.
exception
SnmpTooBigException If the resulting encoding does not fit into maxPktSize bytes.
since
1.5