Package org.opennms.netmgt.syslogd

Class ConvertToEvent

java.lang.Object

org.opennms.netmgt.syslogd.ConvertToEvent

public class ConvertToEvent
extends Object

This routine does the majority of Syslogd's work. Improvements are most likely to be made. TODO: This class is sloooow. It needs to be sped up significantly to handle increased syslog volume.

Author:

Seth, Johan Edstrom, Mathew Brozowski, DJ Gregor, Mike Huot, Jeff Gehlbach, Brian Weaver

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	HIDDEN_MESSAGE	Constant HIDDEN_MESSAGE="The message logged has been removed due"{trunked}

Constructor Summary

Constructors

Constructor	Description
ConvertToEvent(String systemId, String location, InetAddress addr, int port, ByteBuffer incoming, Date receivedTimestamp, SyslogdConfig config, LocationAwareDnsLookupClient locationAwareDnsLookupClient, com.google.common.cache.Cache<HostNameWithLocationKey,String> dnsCache)	Constructs a new event encapsulation instance based upon the information passed to the method.
ConvertToEvent(String systemId, String location, InetAddress addr, int port, ByteBuffer incoming, SyslogdConfig config, LocationAwareDnsLookupClient locationAwareDnsLookupClient)	Constructs a new event encapsulation instance based upon the information passed to the method.

Method Summary

Modifier and Type	Method	Description
Event	getEvent()	getEvent
static EventBuilder	toEventBuilder(SyslogMessage message, String systemId, String location)
static EventBuilder	toEventBuilder(SyslogMessage message, String systemId, String location, Date receivedTimestamp, LocationAwareDnsLookupClient locationAwareDnsLookupClient, com.google.common.cache.Cache<HostNameWithLocationKey,String> dnsCache)
String	toString()	toString
static ByteBuffer	trimTrailingNulls(ByteBuffer original)	Reduce the limit of the buffer to trim trailing nulls from the value.

Methods inherited from class java.lang.Object

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

Field Detail

HIDDEN_MESSAGE

protected static final String HIDDEN_MESSAGE

Constant HIDDEN_MESSAGE="The message logged has been removed due"{trunked}

See Also:

Constant Field Values

Constructor Detail

ConvertToEvent

public ConvertToEvent(String systemId,
                      String location,
                      InetAddress addr,
                      int port,
                      ByteBuffer incoming,
                      SyslogdConfig config,
                      LocationAwareDnsLookupClient locationAwareDnsLookupClient)
               throws MessageDiscardedException

Constructs a new event encapsulation instance based upon the information passed to the method. The passed byte array is decoded into a string using the StandardCharsets.US_ASCII character encoding.

Parameters:

systemId -

location -

addr - The remote agent's address.

port - The remote agent's port

incoming - The syslog datagram in StandardCharsets.US_ASCII encoding.

config - The Syslogd configuration

Throws:

MessageDiscardedException

ConvertToEvent

public ConvertToEvent(String systemId,
                      String location,
                      InetAddress addr,
                      int port,
                      ByteBuffer incoming,
                      Date receivedTimestamp,
                      SyslogdConfig config,
                      LocationAwareDnsLookupClient locationAwareDnsLookupClient,
                      com.google.common.cache.Cache<HostNameWithLocationKey,String> dnsCache)
               throws MessageDiscardedException

Constructs a new event encapsulation instance based upon the information passed to the method. The passed byte array is decoded into a string using the StandardCharsets.US_ASCII character encoding.

Parameters:

systemId -

location -

addr - The remote agent's address.

port - The remote agent's port

incoming - The syslog datagram in StandardCharsets.US_ASCII encoding.

receivedTimestamp - the time the message was received

config - The Syslogd configuration

locationAwareDnsLookupClient - Location Aware DNS Lookup Client

dnsCache -

Throws:

MessageDiscardedException

Method Detail

trimTrailingNulls

public static ByteBuffer trimTrailingNulls(ByteBuffer original)

Reduce the limit of the buffer to trim trailing nulls from the value.

Parameters:

original - ByteBuffer

Returns:

A new ByteBuffer representing the trimmed value.

toEventBuilder

public static final EventBuilder toEventBuilder(SyslogMessage message,
                                                String systemId,
                                                String location)

toEventBuilder

public static final EventBuilder toEventBuilder(SyslogMessage message,
                                                String systemId,
                                                String location,
                                                Date receivedTimestamp,
                                                LocationAwareDnsLookupClient locationAwareDnsLookupClient,
                                                com.google.common.cache.Cache<HostNameWithLocationKey,String> dnsCache)

getEvent

public Event getEvent()

getEvent

Returns:

a Event object.

toString

public String toString()

toString

Overrides:

toString in class Object

Returns:

a String object.