001/*
002 * Copyright 2009-2022 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2009-2022 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) 2009-2022 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 alert severities that may
050 * be included in alert 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 AlertSeverity
064{
065  /**
066   * The alert severity that indicates that the associated alert is
067   * informational.
068   */
069  INFO("info"),
070
071
072
073  /**
074   * The alert severity that indicates that the associated alert indicates a
075   * warning has occurred.
076   */
077  WARNING("warning"),
078
079
080
081  /**
082   * The alert severity that indicates that the associated alert indicates a
083   * non-fatal error has occurred.
084   */
085  ERROR("error"),
086
087
088
089  /**
090   * The alert severity that indicates that the associated alert indicates a
091   * fatal error has occurred.
092   */
093  FATAL("fatal");
094
095
096
097  // The name for this alert severity.
098  @NotNull private final String name;
099
100
101
102  /**
103   * Creates a new alert severity with the specified name.
104   *
105   * @param  name  The name for this alert severity.
106   */
107  AlertSeverity(@NotNull final String name)
108  {
109    this.name = name;
110  }
111
112
113
114  /**
115   * Retrieves the name for this alert severity.
116   *
117   * @return  The name for this alert severity.
118   */
119  @NotNull()
120  public String getName()
121  {
122    return name;
123  }
124
125
126
127  /**
128   * Retrieves the alert severity with the specified name.
129   *
130   * @param  name  The name of the alert severity to retrieve.
131   *
132   * @return  The alert severity with the specified name, or {@code null} if
133   *          there is no alert severity with the given name.
134   */
135  @Nullable()
136  public static AlertSeverity forName(@NotNull final String name)
137  {
138    switch (StaticUtils.toLowerCase(name))
139    {
140      case "info":
141        return INFO;
142      case "warning":
143        return WARNING;
144      case "error":
145        return ERROR;
146      case "fatal":
147        return FATAL;
148      default:
149        return null;
150    }
151  }
152
153
154
155  /**
156   * Retrieves a string representation of this alert severity.
157   *
158   * @return  A string representation of this alert severity.
159   */
160  @Override()
161  @NotNull()
162  public String toString()
163  {
164    return name;
165  }
166}