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

Methods

Modifier and Type	Method and Description
void	deleteMatchingGroupHost()
void	deleteMatchingGroupMessage()
void	deleteNewSuspectOnMessage()
void	deleteSyslogPort()
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getDiscardUei() Returns the value of field 'discardUei'.
String	getForwardingRegexp() Returns the value of field 'forwardingRegexp'.
String	getListenAddress() Returns the value of field 'listenAddress'.
int	getMatchingGroupHost() Returns the value of field 'matchingGroupHost'.
int	getMatchingGroupMessage() Returns the value of field 'matchingGroupMessage'.
boolean	getNewSuspectOnMessage() Returns the value of field 'newSuspectOnMessage'.
String	getParser() Returns the value of field 'parser'.
int	getSyslogPort() Returns the value of field 'syslogPort'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	hasMatchingGroupHost() Method hasMatchingGroupHost.
boolean	hasMatchingGroupMessage() Method hasMatchingGroupMessage.
boolean	hasNewSuspectOnMessage() Method hasNewSuspectOnMessage.
boolean	hasSyslogPort() Method hasSyslogPort.
boolean	isNewSuspectOnMessage() Returns the value of field 'newSuspectOnMessage'.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
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(int matchingGroupHost) Sets the value of field 'matchingGroupHost'.
void	setMatchingGroupMessage(int 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	setSyslogPort(int syslogPort) Sets the value of field 'syslogPort'.
static Configuration	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

Configuration

public Configuration()

Method Detail

deleteMatchingGroupHost

public void deleteMatchingGroupHost()

deleteMatchingGroupMessage

public void deleteMatchingGroupMessage()

deleteNewSuspectOnMessage

public void deleteNewSuspectOnMessage()

deleteSyslogPort

public void deleteSyslogPort()

equals

public boolean equals(Object obj)

Overrides the java.lang.Object.equals method.

Overrides:

equals in class Object

Parameters:

obj -

Returns:

true if the objects are equal.

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 int 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 int 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'.

getSyslogPort

public int 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'.

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

hasSyslogPort

public boolean hasSyslogPort()

Method hasSyslogPort.

Returns:

true if at least one SyslogPort has been added

hashCode

public int hashCode()

Overrides the java.lang.Object.hashCode method.

The following steps came from Effective Java Programming Language Guide by Joshua Bloch, Chapter 3

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'.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

marshal

public void marshal(Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

marshal

public void marshal(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

handler -

Throws:

IOException - if an IOException occurs during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

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(int 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(int 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'.

setSyslogPort

public void setSyslogPort(int 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'.

unmarshal

public static Configuration unmarshal(Reader reader)
                               throws org.exolab.castor.xml.MarshalException,
                                      org.exolab.castor.xml.ValidationException

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.opennms.netmgt.config.syslogd.Configuration

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Throws:

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema