Package org.opends.server.tools

Class LDAPConnectionException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.opends.server.types.OpenDsException

org.opends.server.tools.LDAPConnectionException

All Implemented Interfaces:

Serializable, org.forgerock.i18n.LocalizableException

public class LDAPConnectionException
extends OpenDsException

This class defines an exception that may be thrown during the course of creating an LDAP connection to the server.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
LDAPConnectionException(org.forgerock.i18n.LocalizableMessage message)	Creates a new exception with the provided message.
LDAPConnectionException(org.forgerock.i18n.LocalizableMessage message, int resultCode, org.forgerock.i18n.LocalizableMessage errorMessage)	Creates a new exception with the provided message.
LDAPConnectionException(org.forgerock.i18n.LocalizableMessage message, int resultCode, org.forgerock.i18n.LocalizableMessage errorMessage, Throwable cause)	Creates a new exception with the provided message and underlying cause.
LDAPConnectionException(org.forgerock.i18n.LocalizableMessage message, int resultCode, org.forgerock.i18n.LocalizableMessage errorMessage, DN matchedDN, Throwable cause)	Creates a new exception with the provided message and underlying cause.
LDAPConnectionException(org.forgerock.i18n.LocalizableMessage message, Throwable cause)	Creates a new exception with the provided message and underlying cause.

Method Summary

Modifier and Type	Method	Description
org.forgerock.i18n.LocalizableMessage	getErrorMessage()	Retrieves the server-provided error message associated with this exception.
DN	getMatchedDN()	Return the matched DN associated with this exception.
int	getResultCode()	Return the result code associated with this exception.

Methods inherited from class org.opends.server.types.OpenDsException

getMessageObject

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 Detail

LDAPConnectionException

public LDAPConnectionException(org.forgerock.i18n.LocalizableMessage message)

Creates a new exception with the provided message.

Parameters:

message - The message to use for this exception.

LDAPConnectionException

public LDAPConnectionException(org.forgerock.i18n.LocalizableMessage message,
                               int resultCode,
                               org.forgerock.i18n.LocalizableMessage errorMessage)

Creates a new exception with the provided message.

Parameters:

message - The message to use for this exception.

resultCode - The result code for this exception.

errorMessage - The server-provided error message for this exception.

LDAPConnectionException

public LDAPConnectionException(org.forgerock.i18n.LocalizableMessage message,
                               Throwable cause)

Creates a new exception with the provided message and underlying cause.

Parameters:

message - The message to use for this exception.

cause - The underlying cause that triggered this exception.

LDAPConnectionException

public LDAPConnectionException(org.forgerock.i18n.LocalizableMessage message,
                               int resultCode,
                               org.forgerock.i18n.LocalizableMessage errorMessage,
                               Throwable cause)

Creates a new exception with the provided message and underlying cause.

Parameters:

message - The message to use for this exception.

resultCode - The result code for this exception.

errorMessage - The server-provided error message for this exception.

cause - The underlying cause that triggered this exception.

LDAPConnectionException

public LDAPConnectionException(org.forgerock.i18n.LocalizableMessage message,
                               int resultCode,
                               org.forgerock.i18n.LocalizableMessage errorMessage,
                               DN matchedDN,
                               Throwable cause)

Creates a new exception with the provided message and underlying cause.

Parameters:

message - The explanation to use for this exception.

resultCode - The result code for this exception.

errorMessage - The server-provided error message for this exception.

matchedDN - The matched DN string for this exception.

cause - The underlying cause that triggered this exception.

Method Detail

getResultCode

public int getResultCode()

Return the result code associated with this exception.

Returns:

The result code associated with this exception, or -1 if none was provided.

getErrorMessage

public org.forgerock.i18n.LocalizableMessage getErrorMessage()

Retrieves the server-provided error message associated with this exception.

Returns:

The server-provided error message associated with this exception.

getMatchedDN

public DN getMatchedDN()

Return the matched DN associated with this exception.

Returns:

The matched DN associated with this exception, or null if none was provided.