001/*
002 * Copyright 2014-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2014-2024 Ping Identity Corporation
007 *
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *    http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 */
020/*
021 * Copyright (C) 2014-2024 Ping Identity Corporation
022 *
023 * This program is free software; you can redistribute it and/or modify
024 * it under the terms of the GNU General Public License (GPLv2 only)
025 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
026 * as published by the Free Software Foundation.
027 *
028 * This program is distributed in the hope that it will be useful,
029 * but WITHOUT ANY WARRANTY; without even the implied warranty of
030 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
031 * GNU General Public License for more details.
032 *
033 * You should have received a copy of the GNU General Public License
034 * along with this program; if not, see <http://www.gnu.org/licenses>.
035 */
036package com.unboundid.ldap.sdk.unboundidds;
037
038
039
040import com.unboundid.util.NotNull;
041import com.unboundid.util.Nullable;
042import com.unboundid.util.StaticUtils;
043import com.unboundid.util.ThreadSafety;
044import com.unboundid.util.ThreadSafetyLevel;
045
046
047
048/**
049 * This class provides information about the types of alarm severities that may
050 * be included in alarm entries.
051 * <BR>
052 * <BLOCKQUOTE>
053 *   <B>NOTE:</B>  This class, and other classes within the
054 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
055 *   supported for use against Ping Identity, UnboundID, and
056 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
057 *   for proprietary functionality or for external specifications that are not
058 *   considered stable or mature enough to be guaranteed to work in an
059 *   interoperable way with other types of LDAP servers.
060 * </BLOCKQUOTE>
061 */
062@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
063public enum AlarmSeverity
064{
065  /**
066   * The alarm severity that indicates that the severity cannot be determined.
067   */
068  INDETERMINATE,
069
070
071
072  /**
073   * The alarm severity that indicates that the associated condition is normal.
074   */
075  NORMAL,
076
077
078
079  /**
080   * The alarm severity that indicates there is a warning condition.
081   */
082  WARNING,
083
084
085
086  /**
087   * The alarm severity that indicates there is a minor error condition.
088   */
089  MINOR,
090
091
092
093  /**
094   * The alarm severity that indicates there is a major error condition.
095   */
096  MAJOR,
097
098
099
100  /**
101   * The alarm severity that indicates there is a critical error condition.
102   */
103  CRITICAL;
104
105
106
107  /**
108   * Retrieves the alarm severity with the specified name.
109   *
110   * @param  name  The name of the alarm severity to retrieve.  It must not be
111   *               {@code null}.
112   *
113   * @return  The alarm severity with the specified name, or {@code null} if
114   *          there is no alarm severity with the given name.
115   */
116  @Nullable()
117  public static AlarmSeverity forName(@NotNull final String name)
118  {
119    switch (StaticUtils.toLowerCase(name))
120    {
121      case "indeterminate":
122        return INDETERMINATE;
123      case "normal":
124        return NORMAL;
125      case "warning":
126        return WARNING;
127      case "minor":
128        return MINOR;
129      case "major":
130        return MAJOR;
131      case "critical":
132        return CRITICAL;
133      default:
134        return null;
135    }
136  }
137}