com.cloudbees.syslog

Enum Facility

java.lang.Object

java.lang.Enum<Facility>

com.cloudbees.syslog.Facility

All Implemented Interfaces:

Serializable, Comparable<Facility>

public enum Facility
extends Enum<Facility>
implements Comparable<Facility>

Syslog facility as defined in RFC 5424 - The Syslog Protocol.

See RFC 5427 - Textual Conventions for Syslog Management for the label.

Author:

Cyrille Le Clerc

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALERT log alert, numerical code 14.
AUDIT log audit, numerical code 13.
AUTH security/authorization messages, numerical code 4.
AUTHPRIV security/authorization messages, numerical code 10.
CLOCK clock daemon, numerical code 15.
CRON clock daemon, numerical code 9.
DAEMON system daemons, numerical code 3.
FTP ftp daemon, numerical code 11.
KERN kernel messages, numerical code 0.
LOCAL0 reserved for local use, numerical code 16.
LOCAL1 reserved for local use, numerical code 17.
LOCAL2 reserved for local use, numerical code 18.
LOCAL3 reserved for local use, numerical code 19.
LOCAL4 reserved for local use, numerical code 20.
LOCAL5 reserved for local use, numerical code 21.
LOCAL6 reserved for local use, numerical code 22.
LOCAL7 reserved for local use, numerical code 23.
LPR line printer subsystem, numerical code 6.
MAIL mail system, numerical code 2.
NEWS network news subsystem, numerical code 7.
NTP NTP subsystem, numerical code 12.
SYSLOG messages generated internally by syslogd, numerical code 5.
USER user-level messages, numerical code 1.
UUCP UUCP subsystem, numerical code 8

Method Summary

Methods

Modifier and Type	Method and Description
static Comparator<Facility>	comparator() Compare on numericalCode()
static Facility	fromLabel(String label)
static Facility	fromNumericalCode(int numericalCode)
String	label() Syslog facility textual code.
int	numericalCode() Syslog facility numerical code
static Facility	valueOf(String name) Returns the enum constant of this type with the specified name.
static Facility[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Enum Constant Detail

KERN

public static final Facility KERN

kernel messages, numerical code 0.

USER

public static final Facility USER

user-level messages, numerical code 1.

MAIL

public static final Facility MAIL

mail system, numerical code 2.

DAEMON

public static final Facility DAEMON

system daemons, numerical code 3.

AUTH

public static final Facility AUTH

security/authorization messages, numerical code 4.

SYSLOG

public static final Facility SYSLOG

messages generated internally by syslogd, numerical code 5.

LPR

public static final Facility LPR

line printer subsystem, numerical code 6.

NEWS

public static final Facility NEWS

network news subsystem, numerical code 7.

UUCP

public static final Facility UUCP

UUCP subsystem, numerical code 8

CRON

public static final Facility CRON

clock daemon, numerical code 9.

AUTHPRIV

public static final Facility AUTHPRIV

security/authorization messages, numerical code 10.

FTP

public static final Facility FTP

ftp daemon, numerical code 11.

NTP

public static final Facility NTP

NTP subsystem, numerical code 12.

AUDIT

public static final Facility AUDIT

log audit, numerical code 13.

ALERT

public static final Facility ALERT

log alert, numerical code 14.

CLOCK

public static final Facility CLOCK

clock daemon, numerical code 15.

LOCAL0

public static final Facility LOCAL0

reserved for local use, numerical code 16.

LOCAL1

public static final Facility LOCAL1

reserved for local use, numerical code 17.

LOCAL2

public static final Facility LOCAL2

reserved for local use, numerical code 18.

LOCAL3

public static final Facility LOCAL3

reserved for local use, numerical code 19.

LOCAL4

public static final Facility LOCAL4

reserved for local use, numerical code 20.

LOCAL5

public static final Facility LOCAL5

reserved for local use, numerical code 21.

LOCAL6

public static final Facility LOCAL6

reserved for local use, numerical code 22.

LOCAL7

public static final Facility LOCAL7

reserved for local use, numerical code 23.

Method Detail

values

public static Facility[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Facility c : Facility.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Facility valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

fromNumericalCode

@Nonnull
public static Facility fromNumericalCode(int numericalCode)
                                  throws IllegalArgumentException

Parameters:

numericalCode - Syslog facility numerical code

Returns:

Syslog facility, not null

Throws:

IllegalArgumentException - the given numericalCode is not a valid Syslog facility numerical code

fromLabel

@Nullable
public static Facility fromLabel(String label)
                          throws IllegalArgumentException

Parameters:

label - Syslog facility textual code. null or empty returns null

Returns:

Syslog facility, null if given value is null

Throws:

IllegalArgumentException - the given value is not a valid Syslog facility textual code

numericalCode

public int numericalCode()

Syslog facility numerical code

label

public String label()

Syslog facility textual code. Not null.

comparator

public static Comparator<Facility> comparator()

Compare on numericalCode()