Package org.opends.server.types

Enum Class DisconnectReason

java.lang.Object
java.lang.Enum<DisconnectReason>
org.opends.server.types.DisconnectReason
All Implemented Interfaces:
Serializable, Comparable<DisconnectReason>, java.lang.constant.Constable
public enum DisconnectReason extends Enum<DisconnectReason>
This enumeration defines the set of possible reasons for the closure of a connection between a client and the Directory Server.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ADMIN_DISCONNECT
    The disconnect reason that indicates that the client connection was closed because an administrator terminated the connection.
    ADMIN_LIMIT_EXCEEDED
    The disconnect reason that indicates that the client connection was closed because an administrative limit was exceeded.
    CLIENT_DISCONNECT
    The disconnect reason that indicates that the client connection was closed because the client disconnected without unbinding.
    CLOSED_BY_PLUGIN
    The disconnect reason that indicates that the client connection was closed by a plugin.
    CONNECTION_REJECTED
    The disconnect reason that indicates that the client connection was closed because the client connection was rejected.
    IDLE_TIME_LIMIT_EXCEEDED
    The disconnect reason that indicates that the client connection was closed because the idle time limit was exceeded.
    INVALID_CREDENTIALS
    The disconnect reason that indicates that the client connection was closed because the bound user's entry is no longer accessible.
    IO_TIMEOUT
    The disconnect reason that indicates that the client connection was closed because of an I/O timeout.
    OPERATIONS_ERROR
    The disconnect reason that indicates that the client connection was closed because an operation is not properly sequenced with relation to other operations (of same or different type).
    OTHER
    The disconnect reason that indicates that the client connection was closed for some other reason.
    PROTOCOL_ERROR
    The disconnect reason that indicates that the client connection was closed because of a protocol error.
    SERVER_ERROR
    The disconnect reason that indicates that the client connection was closed because of an internal error within the server.
    SERVER_IN_LOCKDOWN_MODE
    The disconnect reason that indicates that the server is in lockdown mode.
    SERVER_SHUTDOWN
    The disconnect reason that indicates that the client connection was closed because the Directory Server shut down.
    UNBIND
    The disconnect reason that indicates that the client connection was closed because the client unbind from the server.

  • Method Summary

    Modifier and Type
    Method
    Description
    LocalizableMessage
    getClosureMessage()
    Returns the human-readable disconnect reason.
    ResultCode
    getResultCode()
    Returns the LDAP result code associated with this disconnect reason.
    String
    toString()
    Returns a string representation of this disconnect reason.
    static DisconnectReason
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static DisconnectReason[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • UNBIND

      public static final DisconnectReason UNBIND
      The disconnect reason that indicates that the client connection was closed because the client unbind from the server.

    • CLIENT_DISCONNECT

      public static final DisconnectReason CLIENT_DISCONNECT
      The disconnect reason that indicates that the client connection was closed because the client disconnected without unbinding.

    • CONNECTION_REJECTED

      public static final DisconnectReason CONNECTION_REJECTED
      The disconnect reason that indicates that the client connection was closed because the client connection was rejected.

    • PROTOCOL_ERROR

      public static final DisconnectReason PROTOCOL_ERROR
      The disconnect reason that indicates that the client connection was closed because of a protocol error.

    • SERVER_SHUTDOWN

      public static final DisconnectReason SERVER_SHUTDOWN
      The disconnect reason that indicates that the client connection was closed because the Directory Server shut down.

    • ADMIN_DISCONNECT

      public static final DisconnectReason ADMIN_DISCONNECT
      The disconnect reason that indicates that the client connection was closed because an administrator terminated the connection.

    • INVALID_CREDENTIALS

      public static final DisconnectReason INVALID_CREDENTIALS
      The disconnect reason that indicates that the client connection was closed because the bound user's entry is no longer accessible.

    • ADMIN_LIMIT_EXCEEDED

      public static final DisconnectReason ADMIN_LIMIT_EXCEEDED
      The disconnect reason that indicates that the client connection was closed because an administrative limit was exceeded.

    • IDLE_TIME_LIMIT_EXCEEDED

      public static final DisconnectReason IDLE_TIME_LIMIT_EXCEEDED
      The disconnect reason that indicates that the client connection was closed because the idle time limit was exceeded.

    • IO_TIMEOUT

      public static final DisconnectReason IO_TIMEOUT
      The disconnect reason that indicates that the client connection was closed because of an I/O timeout.

    • SERVER_ERROR

      public static final DisconnectReason SERVER_ERROR
      The disconnect reason that indicates that the client connection was closed because of an internal error within the server.

    • CLOSED_BY_PLUGIN

      public static final DisconnectReason CLOSED_BY_PLUGIN
      The disconnect reason that indicates that the client connection was closed by a plugin.

    • OTHER

      public static final DisconnectReason OTHER
      The disconnect reason that indicates that the client connection was closed for some other reason.

    • OPERATIONS_ERROR

      public static final DisconnectReason OPERATIONS_ERROR
      The disconnect reason that indicates that the client connection was closed because an operation is not properly sequenced with relation to other operations (of same or different type).

    • SERVER_IN_LOCKDOWN_MODE

      public static final DisconnectReason SERVER_IN_LOCKDOWN_MODE
      The disconnect reason that indicates that the server is in lockdown mode.

  • Method Details

    • values

      public static DisconnectReason[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static DisconnectReason valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getClosureMessage

      public LocalizableMessage getClosureMessage()
      Returns the human-readable disconnect reason.
      Returns:
      The human-readable disconnect reason.

    • getResultCode

      public ResultCode getResultCode()
      Returns the LDAP result code associated with this disconnect reason.
      Returns:
      The LDAP result code associated with this disconnect reason.

    • toString

      public String toString()
      Returns a string representation of this disconnect reason.
      Overrides:
      toString in class Enum<DisconnectReason>
      Returns:
      A string representation of this disconnect reason.