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

Class BindRequestAccessLogMessage

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.logs.LogMessage
com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessage
com.unboundid.ldap.sdk.unboundidds.logs.OperationAccessLogMessage
com.unboundid.ldap.sdk.unboundidds.logs.OperationRequestAccessLogMessage
com.unboundid.ldap.sdk.unboundidds.logs.BindRequestAccessLogMessage
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
BindForwardAccessLogMessage, BindForwardFailedAccessLogMessage, BindResultAccessLogMessage
@NotExtensible @NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public class BindRequestAccessLogMessage extends OperationRequestAccessLogMessage
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a bind request received from a client.
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.
See Also:

  • Constructor Details

    • BindRequestAccessLogMessage

      public BindRequestAccessLogMessage(@NotNull String s) throws LogException
      Creates a new bind request access log message from the provided message string.
      Parameters:
      s - The string to be parsed as an bind request access log message.
      Throws:
      LogException - If the provided string cannot be parsed as a valid log message.

    • BindRequestAccessLogMessage

      public BindRequestAccessLogMessage(@NotNull LogMessage m)
      Creates a new bind request access log message from the provided message string.
      Parameters:
      m - The log message to be parsed as a bind request access log message.

  • Method Details

    • getAuthenticationType

      @Nullable public final BindRequestAuthenticationType getAuthenticationType()
      Retrieves the type of authentication requested by the client.
      Returns:
      The type of authentication requested by the client, or null if it is not included in the log message.

    • getDN

      @Nullable public final String getDN()
      Retrieves the DN of the user attempting to bind. This value may not be useful for authentication types other than "SIMPLE".
      Returns:
      The DN of the user attempting to bind, or null if it is not included in the log message.

    • getProtocolVersion

      @Nullable public final String getProtocolVersion()
      Retrieves the protocol version for the bind request.
      Returns:
      The protocol version for the bind request, or null if it is not included in the log message.

    • getSASLMechanismName

      @Nullable public final String getSASLMechanismName()
      Retrieves the name of the requested SASL mechanism. This should only be included for SASL bind attempts.
      Returns:
      The name of the requested SASL mechanism, or null if it is not included in the log message.

    • getOperationType

      @NotNull public final AccessLogOperationType getOperationType()
      Retrieves the operation type for the associated operation.
      Specified by:
      getOperationType in class OperationAccessLogMessage
      Returns:
      The operation type for this access log message.