org.opennms.netmgt.config

Interface SyslogdConfig

All Known Implementing Classes:

SyslogConfigBean, SyslogdConfigFactory

public interface SyslogdConfig

SyslogdConfig interface.

Version:

$Id: $

Author:

ranger

Method Summary

Modifier and Type	Method and Description
int	getBatchIntervalMs() Messages are aggregated in batches before being dispatched.
int	getBatchSize() Messages are aggregated in batches before being dispatched.
String	getDiscardUei() getDiscardUei
String	getForwardingRegexp() getForwardingRegexp
List<HideMatch>	getHideMessages() A collection of Strings we do not want to attach to the event.
String	getListenAddress() getListenAddress
Integer	getMatchingGroupHost() getMatchingGroupHost
Integer	getMatchingGroupMessage() getMatchingGroupMessage
boolean	getNewSuspectOnMessage() getNewSuspectOnMessage
int	getNumThreads() Number of threads used for consuming/dispatching messages.
String	getParser() getParser
int	getQueueSize() Maximum number of messages to keep in memory while waiting to be dispatched.
int	getSyslogPort() getSyslogPort
TimeZone	getTimeZone() Optional: - if not null it will be used as default time zone if no time zone is given - if not set the system time zone will be used
List<UeiMatch>	getUeiList() A collection of Strings->UEI's
void	reload() reload configuration
boolean	shouldIncludeRawSyslogmessage() Indicates whether or not to include the raw syslog message as an event parameter on events generated by Syslogd.

Method Detail

getSyslogPort

int getSyslogPort()

getSyslogPort

Returns:

a int.

getListenAddress

String getListenAddress()

getListenAddress

Returns:

a String object.

Since:

1.8.1

getNewSuspectOnMessage

boolean getNewSuspectOnMessage()

getNewSuspectOnMessage

Returns:

a boolean.

getForwardingRegexp

String getForwardingRegexp()

getForwardingRegexp

Returns:

a String object.

getMatchingGroupHost

Integer getMatchingGroupHost()

getMatchingGroupHost

Returns:

a int.

getMatchingGroupMessage

Integer getMatchingGroupMessage()

getMatchingGroupMessage

Returns:

a int.

getParser

String getParser()

getParser

Returns:

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

getUeiList

List<UeiMatch> getUeiList()

A collection of Strings->UEI's

getHideMessages

List<HideMatch> getHideMessages()

A collection of Strings we do not want to attach to the event.

getDiscardUei

String getDiscardUei()

getDiscardUei

Returns:

a String object.

getNumThreads

int getNumThreads()

Number of threads used for consuming/dispatching messages.

Returns:

number of threads

getQueueSize

int getQueueSize()

Maximum number of messages to keep in memory while waiting to be dispatched.

Returns:

queue size

getBatchSize

int getBatchSize()

Messages are aggregated in batches before being dispatched. When the batch reaches this size, it will be dispatched.

Returns:

batch size

getBatchIntervalMs

int getBatchIntervalMs()

Messages are aggregated in batches before being dispatched. When the batch has been created for longer than this interval it will be dispatched, regardless of the size.

Returns:

interval in ms

getTimeZone

TimeZone getTimeZone()

Optional: - if not null it will be used as default time zone if no time zone is given - if not set the system time zone will be used

shouldIncludeRawSyslogmessage

boolean shouldIncludeRawSyslogmessage()

Indicates whether or not to include the raw syslog message as an event parameter on events generated by Syslogd.

Default behavior is false unless configured otherwise.

Returns:

whether or not to include the raw syslog message as an event parameter on events generated by Syslogd

reload

void reload()
     throws IOException

reload configuration

Throws:

IOException