org.opennms.netmgt.config.syslogd

Class Configuration

java.lang.Object

org.opennms.netmgt.config.syslogd.Configuration

All Implemented Interfaces:

Serializable

public class Configuration
extends Object
implements Serializable

Top-level element for the syslogd-configuration.xml configuration file.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Configuration()

Method Summary

Modifier and Type	Method and Description
void	deleteBatchInterval()
void	deleteBatchSize()
void	deleteMatchingGroupHost()
void	deleteMatchingGroupMessage()
void	deleteNewSuspectOnMessage()
void	deleteQueueSize()
void	deleteSyslogPort()
void	deleteThreads()
boolean	equals(Object obj) Overrides the Object.equals method.
Integer	getBatchInterval() Returns the value of field 'batchInterval'.
Integer	getBatchSize() Returns the value of field 'batchSize'.
String	getDiscardUei() Returns the value of field 'discardUei'.
String	getForwardingRegexp() Returns the value of field 'forwardingRegexp'.
String	getListenAddress() Returns the value of field 'listenAddress'.
Integer	getMatchingGroupHost() Returns the value of field 'matchingGroupHost'.
Integer	getMatchingGroupMessage() Returns the value of field 'matchingGroupMessage'.
Boolean	getNewSuspectOnMessage() Returns the value of field 'newSuspectOnMessage'.
String	getParser() Returns the value of field 'parser'.
Integer	getQueueSize() Returns the value of field 'queueSize'.
Integer	getSyslogPort() Returns the value of field 'syslogPort'.
Integer	getThreads() Returns the value of field 'threads'.
boolean	hasBatchInterval() Method hasBatchInterval.
boolean	hasBatchSize() Method hasBatchSize.
int	hashCode() Method hashCode.
boolean	hasMatchingGroupHost() Method hasMatchingGroupHost.
boolean	hasMatchingGroupMessage() Method hasMatchingGroupMessage.
boolean	hasNewSuspectOnMessage() Method hasNewSuspectOnMessage.
boolean	hasQueueSize() Method hasQueueSize.
boolean	hasSyslogPort() Method hasSyslogPort.
boolean	hasThreads() Method hasThreads.
Boolean	isNewSuspectOnMessage() Returns the value of field 'newSuspectOnMessage'.
void	setBatchInterval(Integer batchInterval) Sets the value of field 'batchInterval'.
void	setBatchSize(Integer batchSize) Sets the value of field 'batchSize'.
void	setDiscardUei(String discardUei) Sets the value of field 'discardUei'.
void	setForwardingRegexp(String forwardingRegexp) Sets the value of field 'forwardingRegexp'.
void	setListenAddress(String listenAddress) Sets the value of field 'listenAddress'.
void	setMatchingGroupHost(Integer matchingGroupHost) Sets the value of field 'matchingGroupHost'.
void	setMatchingGroupMessage(Integer matchingGroupMessage) Sets the value of field 'matchingGroupMessage'.
void	setNewSuspectOnMessage(Boolean newSuspectOnMessage) Sets the value of field 'newSuspectOnMessage'.
void	setParser(String parser) Sets the value of field 'parser'.
void	setQueueSize(Integer queueSize) Sets the value of field 'queueSize'.
void	setSyslogPort(Integer syslogPort) Sets the value of field 'syslogPort'.
void	setThreads(Integer threads) Sets the value of field 'threads'.

Methods inherited from class java.lang.Object

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

Constructor Detail

Configuration

public Configuration()

Method Detail

deleteBatchInterval

public void deleteBatchInterval()

deleteBatchSize

public void deleteBatchSize()

deleteMatchingGroupHost

public void deleteMatchingGroupHost()

deleteMatchingGroupMessage

public void deleteMatchingGroupMessage()

deleteNewSuspectOnMessage

public void deleteNewSuspectOnMessage()

deleteQueueSize

public void deleteQueueSize()

deleteSyslogPort

public void deleteSyslogPort()

deleteThreads

public void deleteThreads()

equals

public boolean equals(Object obj)

Overrides the Object.equals method.

Overrides:

equals in class Object

Parameters:

obj -

Returns:

true if the objects are equal.

getBatchInterval

public Integer getBatchInterval()

Returns the value of field 'batchInterval'. The field 'batchInterval' has the following description: Messages are aggregated in batches before being dispatched. When the batch has been created for longer than this interval (ms) it will be dispatched, regardless of the current size.

Returns:

the value of field 'BatchInterval'.

getBatchSize

public Integer getBatchSize()

Returns the value of field 'batchSize'. The field 'batchSize' has the following description: Messages are aggregated in batches before being dispatched. When the batch reaches this size, it will be dispatched.

Returns:

the value of field 'BatchSize'.

getDiscardUei

public String getDiscardUei()

Returns the value of field 'discardUei'. The field 'discardUei' has the following description: A string which, when used as the value of a "uei" element inside a "ueiMatch" element, results in all matching messages to be discarded without an event ever being created

Returns:

the value of field 'DiscardUei'.

getForwardingRegexp

public String getForwardingRegexp()

Returns the value of field 'forwardingRegexp'. The field 'forwardingRegexp' has the following description: The regular expression used to separate message and host.

Returns:

the value of field 'ForwardingRegexp'.

getListenAddress

public String getListenAddress()

Returns the value of field 'listenAddress'. The field 'listenAddress' has the following description: The address on which Syslogd listens for SYSLOG Messages. The default is to listen on all addresses.

Returns:

the value of field 'ListenAddress'.

getMatchingGroupHost

public Integer getMatchingGroupHost()

Returns the value of field 'matchingGroupHost'. The field 'matchingGroupHost' has the following description: The matching group for the host

Returns:

the value of field 'MatchingGroupHost'.

getMatchingGroupMessage

public Integer getMatchingGroupMessage()

Returns the value of field 'matchingGroupMessage'. The field 'matchingGroupMessage' has the following description: The matching group for the message

Returns:

the value of field 'MatchingGroupMessage'.

getNewSuspectOnMessage

public Boolean getNewSuspectOnMessage()

Returns the value of field 'newSuspectOnMessage'. The field 'newSuspectOnMessage' has the following description: Whether messages from devices unknown to OpenNMS should generate newSuspect events.

Returns:

the value of field 'NewSuspectOnMessage'.

getParser

public String getParser()

Returns the value of field 'parser'. The field 'parser' has the following description: A string which defines the class to use when parsing syslog messages. The default is the "CustomSyslogParser", which honors the forwarding-regexp, matching-group-host, and matching-group-message attributes, and can parse most BSD-style Syslog messages, including Syslog-NG's default format. Other options include "org.opennms.netmgt.syslogd.SyslogNGParser" which is a slightly more strict version of the CustomSyslogParser, and "org.opennms.netmgt.syslogd.Rfc5424SyslogParser" which can handle the recent (2009) RFC for syslog messages.

Returns:

the value of field 'Parser'.

getQueueSize

public Integer getQueueSize()

Returns the value of field 'queueSize'. The field 'queueSize' has the following description: Maximum number of messages to keep in memory while waiting to be dispatched.

Returns:

the value of field 'QueueSize'.

getSyslogPort

public Integer getSyslogPort()

Returns the value of field 'syslogPort'. The field 'syslogPort' has the following description: The port on which Syslogd listens for SYSLOG Messages. The standard port is 514.

Returns:

the value of field 'SyslogPort'.

getThreads

public Integer getThreads()

Returns the value of field 'threads'. The field 'threads' has the following description: Number of threads used for consuming/dispatching messages. Defaults to 2 x the number of available processors.

Returns:

the value of field 'Threads'.

hasBatchInterval

public boolean hasBatchInterval()

Method hasBatchInterval.

Returns:

true if at least one BatchInterval has been added

hasBatchSize

public boolean hasBatchSize()

Method hasBatchSize.

Returns:

true if at least one BatchSize has been added

hasMatchingGroupHost

public boolean hasMatchingGroupHost()

Method hasMatchingGroupHost.

Returns:

true if at least one MatchingGroupHost has been added

hasMatchingGroupMessage

public boolean hasMatchingGroupMessage()

Method hasMatchingGroupMessage.

Returns:

true if at least one MatchingGroupMessage has been added

hasNewSuspectOnMessage

public boolean hasNewSuspectOnMessage()

Method hasNewSuspectOnMessage.

Returns:

true if at least one NewSuspectOnMessage has been added

hasQueueSize

public boolean hasQueueSize()

Method hasQueueSize.

Returns:

true if at least one QueueSize has been added

hasSyslogPort

public boolean hasSyslogPort()

Method hasSyslogPort.

Returns:

true if at least one SyslogPort has been added

hasThreads

public boolean hasThreads()

Method hasThreads.

Returns:

true if at least one Threads has been added

hashCode

public int hashCode()

Method hashCode.

Overrides:

hashCode in class Object

Returns:

a hash code value for the object.

isNewSuspectOnMessage

public Boolean isNewSuspectOnMessage()

Returns the value of field 'newSuspectOnMessage'. The field 'newSuspectOnMessage' has the following description: Whether messages from devices unknown to OpenNMS should generate newSuspect events.

Returns:

the value of field 'NewSuspectOnMessage'.

setBatchInterval

public void setBatchInterval(Integer batchInterval)

Sets the value of field 'batchInterval'. The field 'batchInterval' has the following description: Messages are aggregated in batches before being dispatched. When the batch has been created for longer than this interval (ms) it will be dispatched, regardless of the current size.

Parameters:

batchInterval - the value of field 'batchInterval'.

setBatchSize

public void setBatchSize(Integer batchSize)

Sets the value of field 'batchSize'. The field 'batchSize' has the following description: Messages are aggregated in batches before being dispatched. When the batch reaches this size, it will be dispatched.

Parameters:

batchSize - the value of field 'batchSize'.

setDiscardUei

public void setDiscardUei(String discardUei)

Sets the value of field 'discardUei'. The field 'discardUei' has the following description: A string which, when used as the value of a "uei" element inside a "ueiMatch" element, results in all matching messages to be discarded without an event ever being created

Parameters:

discardUei - the value of field 'discardUei'.

setForwardingRegexp

public void setForwardingRegexp(String forwardingRegexp)

Sets the value of field 'forwardingRegexp'. The field 'forwardingRegexp' has the following description: The regular expression used to separate message and host.

Parameters:

forwardingRegexp - the value of field 'forwardingRegexp'.

setListenAddress

public void setListenAddress(String listenAddress)

Sets the value of field 'listenAddress'. The field 'listenAddress' has the following description: The address on which Syslogd listens for SYSLOG Messages. The default is to listen on all addresses.

Parameters:

listenAddress - the value of field 'listenAddress'.

setMatchingGroupHost

public void setMatchingGroupHost(Integer matchingGroupHost)

Sets the value of field 'matchingGroupHost'. The field 'matchingGroupHost' has the following description: The matching group for the host

Parameters:

matchingGroupHost - the value of field 'matchingGroupHost'.

setMatchingGroupMessage

public void setMatchingGroupMessage(Integer matchingGroupMessage)

Sets the value of field 'matchingGroupMessage'. The field 'matchingGroupMessage' has the following description: The matching group for the message

Parameters:

matchingGroupMessage - the value of field 'matchingGroupMessage'.

setNewSuspectOnMessage

public void setNewSuspectOnMessage(Boolean newSuspectOnMessage)

Sets the value of field 'newSuspectOnMessage'. The field 'newSuspectOnMessage' has the following description: Whether messages from devices unknown to OpenNMS should generate newSuspect events.

Parameters:

newSuspectOnMessage - the value of field 'newSuspectOnMessage'.

setParser

public void setParser(String parser)

Sets the value of field 'parser'. The field 'parser' has the following description: A string which defines the class to use when parsing syslog messages. The default is the "CustomSyslogParser", which honors the forwarding-regexp, matching-group-host, and matching-group-message attributes, and can parse most BSD-style Syslog messages, including Syslog-NG's default format. Other options include "org.opennms.netmgt.syslogd.SyslogNGParser" which is a slightly more strict version of the CustomSyslogParser, and "org.opennms.netmgt.syslogd.Rfc5424SyslogParser" which can handle the recent (2009) RFC for syslog messages.

Parameters:

parser - the value of field 'parser'.

setQueueSize

public void setQueueSize(Integer queueSize)

Sets the value of field 'queueSize'. The field 'queueSize' has the following description: Maximum number of messages to keep in memory while waiting to be dispatched.

Parameters:

queueSize - the value of field 'queueSize'.

setSyslogPort

public void setSyslogPort(Integer syslogPort)

Sets the value of field 'syslogPort'. The field 'syslogPort' has the following description: The port on which Syslogd listens for SYSLOG Messages. The standard port is 514.

Parameters:

syslogPort - the value of field 'syslogPort'.

setThreads

public void setThreads(Integer threads)

Sets the value of field 'threads'. The field 'threads' has the following description: Number of threads used for consuming/dispatching messages. Defaults to 2 x the number of available processors.

Parameters:

threads - the value of field 'threads'.