001/*
002 * Copyright 2014-2020 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2014-2020 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) 2015-2020 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.StaticUtils;
041import com.unboundid.util.ThreadSafety;
042import com.unboundid.util.ThreadSafetyLevel;
043
044
045
046/**
047 * This class provides information about the types of alarm severities that may
048 * be included in alarm entries.
049 * <BR>
050 * <BLOCKQUOTE>
051 *   <B>NOTE:</B>  This class, and other classes within the
052 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
053 *   supported for use against Ping Identity, UnboundID, and
054 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
055 *   for proprietary functionality or for external specifications that are not
056 *   considered stable or mature enough to be guaranteed to work in an
057 *   interoperable way with other types of LDAP servers.
058 * </BLOCKQUOTE>
059 */
060@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
061public enum AlarmSeverity
062{
063  /**
064   * The alarm severity that indicates that the severity cannot be determined.
065   */
066  INDETERMINATE,
067
068
069
070  /**
071   * The alarm severity that indicates that the associated condition is normal.
072   */
073  NORMAL,
074
075
076
077  /**
078   * The alarm severity that indicates there is a warning condition.
079   */
080  WARNING,
081
082
083
084  /**
085   * The alarm severity that indicates there is a minor error condition.
086   */
087  MINOR,
088
089
090
091  /**
092   * The alarm severity that indicates there is a major error condition.
093   */
094  MAJOR,
095
096
097
098  /**
099   * The alarm severity that indicates there is a critical error condition.
100   */
101  CRITICAL;
102
103
104
105  /**
106   * Retrieves the alarm severity with the specified name.
107   *
108   * @param  name  The name of the alarm severity to retrieve.  It must not be
109   *               {@code null}.
110   *
111   * @return  The alarm severity with the specified name, or {@code null} if
112   *          there is no alarm severity with the given name.
113   */
114  public static AlarmSeverity forName(final String name)
115  {
116    switch (StaticUtils.toLowerCase(name))
117    {
118      case "indeterminate":
119        return INDETERMINATE;
120      case "normal":
121        return NORMAL;
122      case "warning":
123        return WARNING;
124      case "minor":
125        return MINOR;
126      case "major":
127        return MAJOR;
128      case "critical":
129        return CRITICAL;
130      default:
131        return null;
132    }
133  }
134}