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