Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright 2007-2024 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2007-2024 Ping Identity Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* Copyright (C) 2007-2024 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.ldap.sdk;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.atomic.AtomicReference;
import com.unboundid.util.NotMutable;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.StaticUtils;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
import static com.unboundid.ldap.sdk.LDAPMessages.*;
/**
* This class defines a number of constants associated with LDAP result codes.
* The {@code ResultCode} constant values defined in this class are immutable,
* and at most one result code object will ever be created for a given int
* value, so it is acceptable to compare result codes with either the
* {@link ResultCode#equals} method or the "{@code ==}" operator.
*
* The result codes that are currently defined include:
*
*
*
*
Name
*
Integer Value
*
*
*
SUCCESS
*
0
*
*
*
OPERATIONS_ERROR
*
1
*
*
*
PROTOCOL_ERROR
*
2
*
*
*
TIME_LIMIT_EXCEEDED
*
3
*
*
*
SIZE_LIMIT_EXCEEDED
*
4
*
*
*
COMPARE_FALSE
*
5
*
*
*
COMPARE_TRUE
*
6
*
*
*
AUTH_METHOD_NOT_SUPPORTED
*
7
*
*
*
STRONG_AUTH_REQUIRED
*
8
*
*
*
REFERRAL
*
10
*
*
*
ADMIN_LIMIT_EXCEEDED
*
11
*
*
*
UNAVAILABLE_CRITICAL_EXTENSION
*
12
*
*
*
CONFIDENTIALITY_REQUIRED
*
13
*
*
*
SASL_BIND_IN_PROGRESS
*
14
*
*
*
NO_SUCH_ATTRIBUTE
*
16
*
*
*
UNDEFINED_ATTRIBUTE_TYPE
*
17
*
*
*
INAPPROPRIATE_MATCHING
*
18
*
*
*
CONSTRAINT_VIOLATION
*
19
*
*
*
ATTRIBUTE_OR_VALUE_EXISTS
*
20
*
*
*
INVALID_ATTRIBUTE_SYNTAX
*
21
*
*
*
NO_SUCH_OBJECT
*
32
*
*
*
ALIAS_PROBLEM
*
33
*
*
*
INVALID_DN_SYNTAX
*
34
*
*
*
ALIAS_DEREFERENCING_PROBLEM
*
36
*
*
*
INAPPROPRIATE_AUTHENTICATION
*
48
*
*
*
INVALID_CREDENTIALS
*
49
*
*
*
INSUFFICIENT_ACCESS_RIGHTS
*
50
*
*
*
BUSY
*
51
*
*
*
UNAVAILABLE
*
52
*
*
*
UNWILLING_TO_PERFORM
*
53
*
*
*
LOOP_DETECT
*
54
*
*
*
SORT_CONTROL_MISSING
*
60
*
*
*
OFFSET_RANGE_ERROR
*
61
*
*
*
NAMING_VIOLATION
*
64
*
*
*
OBJECT_CLASS_VIOLATION
*
65
*
*
*
NOT_ALLOWED_ON_NONLEAF
*
66
*
*
*
NOT_ALLOWED_ON_NONLEAF
*
66
*
*
*
NOT_ALLOWED_ON_RDN
*
67
*
*
*
ENTRY_ALREADY_EXISTS
*
68
*
*
*
OBJECT_CLASS_MODS_PROHIBITED
*
69
*
*
*
AFFECTS_MULTIPLE_DSAS
*
71
*
*
*
VIRTUAL_LIST_VIEW_ERROR
*
76
*
*
*
OTHER
*
80
*
*
*
SERVER_DOWN
*
81
*
*
*
LOCAL_ERROR
*
82
*
*
*
ENCODING_ERROR
*
83
*
*
*
DECODING_ERROR
*
84
*
*
*
TIMEOUT
*
85
*
*
*
AUTH_UNKNOWN
*
86
*
*
*
FILTER_ERROR
*
87
*
*
*
USER_CANCELED
*
88
*
*
*
PARAM_ERROR
*
89
*
*
*
NO_MEMORY
*
90
*
*
*
CONNECT_ERROR
*
91
*
*
*
NOT_SUPPORTED
*
92
*
*
*
CONTROL_NOT_FOUND
*
93
*
*
*
NO_RESULTS_RETURNED
*
94
*
*
*
MORE_RESULTS_TO_RETURN
*
95
*
*
*
CLIENT_LOOP
*
96
*
*
*
REFERRAL_LIMIT_EXCEEDED
*
97
*
*
*
CANCELED
*
118
*
*
*
NO_SUCH_OPERATION
*
119
*
*
*
TOO_LATE
*
120
*
*
*
CANNOT_CANCEL
*
121
*
*
*
ASSERTION_FAILED
*
122
*
*
*
AUTHORIZATION_DENIED
*
123
*
*
*
E_SYNC_REFRESH_REQUIRED
*
4096
*
*
*
NO_OPERATION
*
16654
*
*
*
INTERACTIVE_TRANSACTION_ABORTED
*
30221001
*
*
*
DATABASE_LOCK_CONFLICT
*
30221002
*
*
*
MIRRORED_SUBTREE_DIGEST_MISMATCH
*
30221003
*
*
*
TOKEN_DELIVERY_MECHANISM_UNAVAILABLE
*
30221004
*
*
*
TOKEN_DELIVERY_ATTEMPT_FAILED
*
30221005
*
*
*
TOKEN_DELIVERY_INVALID_RECIPIENT_ID
*
30221006
*
*
*
TOKEN_DELIVERY_INVALID_ACCOUNT_STATE
*
30221007
*
*
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class ResultCode
implements Serializable
{
/**
* The integer value (0) for the "SUCCESS" result code.
*/
public static final int SUCCESS_INT_VALUE = 0;
/**
* The result code (0) that will be used to indicate a successful operation.
* This result code is defined in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode SUCCESS =
new ResultCode(INFO_RC_SUCCESS.get(), "success", SUCCESS_INT_VALUE);
/**
* The integer value (1) for the "OPERATIONS_ERROR" result code.
*/
public static final int OPERATIONS_ERROR_INT_VALUE = 1;
/**
* The result code (1) that will be used to indicate that an operation was
* requested out of sequence. This result code is defined in RFC 4511 section
* 4.1.9.
*/
@NotNull public static final ResultCode OPERATIONS_ERROR =
new ResultCode(INFO_RC_OPERATIONS_ERROR.get(), "operationsError",
OPERATIONS_ERROR_INT_VALUE);
/**
* The integer value (2) for the "PROTOCOL_ERROR" result code.
*/
public static final int PROTOCOL_ERROR_INT_VALUE = 2;
/**
* The result code (2) that will be used to indicate that the client sent a
* malformed request. This result code is defined in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode PROTOCOL_ERROR =
new ResultCode(INFO_RC_PROTOCOL_ERROR.get(), "protocolError",
PROTOCOL_ERROR_INT_VALUE);
/**
* The integer value (3) for the "TIME_LIMIT_EXCEEDED" result code.
*/
public static final int TIME_LIMIT_EXCEEDED_INT_VALUE = 3;
/**
* The result code (3) that will be used to indicate that the server was
* unable to complete processing on the request in the allotted time limit.
* This result code is defined in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode TIME_LIMIT_EXCEEDED =
new ResultCode(INFO_RC_TIME_LIMIT_EXCEEDED.get(), "timeLimitExceeded",
TIME_LIMIT_EXCEEDED_INT_VALUE);
/**
* The integer value (4) for the "SIZE_LIMIT_EXCEEDED" result code.
*/
public static final int SIZE_LIMIT_EXCEEDED_INT_VALUE = 4;
/**
* The result code (4) that will be used to indicate that the server found
* more matching entries than the configured request size limit. This result
* code is defined in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode SIZE_LIMIT_EXCEEDED =
new ResultCode(INFO_RC_SIZE_LIMIT_EXCEEDED.get(), "sizeLimitExceeded",
SIZE_LIMIT_EXCEEDED_INT_VALUE);
/**
* The integer value (5) for the "COMPARE_FALSE" result code.
*/
public static final int COMPARE_FALSE_INT_VALUE = 5;
/**
* The result code (5) that will be used if a requested compare assertion does
* not match the target entry. This result code is defined in RFC 4511
* section 4.1.9.
*/
@NotNull public static final ResultCode COMPARE_FALSE =
new ResultCode(INFO_RC_COMPARE_FALSE.get(), "compareFalse",
COMPARE_FALSE_INT_VALUE);
/**
* The integer value (6) for the "COMPARE_TRUE" result code.
*/
public static final int COMPARE_TRUE_INT_VALUE = 6;
/**
* The result code (6) that will be used if a requested compare assertion
* matched the target entry. This result code is defined in RFC 4511 section
* 4.1.9.
*/
@NotNull public static final ResultCode COMPARE_TRUE =
new ResultCode(INFO_RC_COMPARE_TRUE.get(), "compareTrue",
COMPARE_TRUE_INT_VALUE);
/**
* The integer value (7) for the "AUTH_METHOD_NOT_SUPPORTED" result code.
*/
public static final int AUTH_METHOD_NOT_SUPPORTED_INT_VALUE = 7;
/**
* The result code (7) that will be used if the client requested a form of
* authentication that is not supported by the server. This result code is
* defined in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode AUTH_METHOD_NOT_SUPPORTED =
new ResultCode(INFO_RC_AUTH_METHOD_NOT_SUPPORTED.get(),
"authMethodNotSupported",
AUTH_METHOD_NOT_SUPPORTED_INT_VALUE);
/**
* The integer value (8) for the "STRONG_AUTH_REQUIRED" result code.
*/
public static final int STRONG_AUTH_REQUIRED_INT_VALUE = 8;
/**
* The result code (8) that will be used if the client requested an operation
* that requires a strong authentication mechanism. This result code is
* defined in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode STRONG_AUTH_REQUIRED =
new ResultCode(INFO_RC_STRONG_AUTH_REQUIRED.get(),
"strongerAuthRequired",
STRONG_AUTH_REQUIRED_INT_VALUE);
/**
* The integer value (10) for the "REFERRAL" result code.
*/
public static final int REFERRAL_INT_VALUE = 10;
/**
* The result code (10) that will be used if the server sends a referral to
* the client to refer to data in another location. This result code is
* defined in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode REFERRAL =
new ResultCode(INFO_RC_REFERRAL.get(), "referral", REFERRAL_INT_VALUE);
/**
* The integer value (11) for the "ADMIN_LIMIT_EXCEEDED" result code.
*/
public static final int ADMIN_LIMIT_EXCEEDED_INT_VALUE = 11;
/**
* The result code (11) that will be used if a server administrative limit has
* been exceeded. This result code is defined in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode ADMIN_LIMIT_EXCEEDED =
new ResultCode(INFO_RC_ADMIN_LIMIT_EXCEEDED.get(),
"adminLimitExceeded",
ADMIN_LIMIT_EXCEEDED_INT_VALUE);
/**
* The integer value (12) for the "UNAVAILABLE_CRITICAL_EXTENSION" result
* code.
*/
public static final int UNAVAILABLE_CRITICAL_EXTENSION_INT_VALUE = 12;
/**
* The result code (12) that will be used if the client requests a critical
* control that is not supported by the server. This result code is defined
* in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode UNAVAILABLE_CRITICAL_EXTENSION =
new ResultCode(INFO_RC_UNAVAILABLE_CRITICAL_EXTENSION.get(),
"unavailableCriticalExtension",
UNAVAILABLE_CRITICAL_EXTENSION_INT_VALUE);
/**
* The integer value (13) for the "CONFIDENTIALITY_REQUIRED" result code.
*/
public static final int CONFIDENTIALITY_REQUIRED_INT_VALUE = 13;
/**
* The result code (13) that will be used if the server requires a secure
* communication mechanism for the requested operation. This result code is
* defined in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode CONFIDENTIALITY_REQUIRED =
new ResultCode(INFO_RC_CONFIDENTIALITY_REQUIRED.get(),
"confidentialityRequired",
CONFIDENTIALITY_REQUIRED_INT_VALUE);
/**
* The integer value (14) for the "SASL_BIND_IN_PROGRESS" result code.
*/
public static final int SASL_BIND_IN_PROGRESS_INT_VALUE = 14;
/**
* The result code (14) that will be returned from the server after SASL bind
* stages in which more processing is required. This result code is defined
* in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode SASL_BIND_IN_PROGRESS =
new ResultCode(INFO_RC_SASL_BIND_IN_PROGRESS.get(), "saslBindInProgress",
SASL_BIND_IN_PROGRESS_INT_VALUE);
/**
* The integer value (16) for the "NO_SUCH_ATTRIBUTE" result code.
*/
public static final int NO_SUCH_ATTRIBUTE_INT_VALUE = 16;
/**
* The result code (16) that will be used if the client referenced an
* attribute that does not exist in the target entry. This result code is
* defined in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode NO_SUCH_ATTRIBUTE =
new ResultCode(INFO_RC_NO_SUCH_ATTRIBUTE.get(), "noSuchAttribute",
NO_SUCH_ATTRIBUTE_INT_VALUE);
/**
* The integer value (17) for the "UNDEFINED_ATTRIBUTE_TYPE" result code.
*/
public static final int UNDEFINED_ATTRIBUTE_TYPE_INT_VALUE = 17;
/**
* The result code (17) that will be used if the client referenced an
* attribute that is not defined in the server schema. This result code is
* defined in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode UNDEFINED_ATTRIBUTE_TYPE =
new ResultCode(INFO_RC_UNDEFINED_ATTRIBUTE_TYPE.get(),
"undefinedAttributeType",
UNDEFINED_ATTRIBUTE_TYPE_INT_VALUE);
/**
* The integer value (18) for the "INAPPROPRIATE_MATCHING" result code.
*/
public static final int INAPPROPRIATE_MATCHING_INT_VALUE = 18;
/**
* The result code (18) that will be used if the client attempted to use an
* attribute in a search filter in a manner not supported by the matching
* rules associated with that attribute. This result code is defined in RFC
* 4511 section 4.1.9.
*/
@NotNull public static final ResultCode INAPPROPRIATE_MATCHING =
new ResultCode(INFO_RC_INAPPROPRIATE_MATCHING.get(),
"inappropriateMatching",
INAPPROPRIATE_MATCHING_INT_VALUE);
/**
* The integer value (19) for the "CONSTRAINT_VIOLATION" result code.
*/
public static final int CONSTRAINT_VIOLATION_INT_VALUE = 19;
/**
* The result code (19) that will be used if the requested operation would
* violate some constraint defined in the server. This result code is defined
* in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode CONSTRAINT_VIOLATION =
new ResultCode(INFO_RC_CONSTRAINT_VIOLATION.get(), "constraintViolation",
CONSTRAINT_VIOLATION_INT_VALUE);
/**
* The integer value (20) for the "ATTRIBUTE_OR_VALUE_EXISTS" result code.
*/
public static final int ATTRIBUTE_OR_VALUE_EXISTS_INT_VALUE = 20;
/**
* The result code (20) that will be used if the client attempts to modify an
* entry in a way that would create a duplicate value, or create multiple
* values for a single-valued attribute. This result code is defined in RFC
* 4511 section 4.1.9.
*/
@NotNull public static final ResultCode ATTRIBUTE_OR_VALUE_EXISTS =
new ResultCode(INFO_RC_ATTRIBUTE_OR_VALUE_EXISTS.get(),
"attributeOrValueExists",
ATTRIBUTE_OR_VALUE_EXISTS_INT_VALUE);
/**
* The integer value (21) for the "INVALID_ATTRIBUTE_SYNTAX" result code.
*/
public static final int INVALID_ATTRIBUTE_SYNTAX_INT_VALUE = 21;
/**
* The result code (21) that will be used if the client attempts to perform an
* operation that would create an attribute value that violates the syntax
* for that attribute. This result code is defined in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode INVALID_ATTRIBUTE_SYNTAX =
new ResultCode(INFO_RC_INVALID_ATTRIBUTE_SYNTAX.get(),
"invalidAttributeSyntax",
INVALID_ATTRIBUTE_SYNTAX_INT_VALUE);
/**
* The integer value (32) for the "NO_SUCH_OBJECT" result code.
*/
public static final int NO_SUCH_OBJECT_INT_VALUE = 32;
/**
* The result code (32) that will be used if the client targeted an entry that
* does not exist. This result code is defined in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode NO_SUCH_OBJECT =
new ResultCode(INFO_RC_NO_SUCH_OBJECT.get(), "noSuchObject",
NO_SUCH_OBJECT_INT_VALUE);
/**
* The integer value (33) for the "ALIAS_PROBLEM" result code.
*/
public static final int ALIAS_PROBLEM_INT_VALUE = 33;
/**
* The result code (33) that will be used if the client targeted an entry that
* as an alias. This result code is defined in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode ALIAS_PROBLEM =
new ResultCode(INFO_RC_ALIAS_PROBLEM.get(), "aliasProblem",
ALIAS_PROBLEM_INT_VALUE);
/**
* The integer value (34) for the "INVALID_DN_SYNTAX" result code.
*/
public static final int INVALID_DN_SYNTAX_INT_VALUE = 34;
/**
* The result code (34) that will be used if the client provided an invalid
* DN. This result code is defined in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode INVALID_DN_SYNTAX =
new ResultCode(INFO_RC_INVALID_DN_SYNTAX.get(),
"invalidDNSyntax",
INVALID_DN_SYNTAX_INT_VALUE);
/**
* The integer value (36) for the "ALIAS_DEREFERENCING_PROBLEM" result code.
*/
public static final int ALIAS_DEREFERENCING_PROBLEM_INT_VALUE = 36;
/**
* The result code (36) that will be used if a problem is encountered while
* the server is attempting to dereference an alias. This result code is
* defined in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode ALIAS_DEREFERENCING_PROBLEM =
new ResultCode(INFO_RC_ALIAS_DEREFERENCING_PROBLEM.get(),
"aliasDereferencingProblem",
ALIAS_DEREFERENCING_PROBLEM_INT_VALUE);
/**
* The integer value (48) for the "INAPPROPRIATE_AUTHENTICATION" result code.
*/
public static final int INAPPROPRIATE_AUTHENTICATION_INT_VALUE = 48;
/**
* The result code (48) that will be used if the client attempts to perform a
* type of authentication that is not supported for the target user. This
* result code is defined in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode INAPPROPRIATE_AUTHENTICATION =
new ResultCode(INFO_RC_INAPPROPRIATE_AUTHENTICATION.get(),
"inappropriateAuthentication",
INAPPROPRIATE_AUTHENTICATION_INT_VALUE);
/**
* The integer value (49) for the "INVALID_CREDENTIALS" result code.
*/
public static final int INVALID_CREDENTIALS_INT_VALUE = 49;
/**
* The result code (49) that will be used if the client provided invalid
* credentials while trying to authenticate. This result code is defined in
* RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode INVALID_CREDENTIALS =
new ResultCode(INFO_RC_INVALID_CREDENTIALS.get(), "invalidCredentials",
INVALID_CREDENTIALS_INT_VALUE);
/**
* The integer value (50) for the "INSUFFICIENT_ACCESS_RIGHTS" result code.
*/
public static final int INSUFFICIENT_ACCESS_RIGHTS_INT_VALUE = 50;
/**
* The result code (50) that will be used if the client does not have
* permission to perform the requested operation. This result code is defined
* in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode INSUFFICIENT_ACCESS_RIGHTS =
new ResultCode(INFO_RC_INSUFFICIENT_ACCESS_RIGHTS.get(),
"insufficientAccessRights",
INSUFFICIENT_ACCESS_RIGHTS_INT_VALUE);
/**
* The integer value (51) for the "BUSY" result code.
*/
public static final int BUSY_INT_VALUE = 51;
/**
* The result code (51) that will be used if the server is too busy to process
* the requested operation. This result code is defined in RFC 4511 section
* 4.1.9.
*/
@NotNull public static final ResultCode BUSY =
new ResultCode(INFO_RC_BUSY.get(), "busy", BUSY_INT_VALUE);
/**
* The integer value (52) for the "UNAVAILABLE" result code.
*/
public static final int UNAVAILABLE_INT_VALUE = 52;
/**
* The result code (52) that will be used if the server is unavailable. This
* result code is defined in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode UNAVAILABLE =
new ResultCode(INFO_RC_UNAVAILABLE.get(), "unavailable",
UNAVAILABLE_INT_VALUE);
/**
* The integer value (53) for the "UNWILLING_TO_PERFORM" result code.
*/
public static final int UNWILLING_TO_PERFORM_INT_VALUE = 53;
/**
* The result code (53) that will be used if the server is not willing to
* perform the requested operation. This result code is defined in RFC 4511
* section 4.1.9.
*/
@NotNull public static final ResultCode UNWILLING_TO_PERFORM =
new ResultCode(INFO_RC_UNWILLING_TO_PERFORM.get(),
"unwillingToPerform",
UNWILLING_TO_PERFORM_INT_VALUE);
/**
* The integer value (54) for the "LOOP_DETECT" result code.
*/
public static final int LOOP_DETECT_INT_VALUE = 54;
/**
* The result code (54) that will be used if the server detects a chaining or
* alias loop. This result code is defined in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode LOOP_DETECT =
new ResultCode(INFO_RC_LOOP_DETECT.get(), "loopDetect",
LOOP_DETECT_INT_VALUE);
/**
* The integer value (60) for the "SORT_CONTROL_MISSING" result code.
*/
public static final int SORT_CONTROL_MISSING_INT_VALUE = 60;
/**
* The result code (60) that will be used if the client sends a virtual list
* view control without a server-side sort control. This result code is
* defined in draft-ietf-ldapext-ldapv3-vlv-09 section 6.2.
*/
@NotNull public static final ResultCode SORT_CONTROL_MISSING =
new ResultCode(INFO_RC_SORT_CONTROL_MISSING.get(),
"sortControlMissing",
SORT_CONTROL_MISSING_INT_VALUE);
/**
* The integer value (61) for the "OFFSET_RANGE_ERROR" result code.
*/
public static final int OFFSET_RANGE_ERROR_INT_VALUE = 61;
/**
* The result code (61) that will be used if the client provides a virtual
* list view control with a target offset that is out of range for the
* available data set. This result code is defined in
* draft-ietf-ldapext-ldapv3-vlv-09 section 6.2.
*/
@NotNull public static final ResultCode OFFSET_RANGE_ERROR =
new ResultCode(INFO_RC_OFFSET_RANGE_ERROR.get(), "offsetRangeError",
OFFSET_RANGE_ERROR_INT_VALUE);
/**
* The integer value (64) for the "NAMING_VIOLATION" result code.
*/
public static final int NAMING_VIOLATION_INT_VALUE = 64;
/**
* The result code (64) that will be used if the client request violates a
* naming constraint (e.g., a name form or DIT structure rule) defined in the
* server. This result code is defined in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode NAMING_VIOLATION =
new ResultCode(INFO_RC_NAMING_VIOLATION.get(), "namingViolation",
NAMING_VIOLATION_INT_VALUE);
/**
* The integer value (65) for the "OBJECT_CLASS_VIOLATION" result code.
*/
public static final int OBJECT_CLASS_VIOLATION_INT_VALUE = 65;
/**
* The result code (65) that will be used if the client request violates an
* object class constraint (e.g., an undefined object class, a
* disallowed attribute, or a missing required attribute) defined in the
* server. This result code is defined in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode OBJECT_CLASS_VIOLATION =
new ResultCode(INFO_RC_OBJECT_CLASS_VIOLATION.get(),
"objectClassViolation",
OBJECT_CLASS_VIOLATION_INT_VALUE);
/**
* The integer value (66) for the "NOT_ALLOWED_ON_NONLEAF" result code.
*/
public static final int NOT_ALLOWED_ON_NONLEAF_INT_VALUE = 66;
/**
* The result code (66) that will be used if the requested operation is not
* allowed to be performed on non-leaf entries. This result code is defined
* in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode NOT_ALLOWED_ON_NONLEAF =
new ResultCode(INFO_RC_NOT_ALLOWED_ON_NONLEAF.get(),
"notAllowedOnNonLeaf",
NOT_ALLOWED_ON_NONLEAF_INT_VALUE);
/**
* The integer value (67) for the "NOT_ALLOWED_ON_RDN" result code.
*/
public static final int NOT_ALLOWED_ON_RDN_INT_VALUE = 67;
/**
* The result code (67) that will be used if the requested operation would
* alter the RDN of the entry but the operation was not a modify DN request.
* This result code is defined in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode NOT_ALLOWED_ON_RDN =
new ResultCode(INFO_RC_NOT_ALLOWED_ON_RDN.get(), "notAllowedOnRDN",
NOT_ALLOWED_ON_RDN_INT_VALUE);
/**
* The integer value (68) for the "ENTRY_ALREADY_EXISTS" result code.
*/
public static final int ENTRY_ALREADY_EXISTS_INT_VALUE = 68;
/**
* The result code (68) that will be used if the requested operation would
* create a conflict with an entry that already exists in the server. This
* result code is defined in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode ENTRY_ALREADY_EXISTS =
new ResultCode(INFO_RC_ENTRY_ALREADY_EXISTS.get(), "entryAlreadyExists",
ENTRY_ALREADY_EXISTS_INT_VALUE);
/**
* The integer value (69) for the "OBJECT_CLASS_MODS_PROHIBITED" result code.
*/
public static final int OBJECT_CLASS_MODS_PROHIBITED_INT_VALUE = 69;
/**
* The result code (69) that will be used if the requested operation would
* alter the set of object classes defined in the entry in a disallowed
* manner. This result code is defined in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode OBJECT_CLASS_MODS_PROHIBITED =
new ResultCode(INFO_RC_OBJECT_CLASS_MODS_PROHIBITED.get(),
"objectClassModsProhibited",
OBJECT_CLASS_MODS_PROHIBITED_INT_VALUE);
/**
* The integer value (71) for the "AFFECTS_MULTIPLE_DSAS" result code.
*/
public static final int AFFECTS_MULTIPLE_DSAS_INT_VALUE = 71;
/**
* The result code (71) that will be used if the requested operation would
* impact entries in multiple data sources. This result code is defined in
* RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode AFFECTS_MULTIPLE_DSAS =
new ResultCode(INFO_RC_AFFECTS_MULTIPLE_DSAS.get(),
"affectsMultipleDSAs",
AFFECTS_MULTIPLE_DSAS_INT_VALUE);
/**
* The integer value (76) for the "VIRTUAL_LIST_VIEW_ERROR" result code.
*/
public static final int VIRTUAL_LIST_VIEW_ERROR_INT_VALUE = 76;
/**
* The result code (76) that will be used if an error occurred while
* performing processing associated with the virtual list view control. This
* result code is defined in draft-ietf-ldapext-ldapv3-vlv-09 section 6.2.1.
*/
@NotNull public static final ResultCode VIRTUAL_LIST_VIEW_ERROR =
new ResultCode(INFO_RC_VIRTUAL_LIST_VIEW_ERROR.get(),
"virtualListViewError",
VIRTUAL_LIST_VIEW_ERROR_INT_VALUE);
/**
* The integer value (80) for the "OTHER" result code.
*/
public static final int OTHER_INT_VALUE = 80;
/**
* The result code (80) that will be used if none of the other result codes
* are appropriate. This result code is defined in RFC 4511 section 4.1.9.
*/
@NotNull public static final ResultCode OTHER =
new ResultCode(INFO_RC_OTHER.get(), "other", OTHER_INT_VALUE);
/**
* The integer value (81) for the "SERVER_DOWN" result code.
*/
public static final int SERVER_DOWN_INT_VALUE = 81;
/**
* The client-side result code (81) that will be used if an established
* connection to the server is lost. This result code is defined in
* draft-ietf-ldapext-ldap-java-api-19 section 2.15.9.
*/
@NotNull public static final ResultCode SERVER_DOWN =
new ResultCode(INFO_RC_SERVER_DOWN.get(), "SERVER_DOWN",
SERVER_DOWN_INT_VALUE);
/**
* The integer value (82) for the "LOCAL_ERROR" result code.
*/
public static final int LOCAL_ERROR_INT_VALUE = 82;
/**
* The client-side result code (82) that will be used if a generic client-side
* error occurs during processing. This result code is defined in
* draft-ietf-ldapext-ldap-java-api-19 section 2.15.9.
*/
@NotNull public static final ResultCode LOCAL_ERROR =
new ResultCode(INFO_RC_LOCAL_ERROR.get(), "LOCAL_ERROR",
LOCAL_ERROR_INT_VALUE);
/**
* The integer value (83) for the "ENCODING_ERROR" result code.
*/
public static final int ENCODING_ERROR_INT_VALUE = 83;
/**
* The client-side result code (83) that will be used if an error occurs while
* encoding a request. This result code is defined in
* draft-ietf-ldapext-ldap-java-api-19 section 2.15.9.
*/
@NotNull public static final ResultCode ENCODING_ERROR =
new ResultCode(INFO_RC_ENCODING_ERROR.get(), "ENCODING_ERROR",
ENCODING_ERROR_INT_VALUE);
/**
* The integer value (84) for the "DECODING_ERROR" result code.
*/
public static final int DECODING_ERROR_INT_VALUE = 84;
/**
* The client-side result code (84) that will be used if an error occurs while
* decoding a response. This result code is defined in
* draft-ietf-ldapext-ldap-java-api-19 section 2.15.9.
*/
@NotNull public static final ResultCode DECODING_ERROR =
new ResultCode(INFO_RC_DECODING_ERROR.get(),
"DECODING_ERROR",
DECODING_ERROR_INT_VALUE);
/**
* The integer value (85) for the "TIMEOUT" result code.
*/
public static final int TIMEOUT_INT_VALUE = 85;
/**
* The client-side result code (85) that will be used if a client timeout
* occurs while waiting for a response from the server. This result code is
* defined in draft-ietf-ldapext-ldap-java-api-19 section 2.15.9.
*/
@NotNull public static final ResultCode TIMEOUT =
new ResultCode(INFO_RC_TIMEOUT.get(), "LDAP_TIMEOUT", TIMEOUT_INT_VALUE);
/**
* The integer value (86) for the "AUTH_UNKNOWN" result code.
*/
public static final int AUTH_UNKNOWN_INT_VALUE = 86;
/**
* The client-side result code (86) that will be used if the client attempts
* to use an unknown authentication type. This result code is defined in
* draft-ietf-ldapext-ldap-java-api-19 section 2.15.9.
*/
@NotNull public static final ResultCode AUTH_UNKNOWN =
new ResultCode(INFO_RC_AUTH_UNKNOWN.get(), "AUTH_UNKNOWN",
AUTH_UNKNOWN_INT_VALUE);
/**
* The integer value (87) for the "FILTER_ERROR" result code.
*/
public static final int FILTER_ERROR_INT_VALUE = 87;
/**
* The client-side result code (87) that will be used if an error occurs while
* attempting to encode a search filter. This result code is defined in
* draft-ietf-ldapext-ldap-java-api-19 section 2.15.9.
*/
@NotNull public static final ResultCode FILTER_ERROR =
new ResultCode(INFO_RC_FILTER_ERROR.get(), "FILTER_ERROR",
FILTER_ERROR_INT_VALUE);
/**
* The integer value (88) for the "USER_CANCELED" result code.
*/
public static final int USER_CANCELED_INT_VALUE = 88;
/**
* The client-side result code (88) that will be used if the end user canceled
* the operation in progress. This result code is defined in
* draft-ietf-ldapext-ldap-java-api-19 section 2.15.9.
*/
@NotNull public static final ResultCode USER_CANCELED =
new ResultCode(INFO_RC_USER_CANCELED.get(), "USER_CANCELLED",
USER_CANCELED_INT_VALUE);
/**
* The integer value (89) for the "PARAM_ERROR" result code.
*/
public static final int PARAM_ERROR_INT_VALUE = 89;
/**
* The client-side result code (89) that will be used if there is a problem
* with the parameters provided for a request. This result code is defined in
* draft-ietf-ldapext-ldap-java-api-13 section 4.14.7.
*/
@NotNull public static final ResultCode PARAM_ERROR =
new ResultCode(INFO_RC_PARAM_ERROR.get(), "PARAM_ERROR",
PARAM_ERROR_INT_VALUE);
/**
* The integer value (90) for the "NO_MEMORY" result code.
*/
public static final int NO_MEMORY_INT_VALUE = 90;
/**
* The client-side result code (90) that will be used if the client does not
* have sufficient memory to perform the requested operation. This result
* code is defined in draft-ietf-ldapext-ldap-java-api-19 section 2.15.9.
*/
@NotNull public static final ResultCode NO_MEMORY =
new ResultCode(INFO_RC_NO_MEMORY.get(), "NO_MEMORY",
NO_MEMORY_INT_VALUE);
/**
* The integer value (91) for the "CONNECT_ERROR" result code.
*/
public static final int CONNECT_ERROR_INT_VALUE = 91;
/**
* The client-side result code (91) that will be used if an error occurs while
* attempting to connect to a target server. This result code is defined in
* draft-ietf-ldapext-ldap-java-api-19 section 2.15.9.
*/
@NotNull public static final ResultCode CONNECT_ERROR =
new ResultCode(INFO_RC_CONNECT_ERROR.get(), "CONNECT_ERROR",
CONNECT_ERROR_INT_VALUE);
/**
* The integer value (92) for the "NOT_SUPPORTED" result code.
*/
public static final int NOT_SUPPORTED_INT_VALUE = 92;
/**
* The client-side result code (92) that will be used if the requested
* operation is not supported. This result code is defined in
* draft-ietf-ldapext-ldap-java-api-19 section 2.15.9.
*/
@NotNull public static final ResultCode NOT_SUPPORTED =
new ResultCode(INFO_RC_NOT_SUPPORTED.get(), "LDAP_NOT_SUPPORTED",
NOT_SUPPORTED_INT_VALUE);
/**
* The integer value (93) for the "CONTROL_NOT_FOUND" result code.
*/
public static final int CONTROL_NOT_FOUND_INT_VALUE = 93;
/**
* The client-side result code (93) that will be used if the response from the
* server did not include an expected control. This result code is defined in
* draft-ietf-ldapext-ldap-java-api-19 section 2.15.9.
*/
@NotNull public static final ResultCode CONTROL_NOT_FOUND =
new ResultCode(INFO_RC_CONTROL_NOT_FOUND.get(),
"CONTROL_NOT_FOUND",
CONTROL_NOT_FOUND_INT_VALUE);
/**
* The integer value (94) for the "NO_RESULTS_RETURNED" result code.
*/
public static final int NO_RESULTS_RETURNED_INT_VALUE = 94;
/**
* The client-side result code (94) that will be used if the server did not
* send any results. This result code is defined in
* draft-ietf-ldapext-ldap-java-api-19 section 2.15.9.
*/
@NotNull public static final ResultCode NO_RESULTS_RETURNED =
new ResultCode(INFO_RC_NO_RESULTS_RETURNED.get(),
"NO_RESULTS_RETURNED",
NO_RESULTS_RETURNED_INT_VALUE);
/**
* The integer value (95) for the "MORE_RESULTS_TO_RETURN" result code.
*/
public static final int MORE_RESULTS_TO_RETURN_INT_VALUE = 95;
/**
* The client-side result code (95) that will be used if there are still more
* results to return. This result code is defined in
* draft-ietf-ldapext-ldap-java-api-19 section 2.15.9.
*/
@NotNull public static final ResultCode MORE_RESULTS_TO_RETURN =
new ResultCode(INFO_RC_MORE_RESULTS_TO_RETURN.get(),
"MORE_RESULTS_TO_RETURN",
MORE_RESULTS_TO_RETURN_INT_VALUE);
/**
* The integer value (96) for the "CLIENT_LOOP" result code.
*/
public static final int CLIENT_LOOP_INT_VALUE = 96;
/**
* The client-side result code (96) that will be used if the client detects a
* loop while attempting to follow referrals. This result code is defined in
* draft-ietf-ldapext-ldap-java-api-19 section 2.15.9.
*/
@NotNull public static final ResultCode CLIENT_LOOP =
new ResultCode(INFO_RC_CLIENT_LOOP.get(), "CLIENT_LOOP",
CLIENT_LOOP_INT_VALUE);
/**
* The integer value (97) for the "REFERRAL_LIMIT_EXCEEDED" result code.
*/
public static final int REFERRAL_LIMIT_EXCEEDED_INT_VALUE = 97;
/**
* The client-side result code (97) that will be used if the client
* encountered too many referrals in the course of processing an operation.
* This result code is defined in draft-ietf-ldapext-ldap-java-api-19 section
* 2.15.9.
*/
@NotNull public static final ResultCode REFERRAL_LIMIT_EXCEEDED =
new ResultCode(INFO_RC_REFERRAL_LIMIT_EXCEEDED.get(),
"REFERRAL_LIMIT_EXCEEDED",
REFERRAL_LIMIT_EXCEEDED_INT_VALUE);
/**
* The integer value (118) for the "CANCELED" result code.
*/
public static final int CANCELED_INT_VALUE = 118;
/**
* The result code (118) that will be used if the operation was canceled.
* This result code is defined in RFC 3909 section 2.3.
*/
@NotNull public static final ResultCode CANCELED =
new ResultCode(INFO_RC_CANCELED.get(), "canceled", CANCELED_INT_VALUE);
/**
* The integer value (119) for the "NO_SUCH_OPERATION" result code.
*/
public static final int NO_SUCH_OPERATION_INT_VALUE = 119;
/**
* The result code (119) that will be used if the client attempts to cancel an
* operation for which the server has no knowledge (e.g., because the
* operation had already completed or no such operation had been requested).
* This result code is defined in RFC 3909 section 2.3.
*/
@NotNull public static final ResultCode NO_SUCH_OPERATION =
new ResultCode(INFO_RC_NO_SUCH_OPERATION.get(), "noSuchOperation",
NO_SUCH_OPERATION_INT_VALUE);
/**
* The integer value (120) for the "TOO_LATE" result code.
*/
public static final int TOO_LATE_INT_VALUE = 120;
/**
* The result code (120) that will be used if the client attempts to cancel an
* operation too late in the processing for that operation. This result code
* is defined in RFC 3909 section 2.3.
*/
@NotNull public static final ResultCode TOO_LATE =
new ResultCode(INFO_RC_TOO_LATE.get(), "tooLate", TOO_LATE_INT_VALUE);
/**
* The integer value (121) for the "CANNOT_CANCEL" result code.
*/
public static final int CANNOT_CANCEL_INT_VALUE = 121;
/**
* The result code (121) that will be used if the client attempts to cancel an
* operation that cannot be canceled. This result code is defined in RFC 3909
* section 2.3.
*/
@NotNull public static final ResultCode CANNOT_CANCEL =
new ResultCode(INFO_RC_CANNOT_CANCEL.get(), "cannotCancel",
CANNOT_CANCEL_INT_VALUE);
/**
* The integer value (122) for the "ASSERTION_FAILED" result code.
*/
public static final int ASSERTION_FAILED_INT_VALUE = 122;
/**
* The result code (122) that will be used if the requested operation included
* the LDAP assertion control but the assertion did not match the target
* entry. This result code is defined in RFC 4528 section 5.3.
*/
@NotNull public static final ResultCode ASSERTION_FAILED =
new ResultCode(INFO_RC_ASSERTION_FAILED.get(), "assertionFailed",
ASSERTION_FAILED_INT_VALUE);
/**
* The integer value (123) for the "AUTHORIZATION_DENIED" result code.
*/
public static final int AUTHORIZATION_DENIED_INT_VALUE = 123;
/**
* The result code (123) that will be used if the client is denied the ability
* to use the proxied authorization control. This result code is defined in
* RFC 4370 section 6 (although the standard name is not referenced there, but
* it is used in both RFC 4532 section 6.1 and RFC 5805 section 4.4).
*/
@NotNull public static final ResultCode AUTHORIZATION_DENIED =
new ResultCode(INFO_RC_AUTHORIZATION_DENIED.get(),
"authorizationDenied",
AUTHORIZATION_DENIED_INT_VALUE);
/**
* The integer value (4096) for the "E_SYNC_REFRESH_REQUIRED" result code.
*/
public static final int E_SYNC_REFRESH_REQUIRED_INT_VALUE = 4096;
/**
* The result code (4096) that will be used if a client using the content
* synchronization request control requests an incremental update but the
* server is unable to honor that request and requires the client to request
* an initial content. This result code is defined in RFC 4533 section 2.6.
*/
@NotNull public static final ResultCode E_SYNC_REFRESH_REQUIRED =
new ResultCode(INFO_RC_E_SYNC_REFRESH_REQUIRED.get(),
"e-syncRefreshRequired",
E_SYNC_REFRESH_REQUIRED_INT_VALUE);
/**
* The integer value (16654) for the "NO_OPERATION" result code.
*/
public static final int NO_OPERATION_INT_VALUE = 16_654;
/**
* The result code (16654) for operations that completed successfully but no
* changes were made to the server because the LDAP no-op control was included
* in the request. This result code is defined in
* draft-zeilenga-ldap-noop-12 section 4.3 (although the numeric value is not
* defined in that specification; the numeric value used for this result code
* is the same as the one originally used by OpenLDAP).
*/
@NotNull public static final ResultCode NO_OPERATION =
new ResultCode(INFO_RC_NO_OPERATION.get(), "noOperation",
NO_OPERATION_INT_VALUE);
/**
* The integer value (30221001) for the "INTERACTIVE_TRANSACTION_ABORTED"
* result code.
*/
public static final int INTERACTIVE_TRANSACTION_ABORTED_INT_VALUE =
30_221_001;
/**
* The result code (30221001) for use if an interactive transaction has been
* aborted, either due to an explicit request from a client or by the server
* without a client request. This is a proprietary result code originally
* defined by UnboundID corporation.
*/
@NotNull public static final ResultCode INTERACTIVE_TRANSACTION_ABORTED =
new ResultCode(INFO_RC_INTERACTIVE_TRANSACTION_ABORTED.get(),
"interactiveTransactionAborted",
INTERACTIVE_TRANSACTION_ABORTED_INT_VALUE);
/**
* The integer value (30221002) for the "DATABASE_LOCK_CONFLICT" result code.
*/
public static final int DATABASE_LOCK_CONFLICT_INT_VALUE = 30_221_002;
/**
* The result code (30221002) for use if an operation fails because of a
* database lock conflict (e.g., a deadlock or lock timeout). This is a
* proprietary result code originally defined by UnboundID corporation.
*/
@NotNull public static final ResultCode DATABASE_LOCK_CONFLICT =
new ResultCode(INFO_RC_DATABASE_LOCK_CONFLICT.get(),
"databaseLockConflict",
DATABASE_LOCK_CONFLICT_INT_VALUE);
/**
* The integer value (30221003) for the "MIRRORED_SUBTREE_DIGEST_MISMATCH"
* result code.
*/
public static final int MIRRORED_SUBTREE_DIGEST_MISMATCH_INT_VALUE =
30_221_003;
/**
* The result code (30221003) that should be used by a node in a topology of
* servers to indicate that its subtree digest does not match that of its
* master. This is a proprietary result code originally defined by UnboundID
* corporation.
*/
@NotNull public static final ResultCode MIRRORED_SUBTREE_DIGEST_MISMATCH =
new ResultCode(INFO_RC_MIRRORED_SUBTREE_DIGEST_MISMATCH.get(),
"mirroredSubtreeDigestMismatch",
MIRRORED_SUBTREE_DIGEST_MISMATCH_INT_VALUE);
/**
* The integer value (30221004) for the "TOKEN_DELIVERY_MECHANISM_UNAVAILABLE"
* result code.
*/
public static final int TOKEN_DELIVERY_MECHANISM_UNAVAILABLE_INT_VALUE =
30_221_004;
/**
* The result code (30221004) that should be used to indicate that the server
* could not deliver a one-time password, password reset token, or single-use
* token because none of the attempted delivery mechanisms were supported for
* the target user. This is a proprietary result code originally defined by
* UnboundID corporation.
*/
@NotNull public static final ResultCode TOKEN_DELIVERY_MECHANISM_UNAVAILABLE =
new ResultCode(INFO_RC_TOKEN_DELIVERY_MECHANISM_UNAVAILABLE.get(),
"tokenDeliveryMechanismUnavailable",
TOKEN_DELIVERY_MECHANISM_UNAVAILABLE_INT_VALUE);
/**
* The integer value (30221005) for the "TOKEN_DELIVERY_ATTEMPT_FAILED"
* result code.
*/
public static final int TOKEN_DELIVERY_ATTEMPT_FAILED_INT_VALUE = 30_221_005;
/**
* The result code (30221005) that should be used to indicate that the server
* could not deliver a one-time password, password reset token, or single-use
* token because a failure was encountered while attempting to deliver the
* token through all of the supported mechanisms. This is a proprietary
* result code originally defined by UnboundID corporation.
*/
@NotNull public static final ResultCode TOKEN_DELIVERY_ATTEMPT_FAILED =
new ResultCode(INFO_RC_TOKEN_DELIVERY_ATTEMPT_FAILED.get(),
"tokenDeliveryAttemptFailed",
TOKEN_DELIVERY_ATTEMPT_FAILED_INT_VALUE);
/**
* The integer value (30221006) for the "TOKEN_DELIVERY_INVALID_RECIPIENT_ID"
* result code.
*/
public static final int TOKEN_DELIVERY_INVALID_RECIPIENT_ID_INT_VALUE =
30_221_006;
/**
* The result code (30221006) that should be used to indicate that the server
* could not deliver a one-time password, password reset token, or single-use
* token because the client specified a recipient ID that was not appropriate
* for the target user. This is a proprietary result code originally defined
* by UnboundID corporation.
*/
@NotNull public static final ResultCode TOKEN_DELIVERY_INVALID_RECIPIENT_ID =
new ResultCode(INFO_RC_TOKEN_DELIVERY_INVALID_RECIPIENT_ID.get(),
"tokenDeliveryInvalidRecipientID",
TOKEN_DELIVERY_INVALID_RECIPIENT_ID_INT_VALUE);
/**
* The integer value (30221007) for the "TOKEN_DELIVERY_INVALID_ACCOUNT_STATE"
* result code.
*/
public static final int TOKEN_DELIVERY_INVALID_ACCOUNT_STATE_INT_VALUE =
30_221_007;
/**
* The result code (30221007) that should be used to indicate that the server
* could not deliver a one-time password, password reset token, or single-use
* token because the target user account was in an invalid state for receiving
* such tokens (e.g., the account is disabled or locked, the password is
* expired, etc.). This is a proprietary result code originally defined by
* UnboundID corporation.
*/
@NotNull public static final ResultCode TOKEN_DELIVERY_INVALID_ACCOUNT_STATE =
new ResultCode(INFO_RC_TOKEN_DELIVERY_INVALID_ACCOUNT_STATE.get(),
"tokenDeliveryInvalidAccountState",
TOKEN_DELIVERY_INVALID_ACCOUNT_STATE_INT_VALUE);
/**
* The set of result code objects created with undefined int result code
* values.
*/
@NotNull private static final ConcurrentHashMap
UNDEFINED_RESULT_CODES =
new ConcurrentHashMap<>(StaticUtils.computeMapCapacity(10));
/**
* The default set of result codes that may indicate that a connection is not
* usable. This set includes:
*
*
{@link #OPERATIONS_ERROR}
*
{@link #PROTOCOL_ERROR}
*
{@link #BUSY}
*
{@link #UNAVAILABLE}
*
{@link #OTHER}
*
{@link #SERVER_DOWN}
*
{@link #LOCAL_ERROR}
*
{@link #ENCODING_ERROR}
*
{@link #DECODING_ERROR}
*
{@link #TIMEOUT}
*
{@link #NO_MEMORY}
*
{@link #CONNECT_ERROR}
*
*/
@NotNull public static final Set
DEFAULT_CONNECTION_NOT_USABLE_RESULT_CODES = StaticUtils.setOf(
ResultCode.OPERATIONS_ERROR,
ResultCode.PROTOCOL_ERROR,
ResultCode.BUSY,
ResultCode.UNAVAILABLE,
ResultCode.OTHER,
ResultCode.SERVER_DOWN,
ResultCode.LOCAL_ERROR,
ResultCode.ENCODING_ERROR,
ResultCode.DECODING_ERROR,
ResultCode.TIMEOUT,
ResultCode.NO_MEMORY,
ResultCode.CONNECT_ERROR);
/**
* A reference to the set of connection-not-usable result codes that are
* currently in effect.
*/
@NotNull private static final AtomicReference>
CONNECTION_NOT_USABLE_RESULT_CODES_REF =
new AtomicReference<>(DEFAULT_CONNECTION_NOT_USABLE_RESULT_CODES);
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = 7609311304252378100L;
// The integer value for this result code.
private final int intValue;
// The name for this result code.
@NotNull private final String name;
// The name for this result code as it appears in the relevant specification.
@Nullable private final String standardName;
// The string representation for this result code.
@NotNull private final String stringRepresentation;
/**
* Creates a new result code with the specified integer value.
*
* @param intValue The integer value for this result code.
*/
private ResultCode(final int intValue)
{
this.intValue = intValue;
name = String.valueOf(intValue);
stringRepresentation = name;
standardName = null;
}
/**
* Creates a new result code with the specified name and integer value.
*
* @param name The user-friendly name for this result code. It must
* not be {@code null}.
* @param intValue The integer value for this result code.
*/
private ResultCode(@NotNull final String name, final int intValue)
{
this(name, null, intValue);
}
/**
* Creates a new result code with the specified name and integer value.
*
* @param name The user-friendly name for this result code. It
* must not be {@code null}.
* @param standardName The name for this result code as it appears in the
* relevant LDAP specification. It may be {@code null}
* for result codes that are not defined in an official
* specification.
* @param intValue The integer value for this result code.
*/
private ResultCode(@NotNull final String name,
@Nullable final String standardName,
final int intValue)
{
this.name = name;
this.standardName = standardName;
this.intValue = intValue;
stringRepresentation = intValue + " (" + name + ')';
}
/**
* Retrieves the user-friendly name for this result code.
*
* @return The user-friendly name for this result code.
*/
@NotNull()
public String getName()
{
return name;
}
/**
* Retrieves the name for this result code as it appears in the relevant LDAP
* specification, if any. In most cases, it is formatted in camelCase, with
* the first letter lowercase, and the first letter of every subsequent word
* and all letters in acronyms in uppercase. However, some result codes may
* use different formatting (for example, those defined in API specifications
* and meant for client-side use tend to use all uppercase with words
* separated by underscores).
*
* @return The name for this result code as it appears in the relevant LDAP
* specification, or {@code null} if the result code is not defined
* in any public specification.
*/
@Nullable()
public String getStandardName()
{
return standardName;
}
/**
* Retrieves the integer value for this result code.
*
* @return The integer value for this result code.
*/
public int intValue()
{
return intValue;
}
/**
* Retrieves the result code with the specified integer value. If the
* provided integer value does not correspond to a predefined
* {@code ResultCode} object, then a new {@code ResultCode} object will be
* created and returned. Any new result codes created will also be cached
* and returned for any subsequent requests with that integer value so the
* same object will always be returned for a given integer value.
*
* @param intValue The integer value for which to retrieve the corresponding
* result code.
*
* @return The result code with the specified integer value, or a new result
* code
*/
@NotNull()
public static ResultCode valueOf(final int intValue)
{
return valueOf(intValue, null);
}
/**
* Retrieves the result code with the specified integer value. If the
* provided integer value does not correspond to a predefined
* {@code ResultCode} object, then a new {@code ResultCode} object will be
* created and returned. Any new result codes created will also be cached
* and returned for any subsequent requests with that integer value so the
* same object will always be returned for a given integer value.
*
* @param intValue The integer value for which to retrieve the corresponding
* result code.
* @param name The user-friendly name to use for the result code if no
* result code has been previously accessed with the same
* integer value. It may be {@code null} if this is not
* known or a string representation of the integer value
* should be used.
*
* @return The result code with the specified integer value, or a new result
* code
*/
@NotNull()
public static ResultCode valueOf(final int intValue,
@Nullable final String name)
{
return valueOf(intValue, name, true);
}
/**
* Retrieves the result code with the specified integer value. If the
* provided integer value does not correspond to an already-defined
* {@code ResultCode} object, then this method may optionally create and
* return a new {@code ResultCode}. Any new result codes created will also be
* cached and returned for any subsequent requests with that integer value so
* the same object will always be returned for a given integer value.
*
* @param intValue The integer value for which to retrieve the
* corresponding result code.
* @param name The user-friendly name to use for the result
* code if no result code has been previously
* accessed with the same integer value. It may
* be {@code null} if this is not known or a
* string representation of the integer value
* should be used.
* @param createNewResultCode Indicates whether to create a new result code
* object with the specified integer value and
* name if that value does not correspond to
* any already-defined result code.
*
* @return The existing result code with the specified integer value if one
* already existed, a newly-created result code with the specified
* name and integer value if none already existed but
* {@code createNewResultCode} is {@code true}, or {@code null} if no
* result code already existed with the specified integer value and
* {@code createNewResultCode} is {@code false}.
*/
@Nullable()
public static ResultCode valueOf(final int intValue,
@Nullable final String name,
final boolean createNewResultCode)
{
switch (intValue)
{
case SUCCESS_INT_VALUE:
return SUCCESS;
case OPERATIONS_ERROR_INT_VALUE:
return OPERATIONS_ERROR;
case PROTOCOL_ERROR_INT_VALUE:
return PROTOCOL_ERROR;
case TIME_LIMIT_EXCEEDED_INT_VALUE:
return TIME_LIMIT_EXCEEDED;
case SIZE_LIMIT_EXCEEDED_INT_VALUE:
return SIZE_LIMIT_EXCEEDED;
case COMPARE_FALSE_INT_VALUE:
return COMPARE_FALSE;
case COMPARE_TRUE_INT_VALUE:
return COMPARE_TRUE;
case AUTH_METHOD_NOT_SUPPORTED_INT_VALUE:
return AUTH_METHOD_NOT_SUPPORTED;
case STRONG_AUTH_REQUIRED_INT_VALUE:
return STRONG_AUTH_REQUIRED;
case REFERRAL_INT_VALUE:
return REFERRAL;
case ADMIN_LIMIT_EXCEEDED_INT_VALUE:
return ADMIN_LIMIT_EXCEEDED;
case UNAVAILABLE_CRITICAL_EXTENSION_INT_VALUE:
return UNAVAILABLE_CRITICAL_EXTENSION;
case CONFIDENTIALITY_REQUIRED_INT_VALUE:
return CONFIDENTIALITY_REQUIRED;
case SASL_BIND_IN_PROGRESS_INT_VALUE:
return SASL_BIND_IN_PROGRESS;
case NO_SUCH_ATTRIBUTE_INT_VALUE:
return NO_SUCH_ATTRIBUTE;
case UNDEFINED_ATTRIBUTE_TYPE_INT_VALUE:
return UNDEFINED_ATTRIBUTE_TYPE;
case INAPPROPRIATE_MATCHING_INT_VALUE:
return INAPPROPRIATE_MATCHING;
case CONSTRAINT_VIOLATION_INT_VALUE:
return CONSTRAINT_VIOLATION;
case ATTRIBUTE_OR_VALUE_EXISTS_INT_VALUE:
return ATTRIBUTE_OR_VALUE_EXISTS;
case INVALID_ATTRIBUTE_SYNTAX_INT_VALUE:
return INVALID_ATTRIBUTE_SYNTAX;
case NO_SUCH_OBJECT_INT_VALUE:
return NO_SUCH_OBJECT;
case ALIAS_PROBLEM_INT_VALUE:
return ALIAS_PROBLEM;
case INVALID_DN_SYNTAX_INT_VALUE:
return INVALID_DN_SYNTAX;
case ALIAS_DEREFERENCING_PROBLEM_INT_VALUE:
return ALIAS_DEREFERENCING_PROBLEM;
case INAPPROPRIATE_AUTHENTICATION_INT_VALUE:
return INAPPROPRIATE_AUTHENTICATION;
case INVALID_CREDENTIALS_INT_VALUE:
return INVALID_CREDENTIALS;
case INSUFFICIENT_ACCESS_RIGHTS_INT_VALUE:
return INSUFFICIENT_ACCESS_RIGHTS;
case BUSY_INT_VALUE:
return BUSY;
case UNAVAILABLE_INT_VALUE:
return UNAVAILABLE;
case UNWILLING_TO_PERFORM_INT_VALUE:
return UNWILLING_TO_PERFORM;
case LOOP_DETECT_INT_VALUE:
return LOOP_DETECT;
case SORT_CONTROL_MISSING_INT_VALUE:
return SORT_CONTROL_MISSING;
case OFFSET_RANGE_ERROR_INT_VALUE:
return OFFSET_RANGE_ERROR;
case NAMING_VIOLATION_INT_VALUE:
return NAMING_VIOLATION;
case OBJECT_CLASS_VIOLATION_INT_VALUE:
return OBJECT_CLASS_VIOLATION;
case NOT_ALLOWED_ON_NONLEAF_INT_VALUE:
return NOT_ALLOWED_ON_NONLEAF;
case NOT_ALLOWED_ON_RDN_INT_VALUE:
return NOT_ALLOWED_ON_RDN;
case ENTRY_ALREADY_EXISTS_INT_VALUE:
return ENTRY_ALREADY_EXISTS;
case OBJECT_CLASS_MODS_PROHIBITED_INT_VALUE:
return OBJECT_CLASS_MODS_PROHIBITED;
case AFFECTS_MULTIPLE_DSAS_INT_VALUE:
return AFFECTS_MULTIPLE_DSAS;
case VIRTUAL_LIST_VIEW_ERROR_INT_VALUE:
return VIRTUAL_LIST_VIEW_ERROR;
case OTHER_INT_VALUE:
return OTHER;
case SERVER_DOWN_INT_VALUE:
return SERVER_DOWN;
case LOCAL_ERROR_INT_VALUE:
return LOCAL_ERROR;
case ENCODING_ERROR_INT_VALUE:
return ENCODING_ERROR;
case DECODING_ERROR_INT_VALUE:
return DECODING_ERROR;
case TIMEOUT_INT_VALUE:
return TIMEOUT;
case AUTH_UNKNOWN_INT_VALUE:
return AUTH_UNKNOWN;
case FILTER_ERROR_INT_VALUE:
return FILTER_ERROR;
case USER_CANCELED_INT_VALUE:
return USER_CANCELED;
case PARAM_ERROR_INT_VALUE:
return PARAM_ERROR;
case NO_MEMORY_INT_VALUE:
return NO_MEMORY;
case CONNECT_ERROR_INT_VALUE:
return CONNECT_ERROR;
case NOT_SUPPORTED_INT_VALUE:
return NOT_SUPPORTED;
case CONTROL_NOT_FOUND_INT_VALUE:
return CONTROL_NOT_FOUND;
case NO_RESULTS_RETURNED_INT_VALUE:
return NO_RESULTS_RETURNED;
case MORE_RESULTS_TO_RETURN_INT_VALUE:
return MORE_RESULTS_TO_RETURN;
case CLIENT_LOOP_INT_VALUE:
return CLIENT_LOOP;
case REFERRAL_LIMIT_EXCEEDED_INT_VALUE:
return REFERRAL_LIMIT_EXCEEDED;
case CANCELED_INT_VALUE:
return CANCELED;
case NO_SUCH_OPERATION_INT_VALUE:
return NO_SUCH_OPERATION;
case TOO_LATE_INT_VALUE:
return TOO_LATE;
case CANNOT_CANCEL_INT_VALUE:
return CANNOT_CANCEL;
case ASSERTION_FAILED_INT_VALUE:
return ASSERTION_FAILED;
case AUTHORIZATION_DENIED_INT_VALUE:
return AUTHORIZATION_DENIED;
case E_SYNC_REFRESH_REQUIRED_INT_VALUE:
return E_SYNC_REFRESH_REQUIRED;
case NO_OPERATION_INT_VALUE:
return NO_OPERATION;
case INTERACTIVE_TRANSACTION_ABORTED_INT_VALUE:
return INTERACTIVE_TRANSACTION_ABORTED;
case DATABASE_LOCK_CONFLICT_INT_VALUE:
return DATABASE_LOCK_CONFLICT;
case MIRRORED_SUBTREE_DIGEST_MISMATCH_INT_VALUE:
return MIRRORED_SUBTREE_DIGEST_MISMATCH;
case TOKEN_DELIVERY_MECHANISM_UNAVAILABLE_INT_VALUE:
return TOKEN_DELIVERY_MECHANISM_UNAVAILABLE;
case TOKEN_DELIVERY_ATTEMPT_FAILED_INT_VALUE:
return TOKEN_DELIVERY_ATTEMPT_FAILED;
case TOKEN_DELIVERY_INVALID_RECIPIENT_ID_INT_VALUE:
return TOKEN_DELIVERY_INVALID_RECIPIENT_ID;
case TOKEN_DELIVERY_INVALID_ACCOUNT_STATE_INT_VALUE:
return TOKEN_DELIVERY_INVALID_ACCOUNT_STATE;
}
ResultCode rc = UNDEFINED_RESULT_CODES.get(intValue);
if (rc == null)
{
if (! createNewResultCode)
{
return null;
}
if (name == null)
{
rc = new ResultCode(intValue);
}
else
{
rc = new ResultCode(name, intValue);
}
final ResultCode existingRC =
UNDEFINED_RESULT_CODES.putIfAbsent(intValue, rc);
if (existingRC != null)
{
return existingRC;
}
}
return rc;
}
/**
* Retrieves an array of all result codes defined in the LDAP SDK. This will
* not include dynamically-generated values.
*
* @return An array of all result codes defined in the LDAP SDK.
*/
@NotNull()
public static ResultCode[] values()
{
return new ResultCode[]
{
SUCCESS,
OPERATIONS_ERROR,
PROTOCOL_ERROR,
TIME_LIMIT_EXCEEDED,
SIZE_LIMIT_EXCEEDED,
COMPARE_FALSE,
COMPARE_TRUE,
AUTH_METHOD_NOT_SUPPORTED,
STRONG_AUTH_REQUIRED,
REFERRAL,
ADMIN_LIMIT_EXCEEDED,
UNAVAILABLE_CRITICAL_EXTENSION,
CONFIDENTIALITY_REQUIRED,
SASL_BIND_IN_PROGRESS,
NO_SUCH_ATTRIBUTE,
UNDEFINED_ATTRIBUTE_TYPE,
INAPPROPRIATE_MATCHING,
CONSTRAINT_VIOLATION,
ATTRIBUTE_OR_VALUE_EXISTS,
INVALID_ATTRIBUTE_SYNTAX,
NO_SUCH_OBJECT,
ALIAS_PROBLEM,
INVALID_DN_SYNTAX,
ALIAS_DEREFERENCING_PROBLEM,
INAPPROPRIATE_AUTHENTICATION,
INVALID_CREDENTIALS,
INSUFFICIENT_ACCESS_RIGHTS,
BUSY,
UNAVAILABLE,
UNWILLING_TO_PERFORM,
LOOP_DETECT,
SORT_CONTROL_MISSING,
OFFSET_RANGE_ERROR,
NAMING_VIOLATION,
OBJECT_CLASS_VIOLATION,
NOT_ALLOWED_ON_NONLEAF,
NOT_ALLOWED_ON_RDN,
ENTRY_ALREADY_EXISTS,
OBJECT_CLASS_MODS_PROHIBITED,
AFFECTS_MULTIPLE_DSAS,
VIRTUAL_LIST_VIEW_ERROR,
OTHER,
SERVER_DOWN,
LOCAL_ERROR,
ENCODING_ERROR,
DECODING_ERROR,
TIMEOUT,
AUTH_UNKNOWN,
FILTER_ERROR,
USER_CANCELED,
PARAM_ERROR,
NO_MEMORY,
CONNECT_ERROR,
NOT_SUPPORTED,
CONTROL_NOT_FOUND,
NO_RESULTS_RETURNED,
MORE_RESULTS_TO_RETURN,
CLIENT_LOOP,
REFERRAL_LIMIT_EXCEEDED,
CANCELED,
NO_SUCH_OPERATION,
TOO_LATE,
CANNOT_CANCEL,
ASSERTION_FAILED,
AUTHORIZATION_DENIED,
E_SYNC_REFRESH_REQUIRED,
NO_OPERATION,
INTERACTIVE_TRANSACTION_ABORTED,
DATABASE_LOCK_CONFLICT,
MIRRORED_SUBTREE_DIGEST_MISMATCH,
TOKEN_DELIVERY_MECHANISM_UNAVAILABLE,
TOKEN_DELIVERY_ATTEMPT_FAILED,
TOKEN_DELIVERY_INVALID_RECIPIENT_ID,
TOKEN_DELIVERY_INVALID_ACCOUNT_STATE
};
}
/**
* Indicates whether this result code is one that should be used for
* client-side errors rather than returned by the server.
*
* @return {@code true} if this result code is a client-side result code, or
* {@code false} if it is one that may be returned by the server.
*/
public boolean isClientSideResultCode()
{
return isClientSideResultCode(this);
}
/**
* Indicates whether the provided result code is one that should be used for
* client-side errors rather than returned by the server.
*
* @param resultCode The result code for which to make the determination.
*
* @return {@code true} if the provided result code is a client-side result
* code, or {@code false} if it is one that may be returned by the
* server.
*/
public static boolean isClientSideResultCode(
@NotNull final ResultCode resultCode)
{
switch (resultCode.intValue())
{
case SERVER_DOWN_INT_VALUE:
case LOCAL_ERROR_INT_VALUE:
case ENCODING_ERROR_INT_VALUE:
case DECODING_ERROR_INT_VALUE:
case TIMEOUT_INT_VALUE:
case AUTH_UNKNOWN_INT_VALUE:
case FILTER_ERROR_INT_VALUE:
case USER_CANCELED_INT_VALUE:
case PARAM_ERROR_INT_VALUE:
case NO_MEMORY_INT_VALUE:
case CONNECT_ERROR_INT_VALUE:
case NOT_SUPPORTED_INT_VALUE:
case CONTROL_NOT_FOUND_INT_VALUE:
case NO_RESULTS_RETURNED_INT_VALUE:
case MORE_RESULTS_TO_RETURN_INT_VALUE:
case CLIENT_LOOP_INT_VALUE:
case REFERRAL_LIMIT_EXCEEDED_INT_VALUE:
return true;
default:
return false;
}
}
/**
* Retrieves the set of result codes that may indicate that a connection is
* not usable.
*
* @return The set of result codes that may indicate that a connection is
* not usable.
*/
@NotNull()
public static Set getConnectionNotUsableResultCodes()
{
return CONNECTION_NOT_USABLE_RESULT_CODES_REF.get();
}
/**
* Updates the set of result codes that may indicate that a connection is not
* usable.
*
* @param connectionNotUsableResultCodes The set of result codes that may
* indicate that a connection is not
* usable. It must not be
* {@code null}, but may be empty.
*/
public static void setConnectionNotUsableResultCodes(
@NotNull final ResultCode... connectionNotUsableResultCodes)
{
setConnectionNotUsableResultCodes(
Arrays.asList(connectionNotUsableResultCodes));
}
/**
* Updates the set of result codes that may indicate that a connection is not
* usable.
*
* @param connectionNotUsableResultCodes The set of result codes that may
* indicate that a connection is not
* usable. It must not be
* {@code null}, but may be empty.
*/
public static void setConnectionNotUsableResultCodes(
@NotNull final Collection
connectionNotUsableResultCodes)
{
CONNECTION_NOT_USABLE_RESULT_CODES_REF.set(Collections.unmodifiableSet(
new LinkedHashSet<>(connectionNotUsableResultCodes)));
}
/**
* Indicates whether the connection on which this result code was received is
* likely still usable. Note that this is a best guess, and it may or may not
* be correct. It will attempt to be conservative so that a connection is
* more likely to be classified as unusable when it may still be valid than to
* be classified as usable when that is no longer the case.
*
* @return {@code true} if it is likely that the connection on which this
* result code was received is still usable, or {@code false} if it
* may no longer be valid.
*/
public boolean isConnectionUsable()
{
return isConnectionUsable(this);
}
/**
* Indicates whether the connection on which the provided result code was
* received is likely still usable. Note that this is a best guess based on
* the provided result code, and it may or may not be correct. It will
* attempt to be conservative so that a connection is more likely to be
* classified as unusable when it may still be valid than to be classified
* as usable when that is no longer the case.
*
* @param resultCode The result code for which to make the determination.
*
* @return {@code true} if it is likely that the connection on which the
* provided result code was received is still usable, or
* {@code false} if it may no longer be valid.
*/
public static boolean isConnectionUsable(@NotNull final ResultCode resultCode)
{
return ! CONNECTION_NOT_USABLE_RESULT_CODES_REF.get().contains(resultCode);
}
/**
* The hash code for this result code.
*
* @return The hash code for this result code.
*/
@Override()
public int hashCode()
{
return intValue;
}
/**
* Indicates whether the provided object is equal to this result code.
*
* @param o The object for which to make the determination.
*
* @return {@code true} if the provided object is a result code that is equal
* to this result code, or {@code false} if not.
*/
@Override()
public boolean equals(@Nullable final Object o)
{
if (o == null)
{
return false;
}
else if (o == this)
{
return true;
}
else if (o instanceof ResultCode)
{
return (intValue == ((ResultCode) o).intValue);
}
else
{
return false;
}
}
/**
* Retrieves a string representation of this result code.
*
* @return A string representation of this result code.
*/
@Override()
@NotNull()
public String toString()
{
return stringRepresentation;
}
}
