org.apache.log4j.ext
Interface SnmpTrapSenderFacade

All Known Implementing Classes:
JoeSNMPTrapSender, NetSnmpCommandLineTrapSender

public interface SnmpTrapSenderFacade

Title: SnmpTrapSenderFacade
Description: A simplified interface to an underlying SNMP API.

The intent of this class is both to limit the available interface, and allow the underlying SNMP library to be changed, as desired.

Version:
1.0.1 changes ---
2002-10-15: mwm : changed the sysUpTime value to a long, to cope with the SysUpTimeResolver mechanism.
Author:
Mark Masterson (m.masterson@computer.org)
http://www.m2technologies.net/

Method Summary
 void addTrapMessageVariable(java.lang.String applicationTrapOIDValue, java.lang.String value)
          Adds a new Varbind to the SNMP PDU.
 void initialize(java.lang.String managementHostValue, int managementHostTrapListenPortValue, java.lang.String enterpriseOIDValue, java.lang.String localIPAddressValue, int localTrapSendPortValue, int genericTrapTypeValue, int specificTrapTypeValue, java.lang.String communityStringValue, long sysUpTimeValue)
          This method is called to set the values of all of the class fields used as parameters to the underlying SNMP API.
 void sendTrap()
          Sends the PDU defined by the variables of the fields of this class.
 

Method Detail

initialize

void initialize(java.lang.String managementHostValue,
                int managementHostTrapListenPortValue,
                java.lang.String enterpriseOIDValue,
                java.lang.String localIPAddressValue,
                int localTrapSendPortValue,
                int genericTrapTypeValue,
                int specificTrapTypeValue,
                java.lang.String communityStringValue,
                long sysUpTimeValue)
This method is called to set the values of all of the class fields used as parameters to the underlying SNMP API. This method must be called prior to calling either of the other methods in this class.

Parameters:
managementHostValue - - the numeric IP address of the host to which traps should be sent, e.g. "10.255.255.1".

managementHostTrapListenPortValue - - any valid TCP/IP port number. This is the port that the host specified in the "managementHostValue" variable will listen on for SNMP traps.

enterpriseOIDValue - - formatted as an OID E.g. "1.3.6.1.2.1.1.2.0" -- this OID would point to the standard sysObjectID of the "systemName" node of the standard "system" MIB.
If you want(need) to use custom OIDs (such as ones from the "private.enterprises" node -- "1.3.6.1.4.1.x.x.x..."), you always need to provide the fully qualified OID as the value of this variable.

localIPAddressValue - - an IP address, as a String, in numeric, dotted decimal format. E.g. "10.255.255.2". This is the IP address of the host that is using this appender to send SNMP traps. This address will be encoded in the SNMP PDU, and used to provide things like the "agent"'s IP address.

localTrapSendPortValue - - the port that should be used on the local host by the appender to send the trap.

genericTrapTypeValue - - generic trap type for this SNMP PDU. One of the following values (from the SNMP standard):
0 -- cold start
1 -- warm start
2 -- link down
3 -- link up
4 -- authentification failure
5 -- EGP neighbor loss
6 -- enterprise specific

specificTrapTypeValue - - any value within the range defined for an INTEGER in the ASN.1/BER notation; i.e. -128 to 127.

communityStringValue - - E.g. "public".

sysUpTimeValue - - this is meant to be the amount of time, in seconds, elapsed since the last re-start or re-initialization of the calling application. Of course, to set this, your application needs to keep track of the value.

sendTrap

void sendTrap()
Sends the PDU defined by the variables of the fields of this class. This method should always be called last by an application, after having called the initialization() method once, and the addTrapMessageVariable() method one or more times.


addTrapMessageVariable

void addTrapMessageVariable(java.lang.String applicationTrapOIDValue,
                            java.lang.String value)
Adds a new Varbind to the SNMP PDU. The Varbind is made of the value of the application trap OID (applicationTrapOID) parameter, as the key, and the value paramater to this method as the value. A PDU has a collection of Varbind variables -- repeated calls to this method will add to that collection successively.

Parameters:
applicationTrapOIDValue - - formatted as an OID E.g. "1.3.6.1.2.1.1.2.0.0.0.0" -- this OID would point to the standard sysObjectID of the "systemName" node of the standard "system" MIB.
This is the default value, if none is provided.
If you want(need) to use custom OIDs (such as ones from the "private.enterprises" node -- "1.3.6.1.4.1.x.x.x..."), you always need to provide the fully qualified OID as the parameter for this variable.

value - - the text to append to the Varbind that will be added to the SNMP PDU.