org.opennms.netmgt.config
Class SyslogdConfigFactory

java.lang.Object
  org.opennms.netmgt.config.SyslogdConfigFactory

All Implemented Interfaces:

SyslogdConfig

public final class SyslogdConfigFactory
extends Object
implements SyslogdConfig

This is the singleton class used to load the configuration for the OpenNMS Syslogd from syslogd-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

SyslogdConfigFactory(Reader rdr)

Method Summary

String	getDiscardUei()
String	getForwardingRegexp()
HideMessage	getHideMessages()
static SyslogdConfig	getInstance() Return the singleton instance of this factory.
int	getMatchingGroupHost()
int	getMatchingGroupMessage()
boolean	getNewSuspectOnMessage() Return whether or not a newSuspect event should be sent when a trap is received from an unknown IP address.
int	getSyslogPort() Return the port on which SNMP traps should be received.
UeiList	getUeiList()
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(SyslogdConfig config)

Methods inherited from class java.lang.Object

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

Constructor Detail

SyslogdConfigFactory

public SyslogdConfigFactory(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 SyslogdConfig 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(SyslogdConfig config)

getSyslogPort

public int getSyslogPort()

Return the port on which SNMP traps should be received.

Specified by:

getSyslogPort in interface SyslogdConfig

Returns:

the port on which SNMP traps should be received

getNewSuspectOnMessage

public boolean getNewSuspectOnMessage()

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

Specified by:

getNewSuspectOnMessage in interface SyslogdConfig

Returns:

whether to generate newSuspect events on traps.

getForwardingRegexp

public String getForwardingRegexp()

Specified by:

getForwardingRegexp in interface SyslogdConfig

getMatchingGroupHost

public int getMatchingGroupHost()

Specified by:

getMatchingGroupHost in interface SyslogdConfig

getMatchingGroupMessage

public int getMatchingGroupMessage()

Specified by:

getMatchingGroupMessage in interface SyslogdConfig

getUeiList

public UeiList getUeiList()

Specified by:

getUeiList in interface SyslogdConfig

getHideMessages

public HideMessage getHideMessages()

Specified by:

getHideMessages in interface SyslogdConfig

getDiscardUei

public String getDiscardUei()

Specified by:

getDiscardUei in interface SyslogdConfig