Class LDAPResultCode


  • public class LDAPResultCode
    extends Object
    This class defines a set of constants that correspond to the result codes defined in the LDAP protocol. Note that many (but not all) of the result codes numbered 81 and higher come from the LDAP C API specification and are only intended for client-side use and should not be returned from the Directory Server. These are denoted with a "CLIENT_SIDE_" prefix.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ADMIN_LIMIT_EXCEEDED
      The LDAP result code for operations that fail as a result of exceeding an administrative limit.
      static int AFFECTS_MULTIPLE_DSAS
      The LDAP result code for operations that fail because the requested operation would have required interaction with multiple DSAs.
      static int ALIAS_DEREFERENCING_PROBLEM
      The LDAP result code for operations that fail because a problem occurred while attempting to dereference an alias.
      static int ALIAS_PROBLEM
      The LDAP result code for operations that fail because the an alias was encountered in an illegal context.
      static int ASSERTION_FAILED
      The LDAP result code for operations that are rejected because the filter in the LDAP assertion control did not match the target entry.
      static int ATTRIBUTE_OR_VALUE_EXISTS
      The LDAP result code for operations that fail because of a conflict with an existing attribute or value.
      static int AUTH_METHOD_NOT_SUPPORTED
      The LDAP result code for operations that fail because the requested authentication method is not supported.
      static int AUTHORIZATION_DENIED
      The LDAP result code for operations that fail because the server refused the client's requested authorization.
      static int BUSY
      The LDAP result code for operations that fail because the server was too busy to process it.
      static int CANCELED
      The LDAP result code for cancel operations that are successful, or for operations that are canceled.
      static int CANNOT_CANCEL
      The LDAP result code for cancel operations that fail because the specified operation cannot be canceled.
      static int CLIENT_SIDE_AUTH_UNKNOWN
      The client-side result code that indicates that the user requested an unknown or unsupported authentication mechanism.
      static int 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 int 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 int 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 int CLIENT_SIDE_DECODING_ERROR
      The client-side result code that indicates that an error occurred while decoding a response from the server.
      static int 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 int 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 int 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 int CLIENT_SIDE_MORE_RESULTS_TO_RETURN
      The client-side result code that indicates that the server has returned more matching entries for a search operation than have been processed so far.
      static int 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 int CLIENT_SIDE_NO_RESULTS_RETURNED
      The client-side result code that indicates that the server did not return any results for a search operation that was expected to match at least one entry.
      static int CLIENT_SIDE_NOT_SUPPORTED
      The client-side result code that indicates that the user requested an operation that is not supported.
      static int 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 int 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 int CLIENT_SIDE_SERVER_DOWN
      The client-side result code that indicates that a previously-established connection to the server was lost.
      static int CLIENT_SIDE_TIMEOUT
      The client-side result code that indicates that the client did not receive an expected response in a timely manner.
      static int CLIENT_SIDE_USER_CANCELLED
      The client-side result code that indicates that the user cancelled an operation.
      static int COMPARE_FALSE
      The LDAP result code for compare operations in which the assertion is false.
      static int COMPARE_TRUE
      The LDAP result code for compare operations in which the assertion is true.
      static int CONFIDENTIALITY_REQUIRED
      The LDAP result code for operations that fail because confidentiality is required.
      static int CONSTRAINT_VIOLATION
      The LDAP result code for operations that fail because a defined constraint has been violated.
      static int ENTRY_ALREADY_EXISTS
      The LDAP result code for operations that fail because the requested operation would have resulted in an entry that conflicts with one that already exists.
      static int INAPPROPRIATE_AUTHENTICATION
      The LDAP result code for operations that fail because the user attempted to perform a type of authentication that was inappropriate for the targeted entry.
      static int INAPPROPRIATE_MATCHING
      The LDAP result code for operations that fail as a result of attempting an inappropriate form of matching on an attribute.
      static int INSUFFICIENT_ACCESS_RIGHTS
      The LDAP result code for operations that fail because the client does not have permission to perform the requested operation.
      static int INVALID_ATTRIBUTE_SYNTAX
      The LDAP result code for operations that fail because of an invalid attribute syntax.
      static int INVALID_CREDENTIALS
      The LDAP result code for operations that fail because the user supplied invalid credentials for an authentication attempt.
      static int INVALID_DN_SYNTAX
      The LDAP result code for operations that fail because the request included a malformed DN.
      static int LOOP_DETECT
      The LDAP result code for operations that fail because a referral or chaining loop was detected.
      static int NAMING_VIOLATION
      The LDAP result code for operations that fail due to a naming violation.
      static int NO_OPERATION
      The LDAP result code for operations in which no action is taken because the request include the LDAP no-op control.
      static int NO_SUCH_ATTRIBUTE
      The LDAP result code for operations that fail because a specified attribute does not exist.
      static int NO_SUCH_OBJECT
      The LDAP result code for operations that fail because a targeted entry does not exist.
      static int NO_SUCH_OPERATION
      The LDAP result code for cancel operations that fail because the specified operation could not be found.
      static int NOT_ALLOWED_ON_NONLEAF
      The LDAP result code for operations that fail because the requested operation is not allowed on non-leaf entries.
      static int NOT_ALLOWED_ON_RDN
      The LDAP result code for operations that fail because the requested operation is not allowed on an RDN attribute.
      static int OBJECTCLASS_MODS_PROHIBITED
      The LDAP result code for operations that fail because the requested operation attempted to modify objectclass values in an illegal manner.
      static int OBJECTCLASS_VIOLATION
      The LDAP result code for operations that fail because the requested operation would have resulted in an entry that violates the server schema.
      static int OFFSET_RANGE_ERROR
      The LDAP result code for operations that fail because the request included a VLV request control with an invalid offset.
      static int OPERATIONS_ERROR
      The LDAP result code for operations that fail due to an operations error.
      static int OTHER
      The LDAP result code for use in cases in which none of the other defined result codes are appropriate.
      static int PROTOCOL_ERROR
      The LDAP result code for operations that fail due to a protocol error.
      static int REFERRAL
      The LDAP result code for operations that encountered a referral.
      static int SASL_BIND_IN_PROGRESS
      The LDAP result code used for multi-stage SASL bind operations that are not yet complete.
      static int SIZE_LIMIT_EXCEEDED
      The LDAP result code for operations that fail as a result of exceeding a size limit.
      static int SORT_CONTROL_MISSING
      The LDAP result code for operations that fail because the request included a VLV request control without a server-side sort control.
      static int STRONG_AUTH_REQUIRED
      The LDAP result code for operations that fail because strong authentication is required.
      static int SUCCESS
      The LDAP result code for successful operations.
      static int TIME_LIMIT_EXCEEDED
      The LDAP result code for operations that fail as a result of exceeding a time limit.
      static int TOO_LATE
      The LDAP result code for cancel operations that fail because the specified operation has already progressed too far to be canceled.
      static int UNAVAILABLE
      The LDAP result code for operations that fail because the server or a required resource was unavailable.
      static int UNAVAILABLE_CRITICAL_EXTENSION
      The LDAP result code for operations that fail because they contain an unavailable critical extension.
      static int UNDEFINED_ATTRIBUTE_TYPE
      The LDAP result code for operations that fail because a specified attribute type is not defined in the server schema.
      static int UNWILLING_TO_PERFORM
      The LDAP result code for operations that fail because the server was unwilling to perform the requested operation.
      static int VIRTUAL_LIST_VIEW_ERROR
      The LDAP result code for operations that fail due to an error in virtual list view processing.
    • Constructor Summary

      Constructors 
      Constructor Description
      LDAPResultCode()  
    • Field Detail

      • SUCCESS

        public static final int SUCCESS
        The LDAP result code for successful operations.
        See Also:
        Constant Field Values
      • OPERATIONS_ERROR

        public static final int OPERATIONS_ERROR
        The LDAP result code for operations that fail due to an operations error.
        See Also:
        Constant Field Values
      • PROTOCOL_ERROR

        public static final int PROTOCOL_ERROR
        The LDAP result code for operations that fail due to a protocol error.
        See Also:
        Constant Field Values
      • TIME_LIMIT_EXCEEDED

        public static final int TIME_LIMIT_EXCEEDED
        The LDAP result code for operations that fail as a result of exceeding a time limit.
        See Also:
        Constant Field Values
      • SIZE_LIMIT_EXCEEDED

        public static final int SIZE_LIMIT_EXCEEDED
        The LDAP result code for operations that fail as a result of exceeding a size limit.
        See Also:
        Constant Field Values
      • COMPARE_FALSE

        public static final int COMPARE_FALSE
        The LDAP result code for compare operations in which the assertion is false.
        See Also:
        Constant Field Values
      • COMPARE_TRUE

        public static final int COMPARE_TRUE
        The LDAP result code for compare operations in which the assertion is true.
        See Also:
        Constant Field Values
      • AUTH_METHOD_NOT_SUPPORTED

        public static final int AUTH_METHOD_NOT_SUPPORTED
        The LDAP result code for operations that fail because the requested authentication method is not supported.
        See Also:
        Constant Field Values
      • STRONG_AUTH_REQUIRED

        public static final int STRONG_AUTH_REQUIRED
        The LDAP result code for operations that fail because strong authentication is required.
        See Also:
        Constant Field Values
      • REFERRAL

        public static final int REFERRAL
        The LDAP result code for operations that encountered a referral.
        See Also:
        Constant Field Values
      • ADMIN_LIMIT_EXCEEDED

        public static final int ADMIN_LIMIT_EXCEEDED
        The LDAP result code for operations that fail as a result of exceeding an administrative limit.
        See Also:
        Constant Field Values
      • UNAVAILABLE_CRITICAL_EXTENSION

        public static final int UNAVAILABLE_CRITICAL_EXTENSION
        The LDAP result code for operations that fail because they contain an unavailable critical extension.
        See Also:
        Constant Field Values
      • CONFIDENTIALITY_REQUIRED

        public static final int CONFIDENTIALITY_REQUIRED
        The LDAP result code for operations that fail because confidentiality is required.
        See Also:
        Constant Field Values
      • SASL_BIND_IN_PROGRESS

        public static final int SASL_BIND_IN_PROGRESS
        The LDAP result code used for multi-stage SASL bind operations that are not yet complete.
        See Also:
        Constant Field Values
      • NO_SUCH_ATTRIBUTE

        public static final int NO_SUCH_ATTRIBUTE
        The LDAP result code for operations that fail because a specified attribute does not exist.
        See Also:
        Constant Field Values
      • UNDEFINED_ATTRIBUTE_TYPE

        public static final int UNDEFINED_ATTRIBUTE_TYPE
        The LDAP result code for operations that fail because a specified attribute type is not defined in the server schema.
        See Also:
        Constant Field Values
      • INAPPROPRIATE_MATCHING

        public static final int INAPPROPRIATE_MATCHING
        The LDAP result code for operations that fail as a result of attempting an inappropriate form of matching on an attribute.
        See Also:
        Constant Field Values
      • CONSTRAINT_VIOLATION

        public static final int CONSTRAINT_VIOLATION
        The LDAP result code for operations that fail because a defined constraint has been violated.
        See Also:
        Constant Field Values
      • ATTRIBUTE_OR_VALUE_EXISTS

        public static final int ATTRIBUTE_OR_VALUE_EXISTS
        The LDAP result code for operations that fail because of a conflict with an existing attribute or value.
        See Also:
        Constant Field Values
      • INVALID_ATTRIBUTE_SYNTAX

        public static final int INVALID_ATTRIBUTE_SYNTAX
        The LDAP result code for operations that fail because of an invalid attribute syntax.
        See Also:
        Constant Field Values
      • NO_SUCH_OBJECT

        public static final int NO_SUCH_OBJECT
        The LDAP result code for operations that fail because a targeted entry does not exist.
        See Also:
        Constant Field Values
      • ALIAS_PROBLEM

        public static final int ALIAS_PROBLEM
        The LDAP result code for operations that fail because the an alias was encountered in an illegal context.
        See Also:
        Constant Field Values
      • INVALID_DN_SYNTAX

        public static final int INVALID_DN_SYNTAX
        The LDAP result code for operations that fail because the request included a malformed DN.
        See Also:
        Constant Field Values
      • ALIAS_DEREFERENCING_PROBLEM

        public static final int ALIAS_DEREFERENCING_PROBLEM
        The LDAP result code for operations that fail because a problem occurred while attempting to dereference an alias.
        See Also:
        Constant Field Values
      • INAPPROPRIATE_AUTHENTICATION

        public static final int INAPPROPRIATE_AUTHENTICATION
        The LDAP result code for operations that fail because the user attempted to perform a type of authentication that was inappropriate for the targeted entry.
        See Also:
        Constant Field Values
      • INVALID_CREDENTIALS

        public static final int INVALID_CREDENTIALS
        The LDAP result code for operations that fail because the user supplied invalid credentials for an authentication attempt.
        See Also:
        Constant Field Values
      • INSUFFICIENT_ACCESS_RIGHTS

        public static final int INSUFFICIENT_ACCESS_RIGHTS
        The LDAP result code for operations that fail because the client does not have permission to perform the requested operation.
        See Also:
        Constant Field Values
      • BUSY

        public static final int BUSY
        The LDAP result code for operations that fail because the server was too busy to process it.
        See Also:
        Constant Field Values
      • UNAVAILABLE

        public static final int UNAVAILABLE
        The LDAP result code for operations that fail because the server or a required resource was unavailable.
        See Also:
        Constant Field Values
      • UNWILLING_TO_PERFORM

        public static final int UNWILLING_TO_PERFORM
        The LDAP result code for operations that fail because the server was unwilling to perform the requested operation.
        See Also:
        Constant Field Values
      • LOOP_DETECT

        public static final int LOOP_DETECT
        The LDAP result code for operations that fail because a referral or chaining loop was detected.
        See Also:
        Constant Field Values
      • SORT_CONTROL_MISSING

        public static final int SORT_CONTROL_MISSING
        The LDAP result code for operations that fail because the request included a VLV request control without a server-side sort control.
        See Also:
        Constant Field Values
      • OFFSET_RANGE_ERROR

        public static final int OFFSET_RANGE_ERROR
        The LDAP result code for operations that fail because the request included a VLV request control with an invalid offset.
        See Also:
        Constant Field Values
      • NAMING_VIOLATION

        public static final int NAMING_VIOLATION
        The LDAP result code for operations that fail due to a naming violation.
        See Also:
        Constant Field Values
      • OBJECTCLASS_VIOLATION

        public static final int OBJECTCLASS_VIOLATION
        The LDAP result code for operations that fail because the requested operation would have resulted in an entry that violates the server schema.
        See Also:
        Constant Field Values
      • NOT_ALLOWED_ON_NONLEAF

        public static final int NOT_ALLOWED_ON_NONLEAF
        The LDAP result code for operations that fail because the requested operation is not allowed on non-leaf entries.
        See Also:
        Constant Field Values
      • NOT_ALLOWED_ON_RDN

        public static final int NOT_ALLOWED_ON_RDN
        The LDAP result code for operations that fail because the requested operation is not allowed on an RDN attribute.
        See Also:
        Constant Field Values
      • ENTRY_ALREADY_EXISTS

        public static final int ENTRY_ALREADY_EXISTS
        The LDAP result code for operations that fail because the requested operation would have resulted in an entry that conflicts with one that already exists.
        See Also:
        Constant Field Values
      • OBJECTCLASS_MODS_PROHIBITED

        public static final int OBJECTCLASS_MODS_PROHIBITED
        The LDAP result code for operations that fail because the requested operation attempted to modify objectclass values in an illegal manner.
        See Also:
        Constant Field Values
      • AFFECTS_MULTIPLE_DSAS

        public static final int AFFECTS_MULTIPLE_DSAS
        The LDAP result code for operations that fail because the requested operation would have required interaction with multiple DSAs.
        See Also:
        Constant Field Values
      • VIRTUAL_LIST_VIEW_ERROR

        public static final int VIRTUAL_LIST_VIEW_ERROR
        The LDAP result code for operations that fail due to an error in virtual list view processing.
        See Also:
        Constant Field Values
      • OTHER

        public static final int OTHER
        The LDAP result code for use in cases in which none of the other defined result codes are appropriate.
        See Also:
        Constant Field Values
      • CLIENT_SIDE_SERVER_DOWN

        public static final int CLIENT_SIDE_SERVER_DOWN
        The client-side result code that indicates that a previously-established connection to the server was lost. This is for client-side use only and should never be transferred over protocol.
        See Also:
        Constant Field Values
      • CLIENT_SIDE_LOCAL_ERROR

        public static final int 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. This is for client-side use only and should never be transferred over protocol.
        See Also:
        Constant Field Values
      • CLIENT_SIDE_ENCODING_ERROR

        public static final int CLIENT_SIDE_ENCODING_ERROR
        The client-side result code that indicates that an error occurred while encoding a request to send to the server. This is for client-side use only and should never be transferred over protocol.
        See Also:
        Constant Field Values
      • CLIENT_SIDE_DECODING_ERROR

        public static final int CLIENT_SIDE_DECODING_ERROR
        The client-side result code that indicates that an error occurred while decoding a response from the server. This is for client-side use only and should never be transferred over protocol.
        See Also:
        Constant Field Values
      • CLIENT_SIDE_TIMEOUT

        public static final int CLIENT_SIDE_TIMEOUT
        The client-side result code that indicates that the client did not receive an expected response in a timely manner. This is for client-side use only and should never be transferred over protocol.
        See Also:
        Constant Field Values
      • CLIENT_SIDE_AUTH_UNKNOWN

        public static final int CLIENT_SIDE_AUTH_UNKNOWN
        The client-side result code that indicates that the user requested an unknown or unsupported authentication mechanism. This is for client-side use only and should never be transferred over protocol.
        See Also:
        Constant Field Values
      • CLIENT_SIDE_FILTER_ERROR

        public static final int 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. This is for client-side use only and should never be transferred over protocol.
        See Also:
        Constant Field Values
      • CLIENT_SIDE_USER_CANCELLED

        public static final int CLIENT_SIDE_USER_CANCELLED
        The client-side result code that indicates that the user cancelled an operation. This is for client-side use only and should never be transferred over protocol.
        See Also:
        Constant Field Values
      • CLIENT_SIDE_PARAM_ERROR

        public static final int 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. This is for client-side use only and should never be transferred over protocol.
        See Also:
        Constant Field Values
      • CLIENT_SIDE_NO_MEMORY

        public static final int 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. This is for client-side use only and should never be transferred over protocol.
        See Also:
        Constant Field Values
      • CLIENT_SIDE_CONNECT_ERROR

        public static final int CLIENT_SIDE_CONNECT_ERROR
        The client-side result code that indicates that the client was not able to establish a connection to the server. This is for client-side use only and should never be transferred over protocol.
        See Also:
        Constant Field Values
      • CLIENT_SIDE_NOT_SUPPORTED

        public static final int CLIENT_SIDE_NOT_SUPPORTED
        The client-side result code that indicates that the user requested an operation that is not supported. This is for client-side use only and should never be transferred over protocol.
        See Also:
        Constant Field Values
      • CLIENT_SIDE_CONTROL_NOT_FOUND

        public static final int 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. This is for client-side use only and should never be transferred over protocol.
        See Also:
        Constant Field Values
      • CLIENT_SIDE_NO_RESULTS_RETURNED

        public static final int CLIENT_SIDE_NO_RESULTS_RETURNED
        The client-side result code that indicates that the server did not return any results for a search operation that was expected to match at least one entry. This is for client-side use only and should never be transferred over protocol.
        See Also:
        Constant Field Values
      • CLIENT_SIDE_MORE_RESULTS_TO_RETURN

        public static final int CLIENT_SIDE_MORE_RESULTS_TO_RETURN
        The client-side result code that indicates that the server has returned more matching entries for a search operation than have been processed so far. This is for client-side use only and should never be transferred over protocol.
        See Also:
        Constant Field Values
      • CLIENT_SIDE_CLIENT_LOOP

        public static final int 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. This is for client-side use only and should never be transferred over protocol.
        See Also:
        Constant Field Values
      • CLIENT_SIDE_REFERRAL_LIMIT_EXCEEDED

        public static final int 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). This is for client-side use only and should never be transferred over protocol.
        See Also:
        Constant Field Values
      • CANCELED

        public static final int CANCELED
        The LDAP result code for cancel operations that are successful, or for operations that are canceled.
        See Also:
        Constant Field Values
      • NO_SUCH_OPERATION

        public static final int NO_SUCH_OPERATION
        The LDAP result code for cancel operations that fail because the specified operation could not be found.
        See Also:
        Constant Field Values
      • TOO_LATE

        public static final int TOO_LATE
        The LDAP result code for cancel operations that fail because the specified operation has already progressed too far to be canceled.
        See Also:
        Constant Field Values
      • CANNOT_CANCEL

        public static final int CANNOT_CANCEL
        The LDAP result code for cancel operations that fail because the specified operation cannot be canceled.
        See Also:
        Constant Field Values
      • ASSERTION_FAILED

        public static final int ASSERTION_FAILED
        The LDAP result code for operations that are rejected because the filter in the LDAP assertion control did not match the target entry.
        See Also:
        Constant Field Values
      • AUTHORIZATION_DENIED

        public static final int AUTHORIZATION_DENIED
        The LDAP result code for operations that fail because the server refused the client's requested authorization.
        See Also:
        Constant Field Values
      • NO_OPERATION

        public static final int NO_OPERATION
        The LDAP result code for operations in which no action is taken because the request include the LDAP no-op control. FIXME -- This is a temporary result code for use until draft-zeilenga-ldap-noop is updated and an official result code is allocated for it. In the meantime, this result appears to be the one used by OpenLDAP as per the message at http://www.openldap.org/lists/openldap-devel/200601/msg00143.html (0x410e = 16654).
        See Also:
        Constant Field Values
    • Constructor Detail

      • LDAPResultCode

        public LDAPResultCode()
    • Method Detail

      • toString

        public static String toString​(int resultCode)
        Retrieves a string representation of the provided LDAP result code.
        Parameters:
        resultCode - The LDAP result code value for which to obtain the string representation.
        Returns:
        The string representation of the provided LDAP result code.