org.apache.nifi.syslog.parsers

Class SyslogParser

java.lang.Object

org.apache.nifi.syslog.parsers.SyslogParser

public class SyslogParser
extends Object

Parses a Syslog message from a ByteBuffer into a SyslogEvent instance. The Syslog regular expressions below were adapted from the Apache Flume project.

Field Summary

Fields

Modifier and Type	Field and Description
private Charset	charset
static Collection<Pattern>	MESSAGE_PATTERNS
static int	SYSLOG_BODY_POS
static int	SYSLOG_HOSTNAME_POS
static String	SYSLOG_MSG_RFC3164_0
static String	SYSLOG_MSG_RFC5424_0
static int	SYSLOG_PRIORITY_POS
static int	SYSLOG_TIMESTAMP_POS
static int	SYSLOG_VERSION_POS

Constructor Summary

Constructors

Constructor and Description
SyslogParser()
SyslogParser(Charset charset)

Method Summary

Modifier and Type	Method and Description
String	getCharsetName()
SyslogEvent	parseEvent(byte[] bytes, String sender) Parses a SyslogEvent from a byte array.
SyslogEvent	parseEvent(ByteBuffer buffer) Parses a SyslogEvent from a byte buffer.
SyslogEvent	parseEvent(ByteBuffer buffer, String sender) Parses a SyslogEvent from a byte buffer.

Methods inherited from class java.lang.Object

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

Field Detail

SYSLOG_MSG_RFC5424_0

public static final String SYSLOG_MSG_RFC5424_0

See Also:

Constant Field Values

SYSLOG_MSG_RFC3164_0

public static final String SYSLOG_MSG_RFC3164_0

See Also:

Constant Field Values

MESSAGE_PATTERNS

public static final Collection<Pattern> MESSAGE_PATTERNS

SYSLOG_PRIORITY_POS

public static final int SYSLOG_PRIORITY_POS

See Also:

Constant Field Values

SYSLOG_VERSION_POS

public static final int SYSLOG_VERSION_POS

See Also:

Constant Field Values

SYSLOG_TIMESTAMP_POS

public static final int SYSLOG_TIMESTAMP_POS

See Also:

Constant Field Values

SYSLOG_HOSTNAME_POS

public static final int SYSLOG_HOSTNAME_POS

See Also:

Constant Field Values

SYSLOG_BODY_POS

public static final int SYSLOG_BODY_POS

See Also:

Constant Field Values

charset

private Charset charset

Constructor Detail

SyslogParser

public SyslogParser()

SyslogParser

public SyslogParser(Charset charset)

Method Detail

parseEvent

public SyslogEvent parseEvent(ByteBuffer buffer)

Parses a SyslogEvent from a byte buffer.

Parameters:

buffer - a byte buffer containing a syslog message

Returns:

a SyslogEvent parsed from the byte array

parseEvent

public SyslogEvent parseEvent(ByteBuffer buffer,
                              String sender)

Parses a SyslogEvent from a byte buffer.

Parameters:

buffer - a byte buffer containing a syslog message

sender - the hostname of the syslog server that sent the message

Returns:

a SyslogEvent parsed from the byte array

parseEvent

public SyslogEvent parseEvent(byte[] bytes,
                              String sender)

Parses a SyslogEvent from a byte array.

Parameters:

bytes - a byte array containing a syslog message

sender - the hostname of the syslog server that sent the message

Returns:

a SyslogEvent parsed from the byte array

getCharsetName

public String getCharsetName()