001/*
002 * Copyright 2009-2017 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright (C) 2015-2017 Ping Identity Corporation
007 *
008 * This program is free software; you can redistribute it and/or modify
009 * it under the terms of the GNU General Public License (GPLv2 only)
010 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
011 * as published by the Free Software Foundation.
012 *
013 * This program is distributed in the hope that it will be useful,
014 * but WITHOUT ANY WARRANTY; without even the implied warranty of
015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
016 * GNU General Public License for more details.
017 *
018 * You should have received a copy of the GNU General Public License
019 * along with this program; if not, see <http://www.gnu.org/licenses>.
020 */
021package com.unboundid.ldap.sdk.unboundidds.logs;
022
023
024
025import com.unboundid.util.ThreadSafety;
026import com.unboundid.util.ThreadSafetyLevel;
027
028
029
030/**
031 * This enum contains the set of error log categories defined in the Directory
032 * Server.
033 * <BR>
034 * <BLOCKQUOTE>
035 *   <B>NOTE:</B>  This class, and other classes within the
036 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
037 *   supported for use against Ping Identity, UnboundID, and Alcatel-Lucent 8661
038 *   server products.  These classes provide support for proprietary
039 *   functionality or for external specifications that are not considered stable
040 *   or mature enough to be guaranteed to work in an interoperable way with
041 *   other types of LDAP servers.
042 * </BLOCKQUOTE>
043 */
044@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
045public enum ErrorLogCategory
046{
047  /**
048   * The error log category used for messages related to access control.
049   */
050  ACCESS_CONTROL,
051
052
053
054  /**
055   * The error log category used for messages related to the server
056   * administration framework.
057   */
058  ADMIN,
059
060
061
062  /**
063   * The error log category used for messages related to tools used for
064   * administering the server.
065   */
066  ADMIN_TOOL,
067
068
069
070  /**
071   * The error log category used for messages generated by most types of
072   * Directory Server backends.
073   */
074  BACKEND,
075
076
077
078  /**
079   * The error log category used for messages related to the server
080   * configuration.
081   */
082  CONFIG,
083
084
085
086  /**
087   * The error log category used for messages related to the core processing of
088   * the server.
089   */
090  CORE,
091
092
093
094  /**
095   * The error log category used for messages related to the use of the dsconfig
096   * tool.
097   */
098  DSCONFIG,
099
100
101
102  /**
103   * The error log category used for messages generated by server extensions.
104   */
105  EXTENSIONS,
106
107
108
109  /**
110   * The error log category used for messages generated by the backend using the
111   * Berkeley DB Java Edition for storing data.
112   */
113  JEB,
114
115
116
117  /**
118   * The error log category used for messages generated by the logging
119   * framework.
120   */
121  LOG,
122
123
124
125  /**
126   * The error log category used for messages generated by server plugins.
127   */
128  PLUGIN,
129
130
131
132  /**
133   * The error log category used for messages about communication performed with
134   * clients.
135   */
136  PROTOCOL,
137
138
139
140  /**
141   * The error log category used for messages about the operation of the
142   * Directory Proxy Server.
143   */
144  PROXY,
145
146
147
148  /**
149   * The error log category used for messages generated by the QuickSetup tool.
150   */
151  QUICKSETUP,
152
153
154
155  /**
156   * The error log category used for messages related to replication between
157   * server instances.
158   */
159  REPLICATION,
160
161
162
163  /**
164   * The error log category used for messages related to information about the
165   * environment in which the server is running.
166   */
167  RUNTIME_INFORMATION,
168
169
170
171  /**
172   * The error log category used for messages related to the server schema.
173   */
174  SCHEMA,
175
176
177
178  /**
179   * The error log category used for messages related to processing performed by
180   * server tasks.
181   */
182  TASK,
183
184
185
186  /**
187   * The error log category used for messages generated by third-party
188   * components.
189   */
190  THIRD_PARTY,
191
192
193
194  /**
195   * The error log category used for messages generated by server tools.
196   */
197  TOOLS,
198
199
200
201  /**
202   * The error log category used for messages generated by utility classes
203   * within the server.
204   */
205  UTIL,
206
207
208
209  /**
210   * The error log category used for messages about the server version.
211   */
212  VERSION;
213}