A C F G I J N O R S

A

addTrapMessageVariable(String, String) - Method in class org.apache.log4j.ext.JoeSNMPTrapSender
 
addTrapMessageVariable(String, String) - Method in class org.apache.log4j.ext.NetSnmpCommandLineTrapSender
 
addTrapMessageVariable(String, String) - Method in interface org.apache.log4j.ext.SnmpTrapSenderFacade
Adds a new Varbind to the SNMP PDU.
append(LoggingEvent) - Method in class org.apache.log4j.ext.SNMPTrapAppender
Uses an instance of SnmpTrapSenderFacade to send the String returned by Layout.format() as the message(s) of an SNMP trap.

C

close() - Method in class org.apache.log4j.ext.SNMPTrapAppender
Sets the state of the Appender to "closed".

F

formatMultipleVarBinds(LoggingEvent, SnmpTrapSenderFacade) - Method in class org.apache.log4j.ext.SnmpDelimitedConversionPatternLayout
Breaks the conversion pattern string itself up and, using the tokens thus found, builds distinct VarBinds out of the OID's embedded in the conversion pattern string and the escaped elements of the LoggingEvent.

G

getApplicationTrapOID() - Method in class org.apache.log4j.ext.SNMPTrapAppender
Get the trap OID that will be sent in the SNMP PDU for this app.
getCommunityString() - Method in class org.apache.log4j.ext.SNMPTrapAppender
Get the community string set for the SNMP session this appender will use.
getEnterpriseOID() - Method in class org.apache.log4j.ext.SNMPTrapAppender
Get the enterprise OID that will be sent in the SNMP PDU.
getForwardStackTraceWithTrap() - Method in class org.apache.log4j.ext.SNMPTrapAppender
Gets the flag that determines if the contents of the stack trace of any Throwable in the LoggingEvent should be added as VarBinds to the trap PDU.
Default is FALSE.
getGenericTrapType() - Method in class org.apache.log4j.ext.SNMPTrapAppender
Get the generic trap type set for this SNMP PDU.
getImplementationClassName() - Method in class org.apache.log4j.ext.SNMPTrapAppender
Get the value of the concrete class that implements the SnmpTrapSenderFacade interface.
getLocalIPAddress() - Method in class org.apache.log4j.ext.SNMPTrapAppender
Get the IP address of the host that is using this appender to send SNMP traps.
getLocalTrapSendPort() - Method in class org.apache.log4j.ext.SNMPTrapAppender
Get the value of the port that will be used to send traps out from the local host.
getManagementHost() - Method in class org.apache.log4j.ext.SNMPTrapAppender
Get the numeric, dotted-decimal IP address of the remote host that traps will be sent to, as a String.
getManagementHostTrapListenPort() - Method in class org.apache.log4j.ext.SNMPTrapAppender
Get the port used on the remote host to listen for SNMP traps.
getSpecificTrapType() - Method in class org.apache.log4j.ext.SNMPTrapAppender
Get the specific trap type set for this SNMP PDU.
getSysUpTime() - Method in class org.apache.log4j.ext.SNMPTrapAppender
Get the value of the system up time that will be used for the SNMP PDU.
getSysUpTime() - Method in interface org.apache.log4j.ext.SysUpTimeResolver
Implements a mechanism to return a "system up-time" that is relevant and meaningful for a given application.
getSysUpTimeResolver() - Method in class org.apache.log4j.ext.SNMPTrapAppender
Gets the concrete instance of an implementation of the SysUpTimeResolver interface that is being used by the appender.
getTrapVersion() - Method in class org.apache.log4j.ext.SNMPTrapAppender
 
getValuePairDelim() - Method in class org.apache.log4j.ext.SnmpDelimitedConversionPatternLayout
Gets the value of the delimiter used in the conversion pattern string to delimit value pairs that should be added as separate VarBind variables to the trap.
getVarDelim() - Method in class org.apache.log4j.ext.SnmpDelimitedConversionPatternLayout
Gets the value of the delimiter used in the conversion pattern string to delimit the key and value in a value pair embedded within the string.

I

ignoresThrowable() - Method in class org.apache.log4j.ext.SnmpDelimitedConversionPatternLayout
Override this to insulate us from potential changes to the super class.
initialize(SNMPTrapAppender) - Method in class org.apache.log4j.ext.JoeSNMPTrapSender
 
initialize(SNMPTrapAppender) - Method in class org.apache.log4j.ext.NetSnmpCommandLineTrapSender
 
initialize(SNMPTrapAppender) - Method in interface org.apache.log4j.ext.SnmpTrapSenderFacade
This method is called to set the values of all of the class fields used as parameters to the underlying SNMP API.

J

JoeSNMPTrapSender - Class in org.apache.log4j.ext
This class makes use of the JoeSNMP library to implement the underlying SNMP protocol(s).
JoeSNMPTrapSender() - Constructor for class org.apache.log4j.ext.JoeSNMPTrapSender
Default constructor.

N

NetSnmpCommandLineTrapSender - Class in org.apache.log4j.ext
Title: NetSnmpCommandLineTrapSender

Description: This class makes use of the NetSNMP snmptrap utility to send traps that implement the underlying SNMP protocol(s).

NOTE: this class is intended primarily as a "proof-of-concept", and to serve as an example of a possible usage of a command line trap sending utility with the appender.
NetSnmpCommandLineTrapSender() - Constructor for class org.apache.log4j.ext.NetSnmpCommandLineTrapSender
 

O

org.apache.log4j.ext - package org.apache.log4j.ext
 

R

requiresLayout() - Method in class org.apache.log4j.ext.SNMPTrapAppender
Implemented to return "true" .

S

sendTrap() - Method in class org.apache.log4j.ext.JoeSNMPTrapSender
 
sendTrap() - Method in class org.apache.log4j.ext.NetSnmpCommandLineTrapSender
 
sendTrap() - Method in interface org.apache.log4j.ext.SnmpTrapSenderFacade
Sends the PDU defined by the variables of the fields of this class.
setApplicationTrapOID(String) - Method in class org.apache.log4j.ext.SNMPTrapAppender
Set the trap OID that will be sent in the SNMP PDU for this app.
setCommunityString(String) - Method in class org.apache.log4j.ext.SNMPTrapAppender
Set the community string set for the SNMP session this appender will use.
setEnterpriseOID(String) - Method in class org.apache.log4j.ext.SNMPTrapAppender
Set the enterprise OID that will be sent in the SNMP PDU.
setForwardStackTraceWithTrap(String) - Method in class org.apache.log4j.ext.SNMPTrapAppender
Sets the flag that determines if the contents of the stack trace of any Throwable in the LoggingEvent should be added as VarBinds to the trap PDU.
Default is FALSE.
setGenericTrapType(int) - Method in class org.apache.log4j.ext.SNMPTrapAppender
Set the generic trap type for this SNMP PDU.
setImplementationClassName(String) - Method in class org.apache.log4j.ext.SNMPTrapAppender
Set the value of the concrete class that implements the SnmpTrapSenderFacade interface.
setLocalIPAddress(String) - Method in class org.apache.log4j.ext.SNMPTrapAppender
Set the IP address of the host that is using this appender to send SNMP traps.
setLocalTrapSendPort(int) - Method in class org.apache.log4j.ext.SNMPTrapAppender
Set the value of the port that will be used to send traps out from the local host.
setManagementHost(String) - Method in class org.apache.log4j.ext.SNMPTrapAppender
Set the IP address of the remote host that traps should be sent to.
setManagementHostTrapListenPort(int) - Method in class org.apache.log4j.ext.SNMPTrapAppender
Set the port used on the remote host to listen for SNMP traps.
setSpecificTrapType(int) - Method in class org.apache.log4j.ext.SNMPTrapAppender
Set the specific trap type for this SNMP PDU.
setSysUpTime(long) - Method in class org.apache.log4j.ext.SNMPTrapAppender
Deprecated. Now using the excellent SysUpTimeResolver idea from Thomas Muller, but if you set this value in the properties file, the appender will use that value, to maintain backwards compatibility.
setSysUpTimeResolver(String) - Method in class org.apache.log4j.ext.SNMPTrapAppender
See SysUpTimeResolver.
setTrapVersion(int) - Method in class org.apache.log4j.ext.SNMPTrapAppender
 
setValuePairDelim(String) - Method in class org.apache.log4j.ext.SnmpDelimitedConversionPatternLayout
Sets the value of the delimiter used in the conversion pattern string to delimit value pairs that should be added as separate VarBind variables to the trap.
setVarDelim(String) - Method in class org.apache.log4j.ext.SnmpDelimitedConversionPatternLayout
Sets the value of the delimiter used in the conversion pattern string to delimit the key and value in a value pair embedded within the string.
SnmpDelimitedConversionPatternLayout - Class in org.apache.log4j.ext
This layout allows you to embed trap specific OID's in the conversion pattern defined in the configuration script, assigning each embedded OID to a specific element of the LoggingEvent.
SnmpDelimitedConversionPatternLayout() - Constructor for class org.apache.log4j.ext.SnmpDelimitedConversionPatternLayout
 
snmpReceivedTrap(SnmpTrapSession, InetAddress, int, SnmpOctetString, SnmpPduPacket) - Method in class org.apache.log4j.ext.JoeSNMPTrapSender
Skeleton method, implemented only to satisfy the requirements of the JoeSNMP API.
snmpReceivedTrap(SnmpTrapSession, InetAddress, int, SnmpOctetString, SnmpPduTrap) - Method in class org.apache.log4j.ext.JoeSNMPTrapSender
Skeleton method, implemented only to satisfy the requirements of the JoeSNMP API.
SNMPTrapAppender - Class in org.apache.log4j.ext
An appender to send formatted logging event strings to a specified managment host (typically, a MLM of some sort, but could also be an SNMP management console) in the form of an SNMP trap.
SNMPTrapAppender() - Constructor for class org.apache.log4j.ext.SNMPTrapAppender
Default constructor.
SNMPTrapAppender(Layout) - Constructor for class org.apache.log4j.ext.SNMPTrapAppender
Construct the appender with the specified Layout.
SnmpTrapSenderFacade - Interface in org.apache.log4j.ext
Title: SnmpTrapSenderFacade
Description: A simplified interface to an underlying SNMP API.
snmpTrapSessionError(SnmpTrapSession, int, Object) - Method in class org.apache.log4j.ext.JoeSNMPTrapSender
Skeleton method, implemented only to satisfy the requirements of the JoeSNMP API.
SysUpTimeResolver - Interface in org.apache.log4j.ext
Title: SysUpTimeResolver
Description: A class implementing this interface must provide a way of returning the system "up time", in milliseconds.

A C F G I J N O R S