Top Description Fields Constructors Methods
org.apache.log.format

public Class SyslogFormatter

extends Object
implements Formatter
Class Inheritance
All Implemented Interfaces
org.apache.log.format.Formatter
Imports
org.apache.log.LogEvent, .Priority
A formatter that serializes in the format originally used by BSD syslog daemon.
Author
Peter Donald

Field Summary

Modifier and TypeField and Description
public static final int
FACILITY_AUTH

public static final int
FACILITY_AUTHPRIV

public static final int
FACILITY_CRON

public static final int
FACILITY_DAEMON

protected static final String[]
FACILITY_DESCRIPTIONS

public static final int
FACILITY_FTP

public static final int
FACILITY_KERN

public static final int
FACILITY_LOCAL0

public static final int
FACILITY_LOCAL1

public static final int
FACILITY_LOCAL2

public static final int
FACILITY_LOCAL3

public static final int
FACILITY_LOCAL4

public static final int
FACILITY_LOCAL5

public static final int
FACILITY_LOCAL6

public static final int
FACILITY_LOCAL7

public static final int
FACILITY_LPR

public static final int
FACILITY_MAIL

public static final int
FACILITY_NEWS

public static final int
FACILITY_SYSLOG

public static final int
FACILITY_USER

public static final int
FACILITY_UUCP

private int
m_facility

private boolean
m_showFacilityBanner

public static final int
PRIORITY_ALERT

public static final int
PRIORITY_CRIT

public static final int
PRIORITY_DEBUG

public static final int
PRIORITY_EMERG

public static final int
PRIORITY_ERR

public static final int
PRIORITY_INFO

public static final int
PRIORITY_NOTICE

public static final int
PRIORITY_WARNING

Constructor Summary

AccessConstructor and Description
public
SyslogFormatter()

Constructor that assumes FACILITY_USER.

public
SyslogFormatter(final int
the facility constant
facility)

Constructor so that you can associate facility with formatter.

public
SyslogFormatter(final int
the facility code.
facility, final boolean
true if facility banner should be shown
showFacilityBanner)

Constructor allowing setting of facility and whether to show banner.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the formatted string
format(final LogEvent
the event
event)

Implements org.apache.log.format.Formatter.format.

Format log event into syslog string.
protected String

Returns:

the facility description
getFacilityDescription(final int
the facility code
facility)

Retrieve description for facility.

protected int

Returns:

the facility code
getSyslogFacility(final LogEvent
the log event
event)

Get facility associated with event.

protected int

Returns:

the priority code
getSyslogPriority(final LogEvent
the log event
event)

Get syslog priority code for LogEvent.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

FACILITY_AUTHback to summary
public static final int FACILITY_AUTH
FACILITY_AUTHPRIVback to summary
public static final int FACILITY_AUTHPRIV
FACILITY_CRONback to summary
public static final int FACILITY_CRON
FACILITY_DAEMONback to summary
public static final int FACILITY_DAEMON
FACILITY_DESCRIPTIONSback to summary
protected static final String[] FACILITY_DESCRIPTIONS
FACILITY_FTPback to summary
public static final int FACILITY_FTP
FACILITY_KERNback to summary
public static final int FACILITY_KERN
FACILITY_LOCAL0back to summary
public static final int FACILITY_LOCAL0
FACILITY_LOCAL1back to summary
public static final int FACILITY_LOCAL1
FACILITY_LOCAL2back to summary
public static final int FACILITY_LOCAL2
FACILITY_LOCAL3back to summary
public static final int FACILITY_LOCAL3
FACILITY_LOCAL4back to summary
public static final int FACILITY_LOCAL4
FACILITY_LOCAL5back to summary
public static final int FACILITY_LOCAL5
FACILITY_LOCAL6back to summary
public static final int FACILITY_LOCAL6
FACILITY_LOCAL7back to summary
public static final int FACILITY_LOCAL7
FACILITY_LPRback to summary
public static final int FACILITY_LPR
FACILITY_MAILback to summary
public static final int FACILITY_MAIL
FACILITY_NEWSback to summary
public static final int FACILITY_NEWS
FACILITY_SYSLOGback to summary
public static final int FACILITY_SYSLOG
FACILITY_USERback to summary
public static final int FACILITY_USER
FACILITY_UUCPback to summary
public static final int FACILITY_UUCP
m_facilityback to summary
private int m_facility
m_showFacilityBannerback to summary
private boolean m_showFacilityBanner
PRIORITY_ALERTback to summary
public static final int PRIORITY_ALERT
PRIORITY_CRITback to summary
public static final int PRIORITY_CRIT
PRIORITY_DEBUGback to summary
public static final int PRIORITY_DEBUG
PRIORITY_EMERGback to summary
public static final int PRIORITY_EMERG
PRIORITY_ERRback to summary
public static final int PRIORITY_ERR
PRIORITY_INFOback to summary
public static final int PRIORITY_INFO
PRIORITY_NOTICEback to summary
public static final int PRIORITY_NOTICE
PRIORITY_WARNINGback to summary
public static final int PRIORITY_WARNING

Constructor Detail

SyslogFormatterback to summary
public SyslogFormatter()

Constructor that assumes FACILITY_USER.

SyslogFormatterback to summary
public SyslogFormatter(final int facility)

Constructor so that you can associate facility with formatter.

Parameters
facility:int

the facility constant

SyslogFormatterback to summary
public SyslogFormatter(final int facility, final boolean showFacilityBanner)

Constructor allowing setting of facility and whether to show banner.

Parameters
facility:int

the facility code.

showFacilityBanner:boolean

true if facility banner should be shown

Method Detail

formatback to summary
public String format(final LogEvent event)

Implements org.apache.log.format.Formatter.format.

Format log event into syslog string.

Parameters
event:LogEvent

the event

Returns:String

the formatted string

getFacilityDescriptionback to summary
protected String getFacilityDescription(final int facility)

Retrieve description for facility.

Parameters
facility:int

the facility code

Returns:String

the facility description

getSyslogFacilityback to summary
protected int getSyslogFacility(final LogEvent event)

Get facility associated with event. Default implementation returns facility set in constructor.

Parameters
event:LogEvent

the log event

Returns:int

the facility code

getSyslogPriorityback to summary
protected int getSyslogPriority(final LogEvent event)

Get syslog priority code for LogEvent. This is done by translating LogKit priority to syslog priority.

Parameters
event:LogEvent

the log event

Returns:int

the priority code