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

Class TextFormattedBindRequestAccessLogMessage

java.lang.Object

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

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

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

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

All Implemented Interfaces:

AccessLogMessage, BindRequestAccessLogMessage, LogMessage, OperationRequestAccessLogMessage, java.io.Serializable

Direct Known Subclasses:

TextFormattedBindForwardAccessLogMessage, TextFormattedBindResultAccessLogMessage

@NotExtensible
 @NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public class TextFormattedBindRequestAccessLogMessage
extends TextFormattedRequestAccessLogMessage
implements BindRequestAccessLogMessage

This class provides a data structure that holds information about a text-formatted 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.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedLogMessage

NO_FIELD_NAME

Constructor Summary

Constructors

Constructor and Description
TextFormattedBindRequestAccessLogMessage(java.lang.String logMessageString) Creates a new text-formatted bind request access log message from the provided message string.

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.
AccessLogOperationType	getOperationType() Retrieves the operation type for the associated operation.
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 class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedRequestAccessLogMessage

getAdministrativeOperationMessage, getIntermediateClientRequestControl, getMessageID, getMessageType, getOperationID, getOperationPurposeRequestControl, getOrigin, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, getTriggeredByConnectionID, getTriggeredByOperationID, getUsingAdminSessionWorkerThread

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedAccessLogMessage

getConnectionID, getInstanceName, getProductName, getStartupID, getThreadID

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedLogMessage

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getAdministrativeOperationMessage, getMessageID, getOperationID, 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

Constructor Detail

TextFormattedBindRequestAccessLogMessage

public TextFormattedBindRequestAccessLogMessage(@NotNull
                                                java.lang.String logMessageString)
                                         throws LogException

Creates a new text-formatted bind request access log message from the provided message string.

Parameters:

logMessageString - The string representation of this log message. It must not be null.

Throws:

LogException - If the provided string cannot be parsed as a valid log message.

Method Detail

getOperationType

@NotNull
public final AccessLogOperationType getOperationType()

Retrieves the operation type for the associated operation.

Specified by:

getOperationType in interface OperationRequestAccessLogMessage

Returns:

The operation type for this access log message.

getAuthenticationType

@Nullable
public final BindRequestAuthenticationType getAuthenticationType()

Retrieves the type of authentication requested by the client.

Specified by:

getAuthenticationType in interface BindRequestAccessLogMessage

Returns:

The type of authentication requested by the client, or null if it is not included in the log message.

getDN

@Nullable
public final 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".

Specified by:

getDN in interface BindRequestAccessLogMessage

Returns:

The DN of the user attempting to bind, or null if it is not included in the log message.

getProtocolVersion

@Nullable
public final java.lang.String getProtocolVersion()

Retrieves the protocol version for the bind request.

Specified by:

getProtocolVersion in interface BindRequestAccessLogMessage

Returns:

The protocol version for the bind request, or null if it is not included in the log message.

getSASLMechanismName

@Nullable
public final java.lang.String getSASLMechanismName()

Retrieves the name of the requested SASL mechanism. This should only be included for SASL bind attempts.

Specified by:

getSASLMechanismName in interface BindRequestAccessLogMessage

Returns:

The name of the requested SASL mechanism, or null if it is not included in the log message.