org.opends.server.tools
Class LDAPConnectionException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by org.opends.server.types.OpenDsException
              extended by org.opends.server.tools.LDAPConnectionException
All Implemented Interfaces:
java.io.Serializable

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
LDAPConnectionException(Message message)
          Creates a new exception with the provided message.
LDAPConnectionException(Message message, int resultCode, Message errorMessage)
          Creates a new exception with the provided message.
LDAPConnectionException(Message message, int resultCode, Message errorMessage, DN matchedDN, java.lang.Throwable cause)
          Creates a new exception with the provided message and underlying cause.
LDAPConnectionException(Message message, int resultCode, Message errorMessage, java.lang.Throwable cause)
          Creates a new exception with the provided message and underlying cause.
LDAPConnectionException(Message message, java.lang.Throwable cause)
          Creates a new exception with the provided message and underlying cause.
 
Method Summary
 Message 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
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, 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(Message message)
Creates a new exception with the provided message.

Parameters:
message - The message to use for this exception.

LDAPConnectionException

public LDAPConnectionException(Message message,
                               int resultCode,
                               Message 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(Message message,
                               java.lang.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(Message message,
                               int resultCode,
                               Message errorMessage,
                               java.lang.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(Message message,
                               int resultCode,
                               Message errorMessage,
                               DN matchedDN,
                               java.lang.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 Message 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.