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