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

Constructors

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

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SyslogdConfigFactory

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

Constructor for SyslogdConfigFactory.

Parameters:

stream - a InputStream object.

Throws:

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

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

IOException

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)

setInstance

Parameters:

config - a SyslogdConfig object.

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

getListenAddress

public String getListenAddress()

getListenAddress

Specified by:

getListenAddress in interface SyslogdConfig

Returns:

a String object.

Since:

1.8.1

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()

getForwardingRegexp

Specified by:

getForwardingRegexp in interface SyslogdConfig

Returns:

a String object.

getMatchingGroupHost

public int getMatchingGroupHost()

getMatchingGroupHost

Specified by:

getMatchingGroupHost in interface SyslogdConfig

Returns:

a int.

getMatchingGroupMessage

public int getMatchingGroupMessage()

getMatchingGroupMessage

Specified by:

getMatchingGroupMessage in interface SyslogdConfig

Returns:

a int.

getParser

public String getParser()

getParser

Specified by:

getParser in interface SyslogdConfig

Returns:

the parser class to use when parsing syslog messages, as a string.

getUeiList

public UeiList getUeiList()

getUeiList

Specified by:

getUeiList in interface SyslogdConfig

Returns:

a UeiList object.

getHideMessages

public HideMessage getHideMessages()

getHideMessages

Specified by:

getHideMessages in interface SyslogdConfig

Returns:

a HideMessage object.

getDiscardUei

public String getDiscardUei()

getDiscardUei

Specified by:

getDiscardUei in interface SyslogdConfig

Returns:

a String object.