Package org.forgerock.opendj.ldap

Class LdapException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

org.forgerock.opendj.ldap.LdapException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AssertionFailureException, AuthenticationException, AuthorizationException, CancelledResultException, ConnectionException, ConstraintViolationException, EntryNotFoundException, MultipleEntriesFoundException, TimeoutResultException

public class LdapException
extends IOException

Thrown when the result code returned in a Result indicates that the Request was unsuccessful. This class can be sub-classed in order to implement application specific exceptions.

See Also:

• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LdapException(Result result)	Creates a new LDAP exception using the provided result.

Method Summary

Modifier and Type	Method	Description
final Result	getResult()	Returns the error result which caused this exception to be thrown.
static LdapException	newLdapException(Result result)	Creates a new LDAP exception using the provided result.
static LdapException	newLdapException(ResultCode resultCode)	Creates a new LDAP exception with the provided result code and an empty diagnostic message.
static LdapException	newLdapException(ResultCode resultCode, CharSequence diagnosticMessage)	Creates a new LDAP exception with the provided result code and diagnostic message.
static LdapException	newLdapException(ResultCode resultCode, CharSequence diagnosticMessage, Throwable cause)	Creates a new LDAP exception with the provided result code, diagnostic message, and cause.
static LdapException	newLdapException(ResultCode resultCode, Throwable cause)	Creates a new LDAP exception with the provided result code and cause.

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

protected LdapException(Result result)

Creates a new LDAP exception using the provided result.

Parameters:

result - The error result.

Method Details

newLdapException

public static LdapException newLdapException(ResultCode resultCode)

Creates a new LDAP exception with the provided result code and an empty diagnostic message.

Parameters:

resultCode - The result code.

Returns:

The new LDAP exception.

Throws:

IllegalArgumentException - If the provided result code does not represent a failure.

NullPointerException - If resultCode was null.

newLdapException

public static LdapException newLdapException(ResultCode resultCode,
 CharSequence diagnosticMessage)

Creates a new LDAP exception with the provided result code and diagnostic message.

Parameters:

resultCode - The result code.

diagnosticMessage - The diagnostic message, which may be empty or null indicating that none was provided.

Returns:

The new LDAP exception.

Throws:

IllegalArgumentException - If the provided result code does not represent a failure.

NullPointerException - If resultCode was null.

newLdapException

public static LdapException newLdapException(ResultCode resultCode,
 Throwable cause)

Creates a new LDAP exception with the provided result code and cause. The diagnostic message will be taken from the cause, if provided.

Parameters:

resultCode - The result code.

cause - The throwable cause, which may be null indicating that none was provided.

Returns:

The new LDAP exception.

Throws:

IllegalArgumentException - If the provided result code does not represent a failure.

NullPointerException - If resultCode was null.

newLdapException

public static LdapException newLdapException(ResultCode resultCode,
 CharSequence diagnosticMessage,
 Throwable cause)

Creates a new LDAP exception with the provided result code, diagnostic message, and cause.

Parameters:

resultCode - The result code.

diagnosticMessage - The diagnostic message, which may be empty or null indicating that none was provided.

cause - The throwable cause, which may be null indicating that none was provided.

Returns:

The new LDAP exception.

Throws:

IllegalArgumentException - If the provided result code does not represent a failure.

NullPointerException - If resultCode was null.

newLdapException

public static LdapException newLdapException(Result result)

Creates a new LDAP exception using the provided result.

Parameters:

result - The result whose result code indicates a failure.

Returns:

The LDAP exception wrapping the provided result.

Throws:

IllegalArgumentException - If the provided result does not represent a failure.

NullPointerException - If result was null.

getResult

public final Result getResult()

Returns the error result which caused this exception to be thrown. The type of result returned corresponds to the expected result type of the original request.

Returns:

The error result which caused this exception to be thrown.