com.unboundid.ldap.sdk.unboundidds.logs

Enum ErrorLogCategory

java.lang.Object

java.lang.Enum<ErrorLogCategory>

com.unboundid.ldap.sdk.unboundidds.logs.ErrorLogCategory

All Implemented Interfaces:

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

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

This enum contains the set of error log categories 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	Description
ACCESS_CONTROL	The error log category used for messages related to access control.
ADMIN	The error log category used for messages related to the server administration framework.
ADMIN_TOOL	The error log category used for messages related to tools used for administering the server.
BACKEND	The error log category used for messages generated by most types of Directory Server backends.
CONFIG	The error log category used for messages related to the server configuration.
CORE	The error log category used for messages related to the core processing of the server.
DSCONFIG	The error log category used for messages related to the use of the dsconfig tool.
EXTENSIONS	The error log category used for messages generated by server extensions.
JEB	The error log category used for messages generated by the backend using the Berkeley DB Java Edition for storing data.
LOG	The error log category used for messages generated by the logging framework.
PLUGIN	The error log category used for messages generated by server plugins.
PROTOCOL	The error log category used for messages about communication performed with clients.
PROXY	The error log category used for messages about the operation of the Directory Proxy Server.
QUICKSETUP	The error log category used for messages generated by the QuickSetup tool.
REPLICATION	The error log category used for messages related to replication between server instances.
RUNTIME_INFORMATION	The error log category used for messages related to information about the environment in which the server is running.
SCHEMA	The error log category used for messages related to the server schema.
TASK	The error log category used for messages related to processing performed by server tasks.
THIRD_PARTY	The error log category used for messages generated by third-party components.
TOOLS	The error log category used for messages generated by server tools.
UTIL	The error log category used for messages generated by utility classes within the server.
VERSION	The error log category used for messages about the server version.

Method Summary

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

ACCESS_CONTROL

public static final ErrorLogCategory ACCESS_CONTROL

The error log category used for messages related to access control.

ADMIN

public static final ErrorLogCategory ADMIN

The error log category used for messages related to the server administration framework.

ADMIN_TOOL

public static final ErrorLogCategory ADMIN_TOOL

The error log category used for messages related to tools used for administering the server.

BACKEND

public static final ErrorLogCategory BACKEND

The error log category used for messages generated by most types of Directory Server backends.

CONFIG

public static final ErrorLogCategory CONFIG

The error log category used for messages related to the server configuration.

CORE

public static final ErrorLogCategory CORE

The error log category used for messages related to the core processing of the server.

DSCONFIG

public static final ErrorLogCategory DSCONFIG

The error log category used for messages related to the use of the dsconfig tool.

EXTENSIONS

public static final ErrorLogCategory EXTENSIONS

The error log category used for messages generated by server extensions.

JEB

public static final ErrorLogCategory JEB

The error log category used for messages generated by the backend using the Berkeley DB Java Edition for storing data.

LOG

public static final ErrorLogCategory LOG

The error log category used for messages generated by the logging framework.

PLUGIN

public static final ErrorLogCategory PLUGIN

The error log category used for messages generated by server plugins.

PROTOCOL

public static final ErrorLogCategory PROTOCOL

The error log category used for messages about communication performed with clients.

PROXY

public static final ErrorLogCategory PROXY

The error log category used for messages about the operation of the Directory Proxy Server.

QUICKSETUP

public static final ErrorLogCategory QUICKSETUP

The error log category used for messages generated by the QuickSetup tool.

REPLICATION

public static final ErrorLogCategory REPLICATION

The error log category used for messages related to replication between server instances.

RUNTIME_INFORMATION

public static final ErrorLogCategory RUNTIME_INFORMATION

The error log category used for messages related to information about the environment in which the server is running.

SCHEMA

public static final ErrorLogCategory SCHEMA

The error log category used for messages related to the server schema.

TASK

public static final ErrorLogCategory TASK

The error log category used for messages related to processing performed by server tasks.

THIRD_PARTY

public static final ErrorLogCategory THIRD_PARTY

The error log category used for messages generated by third-party components.

TOOLS

public static final ErrorLogCategory TOOLS

The error log category used for messages generated by server tools.

UTIL

public static final ErrorLogCategory UTIL

The error log category used for messages generated by utility classes within the server.

VERSION

public static final ErrorLogCategory VERSION

The error log category used for messages about the server version.

Method Detail

values

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

Returns:

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

valueOf

public static ErrorLogCategory 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 ErrorLogCategory forName(@NotNull
                                                 java.lang.String name)

Retrieves the error log category with the specified name.

Parameters:

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

Returns:

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