OpenNMS API 1.2.3

org.opennms.netmgt.config
Class TrapdConfigFactory

java.lang.Object
  extended byorg.opennms.netmgt.config.TrapdConfigFactory

public final class TrapdConfigFactory
extends java.lang.Object

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

Field Summary
private  TrapdConfiguration m_config
          The config class loaded from the config file
private static boolean m_loaded
          This member is set to true if the configuration file has been loaded.
private static TrapdConfigFactory m_singleton
          The singleton instance of this factory
 
Constructor Summary
private TrapdConfigFactory(java.lang.String configFile)
          Private constructor
 
Method Summary
static TrapdConfigFactory 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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

m_singleton

private static TrapdConfigFactory m_singleton
The singleton instance of this factory


m_config

private TrapdConfiguration m_config
The config class loaded from the config file


m_loaded

private static boolean m_loaded
This member is set to true if the configuration file has been loaded.

Constructor Detail

TrapdConfigFactory

private TrapdConfigFactory(java.lang.String configFile)
                    throws java.io.IOException,
                           org.exolab.castor.xml.MarshalException,
                           org.exolab.castor.xml.ValidationException
Private constructor

Throws:
java.io.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.
Method Detail

init

public static void init()
                 throws java.io.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:
java.io.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 java.io.IOException,
                          org.exolab.castor.xml.MarshalException,
                          org.exolab.castor.xml.ValidationException
Reload the config from the default config file

Throws:
java.io.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 TrapdConfigFactory getInstance()
Return the singleton instance of this factory.

Returns:
The current factory instance.
Throws:
java.lang.IllegalStateException - Thrown if the factory has not yet been initialized.

getSnmpTrapPort

public int getSnmpTrapPort()
Return the port on which SNMP traps should be received.

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.

Returns:
whether to generate newSuspect events on traps.

OpenNMS API 1.2.3

Generated by eevans on May 29 2005 2015.