/** * 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 to encode a full scoped pdu that has not been encrypted. <CODE>contextName</CODE>, <CODE>contextEngineID</CODE> and data are known. * <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;
/** * This method is called to encode a full scoped pdu that as been encrypted. <CODE>contextName</CODE>, <CODE>contextEngineID</CODE> and data are known. * <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;
/** * Called when a request is to be sent to the network. It must be securized. This call is routed to the dedicated model according to the model ID. * <BR>The specified parameters are defined in RFC 2572 (see also the {@link com.sun.jmx.snmp.SnmpV3Message} class). * @param cache The cache that has been created by calling <CODE>createSecurityCache</CODE> on this model. * @param version The SNMP protocol version. * @param msgID The current request id. * @param msgMaxSize The message max size. * @param msgFlags The message flags (reportable, Auth and Priv). * @param msgSecurityModel This current security model. * @param params The security parameters that contain the model dependant parameters. * @param contextEngineID The context engine ID. * @param contextName The context name. * @param data The marshalled varbind list * @param dataLength The marshalled varbind list length. * @param outputBytes The buffer to fill with securized request. This is a representation independant marshalled format. This buffer will be sent to the network. * @return The marshalled byte number. */ public int generateRequestMsg(SnmpSecurityCache cache, int version, int msgID, int msgMaxSize, byte msgFlags, int msgSecurityModel, SnmpSecurityParameters params, byte[] contextEngineID, byte[] contextName, byte[] data, int dataLength, byte[] outputBytes) throws SnmpTooBigException, SnmpStatusException, SnmpSecurityException, SnmpUnknownSecModelException;
/** * Called when a response is to be sent to the network. It must be securized. This call is routed to the dedicated model according to the model ID. * <BR>The specified parameters are defined in RFC 2572 (see also the {@link com.sun.jmx.snmp.SnmpV3Message} class). * @param cache The cache that has been created by calling <CODE>createSecurityCache</CODE> on this model. * @param version The SNMP protocol version. * @param msgID The current request id. * @param msgMaxSize The message max size. * @param msgFlags The message flags (reportable, Auth and Priv). * @param msgSecurityModel This current security model. * @param params The security parameters that contain the model dependant parameters. * @param contextEngineID The context engine ID. * @param contextName The context name. * @param data The marshalled varbind list * @param dataLength The marshalled varbind list length. * @param outputBytes The buffer to fill with securized request. This is a representation independant marshalled format. This buffer will be sent to the network. * @return The marshalled byte number. */ public int generateResponseMsg(SnmpSecurityCache cache, int version, int msgID, int msgMaxSize, byte msgFlags, int msgSecurityModel, SnmpSecurityParameters params, byte[] contextEngineID, byte[] contextName, byte[] data, int dataLength, byte[] outputBytes) throws SnmpTooBigException, SnmpStatusException, SnmpSecurityException, SnmpUnknownSecModelException;
/** * Called when a request is received from the network. It handles authentication and privacy. This call is routed to the dedicated model according to the model ID. * <BR>The specified parameters are defined in RFC 2572 (see also the {@link com.sun.jmx.snmp.SnmpV3Message} class). * @param cache The cache that has been created by calling <CODE>createSecurityCache</CODE> on this model. * @param version The SNMP protocol version. * @param msgID The current request id. * @param msgMaxSize The message max size. * @param msgFlags The message flags (reportable, Auth and Priv) * @param msgSecurityModel This current security model. * @param params The security parameters in a marshalled format. The informations cointained in this array are model dependant. * @param contextEngineID The context engine ID or null if encrypted. * @param contextName The context name or null if encrypted. * @param data The marshalled varbind list or null if encrypted. * @param encryptedPdu The encrypted pdu or null if not encrypted. * @param decryptedPdu The decrypted pdu. If no decryption is to be done, the passed context engine ID, context name and data could be used to fill this object. * @return The decoded security parameters. */ public SnmpSecurityParameters processIncomingRequest(SnmpSecurityCache cache, int version, int msgID, int msgMaxSize, byte msgFlags, int msgSecurityModel, byte[] params, byte[] contextEngineID, byte[] contextName, byte[] data, byte[] encryptedPdu, SnmpDecryptedPdu decryptedPdu) throws SnmpStatusException, SnmpSecurityException, SnmpUnknownSecModelException;
/** * Called when a response is received from the network. It handles authentication and privacy. This call is routed to the dedicated model according to the model ID. * <BR>The specified parameters are defined in RFC 2572 (see also the {@link com.sun.jmx.snmp.SnmpV3Message} class). * @param cache The cache that has been created by calling <CODE>createSecurityCache</CODE> on this model. * @param version The SNMP protocol version. * @param msgID The current request id. * @param msgMaxSize The message max size. * @param msgFlags The message flags (reportable, Auth and Priv). * @param msgSecurityModel This current security model. * @param params The security parameters in a marshalled format. The informations cointained in this array are model dependant. * @param contextEngineID The context engine ID or null if encrypted. * @param contextName The context name or null if encrypted. * @param data The marshalled varbind list or null if encrypted. * @param encryptedPdu The encrypted pdu or null if not encrypted. * @param decryptedPdu The decrypted pdu. If no decryption is to be done, the passed context engine ID, context name and data could be used to fill this object. * @return The security parameters. */ public SnmpSecurityParameters processIncomingResponse(SnmpSecurityCache cache, int version, int msgID, int msgMaxSize, byte msgFlags, int msgSecurityModel, byte[] params, byte[] contextEngineID, byte[] contextName, byte[] data, byte[] encryptedPdu, SnmpDecryptedPdu decryptedPdu) throws SnmpStatusException, SnmpSecurityException, SnmpUnknownSecModelException;
/** * Called when a request is to be sent to the network. It must be securized. * <BR>The specified parameters are defined in RFC 2572 (see also the {@link com.sun.jmx.snmp.SnmpV3Message} class). * @param cache The cache that has been created by calling <CODE>createSecurityCache</CODE> on this model. * @param version The SNMP protocol version. * @param msgID The current request id. * @param msgMaxSize The message max size. * @param msgFlags The message flags (reportable, Auth and Priv). * @param msgSecurityModel This current security model. * @param params The security parameters that contain the model dependant parameters. * @param contextEngineID The context engine ID. * @param contextName The context name. * @param data The marshalled varbind list. * @param dataLength The marshalled varbind list length. * @param outputBytes The buffer to fill with securized request. This is a representation independant marshalled format. This buffer will be sent to the network. * @return The marshalled byte number. */ public int generateRequestMsg(SnmpSecurityCache cache, int version, int msgID, int msgMaxSize, byte msgFlags, int msgSecurityModel, SnmpSecurityParameters params, byte[] contextEngineID, byte[] contextName, byte[] data, int dataLength, byte[] outputBytes) throws SnmpTooBigException, SnmpStatusException, SnmpSecurityException;
/** * Called when a response is to be sent to the network. It must be securized. * <BR>The specified parameters are defined in RFC 2572 (see also the {@link com.sun.jmx.snmp.SnmpV3Message} class). * @param cache The cache that has been created by calling <CODE>createSecurityCache</CODE> on this model. * @param version The SNMP protocol version. * @param msgID The current request id. * @param msgMaxSize The message max size. * @param msgFlags The message flags (reportable, Auth and Priv) * @param msgSecurityModel This current security model. * @param params The security parameters that contain the model dependant parameters. * @param contextEngineID The context engine ID. * @param contextName The context name. * @param data The marshalled varbind list. * @param dataLength The marshalled varbind list length. * @param outputBytes The buffer to fill with securized request. This is a representation independant marshalled format. This buffer will be sent to the network. * @return The marshalled byte number. */ public int generateResponseMsg(SnmpSecurityCache cache, int version, int msgID, int msgMaxSize, byte msgFlags, int msgSecurityModel, SnmpSecurityParameters params, byte[] contextEngineID, byte[] contextName, byte[] data, int dataLength, byte[] outputBytes) throws SnmpTooBigException, SnmpStatusException, SnmpSecurityException;
/** * Called when a request is received from the network. It handles authentication and privacy. * <BR>The specified parameters are defined in RFC 2572 (see also the {@link com.sun.jmx.snmp.SnmpV3Message} class). * @param cache The cache that has been created by calling <CODE>createSecurityCache</CODE> on this model. * @param version The SNMP protocol version. * @param msgID The current request id. * @param msgMaxSize The message max size. * @param msgFlags The message flags (reportable, Auth and Priv) * @param msgSecurityModel This current security model. * @param params The security parameters in a marshalled format. The informations contained in this array are model dependant. * @param contextEngineID The context engine ID or null if encrypted. * @param contextName The context name or null if encrypted. * @param data The marshalled varbind list or null if encrypted * @param encryptedPdu The encrypted pdu or null if not encrypted. * @param decryptedPdu The decrypted pdu. If no decryption is to be done, the passed context engine ID, context name and data could be used to fill this object. * @return The decoded security parameters. */ public SnmpSecurityParameters processIncomingRequest(SnmpSecurityCache cache, int version, int msgID, int msgMaxSize, byte msgFlags, int msgSecurityModel, byte[] params, byte[] contextEngineID, byte[] contextName, byte[] data, byte[] encryptedPdu, SnmpDecryptedPdu decryptedPdu) throws SnmpStatusException, SnmpSecurityException;
/** * Called when a response is received from the network. It handles authentication and privacy. * <BR>The specified parameters are defined in RFC 2572 (see also the {@link com.sun.jmx.snmp.SnmpV3Message} class). * @param cache The cache that has been created by calling <CODE>createSecurityCache</CODE> on this model. * @param version The SNMP protocol version. * @param msgID The current request id. * @param msgMaxSize The message max size. * @param msgFlags The message flags (reportable, Auth and Priv) * @param msgSecurityModel This current security model. * @param params The security parameters in a marshalled format. The informations cointained in this array are model dependant. * @param contextEngineID The context engine ID or null if encrypted. * @param contextName The context name or null if encrypted. * @param data The marshalled varbind list or null if encrypted * @param encryptedPdu The encrypted pdu or null if not encrypted. * @param decryptedPdu The decrypted pdu. If no decryption is to be done, the passed context engine ID, context name and data could be used to fill this object. * @return The security parameters. */ public SnmpSecurityParameters processIncomingResponse(SnmpSecurityCache cache, int version, int msgID, int msgMaxSize, byte msgFlags, int msgSecurityModel, byte[] params, byte[] contextEngineID, byte[] contextName, byte[] data, byte[] encryptedPdu, SnmpDecryptedPdu decryptedPdu) throws SnmpStatusException, SnmpSecurityException;