org.opends.server.types
Class OpenDsException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by org.opends.server.types.OpenDsException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
AdminException, ADSContextException, CryptoManagerException, IdentifiedException, LDAPConnectionException, SSLConnectionException, TaskClientException, TopologyCacheException

@PublicAPI(stability=VOLATILE,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public abstract class OpenDsException
extends java.lang.Exception

This class defines a base exception for OpenDS exceptions.

See Also:
Serialized Form

Constructor Summary
protected OpenDsException()
          Creates a new identified exception.
protected OpenDsException(Message message)
          Creates a new identified exception with the provided information.
protected OpenDsException(Message message, java.lang.Throwable cause)
          Creates a new identified exception with the provided information.
protected OpenDsException(OpenDsException cause)
          Constructs a new instance from another OpenDsException.
protected OpenDsException(java.lang.Throwable cause)
          Creates a new identified exception with the provided information.
 
Method Summary
 Message getMessageObject()
          Returns the message that explains the problem that occurred.
 
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

OpenDsException

protected OpenDsException()
Creates a new identified exception.


OpenDsException

protected OpenDsException(OpenDsException cause)
Constructs a new instance from another OpenDsException. This constructor sets the message to be that of cause.

Parameters:
cause - exception whose message will be used for this exception's message.

OpenDsException

protected OpenDsException(Message message)
Creates a new identified exception with the provided information.

Parameters:
message - The message that explains the problem that occurred.

OpenDsException

protected OpenDsException(java.lang.Throwable cause)
Creates a new identified exception with the provided information.

Parameters:
cause - The underlying cause that triggered this exception.

OpenDsException

protected OpenDsException(Message message,
                          java.lang.Throwable cause)
Creates a new identified exception with the provided information.

Parameters:
message - The message that explains the problem that occurred.
cause - The underlying cause that triggered this exception.
Method Detail

getMessageObject

public Message getMessageObject()
Returns the message that explains the problem that occurred.

Returns:
Message of the problem