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 * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
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 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. 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 * Copyright 2006-2008 Sun Microsystems, Inc.
026 */
027 package org.opends.server.types;
028
029 import static org.opends.server.util.ServerConstants.*;
030 import org.opends.server.loggers.LogCategory;
031
032 /**
033 * Logging categories for the debug log messages.
034 */
035 @org.opends.server.types.PublicAPI(
036 stability=org.opends.server.types.StabilityLevel.UNCOMMITTED,
037 mayInstantiate=false,
038 mayExtend=false,
039 mayInvoke=true)
040 public final class DebugLogCategory extends LogCategory
041 {
042 /**
043 * The log category that will be used for general debug messages.
044 */
045 public static final LogCategory MESSAGE = new DebugLogCategory(
046 DEBUG_CATEGORY_MESSAGE);
047
048 /**
049 * The log category that will be used for constructor messages.
050 * Only logger related classes may use this.
051 */
052 public static final LogCategory CONSTRUCTOR = new DebugLogCategory(
053 DEBUG_CATEGORY_CONSTRUCTOR);
054
055
056 /**
057 * The log category that will be used for raw data read messages.
058 */
059 public static final LogCategory DATA = new DebugLogCategory(
060 DEBUG_CATEGORY_DATA);
061
062
063 /**
064 * The log category that will be used for thrown exception messages.
065 * Only logger related classes may use this.
066 */
067 public static final LogCategory THROWN = new DebugLogCategory(
068 DEBUG_CATEGORY_THROWN);
069
070 /**
071 * The log category that will be used for caught exception messages.
072 * Only logger related classes may use this.
073 */
074 public static final LogCategory CAUGHT = new DebugLogCategory(
075 DEBUG_CATEGORY_CAUGHT);
076
077 /**
078 * The log category that will be used for method entry messages.
079 * Only logger related classes may use this.
080 */
081 public static final LogCategory ENTER = new DebugLogCategory(
082 DEBUG_CATEGORY_ENTER);
083
084 /**
085 * The log category that will be used for method exit messages.
086 * Only logger related classes may use this.
087 */
088 public static final LogCategory EXIT = new DebugLogCategory(
089 DEBUG_CATEGORY_EXIT);
090
091 /**
092 * The log category that will be used for protocol
093 * elements messages.
094 */
095 public static final LogCategory PROTOCOL = new DebugLogCategory(
096 DEBUG_CATEGORY_PROTOCOL);
097
098 /**
099 * The log category that will be used for raw data access
100 * from the JE database messages.
101 */
102 public static final LogCategory DATABASE_ACCESS =
103 new DebugLogCategory(DEBUG_CATEGORY_DATABASE_ACCESS);
104
105
106 /**
107 * Constructor for the DebugLogCategory class.
108 *
109 * @param name The name of the level.
110 */
111 public DebugLogCategory(String name)
112 {
113 super(name);
114 }
115 }