com.unboundid.ldap.sdk.unboundidds.logs.v2

Interface BindRequestAccessLogMessage

All Superinterfaces:

AccessLogMessage, LogMessage, OperationRequestAccessLogMessage, java.io.Serializable

All Known Subinterfaces:

BindForwardAccessLogMessage, BindForwardFailedAccessLogMessage, BindResultAccessLogMessage

All Known Implementing Classes:

JSONBindForwardAccessLogMessage, JSONBindForwardFailedAccessLogMessage, JSONBindRequestAccessLogMessage, JSONBindResultAccessLogMessage, TextFormattedBindForwardAccessLogMessage, TextFormattedBindForwardFailedAccessLogMessage, TextFormattedBindRequestAccessLogMessage, TextFormattedBindResultAccessLogMessage

@NotExtensible
 @ThreadSafety(level=INTERFACE_THREADSAFE)
public interface BindRequestAccessLogMessage
extends OperationRequestAccessLogMessage

This class provides a data structure that holds information about a bind request access log message.

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.

Method Summary

Modifier and Type	Method and Description
BindRequestAuthenticationType	getAuthenticationType() Retrieves the type of authentication requested by the client.
java.lang.String	getDN() Retrieves the DN of the user attempting to bind.
java.lang.String	getProtocolVersion() Retrieves the protocol version for the bind request.
java.lang.String	getSASLMechanismName() Retrieves the name of the requested SASL mechanism.

Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.OperationRequestAccessLogMessage

getAdministrativeOperationMessage, getMessageID, getOperationID, getOperationType, getOrigin, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, getTriggeredByConnectionID, getTriggeredByOperationID, getUsingAdminSessionWorkerThread

Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.AccessLogMessage

getConnectionID, getInstanceName, getMessageType, getProductName, getStartupID, getThreadID

Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.LogMessage

getBoolean, getDouble, getFields, getGeneralizedTime, getInteger, getLong, getRFC3339Timestamp, getString, getTimestamp, toString

Method Detail

getAuthenticationType

@Nullable
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
java.lang.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
java.lang.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
java.lang.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.