public final class ResultCode extends Object
Modifier and Type | Class and Description |
---|---|
static class |
ResultCode.Enum
Contains equivalent values for the ResultCode values.
|
Modifier and Type | Field and Description |
---|---|
static ResultCode |
ADMIN_LIMIT_EXCEEDED
The result code that indicates that processing on the requested operation
could not continue because an administrative limit was exceeded.
|
static ResultCode |
AFFECTS_MULTIPLE_DSAS
The result code that indicates that the operation could not be processed
because it would impact multiple DSAs or other repositories.
|
static ResultCode |
ALIAS_DEREFERENCING_PROBLEM
The result code that indicates that a problem was encountered while
attempting to dereference an alias for a search operation.
|
static ResultCode |
ALIAS_PROBLEM
The result code that indicates that the requested operation failed
because it attempted to perform an illegal operation on an alias.
|
static ResultCode |
ASSERTION_FAILED
The result code that indicates that the filter contained in an assertion
control failed to match the target entry.
|
static ResultCode |
ATTRIBUTE_OR_VALUE_EXISTS
The result code that indicates that the requested operation failed
because it would have resulted in a conflict with an existing attribute
or attribute value in the target entry.
|
static ResultCode |
AUTH_METHOD_NOT_SUPPORTED
The result code that indicates that the requested authentication attempt
failed because it referenced an invalid SASL mechanism.
|
static ResultCode |
AUTHORIZATION_DENIED
The result code that should be used if the server will not allow the
client to use the requested authorization.
|
static ResultCode |
BUSY
The result code that indicates that the server is too busy to process the
requested operation.
|
static ResultCode |
CANCELLED
The result code that indicates that a cancel request was successful, or
that the specified operation was canceled.
|
static ResultCode |
CANNOT_CANCEL
The result code that indicates that a cancel request was unsuccessful
because the targeted operation was one that could not be canceled.
|
static ResultCode |
CLIENT_SIDE_AUTH_UNKNOWN
The client-side result code that indicates that the user requested an
unknown or unsupported authentication mechanism.
|
static ResultCode |
CLIENT_SIDE_CLIENT_LOOP
The client-side result code that indicates that the client detected a
referral loop caused by servers referencing each other in a circular
manner.
|
static ResultCode |
CLIENT_SIDE_CONNECT_ERROR
The client-side result code that indicates that the client was not able
to establish a connection to the server.
|
static ResultCode |
CLIENT_SIDE_CONTROL_NOT_FOUND
The client-side result code that indicates that the client expected a
control to be present in the response from the server but it was not
included.
|
static ResultCode |
CLIENT_SIDE_DECODING_ERROR
The client-side result code that indicates that an error occurred while
decoding a response from the server.
|
static ResultCode |
CLIENT_SIDE_ENCODING_ERROR
The client-side result code that indicates that an error occurred while
encoding a request to send to the server.
|
static ResultCode |
CLIENT_SIDE_FILTER_ERROR
The client-side result code that indicates that the filter provided by
the user was malformed and could not be parsed.
|
static ResultCode |
CLIENT_SIDE_LOCAL_ERROR
The client-side result code that indicates that a local error occurred
that had nothing to do with interaction with the server.
|
static ResultCode |
CLIENT_SIDE_NO_MEMORY
The client-side result code that indicates that the client application
was not able to allocate enough memory for the requested operation.
|
static ResultCode |
CLIENT_SIDE_NO_RESULTS_RETURNED
The client-side result code that indicates that the requested single
entry search operation or read operation failed because the Directory
Server did not return any matching entries.
|
static ResultCode |
CLIENT_SIDE_NOT_SUPPORTED
The client-side result code that indicates that the user requested an
operation that is not supported.
|
static ResultCode |
CLIENT_SIDE_PARAM_ERROR
The client-side result code that indicates that there was a problem with
one or more of the parameters provided by the user.
|
static ResultCode |
CLIENT_SIDE_REFERRAL_LIMIT_EXCEEDED
The client-side result code that indicates that the client reached the
maximum number of hops allowed when attempting to follow a referral
(i.e., following one referral resulted in another referral which resulted
in another referral and so on).
|
static ResultCode |
CLIENT_SIDE_SERVER_DOWN
The client-side result code that indicates that the server is down.
|
static ResultCode |
CLIENT_SIDE_TIMEOUT
The client-side result code that indicates that the client did not
receive an expected response in a timely manner.
|
static ResultCode |
CLIENT_SIDE_UNEXPECTED_RESULTS_RETURNED
The client-side result code that the requested single entry search
operation or read operation failed because the Directory Server returned
multiple matching entries (or search references) when only a single
matching entry was expected.
|
static ResultCode |
CLIENT_SIDE_USER_CANCELLED
The client-side result code that indicates that the user cancelled an
operation.
|
static ResultCode |
COMPARE_FALSE
The result code that indicates that the attribute value assertion
included in a compare request did not match the targeted entry.
|
static ResultCode |
COMPARE_TRUE
The result code that indicates that the attribute value assertion
included in a compare request did match the targeted entry.
|
static ResultCode |
CONFIDENTIALITY_REQUIRED
The result code that indicates that the requested operation could not be
processed because it requires confidentiality for the communication
between the client and the server.
|
static ResultCode |
CONSTRAINT_VIOLATION
The result code that indicates that the requested operation failed
because it would have violated some constraint defined in the server.
|
static ResultCode |
ENTRY_ALREADY_EXISTS
The result code that indicates that the requested operation failed
because it would have resulted in an entry that conflicts with an entry
that already exists.
|
static ResultCode |
INAPPROPRIATE_AUTHENTICATION
The result code that indicates that an authentication attempt failed
because the requested type of authentication was not appropriate for the
targeted entry.
|
static ResultCode |
INAPPROPRIATE_MATCHING
The result code that indicates that the requested operation failed
because it attempted to perform an inappropriate type of matching against
an attribute.
|
static ResultCode |
INSUFFICIENT_ACCESS_RIGHTS
The result code that indicates that the client does not have sufficient
permission to perform the requested operation.
|
static ResultCode |
INVALID_ATTRIBUTE_SYNTAX
The result code that indicates that the requested operation failed
because it violated the syntax for a specified attribute.
|
static ResultCode |
INVALID_CREDENTIALS
The result code that indicates that an authentication attempt failed
because the user did not provide a valid set of credentials.
|
static ResultCode |
INVALID_DN_SYNTAX
The result code that indicates that the requested operation failed
because it would have resulted in an entry with an invalid or malformed
DN.
|
static ResultCode |
LOOP_DETECT
The result code that indicates that a referral or chaining loop was
detected while processing the request.
|
static ResultCode |
NAMING_VIOLATION
The result code that indicates that the requested operation failed
because it would have violated the server's naming configuration.
|
static ResultCode |
NO_OPERATION
The result code that should be used if the server did not actually
complete processing on the associated operation because the request
included the LDAP No-Op control.
|
static ResultCode |
NO_SUCH_ATTRIBUTE
The result code that indicates that the requested operation failed
because it targeted an attribute or attribute value that did not exist in
the specified entry.
|
static ResultCode |
NO_SUCH_OBJECT
The result code that indicates that the requested operation failed
because it referenced an entry that does not exist.
|
static ResultCode |
NO_SUCH_OPERATION
The result code that indicates that a cancel request was unsuccessful
because the targeted operation did not exist or had already completed.
|
static ResultCode |
NOT_ALLOWED_ON_NONLEAF
The result code that indicates that the requested operation is not
allowed for non-leaf entries.
|
static ResultCode |
NOT_ALLOWED_ON_RDN
The result code that indicates that the requested operation is not
allowed on an RDN attribute.
|
static ResultCode |
OBJECTCLASS_MODS_PROHIBITED
The result code that indicates that the operation could not be processed
because it would have modified the objectclasses associated with an entry
in an illegal manner.
|
static ResultCode |
OBJECTCLASS_VIOLATION
The result code that indicates that the requested operation failed
because it would have resulted in an entry that violated the server
schema.
|
static ResultCode |
OFFSET_RANGE_ERROR
The result code that indicates that a search request included a VLV
request control with an invalid offset.
|
static ResultCode |
OPERATIONS_ERROR
The result code that indicates that the operation is not properly
sequenced with relation to other operations (of same or different type).
|
static ResultCode |
OTHER
The result code that should be used if no other result code is
appropriate.
|
static ResultCode |
PROTOCOL_ERROR
The result code that indicates that the client sent a malformed or
illegal request to the server.
|
static ResultCode |
REFERRAL
The result code that indicates that a referral was encountered.
|
static ResultCode |
SASL_BIND_IN_PROGRESS
The result code that should be used for intermediate responses in
multi-stage SASL bind operations.
|
static ResultCode |
SIZE_LIMIT_EXCEEDED
The result code that indicates that a size limit was exceeded while
attempting to process the request.
|
static ResultCode |
SORT_CONTROL_MISSING
The result code that indicates that a search request included a VLV
request control without a server-side sort control.
|
static ResultCode |
STRONG_AUTH_REQUIRED
The result code that indicates that the requested operation could not be
processed because it requires that the client has completed a strong form
of authentication.
|
static ResultCode |
SUCCESS
The result code that indicates that the operation completed successfully.
|
static ResultCode |
TIME_LIMIT_EXCEEDED
The result code that indicates that a time limit was exceeded while
attempting to process the request.
|
static ResultCode |
TOO_LATE
The result code that indicates that a cancel request was unsuccessful
because processing on the targeted operation had already reached a point
at which it could not be canceled.
|
static ResultCode |
UNAVAILABLE
The result code that indicates that either the entire server or one or
more required resources were not available for use in processing the
request.
|
static ResultCode |
UNAVAILABLE_CRITICAL_EXTENSION
The result code that indicates that the requested operation failed
because it included a critical extension that is unsupported or
inappropriate for that request.
|
static ResultCode |
UNDEFINED
The result code that should only be used if the actual result code has
not yet been determined.
|
static ResultCode |
UNDEFINED_ATTRIBUTE_TYPE
The result code that indicates that the requested operation failed
because it referenced an attribute that is not defined in the server
schema.
|
static ResultCode |
UNWILLING_TO_PERFORM
The result code that indicates that the server is unwilling to perform
the requested operation.
|
static ResultCode |
VIRTUAL_LIST_VIEW_ERROR
The result code that indicates that the operation could not be processed
because there was an error while processing the virtual list view
control.
|
Modifier and Type | Method and Description |
---|---|
ResultCode.Enum |
asEnum()
Returns the enum equivalent for this result code.
|
boolean |
equals(Object obj) |
LocalizableMessage |
getName()
Returns the short human-readable name of this result code.
|
int |
hashCode() |
static ResultCode |
internalServerErrorResultCode()
Returns the result code that should be used when the Directory Server
encounters an internal server error.
|
int |
intValue()
Returns the integer value of this result code.
|
boolean |
isClientError()
Returns
true if this ResultCode corresponds to a client-side result code. |
boolean |
isEqualTo(int resultCode)
Returns
true if the provided integer corresponds to this ResultCode . |
boolean |
isExceptional()
Indicates whether this result code represents an error result.
|
boolean |
isTransientError()
Returns whether an exceptional result code represents a transient error.
|
String |
toString()
Returns the string representation of this result code.
|
static ResultCode |
valueOf(int intValue)
Returns the result code having the specified integer value as defined in
RFC 4511 section 4.1.9.
|
static List<ResultCode> |
values()
Returns an unmodifiable list containing the set of available result codes
indexed on their integer value as defined in RFC 4511 section 4.1.9.
|
public static final ResultCode UNDEFINED
Despite not being a standard result code, it is an implementation of the null object design pattern for this type.
public static final ResultCode SUCCESS
This result code corresponds to the LDAP result code value of 0
.
public static final ResultCode OPERATIONS_ERROR
For example, this code is returned if the client attempts to StartTLS [RFC4346] while there are other uncompleted operations or if a TLS layer was already installed.
This result code corresponds to the LDAP result code value of 1
.
public static final ResultCode PROTOCOL_ERROR
This result code corresponds to the LDAP result code value of 2
.
public static final ResultCode TIME_LIMIT_EXCEEDED
This result code corresponds to the LDAP result code value of 3
.
public static final ResultCode SIZE_LIMIT_EXCEEDED
This result code corresponds to the LDAP result code value of 4
.
public static final ResultCode COMPARE_FALSE
This result code corresponds to the LDAP result code value of 5
.
public static final ResultCode COMPARE_TRUE
This result code corresponds to the LDAP result code value of 6
.
public static final ResultCode AUTH_METHOD_NOT_SUPPORTED
This result code corresponds to the LDAP result code value of 7
.
public static final ResultCode STRONG_AUTH_REQUIRED
This result code corresponds to the LDAP result code value of 8
.
public static final ResultCode REFERRAL
Strictly speaking this result code should not be exceptional since it is considered as a "success" response. However, referrals should occur rarely in practice and, when they do occur, should not be ignored since the application may believe that a request has succeeded when, in fact, nothing was done.
This result code corresponds to the LDAP result code value of 10
.
public static final ResultCode ADMIN_LIMIT_EXCEEDED
This result code corresponds to the LDAP result code value of 11
.
public static final ResultCode UNAVAILABLE_CRITICAL_EXTENSION
This result code corresponds to the LDAP result code value of 12
.
public static final ResultCode CONFIDENTIALITY_REQUIRED
This result code corresponds to the LDAP result code value of 13
.
public static final ResultCode SASL_BIND_IN_PROGRESS
This result code corresponds to the LDAP result code value of 14
.
public static final ResultCode NO_SUCH_ATTRIBUTE
This result code corresponds to the LDAP result code value of 16
.
public static final ResultCode UNDEFINED_ATTRIBUTE_TYPE
This result code corresponds to the LDAP result code value of 17
.
public static final ResultCode INAPPROPRIATE_MATCHING
This result code corresponds to the LDAP result code value of 18
.
public static final ResultCode CONSTRAINT_VIOLATION
This result code corresponds to the LDAP result code value of 19
.
public static final ResultCode ATTRIBUTE_OR_VALUE_EXISTS
This result code corresponds to the LDAP result code value of 20
.
public static final ResultCode INVALID_ATTRIBUTE_SYNTAX
This result code corresponds to the LDAP result code value of 21
.
public static final ResultCode NO_SUCH_OBJECT
This result code corresponds to the LDAP result code value of 32
.
public static final ResultCode ALIAS_PROBLEM
This result code corresponds to the LDAP result code value of 33
.
public static final ResultCode INVALID_DN_SYNTAX
This result code corresponds to the LDAP result code value of 34
.
public static final ResultCode ALIAS_DEREFERENCING_PROBLEM
This result code corresponds to the LDAP result code value of 36
.
public static final ResultCode INAPPROPRIATE_AUTHENTICATION
This result code corresponds to the LDAP result code value of 48
.
public static final ResultCode INVALID_CREDENTIALS
This result code corresponds to the LDAP result code value of 49
.
public static final ResultCode INSUFFICIENT_ACCESS_RIGHTS
This result code corresponds to the LDAP result code value of 50
.
public static final ResultCode BUSY
This result code corresponds to the LDAP result code value of 51
.
This is a transient error which means the operation can safely be retried.
public static final ResultCode UNAVAILABLE
This result code corresponds to the LDAP result code value of 52
.
This is a transient error which means the operation can safely be retried.
public static final ResultCode UNWILLING_TO_PERFORM
This result code corresponds to the LDAP result code value of 53
.
public static final ResultCode LOOP_DETECT
This result code corresponds to the LDAP result code value of 54
.
public static final ResultCode SORT_CONTROL_MISSING
This result code corresponds to the LDAP result code value of 60
.
public static final ResultCode OFFSET_RANGE_ERROR
This result code corresponds to the LDAP result code value of 61
.
public static final ResultCode NAMING_VIOLATION
This result code corresponds to the LDAP result code value of 64
.
public static final ResultCode OBJECTCLASS_VIOLATION
This result code corresponds to the LDAP result code value of 65
.
public static final ResultCode NOT_ALLOWED_ON_NONLEAF
This result code corresponds to the LDAP result code value of 66
.
public static final ResultCode NOT_ALLOWED_ON_RDN
This result code corresponds to the LDAP result code value of 67
.
public static final ResultCode ENTRY_ALREADY_EXISTS
This result code corresponds to the LDAP result code value of 68
.
public static final ResultCode OBJECTCLASS_MODS_PROHIBITED
This result code corresponds to the LDAP result code value of 69
.
public static final ResultCode AFFECTS_MULTIPLE_DSAS
This result code corresponds to the LDAP result code value of 71
.
public static final ResultCode VIRTUAL_LIST_VIEW_ERROR
This result code corresponds to the LDAP result code value of 76
.
public static final ResultCode OTHER
This result code corresponds to the LDAP result code value of 80
.
public static final ResultCode CLIENT_SIDE_SERVER_DOWN
This result code corresponds to the LDAP result code value of 81
.
This is a transient error which means the operation can be retried.
public static final ResultCode CLIENT_SIDE_LOCAL_ERROR
This result code corresponds to the LDAP result code value of 82
.
public static final ResultCode CLIENT_SIDE_ENCODING_ERROR
This result code corresponds to the LDAP result code value of 83
.
public static final ResultCode CLIENT_SIDE_DECODING_ERROR
This result code corresponds to the LDAP result code value of 84
.
public static final ResultCode CLIENT_SIDE_TIMEOUT
This result code corresponds to the LDAP result code value of 85
.
This is a transient error which means the operation can be retried.
public static final ResultCode CLIENT_SIDE_AUTH_UNKNOWN
This result code corresponds to the LDAP result code value of 86
.
public static final ResultCode CLIENT_SIDE_FILTER_ERROR
This result code corresponds to the LDAP result code value of 87
.
public static final ResultCode CLIENT_SIDE_USER_CANCELLED
This result code corresponds to the LDAP result code value of 88
.
public static final ResultCode CLIENT_SIDE_PARAM_ERROR
This result code corresponds to the LDAP result code value of 89
.
public static final ResultCode CLIENT_SIDE_NO_MEMORY
This result code corresponds to the LDAP result code value of 90
.
public static final ResultCode CLIENT_SIDE_CONNECT_ERROR
This result code corresponds to the LDAP result code value of 91
.
This is a transient error which means the operation can be retried.
public static final ResultCode CLIENT_SIDE_NOT_SUPPORTED
This result code corresponds to the LDAP result code value of 92
.
public static final ResultCode CLIENT_SIDE_CONTROL_NOT_FOUND
This result code corresponds to the LDAP result code value of 93
.
public static final ResultCode CLIENT_SIDE_NO_RESULTS_RETURNED
This result code corresponds to the LDAP result code value of 94
.
public static final ResultCode CLIENT_SIDE_UNEXPECTED_RESULTS_RETURNED
This result code corresponds to the LDAP result code value of 95
.
public static final ResultCode CLIENT_SIDE_CLIENT_LOOP
This result code corresponds to the LDAP result code value of 96
.
public static final ResultCode CLIENT_SIDE_REFERRAL_LIMIT_EXCEEDED
This result code corresponds to the LDAP result code value of 97
.
public static final ResultCode CANCELLED
This result code corresponds to the LDAP result code value of 118
.
public static final ResultCode NO_SUCH_OPERATION
This result code corresponds to the LDAP result code value of 119
.
public static final ResultCode TOO_LATE
This result code corresponds to the LDAP result code value of 120
.
public static final ResultCode CANNOT_CANCEL
This result code corresponds to the LDAP result code value of 121
.
public static final ResultCode ASSERTION_FAILED
This result code corresponds to the LDAP result code value of 122
.
public static final ResultCode AUTHORIZATION_DENIED
This result code corresponds to the LDAP result code value of 123
.
public static final ResultCode NO_OPERATION
This result code corresponds to the LDAP result code value of
16654
.
public static ResultCode valueOf(int intValue)
intValue
- The integer value of the result code.public static List<ResultCode> values()
public LocalizableMessage getName()
public int intValue()
public ResultCode.Enum asEnum()
ResultCode.Enum.UNKNOWN
if this is an unknown result code.public boolean isExceptional()
The following result codes are NOT interpreted as error results:
In order to make it easier for application to detect referrals, theREFERRAL
result code is interpreted as an error result (the LDAP
RFCs treat referrals as a success response).true
if this result code represents an error result,
otherwise false
.public boolean isTransientError()
false
for successful result codes.true
if exceptional result code represents a transient error,
false
in all other casespublic boolean isClientError()
true
if this ResultCode
corresponds to a client-side result code.
See
draft-ietf-ldapext-ldap-c-api-05.txttrue
if result code represents a client side error,
false
in all other casespublic static ResultCode internalServerErrorResultCode()
public String toString()
public boolean isEqualTo(int resultCode)
true
if the provided integer corresponds to this ResultCode
.resultCode
- The integer to comparetrue
if the provided integer corresponds to this ResultCode
.Copyright 2010-2022 ForgeRock AS.