Package com.unboundid.directory.sdk.common.types

Enum DisconnectReason

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<DisconnectReason>
    public enum DisconnectReason
extends java.lang.Enum<DisconnectReason>
    This enumeration defines the set of possible reasons for the closure of a connection between a client and the server.

    • 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.
      IO_ERROR
      The disconnect reason that indicates that the client connection was closed because of an I/O error.
      IO_TIMEOUT
      The disconnect reason that indicates that the client connection was closed because of an I/O timeout.
      MAX_REQUEST_SIZE_EXCEEDED
      The disconnect reason that indicates that the client connection was closed because the maximum allowed request size was exceeded.
      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.
      SECURITY_PROBLEM
      The disconnect reason that indicates that the client connection was closed because of a security problem.
      SERVER_ERROR
      The disconnect reason that indicates that the client connection was closed because of an internal error within the server.
      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

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getClosureMessage()
      Retrieves the human-readable disconnect reason.
      java.lang.String toString()
      Retrieves a string representation of this disconnect reason.
      static DisconnectReason valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static DisconnectReason[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

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

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • 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.

      • IO_ERROR

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

      • 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.

      • SECURITY_PROBLEM

        public static final DisconnectReason SECURITY_PROBLEM
        The disconnect reason that indicates that the client connection was closed because of a security problem.

      • MAX_REQUEST_SIZE_EXCEEDED

        public static final DisconnectReason MAX_REQUEST_SIZE_EXCEEDED
        The disconnect reason that indicates that the client connection was closed because the maximum allowed request size was exceeded.

      • 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.

    • Method Detail

      • values

        public static DisconnectReason[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (DisconnectReason c : DisconnectReason.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static DisconnectReason valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getClosureMessage

        public java.lang.String getClosureMessage()
        Retrieves the human-readable disconnect reason.
        Returns:
        The human-readable disconnect reason.

      • toString

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