netscape.ldap

Class LDAPException

Implemented Interfaces:
java.io.Serializable
Known Direct Subclasses:
LDAPInterruptedException, LDAPReferralException

public class LDAPException
extends java.lang.Exception
implements java.io.Serializable

Indicates that an error has occurred. An LDAPException can result from physical problems (such as network errors) as well as problems with LDAP operations (for example, if the LDAP add operation fails because of duplicate entry).

Most errors that occur throw this type of exception. In order to determine the cause of the error, you can call the getLDAPResultCode() method to get the specific result code and compare this code against the result codes defined as fields in this class. (For example, if the result code matches the value of the field LDAPException.TIME_LIMIT_EXCEEDED, the time limit passed before the search operation could be completed.)

This exception includes methods for getting an error message that corresponds to the LDAP result code (for example, "Timelimit exceeded" for LDAPException.TIME_LIMIT_EXCEEDED). These error messages are specified in the following files:

netscape/ldap/errors/ErrorCodes_locale_string.props
where locale_string is the name of the locale that includes the language and country, but not the variant.

For example:

netscape/ldap/errors/ErrorCodes_en_US.props
The LDAP Java classes get this locale name by calling the java.util.Locale.toString method for the specified locale and ignoring the variant. If no locale is specified, the LDAP Java classes use the java.util.Locale.getDefault method to get the locale of the local host system.

In order to get error messages for different locales, you need to provide files containing the error messages for those locales. The files should be located in the netscape/ldap/errors directory and should use the naming convention specified above.

The following is a list of LDAP result codes:

 Result
  Code   Defined Value
 ======  =============
   0     SUCCESS
   1     OPERATION_ERROR
   2     PROTOCOL_ERROR
   3     TIME_LIMIT_EXCEEDED
   4     SIZE_LIMIT_EXCEEDED
   5     COMPARE_FALSE
   6     COMPARE_TRUE
   7     AUTH_METHOD_NOT_SUPPORTED
   8     STRONG_AUTH_REQUIRED
   9     LDAP_PARTIAL_RESULTS
  10     REFERRAL (LDAP v3)
  11     ADMIN_LIMIT_EXCEEDED (LDAP v3)
  12     UNAVAILABLE_CRITICAL_EXTENSION (LDAP v3)
  13     CONFIDENTIALITY_REQUIRED (LDAP v3)
  14     SASL_BIND_IN_PROGRESS (LDAP v3)
  16     NO_SUCH_ATTRIBUTE
  17     UNDEFINED_ATTRIBUTE_TYPE
  18     INAPPROPRIATE_MATCHING
  19     CONSTRAINT_VIOLATION
  20     ATTRIBUTE_OR_VALUE_EXISTS
  21     INVALID_ATTRIBUTE_SYNTAX
  32     NO_SUCH_OBJECT
  33     ALIAS_PROBLEM
  34     INVALID_DN_SYNTAX
  35     IS_LEAF
  36     ALIAS_DEREFERENCING_PROBLEM
  48     INAPPROPRIATE_AUTHENTICATION
  49     INVALID_CREDENTIALS
  50     INSUFFICIENT_ACCESS_RIGHTS
  51     BUSY
  52     UNAVAILABLE
  53     UNWILLING_TO_PERFORM
  54     LOOP_DETECT
  64     NAMING_VIOLATION
  65     OBJECT_CLASS_VIOLATION
  66     NOT_ALLOWED_ON_NONLEAF
  67     NOT_ALLOWED_ON_RDN
  68     ENTRY_ALREADY_EXISTS
  69     OBJECT_CLASS_MODS_PROHIBITED
  71     AFFECTS_MULTIPLE_DSAS (LDAP v3)
  80     OTHER
  81     SERVER_DOWN
  85     LDAP_TIMEOUT
  89     PARAM_ERROR
  91     CONNECT_ERROR
  92     LDAP_NOT_SUPPORTED
  93     CONTROL_NOT_FOUND
  94     NO_RESULTS_RETURNED
  95     MORE_RESULTS_TO_RETURN
  96     CLIENT_LOOP
  97     REFERRAL_LIMIT_EXCEEDED
 112     TLS_NOT_SUPPORTED (LDAP v3) 
 

Version:
1.0
See Also:
LDAPReferralException, Serialized Form

Field Summary

static int
ADMIN_LIMIT_EXCEEDED
(11) [LDAP v3] The adminstrative limit on the maximum number of entries to return was exceeded.
static int
AFFECTS_MULTIPLE_DSAS
(71) [LDAP v3] The client attempted to move an entry from one LDAP server to another by requesting a "modify DN" operation.
static int
ALIAS_DEREFERENCING_PROBLEM
(36) An error occurred when dereferencing an alias.
static int
ALIAS_PROBLEM
(33) An problem occurred with an alias.
static int
ATTRIBUTE_OR_VALUE_EXISTS
(20) The value that you are adding to an attribute already exists in the attribute.
static int
AUTH_METHOD_NOT_SUPPORTED
(7) The specified authentication method is not supported by the LDAP server that you are connecting to.
static int
BUSY
(51) The LDAP server is busy.
static int
CLIENT_LOOP
(96) Your LDAP client detected a loop in the referral.
static int
COMPARE_FALSE
(5) Value returned by an LDAP compare operation if the specified attribute and value is not found in the entry (no matching value found).
static int
COMPARE_TRUE
(6) Value returned by an LDAP compare operation if the specified attribute and value is found in the entry (matching value found).
static int
CONFIDENTIALITY_REQUIRED
(13) [LDAP v3] A secure connection is required for this operation.
static int
CONNECT_ERROR
(91) Your LDAP client failed to connect to the LDAP server.
static int
CONSTRAINT_VIOLATION
(19) An internal error occurred in the LDAP server.
static int
CONTROL_NOT_FOUND
(93) The requested control is not found.
static int
ENTRY_ALREADY_EXISTS
(68) The specified entry already exists.
static int
INAPPROPRIATE_AUTHENTICATION
(48) The authentication presented to the server is inappropriate.
static int
INAPPROPRIATE_MATCHING
(18) An inappropriate type of matching was used.
static int
INDEX_RANGE_ERROR
(61) An index range error occurred.
static int
INSUFFICIENT_ACCESS_RIGHTS
(50) The client is authenticated as a user who does not have the access privileges to perform this operation.
static int
INVALID_ATTRIBUTE_SYNTAX
(21) The request contains invalid syntax.
static int
INVALID_CREDENTIALS
(49) The credentials presented to the server for authentication are not valid.
static int
INVALID_DN_SYNTAX
(34) The specified distinguished name (DN) uses invalid syntax.
static int
IS_LEAF
(35) The specified entry is a "leaf" entry (it has no entries beneath it in the directory tree).
static int
LDAP_NOT_SUPPORTED
(92) The request is not supported by this version of the LDAP protocol.
static int
LDAP_PARTIAL_RESULTS
(9) The LDAP server is referring your client to another LDAP server.
static int
LDAP_TIMEOUT
(85) The operation could not be completed within the maximum time limit.
static int
LOOP_DETECT
(54) A loop has been detected.
static int
MORE_RESULTS_TO_RETURN
(95) More results are being returned from the server.
static int
NAMING_VIOLATION
(64) A naming violation has occurred.
static int
NOT_ALLOWED_ON_NONLEAF
(66) The requested operation can only be performed on an entry that has no entries beneath it in the directory tree (in other words, a "leaf" entry).
static int
NOT_ALLOWED_ON_RDN
(67) The specified operation cannot be performed on a relative distinguished name (RDN).
static int
NO_RESULTS_RETURNED
(94) No results have been returned from the server.
static int
NO_SUCH_ATTRIBUTE
(16) The specified attribute could not be found.
static int
NO_SUCH_OBJECT
(32) The entry specified in the request does not exist.
static int
OBJECT_CLASS_MODS_PROHIBITED
(69) You cannot modify the specified object class.
static int
OBJECT_CLASS_VIOLATION
(65) The requested operation will add or change data so that the data no longer complies with the schema.
static int
OPERATION_ERROR
(1) An internal error occurred in the LDAP server.
static int
OTHER
(80) General result code for other types of errors that may occur.
static int
PARAM_ERROR
(89) When calling a constructor or method from your client, one or more parameters were incorrectly specified.
static int
PROTOCOL_ERROR
(2) A LDAP server could not correctly interpret the request sent by your client because the request does not strictly comply with the LDAP protocol.
static int
REFERRAL
(10) [LDAP v3] The server does not hold the requested entry.
static int
REFERRAL_LIMIT_EXCEEDED
(97) The number of sequential referrals (for example, the client may be referred first from LDAP server A to LDAP server B, then from LDAP server B to LDAP server C, and so on) has exceeded the maximum number of referrals (the LDAPv2.REFERRALS_HOP_LIMIT option).
static int
SASL_BIND_IN_PROGRESS
(14) [LDAP v3] While authenticating your client by using a SASL (Simple Authentication Security Layer) mechanism, the server requires the client to send a new SASL bind request (specifying the same SASL mechanism) to continue the authentication process.
static int
SERVER_DOWN
(81) The LDAP server cannot be contacted.
static int
SIZE_LIMIT_EXCEEDED
(4) The search found more than the maximum number of results.
static int
SORT_CONTROL_MISSING
(60) The "server-side sorting" control was not included with the "virtual list view" control in the search request.
static int
STRONG_AUTH_REQUIRED
(8) A stronger authentication method (more than LDAP_AUTH_SIMPLE) is required by the LDAP server that you are connecting to.
static int
SUCCESS
(0) The operation completed successfully.
static int
TIME_LIMIT_EXCEEDED
(3) The search operation could not be completed within the maximum time limit.
static int
TLS_NOT_SUPPORTED
(112) The socket factory of the connection is not capable of initiating a TLS session.
static int
UNAVAILABLE
(52) The LDAP server is unavailable.
static int
UNAVAILABLE_CRITICAL_EXTENSION
(12) [LDAP v3] The server received an LDAP v3 control that is marked critical and either (1) is not recognized or supported by the server, or (2) is inappropriate for the operation requested.
static int
UNDEFINED_ATTRIBUTE_TYPE
(17) The specified attribute is not defined.
static int
UNWILLING_TO_PERFORM
(53) The LDAP server is unable to perform the specified operation.

Constructor Summary

LDAPException()
Constructs a default exception with no specific error information.
LDAPException(String message)
Constructs a default exception with a specified string of additional information.
LDAPException(String message, int resultCode)
Constructs a default exception with a result code and a specified string of additional information.
LDAPException(String message, int resultCode, String serverErrorMessage)
Constructs a default exception with a result code, a specified string of additional information, and a string containing information passed back from the server.
LDAPException(String message, int resultCode, String serverErrorMessage, String matchedDN)
Constructs a default exception with a result code, a specified string of additional information, a string containing information passed back from the server, and the DN of the closest matching entry, if the exception was thrown because an entry could not be found (for example, if cn=Babs Jensen, ou=People, c=Airius.com could not be found but ou=People, c=Airius.com is a valid directory entry, the "matched DN" is ou=People, c=Airius.com.

Method Summary

String
errorCodeToString()
Returns the error message describing the error code (for this exception).
String
errorCodeToString(Locale l)
Returns the error message describing the error code for this exception.
static String
errorCodeToString(int code)
Returns the error message describing the specified error code.
static String
errorCodeToString(int code, Locale locale)
Returns the error message describing the specified error code.
String
getLDAPErrorMessage()
Returns the error message from the last error, if this message is available (that is, if this message was set).
int
getLDAPResultCode()
Returns the result code from the last error that occurred.
String
getMatchedDN()
Returns the maximal subset of a DN which could be matched by the server.
String
toString()
Gets the string representation of the exception, which includes the result code, the message sent back from the LDAP server, the portion of the DN that the server could find in the directory (if applicable), and the error message corresponding to this result code.

Field Details

ADMIN_LIMIT_EXCEEDED

public static final int ADMIN_LIMIT_EXCEEDED
(11) [LDAP v3] The adminstrative limit on the maximum number of entries to return was exceeded. In the Netscape Directory Server 3.0, this corresponds to the "look through limit" for the server. This is the maximum number of entries that the server will check through when determining which entries match the search filter and scope.

Field Value:
11

AFFECTS_MULTIPLE_DSAS

public static final int AFFECTS_MULTIPLE_DSAS
(71) [LDAP v3] The client attempted to move an entry from one LDAP server to another by requesting a "modify DN" operation. In general, clients should not be able to arbitrarily move entries and subtrees between servers.

Field Value:
71
See Also:
netscape.ldap.LDAPConnection.rename(java.lang.String, java.lang.String, java.lang.String, boolean), netscape.ldap.LDAPConnection.rename(java.lang.String, java.lang.String, java.lang.String, boolean, LDAPConstraints)

ALIAS_DEREFERENCING_PROBLEM

public static final int ALIAS_DEREFERENCING_PROBLEM
(36) An error occurred when dereferencing an alias.
Field Value:
36

ALIAS_PROBLEM

public static final int ALIAS_PROBLEM
(33) An problem occurred with an alias.
Field Value:
33

ATTRIBUTE_OR_VALUE_EXISTS

public static final int ATTRIBUTE_OR_VALUE_EXISTS
(20) The value that you are adding to an attribute already exists in the attribute.
Field Value:
20

AUTH_METHOD_NOT_SUPPORTED

public static final int AUTH_METHOD_NOT_SUPPORTED
(7) The specified authentication method is not supported by the LDAP server that you are connecting to. The LDAPConnection class is implemented so that LDAPConnection.authenticate always uses the LDAP_AUTH_SIMPLE method of authentication. (LDAPConnection.authenticate does not allow you to select the method of authentication.)

Field Value:
7

BUSY

public static final int BUSY
(51) The LDAP server is busy.
Field Value:
51

CLIENT_LOOP

public static final int CLIENT_LOOP
(96) Your LDAP client detected a loop in the referral.
Field Value:
96

COMPARE_FALSE

public static final int COMPARE_FALSE
(5) Value returned by an LDAP compare operation if the specified attribute and value is not found in the entry (no matching value found).
Field Value:
5
See Also:
netscape.ldap.LDAPConnection.compare

COMPARE_TRUE

public static final int COMPARE_TRUE
(6) Value returned by an LDAP compare operation if the specified attribute and value is found in the entry (matching value found).
Field Value:
6
See Also:
netscape.ldap.LDAPConnection.compare

CONFIDENTIALITY_REQUIRED

public static final int CONFIDENTIALITY_REQUIRED
(13) [LDAP v3] A secure connection is required for this operation.
Field Value:
13

CONNECT_ERROR

public static final int CONNECT_ERROR
(91) Your LDAP client failed to connect to the LDAP server.
Field Value:
91

CONSTRAINT_VIOLATION

public static final int CONSTRAINT_VIOLATION
(19) An internal error occurred in the LDAP server.
Field Value:
19

CONTROL_NOT_FOUND

public static final int CONTROL_NOT_FOUND
(93) The requested control is not found.

Field Value:
93

ENTRY_ALREADY_EXISTS

public static final int ENTRY_ALREADY_EXISTS
(68) The specified entry already exists. You might receive this error if, for example, you attempt to add an entry that already exists or if you attempt to change the name of an entry to the name of an entry that already exists.
Field Value:
68

INAPPROPRIATE_AUTHENTICATION

public static final int INAPPROPRIATE_AUTHENTICATION
(48) The authentication presented to the server is inappropriate. This result code might occur, for example, if your client presents a password and the corresponding entry has no userpassword attribute.
Field Value:
48

INAPPROPRIATE_MATCHING

public static final int INAPPROPRIATE_MATCHING
(18) An inappropriate type of matching was used.
Field Value:
18

INDEX_RANGE_ERROR

public static final int INDEX_RANGE_ERROR
(61) An index range error occurred.
Field Value:
61

INSUFFICIENT_ACCESS_RIGHTS

public static final int INSUFFICIENT_ACCESS_RIGHTS
(50) The client is authenticated as a user who does not have the access privileges to perform this operation.
Field Value:
50

INVALID_ATTRIBUTE_SYNTAX

public static final int INVALID_ATTRIBUTE_SYNTAX
(21) The request contains invalid syntax.
Field Value:
21

INVALID_CREDENTIALS

public static final int INVALID_CREDENTIALS
(49) The credentials presented to the server for authentication are not valid. (For example, the password sent to the server does not match the user's password in the directory.)
Field Value:
49

INVALID_DN_SYNTAX

public static final int INVALID_DN_SYNTAX
(34) The specified distinguished name (DN) uses invalid syntax.
Field Value:
34

IS_LEAF

public static final int IS_LEAF
(35) The specified entry is a "leaf" entry (it has no entries beneath it in the directory tree).
Field Value:
35

LDAP_NOT_SUPPORTED

public static final int LDAP_NOT_SUPPORTED
(92) The request is not supported by this version of the LDAP protocol.
Field Value:
92

LDAP_PARTIAL_RESULTS

public static final int LDAP_PARTIAL_RESULTS
(9) The LDAP server is referring your client to another LDAP server. If you set up the LDAPConnection options or the LDAPConstraints options for automatic referral, your client will automatically connect and authenticate to the other LDAP server. (This LDAPException will not be raised.)

(To set up automatic referrals in an LDAPConnection object, set the LDAPConnection.REFERRALS option to true and the LDAPConnection.REFERRALS_REBIND_PROC option to the object containing the method for retrieving authentication information (in other words, the distinguished name and password to use when authenticating to other LDAP servers).

If instead you set LDAPConnection.REFERRALS to false (or if you set LDAPConstraints.setReferrals to false, an LDAPReferralException is raised.

If an error occurs during the referral process, an LDAPException with this result code (LDAP_PARTIAL_RESULTS) is raised.

Field Value:
9

LDAP_TIMEOUT

public static final int LDAP_TIMEOUT
(85) The operation could not be completed within the maximum time limit. You can specify the maximum time limit by calling the LDAPConstraints.setTimeLimit method.

Field Value:
85

LOOP_DETECT

public static final int LOOP_DETECT
(54) A loop has been detected.
Field Value:
54

MORE_RESULTS_TO_RETURN

public static final int MORE_RESULTS_TO_RETURN
(95) More results are being returned from the server.
Field Value:
95

NAMING_VIOLATION

public static final int NAMING_VIOLATION
(64) A naming violation has occurred.
Field Value:
64

NOT_ALLOWED_ON_NONLEAF

public static final int NOT_ALLOWED_ON_NONLEAF
(66) The requested operation can only be performed on an entry that has no entries beneath it in the directory tree (in other words, a "leaf" entry).

For example, you cannot delete or rename an entry if the entry has subentries beneath it.

Field Value:
66

NOT_ALLOWED_ON_RDN

public static final int NOT_ALLOWED_ON_RDN
(67) The specified operation cannot be performed on a relative distinguished name (RDN).
Field Value:
67

NO_RESULTS_RETURNED

public static final int NO_RESULTS_RETURNED
(94) No results have been returned from the server.
Field Value:
94

NO_SUCH_ATTRIBUTE

public static final int NO_SUCH_ATTRIBUTE
(16) The specified attribute could not be found.
Field Value:
16

NO_SUCH_OBJECT

public static final int NO_SUCH_OBJECT
(32) The entry specified in the request does not exist.
Field Value:
32

OBJECT_CLASS_MODS_PROHIBITED

public static final int OBJECT_CLASS_MODS_PROHIBITED
(69) You cannot modify the specified object class.
Field Value:
69

OBJECT_CLASS_VIOLATION

public static final int OBJECT_CLASS_VIOLATION
(65) The requested operation will add or change data so that the data no longer complies with the schema.
Field Value:
65

OPERATION_ERROR

public static final int OPERATION_ERROR
(1) An internal error occurred in the LDAP server.
Field Value:
1

OTHER

public static final int OTHER
(80) General result code for other types of errors that may occur.
Field Value:
80

PARAM_ERROR

public static final int PARAM_ERROR
(89) When calling a constructor or method from your client, one or more parameters were incorrectly specified.
Field Value:
89

PROTOCOL_ERROR

public static final int PROTOCOL_ERROR
(2) A LDAP server could not correctly interpret the request sent by your client because the request does not strictly comply with the LDAP protocol. (For example, the data was not correctly BER-encoded, or a specified value -- such as the search scope or modification type -- does not comply with the LDAP protocol. If you invent your own search scope, for instance, this result code might be returned.

Field Value:
2

REFERRAL

public static final int REFERRAL
(10) [LDAP v3] The server does not hold the requested entry. The referral field of the server's response contains a reference to another server (or set of servers), which your client can access through LDAP or other protocols. Typically, these references are LDAP URLs that identify the server that may contain the requested entry.

When this occurs, a LDAPReferralException is thrown. You can catch this exception and call the getURLs method to get the list of LDAP URLs from the exception.

Field Value:
10

REFERRAL_LIMIT_EXCEEDED

public static final int REFERRAL_LIMIT_EXCEEDED
(97) The number of sequential referrals (for example, the client may be referred first from LDAP server A to LDAP server B, then from LDAP server B to LDAP server C, and so on) has exceeded the maximum number of referrals (the LDAPv2.REFERRALS_HOP_LIMIT option).

Field Value:
97

SASL_BIND_IN_PROGRESS

public static final int SASL_BIND_IN_PROGRESS
(14) [LDAP v3] While authenticating your client by using a SASL (Simple Authentication Security Layer) mechanism, the server requires the client to send a new SASL bind request (specifying the same SASL mechanism) to continue the authentication process.
Field Value:
14

SERVER_DOWN

public static final int SERVER_DOWN
(81) The LDAP server cannot be contacted.
Field Value:
81

SIZE_LIMIT_EXCEEDED

public static final int SIZE_LIMIT_EXCEEDED
(4) The search found more than the maximum number of results. You can specify the maximum number of results by calling the LDAPConnection.setOption method or the LDAPSearchConstraints.setSizeLimit method.

Field Value:
4

SORT_CONTROL_MISSING

public static final int SORT_CONTROL_MISSING
(60) The "server-side sorting" control was not included with the "virtual list view" control in the search request.
Field Value:
60

STRONG_AUTH_REQUIRED

public static final int STRONG_AUTH_REQUIRED
(8) A stronger authentication method (more than LDAP_AUTH_SIMPLE) is required by the LDAP server that you are connecting to. The LDAPConnection class is implemented so that LDAPConnection.authenticate always uses the LDAP_AUTH_SIMPLE method of authentication. (LDAPConnection.authenticate does not allow you to select the method of authentication.)

Field Value:
8

SUCCESS

public static final int SUCCESS
(0) The operation completed successfully.
Field Value:
0

TIME_LIMIT_EXCEEDED

public static final int TIME_LIMIT_EXCEEDED
(3) The search operation could not be completed within the maximum time limit. You can specify the maximum time limit by calling the LDAPConnection.setOption method or the LDAPSearchConstraints.setServerTimeLimit method.

Field Value:
3

TLS_NOT_SUPPORTED

public static final int TLS_NOT_SUPPORTED
(112) The socket factory of the connection is not capable of initiating a TLS session.

Field Value:
112

UNAVAILABLE

public static final int UNAVAILABLE
(52) The LDAP server is unavailable.
Field Value:
52

UNAVAILABLE_CRITICAL_EXTENSION

public static final int UNAVAILABLE_CRITICAL_EXTENSION
(12) [LDAP v3] The server received an LDAP v3 control that is marked critical and either (1) is not recognized or supported by the server, or (2) is inappropriate for the operation requested. The Netscape Directory Server 3.0 also returns this result code if the client specifies a matching rule that is not supported by the server.

Field Value:
12

UNDEFINED_ATTRIBUTE_TYPE

public static final int UNDEFINED_ATTRIBUTE_TYPE
(17) The specified attribute is not defined.
Field Value:
17

UNWILLING_TO_PERFORM

public static final int UNWILLING_TO_PERFORM
(53) The LDAP server is unable to perform the specified operation.
Field Value:
53

Constructor Details

LDAPException

public LDAPException()
Constructs a default exception with no specific error information.

LDAPException

public LDAPException(String message)
Constructs a default exception with a specified string of additional information. This string appears if you call the toString() method.

This form is used for lower-level errors. It is recommended that you always use one of the constructors that takes a result code as a parameter. (If your exception is thrown, any code that catches the exception may need to extract the result code from the exception.)

Parameters:
message - the additional error information

LDAPException

public LDAPException(String message,
                     int resultCode)
Constructs a default exception with a result code and a specified string of additional information. This string appears if you call the toString() method. The result code that you set is accessible through the getLDAPResultCode() method.

Parameters:
message - the additional error information to specify
resultCode - the result code returned from the operation that caused this exception

LDAPException

public LDAPException(String message,
                     int resultCode,
                     String serverErrorMessage)
Constructs a default exception with a result code, a specified string of additional information, and a string containing information passed back from the server.

After you construct the LDAPException object, the result code and messages will be accessible through the following ways:

  • The first string of additional information appears if you call the toString() method.

  • The result code that you set is accessible through the getLDAPResultCode() method.

  • The string of server error information that you set is accessible through the getLDAPErrorMessage method.

Use this form of the constructor for higher-level LDAP operational errors.

Parameters:
message - the additional error information to specify
resultCode - the result code returned from the operation that caused this exception
serverErrorMessage - error message specifying additional information returned from the server

LDAPException

public LDAPException(String message,
                     int resultCode,
                     String serverErrorMessage,
                     String matchedDN)
Constructs a default exception with a result code, a specified string of additional information, a string containing information passed back from the server, and the DN of the closest matching entry, if the exception was thrown because an entry could not be found (for example, if cn=Babs Jensen, ou=People, c=Airius.com could not be found but ou=People, c=Airius.com is a valid directory entry, the "matched DN" is ou=People, c=Airius.com.

After you construct the LDAPException object, the result code and messages will be accessible through the following ways:

  • This string of additional information appears if you call the toString() method.

  • The result code that you set is accessible through the getLDAPResultCode() method.

  • The string of server error information that you set is accessible through the getLDAPErrorMessage method.

  • The matched DN that you set is accessible through the getMatchedDN method.

This form is used for higher-level LDAP operational errors.

Parameters:
message - the additional error information
resultCode - the result code returned
serverErrorMessage - error message specifying additional information returned from the server
matchedDN - maximal subset of a specified DN which could be matched by the server

Method Details

errorCodeToString

public String errorCodeToString()
Returns the error message describing the error code (for this exception). The error message is specific to the default locale for this system. (The LDAP Java classes determine the default locale by calling the java.util.Locale.getDefault method and retrieve the error messages from the following file:
netscape/ldap/error/ErrorCodes_locale_name.props
where locale_name is the language and country (concatenated and delimited by an underscore) of the default locale. For example:
netscape/ldap/error/ErrorCodes_en_US.props
Returns:
the error message describing the error code for this exception in the default locale.

errorCodeToString

public String errorCodeToString(Locale l)
Returns the error message describing the error code for this exception. The error message for the specified locale is retrieved from the following file:
netscape/ldap/error/ErrorCodes_locale_name.props
where locale_name is the language and country (concatenated and delimited by an underscore) of the default locale. For example:
netscape/ldap/error/ErrorCodes_en_US.props
Parameters:
l - the java.util.Locale object representing the locale of the error message to retrieve
Returns:
the error message describing the current error code in the specified locale.

errorCodeToString

public static String errorCodeToString(int code)
Returns the error message describing the specified error code. The error message is specific to the default locale for this system. (The LDAP Java classes determine the default locale by calling the java.util.Locale.getDefault method and retrieve the error messages from the following file:
netscape/ldap/error/ErrorCodes_locale_name.props
where locale_name is the language and country (concatenated and delimited by an underscore) of the default locale. For example:
netscape/ldap/error/ErrorCodes_en_US.props
Parameters:
code - the error code for which to get the corresponding error message
Returns:
error message describing the specified error code for the default locale.

errorCodeToString

public static String errorCodeToString(int code,
                                       Locale locale)
Returns the error message describing the specified error code. The error message for the specified locale is retrieved from the following file:
netscape/ldap/error/ErrorCodes_locale_name.props
where locale_name is the language and country (concatenated and delimited by an underscore) of the default locale. For example:
netscape/ldap/error/ErrorCodes_en_US.props
Parameters:
code - the error code for which to get the corresponding error
locale - the java.util.Locale object representing the locale of the error message that you want to retrieve
Returns:
error message describing the specified error code for the specified locale.

getLDAPErrorMessage

public String getLDAPErrorMessage()
Returns the error message from the last error, if this message is available (that is, if this message was set). If the message was not set, this method returns null.

Note that this message is rarely set. (In order to set this message, the code constructing this exception must have called the constructor LDAPException(String, int, String). The last argument, which is additional error information returned from the server, is the string returned by getLDAPErrorMessage.

In most cases, if you want information about the error generated, you should call the toString() method instead.

Returns:
the error message of the last error (or null if no message was set).

getLDAPResultCode

public int getLDAPResultCode()
Returns the result code from the last error that occurred. This result code is defined as a public final static int member of this class. Note that this value is not always valid. -1 indicates that the result code is invalid.
Returns:
the LDAP result code of the last operation.

getMatchedDN

public String getMatchedDN()
Returns the maximal subset of a DN which could be matched by the server. The method should be used if the server returned one of the following errors:
  • NO_SUCH_OBJECT
  • ALIAS_PROBLEM
  • INVALID_DN_SYNTAX
  • ALIAS_DEREFERENCING_PROBLEM
For example, if the DN cn=Babs Jensen, o=People, c=Airius.com could not be found by the DN o=People, c=Airius.com could be found, the matched DN is o=People, c=Airius.com.

If the exception does not specify a matching DN, this method returns null.

Returns:
the maximal subset of a DN which could be matched, or null if the error is not one of the above.

toString

public String toString()
Gets the string representation of the exception, which includes the result code, the message sent back from the LDAP server, the portion of the DN that the server could find in the directory (if applicable), and the error message corresponding to this result code.

For example:

netscape.ldap.LDAPException: error result (32); server error message; matchedDN = ou=people,o=airius.com; No such object
In this example, error result is the string of additional information specified in the exception, 32 is the result code, server error message is the additional information from the server specified in the exception, the matched DN is ou=people,o=airius.com, and the error message corresponding to the result code 32 is No such object.

The error message corresponding to the error code can also be retrieved by using the errorCodeToString method. Note that this method can generate error messages specific to a current locale.

Returns:
string representation of exception.