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.monitors; 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 health check states that may be 048 * held by an LDAP external server. 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 HealthCheckState 062{ 063 /** 064 * The health check state that indicates that the associated LDAP external 065 * server is available. 066 */ 067 AVAILABLE("available"), 068 069 070 071 /** 072 * The health check state that indicates that the associated LDAP external 073 * server is in a degraded state. 074 */ 075 DEGRADED("degraded"), 076 077 078 079 /** 080 * The health check state that indicates that the associated LDAP external 081 * server is unavailable. 082 */ 083 UNAVAILABLE("unavailable"), 084 085 086 087 /** 088 * The health check state that indicates that there are no local servers 089 * defined, and therefore no health information is available for local 090 * servers. 091 */ 092 NO_LOCAL_SERVERS("no-local-servers"), 093 094 095 096 /** 097 * The health check state that indicates that there are no local servers 098 * defined, and therefore no health information is available for remote 099 * servers. 100 */ 101 NO_REMOTE_SERVERS("no-remote-servers"); 102 103 104 105 // The name for this health check state. 106 private final String name; 107 108 109 110 /** 111 * Creates a new health check state with the specified name. 112 * 113 * @param name The name for this health check state. 114 */ 115 HealthCheckState(final String name) 116 { 117 this.name = name; 118 } 119 120 121 122 /** 123 * Retrieves the name for this health check state. 124 * 125 * @return The name for this health check state. 126 */ 127 public String getName() 128 { 129 return name; 130 } 131 132 133 134 /** 135 * Retrieves the health check state with the specified name. 136 * 137 * @param name The name of the health check state to retrieve. It must not 138 * be {@code null}. 139 * 140 * @return The health check state with the specified name, or {@code null} if 141 * there is no health check state with the given name. 142 */ 143 public static HealthCheckState forName(final String name) 144 { 145 switch (StaticUtils.toLowerCase(name)) 146 { 147 case "available": 148 return AVAILABLE; 149 case "degraded": 150 return DEGRADED; 151 case "unavailable": 152 return UNAVAILABLE; 153 case "nolocalservers": 154 case "no-local-servers": 155 case "no_local_servers": 156 return NO_LOCAL_SERVERS; 157 case "noremoteservers": 158 case "no-remote-servers": 159 case "no_remote_servers": 160 return NO_REMOTE_SERVERS; 161 default: 162 return null; 163 } 164 } 165 166 167 168 /** 169 * Retrieves a string representation of this health check state. 170 * 171 * @return A string representation of this health check state. 172 */ 173 @Override() 174 public String toString() 175 { 176 return name; 177 } 178}