Interface BindResultAccessLogMessage
-
- All Superinterfaces:
AccessLogMessage
,BindForwardAccessLogMessage
,BindRequestAccessLogMessage
,LogMessage
,OperationForwardAccessLogMessage
,OperationRequestAccessLogMessage
,OperationResultAccessLogMessage
,java.io.Serializable
- All Known Implementing Classes:
JSONBindResultAccessLogMessage
,TextFormattedBindResultAccessLogMessage
@NotExtensible @ThreadSafety(level=INTERFACE_THREADSAFE) public interface BindResultAccessLogMessage extends OperationResultAccessLogMessage, BindForwardAccessLogMessage
This class provides a data structure that holds information about a bind operation result 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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getAuthenticationDN()
Retrieves the DN of the user authenticated by the bind operation.java.lang.Long
getAuthenticationFailureID()
Retrieves the numeric identifier for the authentication failure reason.java.lang.String
getAuthenticationFailureMessage()
Retrieves a message with information about the reason that the authentication attempt failed.java.lang.String
getAuthenticationFailureName()
Retrieves the name for the authentication failure reason.java.lang.String
getAuthorizationDN()
Retrieves the DN of the alternate authorization identity for the bind operation.java.lang.String
getClientConnectionPolicy()
Retrieves the name of the client connection policy that was selected for the client connection.java.lang.Boolean
getRetiredPasswordUsed()
Indicates whether a retired password was used in the course of processing the bind.-
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.BindRequestAccessLogMessage
getAuthenticationType, getDN, getProtocolVersion, getSASLMechanismName
-
Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.LogMessage
getBoolean, getDouble, getFields, getGeneralizedTime, getInteger, getLong, getRFC3339Timestamp, getString, getTimestamp, toString
-
Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.OperationForwardAccessLogMessage
getTargetHost, getTargetPort, getTargetProtocol
-
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.OperationResultAccessLogMessage
getAdditionalInformation, getDiagnosticMessage, getIntermediateResponsesReturned, getMatchedDN, getMissingPrivileges, getPreAuthorizationUsedPrivileges, getProcessingTimeMillis, getReferralURLs, getResponseControlOIDs, getResultCode, getServersAccessed, getUncachedDataAccessed, getUsedPrivileges, getWorkQueueWaitTimeMillis
-
-
-
-
Method Detail
-
getAuthenticationDN
@Nullable java.lang.String getAuthenticationDN()
Retrieves the DN of the user authenticated by the bind operation.- Returns:
- The DN of the user authenticated by the bind operation, or
null
if it is not included in the log message.
-
getAuthorizationDN
@Nullable java.lang.String getAuthorizationDN()
Retrieves the DN of the alternate authorization identity for the bind operation.- Returns:
- The DN of the alternate authorization identity for the bind
operation, or
null
if it is not included in the log message.
-
getAuthenticationFailureID
@Nullable java.lang.Long getAuthenticationFailureID()
Retrieves the numeric identifier for the authentication failure reason.- Returns:
- The numeric identifier for the authentication failure reason, or
null
if it is not included in the log message.
-
getAuthenticationFailureName
@Nullable java.lang.String getAuthenticationFailureName()
Retrieves the name for the authentication failure reason.- Returns:
- The name for the authentication failure reason, or
null
if it is not included in the log message.
-
getAuthenticationFailureMessage
@Nullable java.lang.String getAuthenticationFailureMessage()
Retrieves a message with information about the reason that the authentication attempt failed.- Returns:
- A message with information about the reason that the
authentication attempt failed, or
null
if it is not included in the log message.
-
getRetiredPasswordUsed
@Nullable java.lang.Boolean getRetiredPasswordUsed()
Indicates whether a retired password was used in the course of processing the bind.- Returns:
true
if a retired password was used in the course of processing the bind,false
if a retired password was not used in the course of processing the bind, ornull
if this was not included in the log message (and a retired password was likely not used in the course of processing the operation).
-
getClientConnectionPolicy
@Nullable java.lang.String getClientConnectionPolicy()
Retrieves the name of the client connection policy that was selected for the client connection.- Returns:
- The name of the client connection policy that was selected for the
client connection, or
null
if it is not included in the log message.
-
-