org.apache.servicemix.snmp.marshaler.SnmpMarshalerSupport Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.servicemix.snmp.marshaler;

import javax.jbi.messaging.MessageExchange;
import javax.jbi.messaging.MessagingException;
import javax.jbi.messaging.NormalizedMessage;

import org.snmp4j.PDU;

/**
 * a marshaler interface for snmp component
 * 
 * @author lhein 
 */
public interface SnmpMarshalerSupport {

    /**
     * converts a snmp event message into a jbi normalized message 
     * 
     * @param exchange                  the exchange object
     * @param inMsg                     the normalized message to fill
     * @param request                   the snmp request. Null when PDU is a trap PDU.
     * @param response                  the snmp response
     * @throws MessagingException       on errors
     */
    void convertToJBI(MessageExchange exchange, NormalizedMessage inMsg, PDU request, PDU response) throws MessagingException;
}