com.unboundid.ldap.sdk.unboundidds.logs

Enum ErrorLogSeverity

java.lang.Object

java.lang.Enum<ErrorLogSeverity>

com.unboundid.ldap.sdk.unboundidds.logs.ErrorLogSeverity

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ErrorLogSeverity>

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public enum ErrorLogSeverity
extends java.lang.Enum<ErrorLogSeverity>

This enum contains the set of error log severities defined in the Directory Server.

NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEBUG The severity that will be used for messages providing debugging information.
FATAL_ERROR The severity that will be used for fatal error messages, which indicate that the server can no longer continue functioning normally.
INFORMATION The severity that will be used for informational messages which may be useful but generally do not need to be written to log files.
MILD_ERROR The severity that will be used for messages about errors that are small in scope and do not generally impact the operation of the server.
MILD_WARNING The severity that will be used for warnings about conditions that do not generally impact the operation of the server.
NOTICE The severity that will be used for significant informational messages that should generally be visible to administrators.
SEVERE_ERROR The severity that will be used for messages about errors that may impact the operation of the server or one of its components.
SEVERE_WARNING The severity that will be used for warning messages about conditions that may impact the operation of the server or one of its components.

Method Summary

Modifier and Type	Method and Description
static ErrorLogSeverity	forName(java.lang.String name) Retrieves the error log severity with the specified name.
static ErrorLogSeverity	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ErrorLogSeverity[]	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

DEBUG

public static final ErrorLogSeverity DEBUG

The severity that will be used for messages providing debugging information.

FATAL_ERROR

public static final ErrorLogSeverity FATAL_ERROR

The severity that will be used for fatal error messages, which indicate that the server can no longer continue functioning normally.

INFORMATION

public static final ErrorLogSeverity INFORMATION

The severity that will be used for informational messages which may be useful but generally do not need to be written to log files.

MILD_ERROR

public static final ErrorLogSeverity MILD_ERROR

The severity that will be used for messages about errors that are small in scope and do not generally impact the operation of the server.

MILD_WARNING

public static final ErrorLogSeverity MILD_WARNING

The severity that will be used for warnings about conditions that do not generally impact the operation of the server.

NOTICE

public static final ErrorLogSeverity NOTICE

The severity that will be used for significant informational messages that should generally be visible to administrators.

SEVERE_ERROR

public static final ErrorLogSeverity SEVERE_ERROR

The severity that will be used for messages about errors that may impact the operation of the server or one of its components.

SEVERE_WARNING

public static final ErrorLogSeverity SEVERE_WARNING

The severity that will be used for warning messages about conditions that may impact the operation of the server or one of its components.

Method Detail

values

public static ErrorLogSeverity[] 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 (ErrorLogSeverity c : ErrorLogSeverity.values())
    System.out.println(c);

Returns:

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

valueOf

public static ErrorLogSeverity valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

forName

@Nullable
public static ErrorLogSeverity forName(@NotNull
                                                 java.lang.String name)

Retrieves the error log severity with the specified name.

Parameters:

name - The name of the error log severity to retrieve. It must not be null.

Returns:

The requested error log severity, or null if no such severity is defined.