Module io.inverno.mod.ldap

Package io.inverno.mod.ldap

Class LDAPException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.inverno.mod.ldap.LDAPException

All Implemented Interfaces:

Serializable

public abstract class LDAPException
extends RuntimeException

Thrown by an LDAPClient to indicate an error wile accessing an LDAP server.

Since:

1.5

Author:

Jeremy Kuhn

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
LDAPException()	Creates an LDAP exception.
LDAPException(String message)	Creates an LDAP exception.
LDAPException(String message, Throwable cause)	Creates an LDAP exception.
LDAPException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace)	Creates an LDAP exception.
LDAPException(Throwable cause)	Creates an LDAP exception.

Method Summary

Modifier and Type	Method	Description
abstract Integer	getErrorCode()	Returns the code corresponding to the LDAP error.
abstract String	getErrorDescription()	Returns the description of the LDAP error.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Details

LDAPException

public LDAPException()

Creates an LDAP exception.

LDAPException

public LDAPException(String message)

Creates an LDAP exception.

Parameters:

message - a message

LDAPException

public LDAPException(Throwable cause)

Creates an LDAP exception.

Parameters:

cause - the cause of the error

LDAPException

public LDAPException(String message,
 Throwable cause)

Creates an LDAP exception.

Parameters:

message - a message

cause - the cause of the error

LDAPException

public LDAPException(String message,
 Throwable cause,
 boolean enableSuppression,
 boolean writableStackTrace)

Creates an LDAP exception.

Parameters:

message - a message

cause - the cause of the error

enableSuppression - whether or not suppression is enabled or disabled

writableStackTrace - whether or not the stack trace should be writable

Method Details

getErrorCode

public abstract Integer getErrorCode()

Returns the code corresponding to the LDAP error.

Returns:

the error code

getErrorDescription

public abstract String getErrorDescription()

Returns the description of the LDAP error.

This shall corresponds to the actual error message returned by the LDAP server.

Returns:

the error description