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:
java.io.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:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description BindRequestAccessLogMessage(LogMessage m)
Creates a new bind request access log message from the provided message string.BindRequestAccessLogMessage(java.lang.String s)
Creates a new bind request access log message from the provided message string.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.OperationRequestAccessLogMessage
getIntermediateClientRequest, getMessageType, getOperationPurpose, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, usingAdminSessionWorkerThread
-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.OperationAccessLogMessage
getMessageID, getOperationID, getOrigin, getTriggeredByConnectionID, getTriggeredByOperationID
-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessage
getConnectionID, getInstanceName, getProductName, getStartupID, parse
-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.LogMessage
getNamedValue, getNamedValueAsBoolean, getNamedValueAsDouble, getNamedValueAsInteger, getNamedValueAsLong, getNamedValues, getTimestamp, getUnnamedValues, hasUnnamedValue, toString
-
-
-
-
Constructor Detail
-
BindRequestAccessLogMessage
public BindRequestAccessLogMessage(@NotNull java.lang.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 Detail
-
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 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 public final 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 public final 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.
-
getOperationType
@NotNull public final AccessLogOperationType getOperationType()
Retrieves the operation type for the associated operation.- Specified by:
getOperationType
in classOperationAccessLogMessage
- Returns:
- The operation type for this access log message.
-
-