Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.cloudbees.syslog.Facility Maven / Gradle / Ivy
/*
* Copyright 2010-2014, CloudBees Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.cloudbees.syslog;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.Comparator;
import java.util.HashMap;
import java.util.Map;
/**
* Syslog facility as defined in RFC 5424 - The Syslog Protocol .
*
* See RFC 5427 - Textual Conventions for Syslog Management for the {@link #label}.
*
* @author Cyrille Le Clerc
*/
public enum Facility implements Comparable {
/**
* kernel messages, numerical code 0.
*/
KERN(0, "KERN"),
/**
* user-level messages, numerical code 1.
*/
USER(1, "USER"),
/**
* mail system, numerical code 2.
*/
MAIL(2, "MAIL"),
/**
* system daemons, numerical code 3.
*/
DAEMON(3, "DAEMON"),
/**
* security/authorization messages, numerical code 4.
*/
AUTH(4, "AUTH"),
/**
* messages generated internally by syslogd, numerical code 5.
*/
SYSLOG(5, "SYSLOG"),
/**
* line printer subsystem, numerical code 6.
*/
LPR(6, "LPR"),
/**
* network news subsystem, numerical code 7.
*/
NEWS(7, "NEWS"),
/**
* UUCP subsystem, numerical code 8
*/
UUCP(8, "UUCP"),
/**
* clock daemon, numerical code 9.
*/
CRON(9, "CRON"),
/**
* security/authorization messages, numerical code 10.
*/
AUTHPRIV(10, "AUTHPRIV"),
/**
* ftp daemon, numerical code 11.
*/
FTP(11, "FTP"),
/**
* NTP subsystem, numerical code 12.
*/
NTP(12, "NTP"),
/**
* log audit, numerical code 13.
*/
AUDIT(13, "AUDIT"),
/**
* log alert, numerical code 14.
*/
ALERT(14, "ALERT"),
/**
* clock daemon, numerical code 15.
*/
CLOCK(15, "CLOCK"),
/**
* reserved for local use, numerical code 16.
*/
LOCAL0(16, "LOCAL0"),
/**
* reserved for local use, numerical code 17.
*/
LOCAL1(17, "LOCAL1"),
/**
* reserved for local use, numerical code 18.
*/
LOCAL2(18, "LOCAL2"),
/**
* reserved for local use, numerical code 19.
*/
LOCAL3(19, "LOCAL3"),
/**
* reserved for local use, numerical code 20.
*/
LOCAL4(20, "LOCAL4"),
/**
* reserved for local use, numerical code 21.
*/
LOCAL5(21, "LOCAL5"),
/**
* reserved for local use, numerical code 22.
*/
LOCAL6(22, "LOCAL6"),
/**
* reserved for local use, numerical code 23.
*/
LOCAL7(23, "LOCAL7");
// mapping
private final static Map facilityFromLabel = new HashMap();
private final static Map facilityFromNumericalCode = new HashMap();
static {
for (Facility facility : Facility.values()) {
facilityFromLabel.put(facility.label, facility);
facilityFromNumericalCode.put(facility.numericalCode, facility);
}
}
/**
* Syslog facility numerical code
*/
private final int numericalCode;
/**
* Syslog facility textual code. Not {@code null}
*/
@Nonnull
private final String label;
private Facility(int numericalCode, @Nonnull String label) {
this.numericalCode = numericalCode;
this.label = label;
}
/**
* @param numericalCode Syslog facility numerical code
* @return Syslog facility, not {@code null}
* @throws IllegalArgumentException the given numericalCode is not a valid Syslog facility numerical code
*/
@Nonnull
public static Facility fromNumericalCode(int numericalCode) throws IllegalArgumentException {
Facility facility = facilityFromNumericalCode.get(numericalCode);
if (facility == null) {
throw new IllegalArgumentException("Invalid facility '" + numericalCode + "'");
}
return facility;
}
/**
* @param label Syslog facility textual code. {@code null} or empty returns {@code null}
* @return Syslog facility, {@code null} if given value is {@code null}
* @throws IllegalArgumentException the given value is not a valid Syslog facility textual code
*/
@Nullable
public static Facility fromLabel(String label) throws IllegalArgumentException {
if (label == null || label.isEmpty())
return null;
Facility facility = facilityFromLabel.get(label);
if (facility == null) {
throw new IllegalArgumentException("Invalid facility '" + label + "'");
}
return facility;
}
/**
* Syslog facility numerical code
*/
public int numericalCode() {
return numericalCode;
}
/**
* Syslog facility textual code. Not {@code null}.
*/
public String label() {
return label;
}
/**
* Compare on {@link Facility#numericalCode()}
*/
public static Comparator comparator() {
return new Comparator() {
@Override
public int compare(Facility f1, Facility f2) {
return Integer.compare(f1.numericalCode, f2.numericalCode);
}
};
}
}
