Facility (org.openidentityplatform.commons.parent 2.2.3 Documentation)

java.lang.Object
- java.lang.Enum<Facility>
- - org.forgerock.audit.handlers.syslog.Facility

All Implemented Interfaces:

Serializable, Comparable<Facility>
```
public enum Facility
extends Enum<Facility>
```
Defines the standard Syslog message facilities.

See Also:

RFC-5424 section 6.2.1

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AUTH` Security/authorization messages.
`AUTHPRIV` Security/authorization messages.
`CLOCKD` Clock daemon.
`CRON` Clock daemon.
`DAEMON` System daemons.
`FTP` FTP daemon.
`KERN` Kernel messages.
`LOCAL0` Local use 0 (local0).
`LOCAL1` Local use 1 (local1).
`LOCAL2` Local use 2 (local2).
`LOCAL3` Local use 3 (local3).
`LOCAL4` Local use 4 (local4).
`LOCAL5` Local use 5 (local5).
`LOCAL6` Local use 6 (local6).
`LOCAL7` Local use 7 (local7).
`LOGALERT` Log alert.
`LOGAUDIT` Log audit.
`LPR` Line printer subsystem.
`MAIL` Mail system.
`NEWS` Network news subsystem.
`NTP` NTP subsystem.
`SYSLOG` Messages generated internally by syslogd.
`USER` User-level messages.
`UUCP` UUCP subsystem.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getCode()` Get the syslog code for the facility.
`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

- Enum Constant Detail
  - KERN
```
public static final Facility KERN
```
    Kernel messages.
  - USER
```
public static final Facility USER
```
    User-level messages.
  - MAIL
```
public static final Facility MAIL
```
    Mail system.
  - DAEMON
```
public static final Facility DAEMON
```
    System daemons.
  - AUTH
```
public static final Facility AUTH
```
    Security/authorization messages.
  - SYSLOG
```
public static final Facility SYSLOG
```
    Messages generated internally by syslogd.
  - LPR
```
public static final Facility LPR
```
    Line printer subsystem.
  - NEWS
```
public static final Facility NEWS
```
    Network news subsystem.
  - UUCP
```
public static final Facility UUCP
```
    UUCP subsystem.
  - CRON
```
public static final Facility CRON
```
    Clock daemon.
  - AUTHPRIV
```
public static final Facility AUTHPRIV
```
    Security/authorization messages.
  - FTP
```
public static final Facility FTP
```
    FTP daemon.
  - NTP
```
public static final Facility NTP
```
    NTP subsystem.
  - LOGAUDIT
```
public static final Facility LOGAUDIT
```
    Log audit.
  - LOGALERT
```
public static final Facility LOGALERT
```
    Log alert.
  - CLOCKD
```
public static final Facility CLOCKD
```
    Clock daemon.
  - LOCAL0
```
public static final Facility LOCAL0
```
    Local use 0 (local0).
  - LOCAL1
```
public static final Facility LOCAL1
```
    Local use 1 (local1).
  - LOCAL2
```
public static final Facility LOCAL2
```
    Local use 2 (local2).
  - LOCAL3
```
public static final Facility LOCAL3
```
    Local use 3 (local3).
  - LOCAL4
```
public static final Facility LOCAL4
```
    Local use 4 (local4).
  - LOCAL5
```
public static final Facility LOCAL5
```
    Local use 5 (local5).
  - LOCAL6
```
public static final Facility LOCAL6
```
    Local use 6 (local6).
  - LOCAL7
```
public static final Facility LOCAL7
```
    Local use 7 (local7).
- 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
  - getCode
```
public int getCode()
```
    Get the syslog code for the facility.
    
    Returns:
    
    The code.

Enum Facility

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

KERN

USER

MAIL

DAEMON

AUTH

SYSLOG

LPR

NEWS

UUCP

CRON

AUTHPRIV

FTP

NTP

LOGAUDIT

LOGALERT

CLOCKD

LOCAL0

LOCAL1

LOCAL2

LOCAL3

LOCAL4

LOCAL5

LOCAL6

LOCAL7

Method Detail

values

valueOf

getCode