org.snmp4j.agent.ProxyForwarder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of snmp4j-agent Show documentation

SNMP-Agent API for Java

There is a newer version: 3.8.1

/*_############################################################################
  _## 
  _##  SNMP4J-Agent 3 - ProxyForwarder.java  
  _## 
  _##  Copyright (C) 2005-2018  Frank Fock (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.agent;

import org.snmp4j.smi.Address;

/**
 * The ProxyForwarder class represents a proxy forwarder instance as defined by RFC 3413.
 *
 * @author Frank Fock
 * @version 1.0
 */
public interface ProxyForwarder {

    int PROXY_TYPE_ALL = 0;
    int PROXY_TYPE_READ = 1;
    int PROXY_TYPE_WRITE = 2;
    int PROXY_TYPE_NOTIFY = 3;
    int PROXY_TYPE_INFORM = 4;

    /**
     * Forwards a Request if it matches the criteria defined by the SNMP-PROXY-MIB associated with this
     * proxy forwarder.
     *
     * @param request
     *         the proxy forward request. If the request has been forwarded successfully to a single target, then the
     *         responsePDU will be set to the response PDU received from the target entity.
     * @param  type of the peer {@link Address}.
     *
     * @return true if the request has been forwarded, false
     * otherwise.
     */
     boolean forward(ProxyForwardRequest request);

}