com.adventnet.utils.appender
Class SnmpTrapAppenderExtension

java.lang.Object
  org.apache.log4j.AppenderSkeleton
      org.apache.log4j.ext.SNMPTrapAppender
          com.adventnet.utils.appender.SnmpTrapAppenderExtension

All Implemented Interfaces:

org.apache.log4j.Appender, org.apache.log4j.spi.OptionHandler

public class SnmpTrapAppenderExtension
extends org.apache.log4j.ext.SNMPTrapAppender

Title: SnmpTrapAppenderExtension
Description: An extension of the SNMPTrapAppender written by Mark Masterson (see below), which provides for the additon of several proprietary, AdventNet specific varaibles to the Appender's configuration.

============================================================================
This license is based on the Apache Software License, Version 1.1

============================================================================

Copyright (C) 2001-2003 Mark Masterson. All rights reserved.

Redistribution and use in source and binary forms, with or without modifica-
tion, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

3. The end-user documentation included with the redistribution, if any, must
include the following acknowledgment: "This product includes software
developed by the Apache Software Foundation (http://www.apache.org/)."
Alternately, this acknowledgment may appear in the software itself, if
and wherever such third-party acknowledgments normally appear.

4. The names Mark Masterson, M2 Technologies, SNMPTrapAppender or log4j must
not be used to endorse or promote products derived from this software
without prior written permission. For written permission, please contact
m.masterson@computer.org.

5. Products derived from this software may not be called "Apache", nor may
"Apache" appear in their name, without prior written permission of the
Apache Software Foundation.

THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Field Summary

Fields inherited from class org.apache.log4j.AppenderSkeleton

closed, errorHandler, headFilter, layout, name, tailFilter, threshold

Constructor Summary

SnmpTrapAppenderExtension()

Method Summary

int	getTrapIndex() Method to get the Trap Index value
SnmpTrapService	getTrapListener() Method to get the SnmpTrapService instance associated with this class.
int	getTrapSource() Method to set the TrapSource to this Appender Extension
void	setTrapIndex(int trapIndex) Method to set the TrapIndex value
void	setTrapListener(SnmpTrapService trapListener) Method to ser your SnmpTrapService instance to send the Traps.
void	setTrapSource(int trapSource) Method to set the TrapSource for this Appender (Either DEFAULT \ TFTABLE ) If this is set to be TFTABLE you have to associate a SnmpTrapService instance to this class.

Methods inherited from class org.apache.log4j.ext.SNMPTrapAppender

append, close, getApplicationTrapOID, getCommunityString, getEnterpriseOID, getForwardStackTraceWithTrap, getGenericTrapType, getImplementationClassName, getLocalIPAddress, getLocalTrapSendPort, getManagementHost, getManagementHostTrapListenPort, getSpecificTrapType, getSysUpTime, getSysUpTimeResolver, getTrapVersion, requiresLayout, setApplicationTrapOID, setCommunityString, setEnterpriseOID, setForwardStackTraceWithTrap, setGenericTrapType, setImplementationClassName, setLocalIPAddress, setLocalTrapSendPort, setManagementHost, setManagementHostTrapListenPort, setSpecificTrapType, setSysUpTime, setSysUpTimeResolver, setTrapVersion

Methods inherited from class org.apache.log4j.AppenderSkeleton

activateOptions, addFilter, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setErrorHandler, setLayout, setName, setThreshold

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SnmpTrapAppenderExtension

public SnmpTrapAppenderExtension()

Method Detail

getTrapIndex

public int getTrapIndex()

Method to get the Trap Index value

Returns:

return the TrapIndex int value

setTrapIndex

public void setTrapIndex(int trapIndex)

Method to set the TrapIndex value

Parameters:

trapIndex - the TrapIndex value to be set

getTrapSource

public int getTrapSource()

Method to set the TrapSource to this Appender Extension

setTrapSource

public void setTrapSource(int trapSource)

Method to set the TrapSource for this Appender (Either DEFAULT \ TFTABLE ) If this is set to be TFTABLE you have to associate a SnmpTrapService instance to this class. If you set this to 1 (TFTABLE), the Traps will be sent based on the Forwarding Table set to the SnmpTrapService variable associated to this class. If this set to 0 (DEFAULT), the Traps will be sent to the Default configurations mentioned in the configuraion file or API.

Parameters:

trapSource - 0 or 1 based on which the Traps will be sent.

See Also:

setTrapListener(SnmpTrapService trapListener)

setTrapListener

public void setTrapListener(SnmpTrapService trapListener)

Method to ser your SnmpTrapService instance to send the Traps. If this is not set, Appender will create it's own TrapService to send the Traps.

Parameters:

trapListener - the SnmpTrapService instance to be used to send Traps.

getTrapListener

public SnmpTrapService getTrapListener()

Method to get the SnmpTrapService instance associated with this class.

Returns:

the SnmpTrapService instance.