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 *      Copyright 2010-2019 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.common.types;
028
029
030
031import com.unboundid.util.ThreadSafety;
032import com.unboundid.util.ThreadSafetyLevel;
033
034
035
036/**
037 * This enum defines the set of severities that may be used for error log
038 * messages.
039 */
040@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
041public enum LogSeverity
042{
043  /**
044   * This severity should be used for messages about the most severe types of
045   * errors which may prevent the server from continuing to function.
046   */
047  FATAL_ERROR,
048
049
050
051  /**
052   * This severity should be used for messages about severe errors which may
053   * interfere with the function of the server.
054   */
055  SEVERE_ERROR,
056
057
058
059  /**
060   * This severity should be used for messages about errors which may interfere
061   * with the processing of the task at hand, but should not have any lasting
062   * impact on the overall operation of the server.
063   */
064  MILD_ERROR,
065
066
067
068  /**
069   * This severity should be used for messages about warning conditions which
070   * may lead to problems which could interfere with the operation of the
071   * server.
072   */
073  SEVERE_WARNING,
074
075
076
077  /**
078   * This severity should be used for messages about warning conditions which
079   * may lead to problems which could interfere with the processing of the
080   * task at hand.
081   */
082  MILD_WARNING,
083
084
085
086  /**
087   * This severity should be used for messages about significant events that
088   * occur within the server which may provide administrators with valuable
089   * information about the operation of the server.
090   */
091  NOTICE,
092
093
094
095  /**
096   * This severity should be used for informational messages about general
097   * processing occurring within the server which may be helpful when
098   * troubleshooting but are not necessarily important enough to make available
099   * to administrators under normal conditions.
100   */
101  INFO,
102
103
104
105  /**
106   * This severity should be used for the most verbose types of messages which
107   * should only be used when debugging a problem.
108   */
109  DEBUG;
110}