/** * This method is called to encode a full scoped pdu that as not been encrypted. <CODE>contextName</CODE>, <CODE>contextEngineID</CODE> and data are known. It will be routed to the dedicated model according to the version value. * <BR>The specified parameters are defined in RFC 2572 (see also the {@link com.sun.jmx.snmp.SnmpV3Message} class). * @param version The SNMP protocol version. * @param msgID The SNMP message ID. * @param msgMaxSize The max message size. * @param msgFlags The message flags. * @param msgSecurityModel The message security model. * @param params The security parameters. * @param contextEngineID The context engine ID. * @param contextName The context name. * @param data The encoded data. * @param dataLength The encoded data length. * @param outputBytes The buffer containing the encoded message. * @return The encoded bytes number. */ public int encode(int version, int msgID, int msgMaxSize, byte msgFlags, int msgSecurityModel, SnmpSecurityParameters params, byte[] contextEngineID, byte[] contextName, byte[] data, int dataLength, byte[] outputBytes) throws SnmpTooBigException, SnmpUnknownMsgProcModelException ;
/** * This method is called to encode a full scoped pdu that as been encrypted. <CODE>contextName</CODE>, <CODE>contextEngineID</CODE> and data are not known. It will be routed to the dedicated model according to the version value. * <BR>The specified parameters are defined in RFC 2572 (see also the {@link com.sun.jmx.snmp.SnmpV3Message} class). * @param version The SNMP protocol version. * @param msgID The SNMP message ID. * @param msgMaxSize The max message size. * @param msgFlags The message flags. * @param msgSecurityModel The message security model. * @param params The security parameters. * @param encryptedPdu The encrypted pdu. * @param outputBytes The buffer containing the encoded message. * @return The encoded bytes number. */ public int encodePriv(int version, int msgID, int msgMaxSize, byte msgFlags, int msgSecurityModel, SnmpSecurityParameters params, byte[] encryptedPdu, byte[] outputBytes) throws SnmpTooBigException, SnmpUnknownMsgProcModelException;
/** * This method is called when a call is received from the network. * @param model The model ID. * @param factory The pdu factory to use to encode and decode pdu. * @return The object that will handle every steps of the receiving (mainly unmarshalling and security). */ public SnmpIncomingRequest getIncomingRequest(int model, SnmpPduFactory factory) throws SnmpUnknownMsgProcModelException;
/** * This method is called when a call is to be sent to the network. The sub system routes the call to the dedicated model according to the model ID. * @param model The model ID. * @param factory The pdu factory to use to encode and decode pdu. * @return The object that will handle every steps of the sending (mainly marshalling and security). */ public SnmpOutgoingRequest getOutgoingRequest(int model, SnmpPduFactory factory) throws SnmpUnknownMsgProcModelException ;
/** * This method is called to instantiate a pdu according to the passed pdu type and parameters. The sub system routes the call to the dedicated model according to the model ID. * @param model The model ID. * @param p The request parameters. * @param type The pdu type. * @return The pdu. */ public SnmpPdu getRequestPdu(int model, SnmpParams p, int type) throws SnmpUnknownMsgProcModelException, SnmpStatusException ;
/** * This method is called when a call is received from the network. The sub system routes the call to the dedicated model according to the model ID. * @param model The model ID. * @param factory The pdu factory to use to decode pdu. * @return The object that will handle every steps of the receiving (mainly marshalling and security). */ public SnmpIncomingResponse getIncomingResponse(int model, SnmpPduFactory factory) throws SnmpUnknownMsgProcModelException;
/** * This method returns a decoded scoped pdu. This method decodes only the <CODE>contextEngineID</CODE>, <CODE>contextName</CODE> and data. It is needed by the <CODE>SnmpSecurityModel</CODE> after decryption. It will be routed to the dedicated model according to the version value. * @param version The SNMP protocol version. * @param pdu The encoded pdu. * @return the partialy scoped pdu. */ public SnmpDecryptedPdu decode(int version, byte[] pdu) throws SnmpStatusException, SnmpUnknownMsgProcModelException;
/** * This method returns an encoded scoped pdu. This method encodes only the <CODE>contextEngineID</CODE>, <CODE>contextName</CODE> and data. It is needed by the <CODE>SnmpSecurityModel</CODE> for decryption. It will be routed to the dedicated model according to the version value. * @param version The SNMP protocol version. * @param pdu The pdu to encode. * @param outputBytes The partialy scoped pdu. * @return The encoded bytes number. */ public int encode(int version, SnmpDecryptedPdu pdu, byte[] outputBytes) throws SnmpTooBigException, SnmpUnknownMsgProcModelException;
