@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ResultCode extends java.lang.Object implements java.io.Serializable
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
equals(java.lang.Object)
method or the "==
" operator.
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 |
Modifier and Type | Field and Description |
---|---|
static ResultCode |
ADMIN_LIMIT_EXCEEDED
The result code (11) that will be used if a server administrative limit has
been exceeded.
|
static int |
ADMIN_LIMIT_EXCEEDED_INT_VALUE
The integer value (11) for the "ADMIN_LIMIT_EXCEEDED" result code.
|
static ResultCode |
AFFECTS_MULTIPLE_DSAS
The result code (71) that will be used if the requested operation would
impact entries in multiple data sources.
|
static int |
AFFECTS_MULTIPLE_DSAS_INT_VALUE
The integer value (71) for the "AFFECTS_MULTIPLE_DSAS" result code.
|
static ResultCode |
ALIAS_DEREFERENCING_PROBLEM
The result code (36) that will be used if a problem is encountered while
the server is attempting to dereference an alias.
|
static int |
ALIAS_DEREFERENCING_PROBLEM_INT_VALUE
The integer value (36) for the "ALIAS_DEREFERENCING_PROBLEM" result code.
|
static ResultCode |
ALIAS_PROBLEM
The result code (33) that will be used if the client targeted an entry that
as an alias.
|
static int |
ALIAS_PROBLEM_INT_VALUE
The integer value (33) for the "ALIAS_PROBLEM" result code.
|
static ResultCode |
ASSERTION_FAILED
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.
|
static int |
ASSERTION_FAILED_INT_VALUE
The integer value (122) for the "ASSERTION_FAILED" result code.
|
static ResultCode |
ATTRIBUTE_OR_VALUE_EXISTS
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.
|
static int |
ATTRIBUTE_OR_VALUE_EXISTS_INT_VALUE
The integer value (20) for the "ATTRIBUTE_OR_VALUE_EXISTS" result code.
|
static ResultCode |
AUTH_METHOD_NOT_SUPPORTED
The result code (7) that will be used if the client requested a form of
authentication that is not supported by the server.
|
static int |
AUTH_METHOD_NOT_SUPPORTED_INT_VALUE
The integer value (7) for the "AUTH_METHOD_NOT_SUPPORTED" result code.
|
static ResultCode |
AUTH_UNKNOWN
The client-side result code (86) that will be used if the client attempts
to use an unknown authentication type.
|
static int |
AUTH_UNKNOWN_INT_VALUE
The integer value (86) for the "AUTH_UNKNOWN" result code.
|
static ResultCode |
AUTHORIZATION_DENIED
The result code (123) that will be used if the client is denied the ability
to use the proxied authorization control.
|
static int |
AUTHORIZATION_DENIED_INT_VALUE
The integer value (123) for the "AUTHORIZATION_DENIED" result code.
|
static ResultCode |
BUSY
The result code (51) that will be used if the server is too busy to process
the requested operation.
|
static int |
BUSY_INT_VALUE
The integer value (51) for the "BUSY" result code.
|
static ResultCode |
CANCELED
The result code (118) that will be used if the operation was canceled.
|
static int |
CANCELED_INT_VALUE
The integer value (118) for the "CANCELED" result code.
|
static ResultCode |
CANNOT_CANCEL
The result code (121) that will be used if the client attempts to cancel an
operation that cannot be canceled.
|
static int |
CANNOT_CANCEL_INT_VALUE
The integer value (121) for the "CANNOT_CANCEL" result code.
|
static ResultCode |
CLIENT_LOOP
The client-side result code (96) that will be used if the client detects a
loop while attempting to follow referrals.
|
static int |
CLIENT_LOOP_INT_VALUE
The integer value (96) for the "CLIENT_LOOP" result code.
|
static ResultCode |
COMPARE_FALSE
The result code (5) that will be used if a requested compare assertion does
not match the target entry.
|
static int |
COMPARE_FALSE_INT_VALUE
The integer value (5) for the "COMPARE_FALSE" result code.
|
static ResultCode |
COMPARE_TRUE
The result code (6) that will be used if a requested compare assertion
matched the target entry.
|
static int |
COMPARE_TRUE_INT_VALUE
The integer value (6) for the "COMPARE_TRUE" result code.
|
static ResultCode |
CONFIDENTIALITY_REQUIRED
The result code (13) that will be used if the server requires a secure
communication mechanism for the requested operation.
|
static int |
CONFIDENTIALITY_REQUIRED_INT_VALUE
The integer value (13) for the "CONFIDENTIALITY_REQUIRED" result code.
|
static ResultCode |
CONNECT_ERROR
The client-side result code (91) that will be used if an error occurs while
attempting to connect to a target server.
|
static int |
CONNECT_ERROR_INT_VALUE
The integer value (91) for the "CONNECT_ERROR" result code.
|
static ResultCode |
CONSTRAINT_VIOLATION
The result code (19) that will be used if the requested operation would
violate some constraint defined in the server.
|
static int |
CONSTRAINT_VIOLATION_INT_VALUE
The integer value (19) for the "CONSTRAINT_VIOLATION" result code.
|
static ResultCode |
CONTROL_NOT_FOUND
The client-side result code (93) that will be used if the response from the
server did not include an expected control.
|
static int |
CONTROL_NOT_FOUND_INT_VALUE
The integer value (93) for the "CONTROL_NOT_FOUND" result code.
|
static ResultCode |
DATABASE_LOCK_CONFLICT
The result code (30221002) for use if an operation fails because of a
database lock conflict (e.g., a deadlock or lock timeout).
|
static int |
DATABASE_LOCK_CONFLICT_INT_VALUE
The integer value (30221002) for the "DATABASE_LOCK_CONFLICT" result code.
|
static ResultCode |
DECODING_ERROR
The client-side result code (84) that will be used if an error occurs while
decoding a response.
|
static int |
DECODING_ERROR_INT_VALUE
The integer value (84) for the "DECODING_ERROR" result code.
|
static java.util.Set<ResultCode> |
DEFAULT_CONNECTION_NOT_USABLE_RESULT_CODES
The default set of result codes that may indicate that a connection is not
usable.
|
static ResultCode |
E_SYNC_REFRESH_REQUIRED
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.
|
static int |
E_SYNC_REFRESH_REQUIRED_INT_VALUE
The integer value (4096) for the "E_SYNC_REFRESH_REQUIRED" result code.
|
static ResultCode |
ENCODING_ERROR
The client-side result code (83) that will be used if an error occurs while
encoding a request.
|
static int |
ENCODING_ERROR_INT_VALUE
The integer value (83) for the "ENCODING_ERROR" result code.
|
static ResultCode |
ENTRY_ALREADY_EXISTS
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.
|
static int |
ENTRY_ALREADY_EXISTS_INT_VALUE
The integer value (68) for the "ENTRY_ALREADY_EXISTS" result code.
|
static ResultCode |
FILTER_ERROR
The client-side result code (87) that will be used if an error occurs while
attempting to encode a search filter.
|
static int |
FILTER_ERROR_INT_VALUE
The integer value (87) for the "FILTER_ERROR" result code.
|
static ResultCode |
INAPPROPRIATE_AUTHENTICATION
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.
|
static int |
INAPPROPRIATE_AUTHENTICATION_INT_VALUE
The integer value (48) for the "INAPPROPRIATE_AUTHENTICATION" result code.
|
static ResultCode |
INAPPROPRIATE_MATCHING
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.
|
static int |
INAPPROPRIATE_MATCHING_INT_VALUE
The integer value (18) for the "INAPPROPRIATE_MATCHING" result code.
|
static ResultCode |
INSUFFICIENT_ACCESS_RIGHTS
The result code (50) that will be used if the client does not have
permission to perform the requested operation.
|
static int |
INSUFFICIENT_ACCESS_RIGHTS_INT_VALUE
The integer value (50) for the "INSUFFICIENT_ACCESS_RIGHTS" result code.
|
static ResultCode |
INTERACTIVE_TRANSACTION_ABORTED
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.
|
static int |
INTERACTIVE_TRANSACTION_ABORTED_INT_VALUE
The integer value (30221001) for the "INTERACTIVE_TRANSACTION_ABORTED"
result code.
|
static ResultCode |
INVALID_ATTRIBUTE_SYNTAX
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.
|
static int |
INVALID_ATTRIBUTE_SYNTAX_INT_VALUE
The integer value (21) for the "INVALID_ATTRIBUTE_SYNTAX" result code.
|
static ResultCode |
INVALID_CREDENTIALS
The result code (49) that will be used if the client provided invalid
credentials while trying to authenticate.
|
static int |
INVALID_CREDENTIALS_INT_VALUE
The integer value (49) for the "INVALID_CREDENTIALS" result code.
|
static ResultCode |
INVALID_DN_SYNTAX
The result code (34) that will be used if the client provided an invalid
DN.
|
static int |
INVALID_DN_SYNTAX_INT_VALUE
The integer value (34) for the "INVALID_DN_SYNTAX" result code.
|
static ResultCode |
LOCAL_ERROR
The client-side result code (82) that will be used if a generic client-side
error occurs during processing.
|
static int |
LOCAL_ERROR_INT_VALUE
The integer value (82) for the "LOCAL_ERROR" result code.
|
static ResultCode |
LOOP_DETECT
The result code (54) that will be used if the server detects a chaining or
alias loop.
|
static int |
LOOP_DETECT_INT_VALUE
The integer value (54) for the "LOOP_DETECT" result code.
|
static ResultCode |
MIRRORED_SUBTREE_DIGEST_MISMATCH
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.
|
static int |
MIRRORED_SUBTREE_DIGEST_MISMATCH_INT_VALUE
The integer value (30221003) for the "MIRRORED_SUBTREE_DIGEST_MISMATCH"
result code.
|
static ResultCode |
MORE_RESULTS_TO_RETURN
The client-side result code (95) that will be used if there are still more
results to return.
|
static int |
MORE_RESULTS_TO_RETURN_INT_VALUE
The integer value (95) for the "MORE_RESULTS_TO_RETURN" result code.
|
static ResultCode |
NAMING_VIOLATION
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.
|
static int |
NAMING_VIOLATION_INT_VALUE
The integer value (64) for the "NAMING_VIOLATION" result code.
|
static ResultCode |
NO_MEMORY
The client-side result code (90) that will be used if the client does not
have sufficient memory to perform the requested operation.
|
static int |
NO_MEMORY_INT_VALUE
The integer value (90) for the "NO_MEMORY" result code.
|
static ResultCode |
NO_OPERATION
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.
|
static int |
NO_OPERATION_INT_VALUE
The integer value (16654) for the "NO_OPERATION" result code.
|
static ResultCode |
NO_RESULTS_RETURNED
The client-side result code (94) that will be used if the server did not
send any results.
|
static int |
NO_RESULTS_RETURNED_INT_VALUE
The integer value (94) for the "NO_RESULTS_RETURNED" result code.
|
static ResultCode |
NO_SUCH_ATTRIBUTE
The result code (16) that will be used if the client referenced an
attribute that does not exist in the target entry.
|
static int |
NO_SUCH_ATTRIBUTE_INT_VALUE
The integer value (16) for the "NO_SUCH_ATTRIBUTE" result code.
|
static ResultCode |
NO_SUCH_OBJECT
The result code (32) that will be used if the client targeted an entry that
does not exist.
|
static int |
NO_SUCH_OBJECT_INT_VALUE
The integer value (32) for the "NO_SUCH_OBJECT" result code.
|
static ResultCode |
NO_SUCH_OPERATION
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).
|
static int |
NO_SUCH_OPERATION_INT_VALUE
The integer value (119) for the "NO_SUCH_OPERATION" result code.
|
static ResultCode |
NOT_ALLOWED_ON_NONLEAF
The result code (66) that will be used if the requested operation is not
allowed to be performed on non-leaf entries.
|
static int |
NOT_ALLOWED_ON_NONLEAF_INT_VALUE
The integer value (66) for the "NOT_ALLOWED_ON_NONLEAF" result code.
|
static ResultCode |
NOT_ALLOWED_ON_RDN
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.
|
static int |
NOT_ALLOWED_ON_RDN_INT_VALUE
The integer value (67) for the "NOT_ALLOWED_ON_RDN" result code.
|
static ResultCode |
NOT_SUPPORTED
The client-side result code (92) that will be used if the requested
operation is not supported.
|
static int |
NOT_SUPPORTED_INT_VALUE
The integer value (92) for the "NOT_SUPPORTED" result code.
|
static ResultCode |
OBJECT_CLASS_MODS_PROHIBITED
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.
|
static int |
OBJECT_CLASS_MODS_PROHIBITED_INT_VALUE
The integer value (69) for the "OBJECT_CLASS_MODS_PROHIBITED" result code.
|
static ResultCode |
OBJECT_CLASS_VIOLATION
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.
|
static int |
OBJECT_CLASS_VIOLATION_INT_VALUE
The integer value (65) for the "OBJECT_CLASS_VIOLATION" result code.
|
static ResultCode |
OFFSET_RANGE_ERROR
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.
|
static int |
OFFSET_RANGE_ERROR_INT_VALUE
The integer value (61) for the "OFFSET_RANGE_ERROR" result code.
|
static ResultCode |
OPERATIONS_ERROR
The result code (1) that will be used to indicate that an operation was
requested out of sequence.
|
static int |
OPERATIONS_ERROR_INT_VALUE
The integer value (1) for the "OPERATIONS_ERROR" result code.
|
static ResultCode |
OTHER
The result code (80) that will be used if none of the other result codes
are appropriate.
|
static int |
OTHER_INT_VALUE
The integer value (80) for the "OTHER" result code.
|
static ResultCode |
PARAM_ERROR
The client-side result code (89) that will be used if there is a problem
with the parameters provided for a request.
|
static int |
PARAM_ERROR_INT_VALUE
The integer value (89) for the "PARAM_ERROR" result code.
|
static ResultCode |
PROTOCOL_ERROR
The result code (2) that will be used to indicate that the client sent a
malformed request.
|
static int |
PROTOCOL_ERROR_INT_VALUE
The integer value (2) for the "PROTOCOL_ERROR" result code.
|
static ResultCode |
REFERRAL
The result code (10) that will be used if the server sends a referral to
the client to refer to data in another location.
|
static int |
REFERRAL_INT_VALUE
The integer value (10) for the "REFERRAL" result code.
|
static ResultCode |
REFERRAL_LIMIT_EXCEEDED
The client-side result code (97) that will be used if the client
encountered too many referrals in the course of processing an operation.
|
static int |
REFERRAL_LIMIT_EXCEEDED_INT_VALUE
The integer value (97) for the "REFERRAL_LIMIT_EXCEEDED" result code.
|
static ResultCode |
SASL_BIND_IN_PROGRESS
The result code (14) that will be returned from the server after SASL bind
stages in which more processing is required.
|
static int |
SASL_BIND_IN_PROGRESS_INT_VALUE
The integer value (14) for the "SASL_BIND_IN_PROGRESS" result code.
|
static ResultCode |
SERVER_DOWN
The client-side result code (81) that will be used if an established
connection to the server is lost.
|
static int |
SERVER_DOWN_INT_VALUE
The integer value (81) for the "SERVER_DOWN" result code.
|
static ResultCode |
SIZE_LIMIT_EXCEEDED
The result code (4) that will be used to indicate that the server found
more matching entries than the configured request size limit.
|
static int |
SIZE_LIMIT_EXCEEDED_INT_VALUE
The integer value (4) for the "SIZE_LIMIT_EXCEEDED" result code.
|
static ResultCode |
SORT_CONTROL_MISSING
The result code (60) that will be used if the client sends a virtual list
view control without a server-side sort control.
|
static int |
SORT_CONTROL_MISSING_INT_VALUE
The integer value (60) for the "SORT_CONTROL_MISSING" result code.
|
static ResultCode |
STRONG_AUTH_REQUIRED
The result code (8) that will be used if the client requested an operation
that requires a strong authentication mechanism.
|
static int |
STRONG_AUTH_REQUIRED_INT_VALUE
The integer value (8) for the "STRONG_AUTH_REQUIRED" result code.
|
static ResultCode |
SUCCESS
The result code (0) that will be used to indicate a successful operation.
|
static int |
SUCCESS_INT_VALUE
The integer value (0) for the "SUCCESS" result code.
|
static ResultCode |
TIME_LIMIT_EXCEEDED
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.
|
static int |
TIME_LIMIT_EXCEEDED_INT_VALUE
The integer value (3) for the "TIME_LIMIT_EXCEEDED" result code.
|
static ResultCode |
TIMEOUT
The client-side result code (85) that will be used if a client timeout
occurs while waiting for a response from the server.
|
static int |
TIMEOUT_INT_VALUE
The integer value (85) for the "TIMEOUT" result code.
|
static ResultCode |
TOKEN_DELIVERY_ATTEMPT_FAILED
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.
|
static int |
TOKEN_DELIVERY_ATTEMPT_FAILED_INT_VALUE
The integer value (30221005) for the "TOKEN_DELIVERY_ATTEMPT_FAILED"
result code.
|
static ResultCode |
TOKEN_DELIVERY_INVALID_ACCOUNT_STATE
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.).
|
static int |
TOKEN_DELIVERY_INVALID_ACCOUNT_STATE_INT_VALUE
The integer value (30221007) for the "TOKEN_DELIVERY_INVALID_ACCOUNT_STATE"
result code.
|
static ResultCode |
TOKEN_DELIVERY_INVALID_RECIPIENT_ID
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.
|
static int |
TOKEN_DELIVERY_INVALID_RECIPIENT_ID_INT_VALUE
The integer value (30221006) for the "TOKEN_DELIVERY_INVALID_RECIPIENT_ID"
result code.
|
static ResultCode |
TOKEN_DELIVERY_MECHANISM_UNAVAILABLE
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.
|
static int |
TOKEN_DELIVERY_MECHANISM_UNAVAILABLE_INT_VALUE
The integer value (30221004) for the "TOKEN_DELIVERY_MECHANISM_UNAVAILABLE"
result code.
|
static ResultCode |
TOO_LATE
The result code (120) that will be used if the client attempts to cancel an
operation too late in the processing for that operation.
|
static int |
TOO_LATE_INT_VALUE
The integer value (120) for the "TOO_LATE" result code.
|
static ResultCode |
UNAVAILABLE
The result code (52) that will be used if the server is unavailable.
|
static ResultCode |
UNAVAILABLE_CRITICAL_EXTENSION
The result code (12) that will be used if the client requests a critical
control that is not supported by the server.
|
static int |
UNAVAILABLE_CRITICAL_EXTENSION_INT_VALUE
The integer value (12) for the "UNAVAILABLE_CRITICAL_EXTENSION" result
code.
|
static int |
UNAVAILABLE_INT_VALUE
The integer value (52) for the "UNAVAILABLE" result code.
|
static ResultCode |
UNDEFINED_ATTRIBUTE_TYPE
The result code (17) that will be used if the client referenced an
attribute that is not defined in the server schema.
|
static int |
UNDEFINED_ATTRIBUTE_TYPE_INT_VALUE
The integer value (17) for the "UNDEFINED_ATTRIBUTE_TYPE" result code.
|
static ResultCode |
UNWILLING_TO_PERFORM
The result code (53) that will be used if the server is not willing to
perform the requested operation.
|
static int |
UNWILLING_TO_PERFORM_INT_VALUE
The integer value (53) for the "UNWILLING_TO_PERFORM" result code.
|
static ResultCode |
USER_CANCELED
The client-side result code (88) that will be used if the end user canceled
the operation in progress.
|
static int |
USER_CANCELED_INT_VALUE
The integer value (88) for the "USER_CANCELED" result code.
|
static ResultCode |
VIRTUAL_LIST_VIEW_ERROR
The result code (76) that will be used if an error occurred while
performing processing associated with the virtual list view control.
|
static int |
VIRTUAL_LIST_VIEW_ERROR_INT_VALUE
The integer value (76) for the "VIRTUAL_LIST_VIEW_ERROR" result code.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object o)
Indicates whether the provided object is equal to this result code.
|
static java.util.Set<ResultCode> |
getConnectionNotUsableResultCodes()
Retrieves the set of result codes that may indicate that a connection is
not usable.
|
java.lang.String |
getName()
Retrieves the user-friendly name for this result code.
|
java.lang.String |
getStandardName()
Retrieves the name for this result code as it appears in the relevant LDAP
specification, if any.
|
int |
hashCode()
The hash code for this result code.
|
int |
intValue()
Retrieves the integer value for this result code.
|
boolean |
isClientSideResultCode()
Indicates whether this result code is one that should be used for
client-side errors rather than returned by the server.
|
static boolean |
isClientSideResultCode(ResultCode resultCode)
Indicates whether the provided result code is one that should be used for
client-side errors rather than returned by the server.
|
boolean |
isConnectionUsable()
Indicates whether the connection on which this result code was received is
likely still usable.
|
static boolean |
isConnectionUsable(ResultCode resultCode)
Indicates whether the connection on which the provided result code was
received is likely still usable.
|
static void |
setConnectionNotUsableResultCodes(java.util.Collection<ResultCode> connectionNotUsableResultCodes)
Updates the set of result codes that may indicate that a connection is not
usable.
|
static void |
setConnectionNotUsableResultCodes(ResultCode... connectionNotUsableResultCodes)
Updates the set of result codes that may indicate that a connection is not
usable.
|
java.lang.String |
toString()
Retrieves a string representation of this result code.
|
static ResultCode |
valueOf(int intValue)
Retrieves the result code with the specified integer value.
|
static ResultCode |
valueOf(int intValue,
java.lang.String name)
Retrieves the result code with the specified integer value.
|
static ResultCode |
valueOf(int intValue,
java.lang.String name,
boolean createNewResultCode)
Retrieves the result code with the specified integer value.
|
static ResultCode[] |
values()
Retrieves an array of all result codes defined in the LDAP SDK.
|
public static final int SUCCESS_INT_VALUE
@NotNull public static final ResultCode SUCCESS
public static final int OPERATIONS_ERROR_INT_VALUE
@NotNull public static final ResultCode OPERATIONS_ERROR
public static final int PROTOCOL_ERROR_INT_VALUE
@NotNull public static final ResultCode PROTOCOL_ERROR
public static final int TIME_LIMIT_EXCEEDED_INT_VALUE
@NotNull public static final ResultCode TIME_LIMIT_EXCEEDED
public static final int SIZE_LIMIT_EXCEEDED_INT_VALUE
@NotNull public static final ResultCode SIZE_LIMIT_EXCEEDED
public static final int COMPARE_FALSE_INT_VALUE
@NotNull public static final ResultCode COMPARE_FALSE
public static final int COMPARE_TRUE_INT_VALUE
@NotNull public static final ResultCode COMPARE_TRUE
public static final int AUTH_METHOD_NOT_SUPPORTED_INT_VALUE
@NotNull public static final ResultCode AUTH_METHOD_NOT_SUPPORTED
public static final int STRONG_AUTH_REQUIRED_INT_VALUE
@NotNull public static final ResultCode STRONG_AUTH_REQUIRED
public static final int REFERRAL_INT_VALUE
@NotNull public static final ResultCode REFERRAL
public static final int ADMIN_LIMIT_EXCEEDED_INT_VALUE
@NotNull public static final ResultCode ADMIN_LIMIT_EXCEEDED
public static final int UNAVAILABLE_CRITICAL_EXTENSION_INT_VALUE
@NotNull public static final ResultCode UNAVAILABLE_CRITICAL_EXTENSION
public static final int CONFIDENTIALITY_REQUIRED_INT_VALUE
@NotNull public static final ResultCode CONFIDENTIALITY_REQUIRED
public static final int SASL_BIND_IN_PROGRESS_INT_VALUE
@NotNull public static final ResultCode SASL_BIND_IN_PROGRESS
public static final int NO_SUCH_ATTRIBUTE_INT_VALUE
@NotNull public static final ResultCode NO_SUCH_ATTRIBUTE
public static final int UNDEFINED_ATTRIBUTE_TYPE_INT_VALUE
@NotNull public static final ResultCode UNDEFINED_ATTRIBUTE_TYPE
public static final int INAPPROPRIATE_MATCHING_INT_VALUE
@NotNull public static final ResultCode INAPPROPRIATE_MATCHING
public static final int CONSTRAINT_VIOLATION_INT_VALUE
@NotNull public static final ResultCode CONSTRAINT_VIOLATION
public static final int ATTRIBUTE_OR_VALUE_EXISTS_INT_VALUE
@NotNull public static final ResultCode ATTRIBUTE_OR_VALUE_EXISTS
public static final int INVALID_ATTRIBUTE_SYNTAX_INT_VALUE
@NotNull public static final ResultCode INVALID_ATTRIBUTE_SYNTAX
public static final int NO_SUCH_OBJECT_INT_VALUE
@NotNull public static final ResultCode NO_SUCH_OBJECT
public static final int ALIAS_PROBLEM_INT_VALUE
@NotNull public static final ResultCode ALIAS_PROBLEM
public static final int INVALID_DN_SYNTAX_INT_VALUE
@NotNull public static final ResultCode INVALID_DN_SYNTAX
public static final int ALIAS_DEREFERENCING_PROBLEM_INT_VALUE
@NotNull public static final ResultCode ALIAS_DEREFERENCING_PROBLEM
public static final int INAPPROPRIATE_AUTHENTICATION_INT_VALUE
@NotNull public static final ResultCode INAPPROPRIATE_AUTHENTICATION
public static final int INVALID_CREDENTIALS_INT_VALUE
@NotNull public static final ResultCode INVALID_CREDENTIALS
public static final int INSUFFICIENT_ACCESS_RIGHTS_INT_VALUE
@NotNull public static final ResultCode INSUFFICIENT_ACCESS_RIGHTS
public static final int BUSY_INT_VALUE
@NotNull public static final ResultCode BUSY
public static final int UNAVAILABLE_INT_VALUE
@NotNull public static final ResultCode UNAVAILABLE
public static final int UNWILLING_TO_PERFORM_INT_VALUE
@NotNull public static final ResultCode UNWILLING_TO_PERFORM
public static final int LOOP_DETECT_INT_VALUE
@NotNull public static final ResultCode LOOP_DETECT
public static final int SORT_CONTROL_MISSING_INT_VALUE
@NotNull public static final ResultCode SORT_CONTROL_MISSING
public static final int OFFSET_RANGE_ERROR_INT_VALUE
@NotNull public static final ResultCode OFFSET_RANGE_ERROR
public static final int NAMING_VIOLATION_INT_VALUE
@NotNull public static final ResultCode NAMING_VIOLATION
public static final int OBJECT_CLASS_VIOLATION_INT_VALUE
@NotNull public static final ResultCode OBJECT_CLASS_VIOLATION
public static final int NOT_ALLOWED_ON_NONLEAF_INT_VALUE
@NotNull public static final ResultCode NOT_ALLOWED_ON_NONLEAF
public static final int NOT_ALLOWED_ON_RDN_INT_VALUE
@NotNull public static final ResultCode NOT_ALLOWED_ON_RDN
public static final int ENTRY_ALREADY_EXISTS_INT_VALUE
@NotNull public static final ResultCode ENTRY_ALREADY_EXISTS
public static final int OBJECT_CLASS_MODS_PROHIBITED_INT_VALUE
@NotNull public static final ResultCode OBJECT_CLASS_MODS_PROHIBITED
public static final int AFFECTS_MULTIPLE_DSAS_INT_VALUE
@NotNull public static final ResultCode AFFECTS_MULTIPLE_DSAS
public static final int VIRTUAL_LIST_VIEW_ERROR_INT_VALUE
@NotNull public static final ResultCode VIRTUAL_LIST_VIEW_ERROR
public static final int OTHER_INT_VALUE
@NotNull public static final ResultCode OTHER
public static final int SERVER_DOWN_INT_VALUE
@NotNull public static final ResultCode SERVER_DOWN
public static final int LOCAL_ERROR_INT_VALUE
@NotNull public static final ResultCode LOCAL_ERROR
public static final int ENCODING_ERROR_INT_VALUE
@NotNull public static final ResultCode ENCODING_ERROR
public static final int DECODING_ERROR_INT_VALUE
@NotNull public static final ResultCode DECODING_ERROR
public static final int TIMEOUT_INT_VALUE
@NotNull public static final ResultCode TIMEOUT
public static final int AUTH_UNKNOWN_INT_VALUE
@NotNull public static final ResultCode AUTH_UNKNOWN
public static final int FILTER_ERROR_INT_VALUE
@NotNull public static final ResultCode FILTER_ERROR
public static final int USER_CANCELED_INT_VALUE
@NotNull public static final ResultCode USER_CANCELED
public static final int PARAM_ERROR_INT_VALUE
@NotNull public static final ResultCode PARAM_ERROR
public static final int NO_MEMORY_INT_VALUE
@NotNull public static final ResultCode NO_MEMORY
public static final int CONNECT_ERROR_INT_VALUE
@NotNull public static final ResultCode CONNECT_ERROR
public static final int NOT_SUPPORTED_INT_VALUE
@NotNull public static final ResultCode NOT_SUPPORTED
public static final int CONTROL_NOT_FOUND_INT_VALUE
@NotNull public static final ResultCode CONTROL_NOT_FOUND
public static final int NO_RESULTS_RETURNED_INT_VALUE
@NotNull public static final ResultCode NO_RESULTS_RETURNED
public static final int MORE_RESULTS_TO_RETURN_INT_VALUE
@NotNull public static final ResultCode MORE_RESULTS_TO_RETURN
public static final int CLIENT_LOOP_INT_VALUE
@NotNull public static final ResultCode CLIENT_LOOP
public static final int REFERRAL_LIMIT_EXCEEDED_INT_VALUE
@NotNull public static final ResultCode REFERRAL_LIMIT_EXCEEDED
public static final int CANCELED_INT_VALUE
@NotNull public static final ResultCode CANCELED
public static final int NO_SUCH_OPERATION_INT_VALUE
@NotNull public static final ResultCode NO_SUCH_OPERATION
public static final int TOO_LATE_INT_VALUE
@NotNull public static final ResultCode TOO_LATE
public static final int CANNOT_CANCEL_INT_VALUE
@NotNull public static final ResultCode CANNOT_CANCEL
public static final int ASSERTION_FAILED_INT_VALUE
@NotNull public static final ResultCode ASSERTION_FAILED
public static final int AUTHORIZATION_DENIED_INT_VALUE
@NotNull public static final ResultCode AUTHORIZATION_DENIED
public static final int E_SYNC_REFRESH_REQUIRED_INT_VALUE
@NotNull public static final ResultCode E_SYNC_REFRESH_REQUIRED
public static final int NO_OPERATION_INT_VALUE
@NotNull public static final ResultCode NO_OPERATION
public static final int INTERACTIVE_TRANSACTION_ABORTED_INT_VALUE
@NotNull public static final ResultCode INTERACTIVE_TRANSACTION_ABORTED
public static final int DATABASE_LOCK_CONFLICT_INT_VALUE
@NotNull public static final ResultCode DATABASE_LOCK_CONFLICT
public static final int MIRRORED_SUBTREE_DIGEST_MISMATCH_INT_VALUE
@NotNull public static final ResultCode MIRRORED_SUBTREE_DIGEST_MISMATCH
public static final int TOKEN_DELIVERY_MECHANISM_UNAVAILABLE_INT_VALUE
@NotNull public static final ResultCode TOKEN_DELIVERY_MECHANISM_UNAVAILABLE
public static final int TOKEN_DELIVERY_ATTEMPT_FAILED_INT_VALUE
@NotNull public static final ResultCode TOKEN_DELIVERY_ATTEMPT_FAILED
public static final int TOKEN_DELIVERY_INVALID_RECIPIENT_ID_INT_VALUE
@NotNull public static final ResultCode TOKEN_DELIVERY_INVALID_RECIPIENT_ID
public static final int TOKEN_DELIVERY_INVALID_ACCOUNT_STATE_INT_VALUE
@NotNull public static final ResultCode TOKEN_DELIVERY_INVALID_ACCOUNT_STATE
@NotNull public static final java.util.Set<ResultCode> DEFAULT_CONNECTION_NOT_USABLE_RESULT_CODES
@NotNull public java.lang.String getName()
@Nullable public java.lang.String getStandardName()
null
if the result code is not defined
in any public specification.public int intValue()
@NotNull public static ResultCode valueOf(int intValue)
ResultCode
object, then a new 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.intValue
- The integer value for which to retrieve the corresponding
result code.@NotNull public static ResultCode valueOf(int intValue, @Nullable java.lang.String name)
ResultCode
object, then a new 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.intValue
- The integer value for which to retrieve the corresponding
result code.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 null
if this is not
known or a string representation of the integer value
should be used.@Nullable public static ResultCode valueOf(int intValue, @Nullable java.lang.String name, boolean createNewResultCode)
ResultCode
object, then this method may optionally create and
return a new 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.intValue
- The integer value for which to retrieve the
corresponding result code.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 null
if this is not known or a
string representation of the integer value
should be used.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.createNewResultCode
is true
, or null
if no
result code already existed with the specified integer value and
createNewResultCode
is false
.@NotNull public static ResultCode[] values()
public boolean isClientSideResultCode()
true
if this result code is a client-side result code, or
false
if it is one that may be returned by the server.public static boolean isClientSideResultCode(@NotNull ResultCode resultCode)
resultCode
- The result code for which to make the determination.true
if the provided result code is a client-side result
code, or false
if it is one that may be returned by the
server.@NotNull public static java.util.Set<ResultCode> getConnectionNotUsableResultCodes()
public static void setConnectionNotUsableResultCodes(@NotNull ResultCode... connectionNotUsableResultCodes)
connectionNotUsableResultCodes
- The set of result codes that may
indicate that a connection is not
usable. It must not be
null
, but may be empty.public static void setConnectionNotUsableResultCodes(@NotNull java.util.Collection<ResultCode> connectionNotUsableResultCodes)
connectionNotUsableResultCodes
- The set of result codes that may
indicate that a connection is not
usable. It must not be
null
, but may be empty.public boolean isConnectionUsable()
true
if it is likely that the connection on which this
result code was received is still usable, or false
if it
may no longer be valid.public static boolean isConnectionUsable(@NotNull ResultCode resultCode)
resultCode
- The result code for which to make the determination.true
if it is likely that the connection on which the
provided result code was received is still usable, or
false
if it may no longer be valid.public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(@Nullable java.lang.Object o)
equals
in class java.lang.Object
o
- The object for which to make the determination.true
if the provided object is a result code that is equal
to this result code, or false
if not.