Package org.opends.server.types

Class DisconnectException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.opends.server.types.OpenDsException

org.opends.server.types.DisconnectException

All Implemented Interfaces:

Serializable, LocalizableException

public final class DisconnectException
extends OpenDsException

A disconnect exception is thrown in order to indicate that an accepted connection has been rejected and must be disconnected immediately. This may happen when the server is locked down or an administrative limit has been reached.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DisconnectException(DisconnectReason reason, LocalizableMessage message)	Creates a new initialization exception with the provided message.

Method Summary

Modifier and Type	Method	Description
Throwable	fillInStackTrace()	Prevent costly stack traces from being created because they are not useful for this type of exception.
DisconnectReason	getDisconnectReason()	Returns the reason for disconnecting the client.

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

getMessageObject

Methods inherited from class java.lang.Throwable

addSuppressed, 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

DisconnectException

public DisconnectException(DisconnectReason reason,
 LocalizableMessage message)

Creates a new initialization exception with the provided message.

Parameters:

reason - The reason for disconnecting the client.

message - The message that explains the problem that occurred.

Method Details

getDisconnectReason

public DisconnectReason getDisconnectReason()

Returns the reason for disconnecting the client.

Returns:

The reason for disconnecting the client.

fillInStackTrace

public Throwable fillInStackTrace()

Prevent costly stack traces from being created because they are not useful for this type of exception.

Overrides:

fillInStackTrace in class Throwable