Package com.unboundid.ldap.sdk.unboundidds.logs

Enum AccessLogMessageType

java.lang.Object
java.lang.Enum<AccessLogMessageType>
com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessageType
All Implemented Interfaces:
Serializable, Comparable<AccessLogMessageType>, java.lang.constant.Constable
@ThreadSafety(level=COMPLETELY_THREADSAFE) public enum AccessLogMessageType extends Enum<AccessLogMessageType>
This enum defines the set of access log message types.
NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

  • 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
    ASSURANCE_COMPLETE
    The message type that will be used for messages about the result of replication assurance processing.
    CLIENT_CERTIFICATE
    The message type that will be used for messages about connections established to the Directory Server.
    CONNECT
    The message type that will be used for messages about connections established to the Directory Server.
    DISCONNECT
    The message type that will be used for messages about connections disconnected from the Directory Server.
    ENTRY
    The message type that will be used for messages about search result entries returned by the Directory Server.
    ENTRY_REBALANCING_REQUEST
    The message type that will be used for messages that provide information about the beginning of an entry-rebalancing operation.
    ENTRY_REBALANCING_RESULT
    The message type that will be used for messages that provide information about the result of an entry-rebalancing operation.
    FORWARD
    The message type that will be used for messages about operations forwarded to another server.
    FORWARD_FAILED
    The message type that will be used for messages about failed attempts to forward a request to another server.
    INTERMEDIATE_RESPONSE
    The message type that will be used for intermediate response messages.
    REFERENCE
    The message type that will be used for messages about search result references returned by the Directory Server.
    REQUEST
    The message type that will be used for messages about operation requests received from the Directory Server.
    RESULT
    The message type that will be used for messages about operation results, which may include responses sent to clients or results for operations with no response.
    SECURITY_NEGOTIATION
    The message type that will be used for messages about the processing performed to negotiate a secure form of communication between the client and the server.

  • Method Summary

    Modifier and Type
    Method
    Description
    static AccessLogMessageType
    forName(String logIdentifier)
    Retrieves the access log message type with the provided identifier.
    String
    getLogIdentifier()
    Retrieves the string that will be used to identify this message type in log files.
    static AccessLogMessageType
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static AccessLogMessageType[]
    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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • ASSURANCE_COMPLETE

      public static final AccessLogMessageType ASSURANCE_COMPLETE
      The message type that will be used for messages about the result of replication assurance processing.

    • CLIENT_CERTIFICATE

      public static final AccessLogMessageType CLIENT_CERTIFICATE
      The message type that will be used for messages about connections established to the Directory Server.

    • CONNECT

      public static final AccessLogMessageType CONNECT
      The message type that will be used for messages about connections established to the Directory Server.

    • DISCONNECT

      public static final AccessLogMessageType DISCONNECT
      The message type that will be used for messages about connections disconnected from the Directory Server.

    • ENTRY

      public static final AccessLogMessageType ENTRY
      The message type that will be used for messages about search result entries returned by the Directory Server.

    • ENTRY_REBALANCING_REQUEST

      public static final AccessLogMessageType ENTRY_REBALANCING_REQUEST
      The message type that will be used for messages that provide information about the beginning of an entry-rebalancing operation.

    • ENTRY_REBALANCING_RESULT

      public static final AccessLogMessageType ENTRY_REBALANCING_RESULT
      The message type that will be used for messages that provide information about the result of an entry-rebalancing operation.

    • FORWARD

      public static final AccessLogMessageType FORWARD
      The message type that will be used for messages about operations forwarded to another server.

    • FORWARD_FAILED

      public static final AccessLogMessageType FORWARD_FAILED
      The message type that will be used for messages about failed attempts to forward a request to another server.

    • INTERMEDIATE_RESPONSE

      public static final AccessLogMessageType INTERMEDIATE_RESPONSE
      The message type that will be used for intermediate response messages.

    • REFERENCE

      public static final AccessLogMessageType REFERENCE
      The message type that will be used for messages about search result references returned by the Directory Server.

    • REQUEST

      public static final AccessLogMessageType REQUEST
      The message type that will be used for messages about operation requests received from the Directory Server.

    • RESULT

      public static final AccessLogMessageType RESULT
      The message type that will be used for messages about operation results, which may include responses sent to clients or results for operations with no response.

    • SECURITY_NEGOTIATION

      public static final AccessLogMessageType SECURITY_NEGOTIATION
      The message type that will be used for messages about the processing performed to negotiate a secure form of communication between the client and the server.

  • Method Details

    • values

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

    • valueOf

      public static AccessLogMessageType valueOf(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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getLogIdentifier

      @NotNull public String getLogIdentifier()
      Retrieves the string that will be used to identify this message type in log files.
      Returns:
      The string that will be used to identify this message type in log files.

    • forName

      @Nullable public static AccessLogMessageType forName(@NotNull String logIdentifier)
      Retrieves the access log message type with the provided identifier.
      Parameters:
      logIdentifier - The identifier string for which to retrieve the corresponding access log message type.
      Returns:
      The appropriate message type, or null if there is no message type associated with the provided identifier.