Package org.apache.log.format
Class SyslogFormatter
java.lang.Object
org.apache.log.format.SyslogFormatter
- All Implemented Interfaces:
Formatter
A formatter that serializes in the format originally
used by BSD syslog daemon.
- Author:
- Peter Donald
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
protected static final String[]
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
private int
private boolean
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
-
Constructor Summary
ConstructorsConstructorDescriptionConstructor 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
Modifier and TypeMethodDescriptionFormat 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
-
PRIORITY_DEBUG
public static final int PRIORITY_DEBUG- See Also:
-
PRIORITY_INFO
public static final int PRIORITY_INFO- See Also:
-
PRIORITY_NOTICE
public static final int PRIORITY_NOTICE- See Also:
-
PRIORITY_WARNING
public static final int PRIORITY_WARNING- See Also:
-
PRIORITY_ERR
public static final int PRIORITY_ERR- See Also:
-
PRIORITY_CRIT
public static final int PRIORITY_CRIT- See Also:
-
PRIORITY_ALERT
public static final int PRIORITY_ALERT- See Also:
-
PRIORITY_EMERG
public static final int PRIORITY_EMERG- See Also:
-
FACILITY_KERN
public static final int FACILITY_KERN- See Also:
-
FACILITY_USER
public static final int FACILITY_USER- See Also:
-
FACILITY_MAIL
public static final int FACILITY_MAIL- See Also:
-
FACILITY_DAEMON
public static final int FACILITY_DAEMON- See Also:
-
FACILITY_AUTH
public static final int FACILITY_AUTH- See Also:
-
FACILITY_SYSLOG
public static final int FACILITY_SYSLOG- See Also:
-
FACILITY_LPR
public static final int FACILITY_LPR- See Also:
-
FACILITY_NEWS
public static final int FACILITY_NEWS- See Also:
-
FACILITY_UUCP
public static final int FACILITY_UUCP- See Also:
-
FACILITY_CRON
public static final int FACILITY_CRON- See Also:
-
FACILITY_AUTHPRIV
public static final int FACILITY_AUTHPRIV- See Also:
-
FACILITY_FTP
public static final int FACILITY_FTP- See Also:
-
FACILITY_LOCAL0
public static final int FACILITY_LOCAL0- See Also:
-
FACILITY_LOCAL1
public static final int FACILITY_LOCAL1- See Also:
-
FACILITY_LOCAL2
public static final int FACILITY_LOCAL2- See Also:
-
FACILITY_LOCAL3
public static final int FACILITY_LOCAL3- See Also:
-
FACILITY_LOCAL4
public static final int FACILITY_LOCAL4- See Also:
-
FACILITY_LOCAL5
public static final int FACILITY_LOCAL5- See Also:
-
FACILITY_LOCAL6
public static final int FACILITY_LOCAL6- See Also:
-
FACILITY_LOCAL7
public static final int FACILITY_LOCAL7- See Also:
-
FACILITY_DESCRIPTIONS
-
m_facility
private int m_facility -
m_showFacilityBanner
private boolean m_showFacilityBanner
-
-
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
Format log event into syslog string. -
getFacilityDescription
Retrieve description for facility.- Parameters:
facility
- the facility code- Returns:
- the facility description
-
getSyslogFacility
Get facility associated with event. Default implementation returns facility set in constructor.- Parameters:
event
- the log event- Returns:
- the facility code
-
getSyslogPriority
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
-