org.apache.log.format

Class SyslogFormatter

public class SyslogFormatter extends Object implements Formatter

A formatter that serializes in the format originally used by BSD syslog daemon.

Author: Peter Donald

Field Summary
static intFACILITY_AUTH
static intFACILITY_AUTHPRIV
static intFACILITY_CRON
static intFACILITY_DAEMON
protected static String[]FACILITY_DESCRIPTIONS
static intFACILITY_FTP
static intFACILITY_KERN
static intFACILITY_LOCAL0
static intFACILITY_LOCAL1
static intFACILITY_LOCAL2
static intFACILITY_LOCAL3
static intFACILITY_LOCAL4
static intFACILITY_LOCAL5
static intFACILITY_LOCAL6
static intFACILITY_LOCAL7
static intFACILITY_LPR
static intFACILITY_MAIL
static intFACILITY_NEWS
static intFACILITY_SYSLOG
static intFACILITY_USER
static intFACILITY_UUCP
intm_facility
booleanm_showFacilityBanner
static intPRIORITY_ALERT
static intPRIORITY_CRIT
static intPRIORITY_DEBUG
static intPRIORITY_EMERG
static intPRIORITY_ERR
static intPRIORITY_INFO
static intPRIORITY_NOTICE
static intPRIORITY_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
Stringformat(LogEvent event)
Format log event into syslog string.
protected StringgetFacilityDescription(int facility)
Retrieve description for facility.
protected intgetSyslogFacility(LogEvent event)
Get facility associated with event.
protected intgetSyslogPriority(LogEvent event)
Get syslog priority code for LogEvent.

Field Detail

FACILITY_AUTH

public static final int FACILITY_AUTH

FACILITY_AUTHPRIV

public static final int FACILITY_AUTHPRIV

FACILITY_CRON

public static final int FACILITY_CRON

FACILITY_DAEMON

public static final int FACILITY_DAEMON

FACILITY_DESCRIPTIONS

protected static final String[] FACILITY_DESCRIPTIONS

FACILITY_FTP

public static final int FACILITY_FTP

FACILITY_KERN

public static final int FACILITY_KERN

FACILITY_LOCAL0

public static final int FACILITY_LOCAL0

FACILITY_LOCAL1

public static final int FACILITY_LOCAL1

FACILITY_LOCAL2

public static final int FACILITY_LOCAL2

FACILITY_LOCAL3

public static final int FACILITY_LOCAL3

FACILITY_LOCAL4

public static final int FACILITY_LOCAL4

FACILITY_LOCAL5

public static final int FACILITY_LOCAL5

FACILITY_LOCAL6

public static final int FACILITY_LOCAL6

FACILITY_LOCAL7

public static final int FACILITY_LOCAL7

FACILITY_LPR

public static final int FACILITY_LPR

FACILITY_MAIL

public static final int FACILITY_MAIL

FACILITY_NEWS

public static final int FACILITY_NEWS

FACILITY_SYSLOG

public static final int FACILITY_SYSLOG

FACILITY_USER

public static final int FACILITY_USER

FACILITY_UUCP

public static final int FACILITY_UUCP

m_facility

private int m_facility

m_showFacilityBanner

private boolean m_showFacilityBanner

PRIORITY_ALERT

public static final int PRIORITY_ALERT

PRIORITY_CRIT

public static final int PRIORITY_CRIT

PRIORITY_DEBUG

public static final int PRIORITY_DEBUG

PRIORITY_EMERG

public static final int PRIORITY_EMERG

PRIORITY_ERR

public static final int PRIORITY_ERR

PRIORITY_INFO

public static final int PRIORITY_INFO

PRIORITY_NOTICE

public static final int PRIORITY_NOTICE

PRIORITY_WARNING

public static final int PRIORITY_WARNING

Constructor Detail

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 Detail

format

public String format(LogEvent event)
Format log event into syslog string.

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