/*
* Copyright 2001-2003 Sun Microsystems, Inc. All Rights Reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Sun designates this
* particular file as subject to the "Classpath" exception as provided
* by Sun in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
* CA 95054 USA or visit www.sun.com if you need additional information or
* have any questions.
*/
package com.sun.jmx.snmp.internal;
import com.sun.jmx.snmp.mpm.SnmpMsgTranslator;
import com.sun.jmx.snmp.SnmpTooBigException;
import com.sun.jmx.snmp.SnmpStatusException;
import com.sun.jmx.snmp.SnmpPdu;
import com.sun.jmx.snmp.SnmpPduFactory;
import com.sun.jmx.snmp.SnmpSecurityParameters;
import com.sun.jmx.snmp.SnmpParams;
/**
* The message processing model interface. Any message processing model must implement this interface in order to be integrated in the engine framework.
* The model is called by the dispatcher when a call is received or when a call is sent.
* <p><b>This API is a Sun Microsystems internal API and is subject
* to change without notice.</b></p>
* @since 1.5
*/
public interface SnmpMsgProcessingModel extends SnmpModel {
/**
* This method is called when a call is to be sent to the network.
* @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(SnmpPduFactory factory);
/**
* This method is called when a call is received from the network.
* @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(SnmpPduFactory factory);
/**
* This method is called when a response is received from the network.
* @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 SnmpIncomingResponse getIncomingResponse(SnmpPduFactory factory);
/**
* This method is called to instantiate a pdu according to the passed pdu type and parameters.
* @param p The request parameters.
* @param type The pdu type.
* @return The pdu.
*/
public SnmpPdu getRequestPdu(SnmpParams p, int type) throws SnmpStatusException;
/**
* 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;
/**
* 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.
* @param pdu The encoded pdu.
* @return The partialy scoped pdu.
*/
public SnmpDecryptedPdu decode(byte[] pdu) throws SnmpStatusException;
/**
* This method returns an encoded scoped pdu. This method encode only the <CODE>contextEngineID</CODE>, <CODE>contextName</CODE> and data. It is needed by the <CODE>SnmpSecurityModel</CODE> for decryption.
* @param pdu The pdu to encode.
* @param outputBytes The partialy scoped pdu.
* @return The encoded bytes number.
*/
public int encode(SnmpDecryptedPdu pdu,
byte[] outputBytes) throws SnmpTooBigException;
/**
* In order to change the behavior of the translator, set it.
* @param translator The translator that will be used.
*/
public void setMsgTranslator(SnmpMsgTranslator translator);
/**
* Returns the current translator.
* @return The current translator.
*/
public SnmpMsgTranslator getMsgTranslator();
}