messageprocessingmodel.java

snmp4j

/*_############################################################################
  _##
  _##  SNMP4J - MessageProcessingModel.java
  _##
  _##  Copyright 2003-2005  Frank Fock and Jochen Katz (SNMP4J.org)
  _##
  _##  Licensed under the Apache License, Version 2.0 (the "License");
  _##  you may not use this file except in compliance with the License.
  _##  You may obtain a copy of the License at
  _##
  _##      http://www.apache.org/licenses/LICENSE-2.0
  _##
  _##  Unless required by applicable law or agreed to in writing, software
  _##  distributed under the License is distributed on an "AS IS" BASIS,
  _##  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  _##  See the License for the specific language governing permissions and
  _##  limitations under the License.
  _##
  _##########################################################################*/



package org.snmp4j.mp;

import java.io.IOException;
import org.snmp4j.*;
import org.snmp4j.smi.*;
import org.snmp4j.asn1.BERInputStream;
import org.snmp4j.MutablePDU;
import org.snmp4j.MessageDispatcher;
// needed by JavaDoc:
import org.snmp4j.security.SecurityLevel;
import org.snmp4j.security.SecurityModel;
import org.snmp4j.mp.*;
import org.snmp4j.asn1.BEROutputStream;

/**
 * The <code>MessageProcessingModel</code> interface defines common methods
 * to all SNMP message processing models.
 * <p>Note: The read counter of the {@link BERInputStream} parameters in this
 * interface should not be reset while those methods are executed.
 *
 * @author Frank Fock
 * @version 1.0
 */
public interface MessageProcessingModel {

  int MPv1  = 0;
  int MPv2c = 1;
  int MPv2u = 2;
  int MPv3  = 3;

  /**
   * Gets the numerical ID of the message processing model as defined by the
   * constants in this interface or by an appropriate constant in the
   * class implementing this interface.
   * @return
   *    a positive integer value.
   */
  int getID();

  /**
   * Prepares an outgoing message as defined in RFC3412