org.opennms.netmgt.config

Class TrapdConfigFactory

java.lang.Object

org.opennms.netmgt.config.TrapdConfigFactory

All Implemented Interfaces:

TrapdConfig

public final class TrapdConfigFactory
extends Object
implements TrapdConfig

This is the singleton class used to load the configuration for the OpenNMS Trapd from the trapd-configuration.xml. Note: Users of this class should make sure the init() is called before calling any other method to ensure the config is loaded before accessing other convenience methods.

Author:

Sowmya Nataraj , Tarus Balog , OpenNMS

Constructor Summary

Constructors

Constructor and Description
TrapdConfigFactory(InputStream stream) Constructor for TrapdConfigFactory.

Method Summary

Modifier and Type	Method and Description
static TrapdConfig	getInstance() Return the singleton instance of this factory.
boolean	getNewSuspectOnTrap() Return whether or not a newSuspect event should be sent when a trap is received from an unknown IP address.
String	getSnmpTrapAddress()
int	getSnmpTrapPort() Return the port on which SNMP traps should be received.
List<SnmpV3User>	getSnmpV3Users() getSnmpV3Users
static void	init() Load the config from the default config file and create the singleton instance of this factory.
static void	reload() Reload the config from the default config file
static void	setInstance(TrapdConfig config) setInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

TrapdConfigFactory

public TrapdConfigFactory(InputStream stream)
                   throws org.exolab.castor.xml.MarshalException,
                          org.exolab.castor.xml.ValidationException

Constructor for TrapdConfigFactory.

Parameters:

stream - a InputStream object.

Throws:

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

Method Detail

init

public static void init()
                 throws IOException,
                        org.exolab.castor.xml.MarshalException,
                        org.exolab.castor.xml.ValidationException

Load the config from the default config file and create the singleton instance of this factory.

Throws:

IOException - Thrown if the specified config file cannot be read

org.exolab.castor.xml.MarshalException - Thrown if the file does not conform to the schema.

org.exolab.castor.xml.ValidationException - Thrown if the contents do not match the required schema.

IOException - if any.

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

reload

public static void reload()
                   throws IOException,
                          org.exolab.castor.xml.MarshalException,
                          org.exolab.castor.xml.ValidationException

Reload the config from the default config file

Throws:

IOException - Thrown if the specified config file cannot be read/loaded

org.exolab.castor.xml.MarshalException - Thrown if the file does not conform to the schema.

org.exolab.castor.xml.ValidationException - Thrown if the contents do not match the required schema.

IOException - if any.

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

getInstance

public static TrapdConfig getInstance()

Return the singleton instance of this factory.

Returns:

The current factory instance.

Throws:

IllegalStateException - Thrown if the factory has not yet been initialized.

setInstance

public static void setInstance(TrapdConfig config)

setInstance

Parameters:

config - a TrapdConfig object.

getSnmpTrapAddress

public String getSnmpTrapAddress()

Specified by:

getSnmpTrapAddress in interface TrapdConfig

getSnmpTrapPort

public int getSnmpTrapPort()

Return the port on which SNMP traps should be received.

Specified by:

getSnmpTrapPort in interface TrapdConfig

Returns:

the port on which SNMP traps should be received

getNewSuspectOnTrap

public boolean getNewSuspectOnTrap()

Return whether or not a newSuspect event should be sent when a trap is received from an unknown IP address.

Specified by:

getNewSuspectOnTrap in interface TrapdConfig

Returns:

whether to generate newSuspect events on traps.

getSnmpV3Users

public List<SnmpV3User> getSnmpV3Users()

Description copied from interface: TrapdConfig

getSnmpV3Users

Specified by:

getSnmpV3Users in interface TrapdConfig

Returns:

a java.util.List.