001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at
010 * docs/licenses/cddl.txt
011 * or http://www.opensource.org/licenses/cddl1.php.
012 * See the License for the specific language governing permissions
013 * and limitations under the License.
014 *
015 * When distributing Covered Code, include this CDDL HEADER in each
016 * file and include the License file at
017 * docs/licenses/cddl.txt.  If applicable,
018 * add the following below this CDDL HEADER, with the fields enclosed
019 * by brackets "[]" replaced with your own identifying information:
020 *      Portions Copyright [yyyy] [name of copyright owner]
021 *
022 * CDDL HEADER END
023 *
024 *
025 *      Portions Copyright 2007-2019 Ping Identity Corporation
026 *      Portions Copyright 2007-2008 Sun Microsystems, Inc.
027 */
028package com.unboundid.directory.sdk.common.types;
029
030
031
032import com.unboundid.util.ThreadSafety;
033import com.unboundid.util.ThreadSafetyLevel;
034
035
036
037/**
038 * This enum defines the set of severities that may be used for error log
039 * messages.
040 */
041@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
042public enum LogCategory
043{
044
045  /**
046   * The category used for messages associated with Access Control.
047   */
048  ACCESS_CONTROL,
049
050
051
052  /**
053   * The category used for messages associated with the
054   * administration framework.
055   */
056  ADMIN,
057
058
059
060  /**
061   * The category used for messages associated with the tool like the
062   * offline installer and uninstaller.
063   */
064  ADMIN_TOOL,
065
066
067
068  /**
069   * The category used for messages associated with generic backends.
070   */
071  BACKEND,
072
073
074
075  /**
076   * The category that will be used for messages associated with
077   * configuration handling.
078   */
079  CONFIG,
080
081
082
083  /**
084   * The category that will be used for messages associated with the
085   * core server.
086   */
087  CORE,
088
089
090
091  /**
092   * The category used for messages associated with the dsconfig
093   * administration tool.
094   */
095  DSCONFIG,
096
097
098
099  /**
100   * The category that will be used for messages associated with server
101   * extensions (e.g., extended operations, SASL mechanisms, password storage
102   * schemes, password validators, etc.).
103   */
104  EXTENSIONS,
105
106
107
108  /**
109   * The category used for messages associated with the JE backend.
110   */
111  JEB,
112
113
114
115  /**
116   * The category that will be used for messages associated with the
117   * server loggers.
118   */
119  LOG,
120
121
122
123  /**
124   * The category that will be used for messages associated with plugin
125   * processing.
126   */
127  PLUGIN,
128
129
130
131  /**
132   * The category that will be used for messages associated with
133   * connection and protocol handling (e.g., ASN.1 and LDAP).
134   */
135  PROTOCOL,
136
137
138
139  /**
140   * The category that will be used for messages associated with Directory Proxy
141   * Server functionality.
142   */
143  PROXY,
144
145
146
147  /**
148   * The category used for messages associated with replication.
149   */
150  REPLICATION,
151
152
153
154  /**
155   * The category used for messages associated with the runtime information.
156   */
157  RUNTIME_INFORMATION,
158
159
160
161  /**
162   * The category that will be used for messages associated with the
163   * server schema elements.
164   */
165  SCHEMA,
166
167
168
169  /**
170   * The category used for messages associated with the setup tools.
171   */
172  SETUP,
173
174
175
176  /**
177   * The category that will be used for messages associated with
178   * Data Sync Server functionality.
179   */
180  SYNC,
181
182
183
184  /**
185   * The category used for messages associated with tasks.
186   */
187  TASK,
188
189
190
191  /**
192   * The category that will be used for messages associated with
193   * third-party (including user-defined) modules.
194   */
195  THIRD_PARTY,
196
197
198
199  /**
200   * The category used for messages associated with tools.
201   */
202  TOOLS,
203
204
205
206  /**
207   * The category that will be used for messages associated with the updater
208   * tool.
209   */
210  UPDATE,
211
212
213
214  /**
215   * The category that will be used for messages associated with
216   * user-defined modules.
217   */
218  USER_DEFINED,
219
220
221
222  /**
223   * The category that will be used for messages associated with the
224   * general server utilities.
225   */
226  UTIL,
227
228
229
230  /**
231   * The category used for messages associated with version information.
232   */
233  VERSION;
234}