001/* 002 * Copyright 2013-2020 Ping Identity Corporation 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright 2013-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.controls; 037 038 039 040import com.unboundid.util.StaticUtils; 041import com.unboundid.util.ThreadSafety; 042import com.unboundid.util.ThreadSafetyLevel; 043 044 045 046/** 047 * This enum defines the set of result code values that may be included in a 048 * an assured replication server result. 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 AssuredReplicationServerResultCode 062{ 063 /** 064 * Indicates that the requested level of assurance was successfully attained. 065 */ 066 COMPLETE(0), 067 068 069 070 /** 071 * Indicates that the requested level of assurance could not be attained 072 * before the timeout elapsed. 073 */ 074 TIMEOUT(1), 075 076 077 078 /** 079 * Indicates that a replication conflict was encountered that will prevent 080 * the associated operation from being applied to the target server. 081 */ 082 CONFLICT(2), 083 084 085 086 /** 087 * Indicates that the target server was shut down while waiting for an 088 * assurance result. 089 */ 090 SERVER_SHUTDOWN(3), 091 092 093 094 /** 095 * Indicates that the target server became unavailable while waiting for an 096 * assurance result. 097 */ 098 UNAVAILABLE(4), 099 100 101 102 /** 103 * Indicates that the replication assurance engine detected a duplicate 104 * request for the same operation. 105 */ 106 DUPLICATE(5); 107 108 109 110 // The integer value for this server result code. 111 private final int intValue; 112 113 114 115 /** 116 * Creates a new assured replication server result code with the specified 117 * integer value. 118 * 119 * @param intValue The integer value for this assured replication server 120 * result code. 121 */ 122 AssuredReplicationServerResultCode(final int intValue) 123 { 124 this.intValue = intValue; 125 } 126 127 128 129 /** 130 * Retrieves the integer value for this assured replication server result 131 * code. 132 * 133 * @return The integer value for this assured replication server result code. 134 */ 135 public int intValue() 136 { 137 return intValue; 138 } 139 140 141 142 /** 143 * Retrieves the assured replication server result code with the specified 144 * integer value. 145 * 146 * @param intValue The integer value for the server result code to 147 * retrieve. 148 * 149 * @return The requested assured replication server result code, or 150 * {@code null} if there is no server result code with the specified 151 * integer value. 152 */ 153 public static AssuredReplicationServerResultCode valueOf(final int intValue) 154 { 155 for (final AssuredReplicationServerResultCode rc : values()) 156 { 157 if (rc.intValue == intValue) 158 { 159 return rc; 160 } 161 } 162 163 return null; 164 } 165 166 167 168 /** 169 * Retrieves the assured replication server result code with the specified 170 * name. 171 * 172 * @param name The name of the assured replication server result code to 173 * retrieve. It must not be {@code null}. 174 * 175 * @return The requested assured replication server result code, or 176 * {@code null} if no such result code is defined. 177 */ 178 public static AssuredReplicationServerResultCode forName(final String name) 179 { 180 switch (StaticUtils.toLowerCase(name)) 181 { 182 case "complete": 183 return COMPLETE; 184 case "timeout": 185 return TIMEOUT; 186 case "conflict": 187 return CONFLICT; 188 case "servershutdown": 189 case "server-shutdown": 190 case "server_shutdown": 191 return SERVER_SHUTDOWN; 192 case "unavailable": 193 return UNAVAILABLE; 194 case "duplicate": 195 return DUPLICATE; 196 default: 197 return null; 198 } 199 } 200}