org.forgerock.opendj.io

Class LdapSocketClosedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

org.forgerock.opendj.io.LdapSocketClosedException

All Implemented Interfaces:

Serializable

public final class LdapSocketClosedException
extends IOException

Thrown when a LdapSocket has been closed locally.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static LdapSocketClosedException	fatalError(Throwable cause) Returns a LdapSocketClosedException specifying that the socket has been closed locally as a result of a fatal error.
static LdapSocketClosedException	gracefullyClosed() Returns a LdapSocketClosedException specifying that the socket has been intentionally and gracefully closed locally.

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

Method Detail

gracefullyClosed

public static LdapSocketClosedException gracefullyClosed()

Returns a LdapSocketClosedException specifying that the socket has been intentionally and gracefully closed locally.

The returned exception reflects an expected end of connection. As an example this can be used by a server to disconnect gracefully a client after receiving an UnbindRequest. On the client-side, the exception can be used when a process has completed and needs to release resources (e.g: after receiving the result of a request).

Because the close is intentional, Throwable.getCause() will always return null.

Returns:

A new LdapSocketClosedException

fatalError

public static LdapSocketClosedException fatalError(Throwable cause)

Returns a LdapSocketClosedException specifying that the socket has been closed locally as a result of a fatal error.

The returned exception reflects an unexpected end of connection. As an example this can be used by a server to disconnect a client after receiving invalid data.

Because the close is the result of a fatal error, Throwable.getCause() will return the reason for the disconnection.

Parameters:

cause - The reason why the connection has been closed.

Returns:

A new LdapSocketClosedException