Package org.opends.server.types

Class OpenDsException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.opends.server.types.OpenDsException

All Implemented Interfaces:

Serializable, org.forgerock.i18n.LocalizableException

Direct Known Subclasses:

ADSContextException, ApplicationException, CannotRenameException, ChangelogException, CheckEntrySyntaxException, ConfigReadException, CryptoManagerException, EmbeddedDirectoryServerException, IdentifiedException, IncompatibleVersionException, LDAPConnectionException, OfflineUpdateException, OnlineUpdateException, PeerNotFoundException, ReplicationCliException, SSLConnectionException, TaskClientException, TopologyCacheException, UserDataException, WebBrowserException

@PublicAPI(stability=VOLATILE,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public abstract class OpenDsException
extends Exception
implements org.forgerock.i18n.LocalizableException

This class defines a base exception for OpenDS exceptions.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OpenDsException()	Creates a new identified exception.
protected	OpenDsException(Throwable cause)	Creates a new identified exception with the provided information.
protected	OpenDsException(org.forgerock.i18n.LocalizableMessage message)	Creates a new identified exception with the provided information.
protected	OpenDsException(org.forgerock.i18n.LocalizableMessage message, Throwable cause)	Creates a new identified exception with the provided information.
protected	OpenDsException(OpenDsException cause)	Constructs a new instance from another OpenDsException.

Method Summary

Modifier and Type	Method	Description
org.forgerock.i18n.LocalizableMessage	getMessageObject()	Returns the message that explains the problem that occurred.

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

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(org.forgerock.i18n.LocalizableMessage message)

Creates a new identified exception with the provided information.

Parameters:

message - The message that explains the problem that occurred.

OpenDsException

protected OpenDsException(Throwable cause)

Creates a new identified exception with the provided information.

Parameters:

cause - The underlying cause that triggered this exception.

OpenDsException

protected OpenDsException(org.forgerock.i18n.LocalizableMessage message,
                          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 org.forgerock.i18n.LocalizableMessage getMessageObject()

Returns the message that explains the problem that occurred.

Specified by:

getMessageObject in interface org.forgerock.i18n.LocalizableException

Returns:

LocalizableMessage of the problem