com.nitido.directory
Class DirectoryException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.nitido.directory.DirectoryException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DirAuthenticationFailedException, DirEntryAlreadyExistsException, DirReferralException, DirSchemaViolationException

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

The DirectoryException class is the generic exception thrown by this library.

See Also:

Serialized Form

Field Summary

static int	BAD_FILTER
static int	CONNECTION_PROBLEM
static int	ENTRY_ALREADY_EXISTS
static int	GENERIC
static int	INVALID_CREDENTIALS
static int	LDAP_ADMINLIMIT_EXCEEDED
static int	LDAP_AFFECTS_MULTIPLE_DSAS
static int	LDAP_ALIAS_DEREFERENCING_PROBLEM
static int	LDAP_ALIAS_PROBLEM
static int	LDAP_ATTRIBUTE_OR_VALUE_EXISTS
static int	LDAP_AUTH_METHOD_NOT_SUPPORTED
static int	LDAP_BUSY
static int	LDAP_CLIENT_LOOP
static int	LDAP_COMPARE_FALSE
static int	LDAP_COMPARE_TRUE
static int	LDAP_CONFIDENTIALITY_REQUIRED
static int	LDAP_CONNECT_ERROR
static int	LDAP_CONSTRAINT_VIOLATION
static int	LDAP_CONTROL_NOT_FOUND
static int	LDAP_ENTRY_ALREADY_EXISTS
static int	LDAP_INAPPROPRIATE_AUTHENTICATION
static int	LDAP_INAPPROPRIATE_MATCHING
static int	LDAP_INSUFFICIENT_ACCESS_RIGHTS
static int	LDAP_INVALID_ATTRIBUTE_SYNTAX
static int	LDAP_INVALID_CREDENTIALS
static int	LDAP_INVALID_DN_SYNTAX
static int	LDAP_LOOP_DETECT
static int	LDAP_MORE_RESULTS_TO_RETURNED
static int	LDAP_NAMING_VIOLATION
static int	LDAP_NO_RESULTS_RETURNED
static int	LDAP_NO_SUCH_ATTRIBUTE
static int	LDAP_NO_SUCH_OBJECT
static int	LDAP_NOT_ALLOWED_ON_NON_LEAF
static int	LDAP_NOT_ALLOWED_ON_RDN
static int	LDAP_NOT_SUPPORTED
static int	LDAP_OBJECT_CLASS_MODS_PROHIBITED
static int	LDAP_OBJECT_CLASS_VIOLATION
static int	LDAP_OPERATIONS_ERROR
static int	LDAP_OTHER
static int	LDAP_PARAM_ERROR
static int	LDAP_PROTOCOL_ERROR
static int	LDAP_REFERRAL
static int	LDAP_REFERRAL_LIMIT_EXCEEDED
static int	LDAP_SASL_BIND_IN_PROGRESS
static int	LDAP_SERVER_DOWN
static int	LDAP_SIZELIMIT_EXCEEDED
static int	LDAP_STRONG_AUTH_REQUIRED
static int	LDAP_SUCCESS
static int	LDAP_TIMELIMIT_EXCEEDED
static int	LDAP_TIMEOUT
static int	LDAP_TLS_NOT_SUPPORTED
static int	LDAP_UNAVAILABLE
static int	LDAP_UNAVAILABLE_CRITICAL_EXTENSION
static int	LDAP_UNDEFINED_ATTRIBUTE_TYPE
static int	LDAP_UNWILLING_TO_PERFORM
static int	NO_SUCH_ATTRIBUTE
static int	NO_SUCH_OBJECT
static int	OK

Constructor Summary

DirectoryException(int errorCode, java.lang.String msg, java.lang.Throwable rootCause)
Constructor that takes in the error message and the original Throwable that causes this exception.

DirectoryException(java.lang.String msg)
Constructor that takes in only

DirectoryException(java.lang.String msg, java.lang.Throwable rootCause)
Constructor that takes in the error message and the original Throwable that causes this exception.

Method Summary

int	getErrorCode() Return the error code for the exception.
java.lang.String	getMessage() Return the detail message of this exception.
java.lang.Throwable	getRootCause() Get the original Throwable that causes this exception.
java.lang.String	toString()

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

OK

public static final int OK

See Also:

Constant Field Values

GENERIC

public static final int GENERIC

See Also:

Constant Field Values

NO_SUCH_OBJECT

public static final int NO_SUCH_OBJECT

See Also:

Constant Field Values

NO_SUCH_ATTRIBUTE

public static final int NO_SUCH_ATTRIBUTE

See Also:

Constant Field Values

INVALID_CREDENTIALS

public static final int INVALID_CREDENTIALS

See Also:

Constant Field Values

CONNECTION_PROBLEM

public static final int CONNECTION_PROBLEM

See Also:

Constant Field Values

BAD_FILTER

public static final int BAD_FILTER

See Also:

Constant Field Values

ENTRY_ALREADY_EXISTS

public static final int ENTRY_ALREADY_EXISTS

See Also:

Constant Field Values

LDAP_SUCCESS

public static final int LDAP_SUCCESS

See Also:

Constant Field Values

LDAP_OPERATIONS_ERROR

public static final int LDAP_OPERATIONS_ERROR

See Also:

Constant Field Values

LDAP_PROTOCOL_ERROR

public static final int LDAP_PROTOCOL_ERROR

See Also:

Constant Field Values

LDAP_TIMELIMIT_EXCEEDED

public static final int LDAP_TIMELIMIT_EXCEEDED

See Also:

Constant Field Values

LDAP_SIZELIMIT_EXCEEDED

public static final int LDAP_SIZELIMIT_EXCEEDED

See Also:

Constant Field Values

LDAP_COMPARE_FALSE

public static final int LDAP_COMPARE_FALSE

See Also:

Constant Field Values

LDAP_COMPARE_TRUE

public static final int LDAP_COMPARE_TRUE

See Also:

Constant Field Values

LDAP_AUTH_METHOD_NOT_SUPPORTED

public static final int LDAP_AUTH_METHOD_NOT_SUPPORTED

See Also:

Constant Field Values

LDAP_STRONG_AUTH_REQUIRED

public static final int LDAP_STRONG_AUTH_REQUIRED

See Also:

Constant Field Values

LDAP_REFERRAL

public static final int LDAP_REFERRAL

See Also:

Constant Field Values

LDAP_ADMINLIMIT_EXCEEDED

public static final int LDAP_ADMINLIMIT_EXCEEDED

See Also:

Constant Field Values

LDAP_UNAVAILABLE_CRITICAL_EXTENSION

public static final int LDAP_UNAVAILABLE_CRITICAL_EXTENSION

See Also:

Constant Field Values

LDAP_CONFIDENTIALITY_REQUIRED

public static final int LDAP_CONFIDENTIALITY_REQUIRED

See Also:

Constant Field Values

LDAP_SASL_BIND_IN_PROGRESS

public static final int LDAP_SASL_BIND_IN_PROGRESS

See Also:

Constant Field Values

LDAP_NO_SUCH_ATTRIBUTE

public static final int LDAP_NO_SUCH_ATTRIBUTE

See Also:

Constant Field Values

LDAP_UNDEFINED_ATTRIBUTE_TYPE

public static final int LDAP_UNDEFINED_ATTRIBUTE_TYPE

See Also:

Constant Field Values

LDAP_INAPPROPRIATE_MATCHING

public static final int LDAP_INAPPROPRIATE_MATCHING

See Also:

Constant Field Values

LDAP_CONSTRAINT_VIOLATION

public static final int LDAP_CONSTRAINT_VIOLATION

See Also:

Constant Field Values

LDAP_ATTRIBUTE_OR_VALUE_EXISTS

public static final int LDAP_ATTRIBUTE_OR_VALUE_EXISTS

See Also:

Constant Field Values

LDAP_INVALID_ATTRIBUTE_SYNTAX

public static final int LDAP_INVALID_ATTRIBUTE_SYNTAX

See Also:

Constant Field Values

LDAP_NO_SUCH_OBJECT

public static final int LDAP_NO_SUCH_OBJECT

See Also:

Constant Field Values

LDAP_ALIAS_PROBLEM

public static final int LDAP_ALIAS_PROBLEM

See Also:

Constant Field Values

LDAP_INVALID_DN_SYNTAX

public static final int LDAP_INVALID_DN_SYNTAX

See Also:

Constant Field Values

LDAP_ALIAS_DEREFERENCING_PROBLEM

public static final int LDAP_ALIAS_DEREFERENCING_PROBLEM

See Also:

Constant Field Values

LDAP_INAPPROPRIATE_AUTHENTICATION

public static final int LDAP_INAPPROPRIATE_AUTHENTICATION

See Also:

Constant Field Values

LDAP_INVALID_CREDENTIALS

public static final int LDAP_INVALID_CREDENTIALS

See Also:

Constant Field Values

LDAP_INSUFFICIENT_ACCESS_RIGHTS

public static final int LDAP_INSUFFICIENT_ACCESS_RIGHTS

See Also:

Constant Field Values

LDAP_BUSY

public static final int LDAP_BUSY

See Also:

Constant Field Values

LDAP_UNAVAILABLE

public static final int LDAP_UNAVAILABLE

See Also:

Constant Field Values

LDAP_UNWILLING_TO_PERFORM

public static final int LDAP_UNWILLING_TO_PERFORM

See Also:

Constant Field Values

LDAP_LOOP_DETECT

public static final int LDAP_LOOP_DETECT

See Also:

Constant Field Values

LDAP_NAMING_VIOLATION

public static final int LDAP_NAMING_VIOLATION

See Also:

Constant Field Values

LDAP_OBJECT_CLASS_VIOLATION

public static final int LDAP_OBJECT_CLASS_VIOLATION

See Also:

Constant Field Values

LDAP_NOT_ALLOWED_ON_NON_LEAF

public static final int LDAP_NOT_ALLOWED_ON_NON_LEAF

See Also:

Constant Field Values

LDAP_NOT_ALLOWED_ON_RDN

public static final int LDAP_NOT_ALLOWED_ON_RDN

See Also:

Constant Field Values

LDAP_ENTRY_ALREADY_EXISTS

public static final int LDAP_ENTRY_ALREADY_EXISTS

See Also:

Constant Field Values

LDAP_OBJECT_CLASS_MODS_PROHIBITED

public static final int LDAP_OBJECT_CLASS_MODS_PROHIBITED

See Also:

Constant Field Values

LDAP_AFFECTS_MULTIPLE_DSAS

public static final int LDAP_AFFECTS_MULTIPLE_DSAS

See Also:

Constant Field Values

LDAP_OTHER

public static final int LDAP_OTHER

See Also:

Constant Field Values

LDAP_SERVER_DOWN

public static final int LDAP_SERVER_DOWN

See Also:

Constant Field Values

LDAP_TIMEOUT

public static final int LDAP_TIMEOUT

See Also:

Constant Field Values

LDAP_PARAM_ERROR

public static final int LDAP_PARAM_ERROR

See Also:

Constant Field Values

LDAP_CONNECT_ERROR

public static final int LDAP_CONNECT_ERROR

See Also:

Constant Field Values

LDAP_NOT_SUPPORTED

public static final int LDAP_NOT_SUPPORTED

See Also:

Constant Field Values

LDAP_CONTROL_NOT_FOUND

public static final int LDAP_CONTROL_NOT_FOUND

See Also:

Constant Field Values

LDAP_NO_RESULTS_RETURNED

public static final int LDAP_NO_RESULTS_RETURNED

See Also:

Constant Field Values

LDAP_MORE_RESULTS_TO_RETURNED

public static final int LDAP_MORE_RESULTS_TO_RETURNED

See Also:

Constant Field Values

LDAP_CLIENT_LOOP

public static final int LDAP_CLIENT_LOOP

See Also:

Constant Field Values

LDAP_REFERRAL_LIMIT_EXCEEDED

public static final int LDAP_REFERRAL_LIMIT_EXCEEDED

See Also:

Constant Field Values

LDAP_TLS_NOT_SUPPORTED

public static final int LDAP_TLS_NOT_SUPPORTED

See Also:

Constant Field Values

Constructor Detail

DirectoryException

public DirectoryException(java.lang.String msg)

Constructor that takes in only

DirectoryException

public DirectoryException(java.lang.String msg,
                          java.lang.Throwable rootCause)

Constructor that takes in the error message and the original Throwable that causes this exception.

Parameters:

msg - The error message.

rootCause - The original Throwable that cuases this exception.

DirectoryException

public DirectoryException(int errorCode,
                          java.lang.String msg,
                          java.lang.Throwable rootCause)

Constructor that takes in the error message and the original Throwable that causes this exception.

Parameters:

errorCode - The error code for the exception

msg - The error message.

rootCause - The original Throwable that cuases this exception.

Method Detail

getMessage

public java.lang.String getMessage()

Return the detail message of this exception.

If a root cause throwable exists, this method will append the root cause throwable's message at the end of the result.

Overrides:

getMessage in class java.lang.Throwable

Returns:

the detail message string.

getErrorCode

public int getErrorCode()

Return the error code for the exception.

getRootCause

public java.lang.Throwable getRootCause()

Get the original Throwable that causes this exception.

Returns:

the root cause Throwable.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Throwable