Package org.opennms.netmgt.syslogd

Class SyslogConfigBean

java.lang.Object

org.opennms.netmgt.syslogd.SyslogConfigBean

All Implemented Interfaces:

SyslogdConfig

public final class SyslogConfigBean
extends Object
implements SyslogdConfig

This is a bean container that can be used as a SyslogdConfig service.

Constructor Summary

Constructors

Constructor	Description
SyslogConfigBean()

Method Summary

Modifier and Type	Method	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
void	setBatchIntervalMs(int batchIntervalMs)
void	setBatchSize(int batchSize)
void	setDiscardUei(String discardUei)
void	setForwardingRegexp(String forwardingRegexp)
void	setIncludeRawSyslogmessage(boolean includeRawSyslogmessage)
void	setListenAddress(String listenAddress)
void	setMatchingGroupHost(int matchingGroupHost)
void	setMatchingGroupMessage(int matchingGroupMessage)
void	setNewSuspectOnMessage(boolean newSuspectOnMessage)
void	setNumThreads(int numThreads)
void	setParser(String parser)
void	setQueueSize(int queueSize)
void	setSyslogPort(int syslogPort)
void	setTimeZone(TimeZone timeZone)
boolean	shouldIncludeRawSyslogmessage()	Indicates whether or not to include the raw syslog message as an event parameter on events generated by Syslogd.

Methods inherited from class java.lang.Object

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

Constructor Detail

SyslogConfigBean

public SyslogConfigBean()

Method Detail

getSyslogPort

public int getSyslogPort()

Description copied from interface: SyslogdConfig

getSyslogPort

Specified by:

getSyslogPort in interface SyslogdConfig

Returns:

a int.

setSyslogPort

public void setSyslogPort(int syslogPort)

getListenAddress

public String getListenAddress()

Description copied from interface: SyslogdConfig

getListenAddress

Specified by:

getListenAddress in interface SyslogdConfig

Returns:

a String object.

setListenAddress

public void setListenAddress(String listenAddress)

getNewSuspectOnMessage

public boolean getNewSuspectOnMessage()

Description copied from interface: SyslogdConfig

getNewSuspectOnMessage

Specified by:

getNewSuspectOnMessage in interface SyslogdConfig

Returns:

a boolean.

setNewSuspectOnMessage

public void setNewSuspectOnMessage(boolean newSuspectOnMessage)

getForwardingRegexp

public String getForwardingRegexp()

Description copied from interface: SyslogdConfig

getForwardingRegexp

Specified by:

getForwardingRegexp in interface SyslogdConfig

Returns:

a String object.

setForwardingRegexp

public void setForwardingRegexp(String forwardingRegexp)

getMatchingGroupHost

public Integer getMatchingGroupHost()

Description copied from interface: SyslogdConfig

getMatchingGroupHost

Specified by:

getMatchingGroupHost in interface SyslogdConfig

Returns:

a int.

setMatchingGroupHost

public void setMatchingGroupHost(int matchingGroupHost)

getMatchingGroupMessage

public Integer getMatchingGroupMessage()

Description copied from interface: SyslogdConfig

getMatchingGroupMessage

Specified by:

getMatchingGroupMessage in interface SyslogdConfig

Returns:

a int.

setMatchingGroupMessage

public void setMatchingGroupMessage(int matchingGroupMessage)

getParser

public String getParser()

Description copied from interface: SyslogdConfig

getParser

Specified by:

getParser in interface SyslogdConfig

Returns:

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

setParser

public void setParser(String parser)

getUeiList

public List<UeiMatch> getUeiList()

Description copied from interface: SyslogdConfig

A collection of Strings->UEI's

Specified by:

getUeiList in interface SyslogdConfig

getHideMessages

public List<HideMatch> getHideMessages()

Description copied from interface: SyslogdConfig

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

Specified by:

getHideMessages in interface SyslogdConfig

getDiscardUei

public String getDiscardUei()

Description copied from interface: SyslogdConfig

getDiscardUei

Specified by:

getDiscardUei in interface SyslogdConfig

Returns:

a String object.

setDiscardUei

public void setDiscardUei(String discardUei)

getNumThreads

public int getNumThreads()

Description copied from interface: SyslogdConfig

Number of threads used for consuming/dispatching messages.

Specified by:

getNumThreads in interface SyslogdConfig

Returns:

number of threads

setNumThreads

public void setNumThreads(int numThreads)

getQueueSize

public int getQueueSize()

Description copied from interface: SyslogdConfig

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

Specified by:

getQueueSize in interface SyslogdConfig

Returns:

queue size

setQueueSize

public void setQueueSize(int queueSize)

getBatchSize

public int getBatchSize()

Description copied from interface: SyslogdConfig

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

Specified by:

getBatchSize in interface SyslogdConfig

Returns:

batch size

setBatchSize

public void setBatchSize(int batchSize)

getBatchIntervalMs

public int getBatchIntervalMs()

Description copied from interface: SyslogdConfig

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.

Specified by:

getBatchIntervalMs in interface SyslogdConfig

Returns:

interval in ms

getTimeZone

public TimeZone getTimeZone()

Description copied from interface: SyslogdConfig

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

Specified by:

getTimeZone in interface SyslogdConfig

setTimeZone

public void setTimeZone(TimeZone timeZone)

shouldIncludeRawSyslogmessage

public boolean shouldIncludeRawSyslogmessage()

Description copied from interface: SyslogdConfig

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.

Specified by:

shouldIncludeRawSyslogmessage in interface SyslogdConfig

Returns:

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

setIncludeRawSyslogmessage

public void setIncludeRawSyslogmessage(boolean includeRawSyslogmessage)

setBatchIntervalMs

public void setBatchIntervalMs(int batchIntervalMs)

reload

public void reload()
            throws IOException

Description copied from interface: SyslogdConfig

reload configuration

Specified by:

reload in interface SyslogdConfig

Throws:

IOException