org.apache.log.format

Class SyslogFormatter

Implemented Interfaces:
Formatter, Formatter

public class SyslogFormatter
extends java.lang.Object
implements Formatter, Formatter

A formatter that serializes in the format originally used by BSD syslog daemon.
Author:
Peter Donald

Field Summary

static int
FACILITY_AUTH
static int
FACILITY_AUTHPRIV
static int
FACILITY_CRON
static int
FACILITY_DAEMON
protected static String[]
FACILITY_DESCRIPTIONS
static int
FACILITY_FTP
static int
FACILITY_KERN
static int
FACILITY_LOCAL0
static int
FACILITY_LOCAL1
static int
FACILITY_LOCAL2
static int
FACILITY_LOCAL3
static int
FACILITY_LOCAL4
static int
FACILITY_LOCAL5
static int
FACILITY_LOCAL6
static int
FACILITY_LOCAL7
static int
FACILITY_LPR
static int
FACILITY_MAIL
static int
FACILITY_NEWS
static int
FACILITY_SYSLOG
static int
FACILITY_USER
static int
FACILITY_UUCP
static int
PRIORITY_ALERT
static int
PRIORITY_CRIT
static int
PRIORITY_DEBUG
static int
PRIORITY_EMERG
static int
PRIORITY_ERR
static int
PRIORITY_INFO
static int
PRIORITY_NOTICE
static int
PRIORITY_WARNING

Constructor Summary

SyslogFormatter()
Constructor that assumes FACILITY_USER.
SyslogFormatter(int facility)
Constructor so that you can associate facility with formatter.
SyslogFormatter(int facility, boolean showFacilityBanner)
Constructor allowing setting of facility and whether to show banner.

Method Summary

String
format(LogEvent event)
Format log event into syslog string.
protected String
getFacilityDescription(int facility)
Retrieve description for facility.
protected int
getSyslogFacility(LogEvent event)
Get facility associated with event.
protected int
getSyslogPriority(LogEvent event)
Get syslog priority code for LogEvent.

Field Details

FACILITY_AUTH

public static final int FACILITY_AUTH
Field Value:
32

FACILITY_AUTHPRIV

public static final int FACILITY_AUTHPRIV
Field Value:
80

FACILITY_CRON

public static final int FACILITY_CRON
Field Value:
72

FACILITY_DAEMON

public static final int FACILITY_DAEMON
Field Value:
24

FACILITY_DESCRIPTIONS

protected static final String[] FACILITY_DESCRIPTIONS

FACILITY_FTP

public static final int FACILITY_FTP
Field Value:
88

FACILITY_KERN

public static final int FACILITY_KERN
Field Value:
0

FACILITY_LOCAL0

public static final int FACILITY_LOCAL0
Field Value:
128

FACILITY_LOCAL1

public static final int FACILITY_LOCAL1
Field Value:
136

FACILITY_LOCAL2

public static final int FACILITY_LOCAL2
Field Value:
144

FACILITY_LOCAL3

public static final int FACILITY_LOCAL3
Field Value:
152

FACILITY_LOCAL4

public static final int FACILITY_LOCAL4
Field Value:
160

FACILITY_LOCAL5

public static final int FACILITY_LOCAL5
Field Value:
168

FACILITY_LOCAL6

public static final int FACILITY_LOCAL6
Field Value:
176

FACILITY_LOCAL7

public static final int FACILITY_LOCAL7
Field Value:
184

FACILITY_LPR

public static final int FACILITY_LPR
Field Value:
48

FACILITY_MAIL

public static final int FACILITY_MAIL
Field Value:
16

FACILITY_NEWS

public static final int FACILITY_NEWS
Field Value:
56

FACILITY_SYSLOG

public static final int FACILITY_SYSLOG
Field Value:
40

FACILITY_USER

public static final int FACILITY_USER
Field Value:
8

FACILITY_UUCP

public static final int FACILITY_UUCP
Field Value:
64

PRIORITY_ALERT

public static final int PRIORITY_ALERT
Field Value:
1

PRIORITY_CRIT

public static final int PRIORITY_CRIT
Field Value:
2

PRIORITY_DEBUG

public static final int PRIORITY_DEBUG
Field Value:
7

PRIORITY_EMERG

public static final int PRIORITY_EMERG
Field Value:
0

PRIORITY_ERR

public static final int PRIORITY_ERR
Field Value:
3

PRIORITY_INFO

public static final int PRIORITY_INFO
Field Value:
6

PRIORITY_NOTICE

public static final int PRIORITY_NOTICE
Field Value:
5

PRIORITY_WARNING

public static final int PRIORITY_WARNING
Field Value:
4

Constructor Details

SyslogFormatter

public SyslogFormatter()
Constructor that assumes FACILITY_USER.

SyslogFormatter

public SyslogFormatter(int facility)
Constructor so that you can associate facility with formatter.
Parameters:
facility - the facility constant

SyslogFormatter

public SyslogFormatter(int facility,
                       boolean showFacilityBanner)
Constructor allowing setting of facility and whether to show banner.
Parameters:
facility - the facility code.
showFacilityBanner - true if facility banner should be shown

Method Details

format

public String format(LogEvent event)
Format log event into syslog string.
Specified by:
format in interface Formatter
format in interface Formatter
Parameters:
event - the event
Returns:
the formatted string

getFacilityDescription

protected String getFacilityDescription(int facility)
Retrieve description for facility.
Parameters:
facility - the facility code
Returns:
the facility description

getSyslogFacility

protected int getSyslogFacility(LogEvent event)
Get facility associated with event. Default implementation returns facility set in constructor.
Parameters:
event - the log event
Returns:
the facility code

getSyslogPriority

protected int getSyslogPriority(LogEvent event)
Get syslog priority code for LogEvent. This is done by translating LogKit priority to syslog priority.
Parameters:
event - the log event
Returns:
the priority code