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

TrapdConfigFactory(Reader rdr)

Method Summary

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.
int	getSnmpTrapPort() Return the port on which SNMP traps should be received.
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)

Methods inherited from class java.lang.Object

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

Constructor Detail

TrapdConfigFactory

public TrapdConfigFactory(Reader rdr)
                   throws org.exolab.castor.xml.MarshalException,
                          org.exolab.castor.xml.ValidationException

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

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.

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.

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)

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.