com.unboundid.ldap.sdk.unboundidds.logs

Class BindResultAccessLogMessage

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

com.unboundid.ldap.sdk.unboundidds.logs.BindResultAccessLogMessage

All Implemented Interfaces:

MinimalOperationResultAccessLogMessage, OperationResultAccessLogMessage, java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class BindResultAccessLogMessage
extends BindRequestAccessLogMessage
implements OperationResultAccessLogMessage

This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about the result of a bind operation processed by the Directory Server.

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 and Description
BindResultAccessLogMessage(LogMessage m) Creates a new bind result access log message from the provided log message.
BindResultAccessLogMessage(java.lang.String s) Creates a new bind result access log message from the provided message string.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAdditionalInformation() Retrieves a message with additional information about the result of the operation.
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	getAuthenticationFailureReason() Retrieves a message with information about the reason that the authentication attempt failed.
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.String	getDiagnosticMessage() Retrieves the diagnostic message for the operation.
java.lang.String	getIntermediateClientResult() Retrieves the content of the intermediate client result for the operation.
java.lang.Long	getIntermediateResponsesReturned() Retrieves the number of intermediate response messages returned in the course of processing the operation.
java.lang.String	getMatchedDN() Retrieves the matched DN for the operation.
AccessLogMessageType	getMessageType() Retrieves the message type for this access log message.
java.util.List<java.lang.String>	getMissingPrivileges() Retrieves the names of any privileges that would have been required for processing the operation but that the requester did not have.
java.util.List<java.lang.String>	getPreAuthorizationUsedPrivileges() Retrieves the names of any privileges used during the course of processing the operation before an alternate authorization identity was assigned.
java.lang.Double	getProcessingTimeMillis() Retrieves the length of time in milliseconds required to process the operation.
java.lang.Double	getQueueTimeMillis() Retrieves the length of time in milliseconds the operation was required to wait on the work queue.
java.util.List<java.lang.String>	getReferralURLs() Retrieves the list of referral URLs for the operation.
java.util.List<java.lang.String>	getResponseControlOIDs() Retrieves the OIDs of any response controls contained in the log message.
ResultCode	getResultCode() Retrieves the result code for the operation.
java.lang.Boolean	getRetiredPasswordUsed() Indicates whether a retired password was used in the course of processing the bind.
java.util.List<java.lang.String>	getServersAccessed() Retrieves a list of the additional servers that were accessed in the course of processing the operation.
java.lang.String	getTargetHost() Retrieves the address of the backend server to which the request has been forwarded.
java.lang.Integer	getTargetPort() Retrieves the port of the backend server to which the request has been forwarded.
java.lang.String	getTargetProtocol() Retrieves the protocol used to forward the request to the backend server.
java.lang.Boolean	getUncachedDataAccessed() Indicates whether the server accessed any uncached data in the course of processing the operation.
java.util.List<java.lang.String>	getUsedPrivileges() Retrieves the names of any privileges used during the course of processing the operation.

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.BindRequestAccessLogMessage

getAuthenticationType, getDN, getOperationType, getProtocolVersion, getSASLMechanismName

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.OperationRequestAccessLogMessage

getIntermediateClientRequest, 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

Methods inherited from class java.lang.Object

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

Constructor Detail

BindResultAccessLogMessage

public BindResultAccessLogMessage(@NotNull
                                  java.lang.String s)
                           throws LogException

Creates a new bind result access log message from the provided message string.

Parameters:

s - The string to be parsed as a bind result access log message.

Throws:

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

BindResultAccessLogMessage

public BindResultAccessLogMessage(@NotNull
                                  LogMessage m)

Creates a new bind result access log message from the provided log message.

Parameters:

m - The log message to be parsed as a bind result access log message.

Method Detail

getResultCode

@Nullable
public ResultCode getResultCode()

Retrieves the result code for the operation.

Specified by:

getResultCode in interface MinimalOperationResultAccessLogMessage

Returns:

The result code for the operation, or null if it is not included in the log message.

getDiagnosticMessage

@Nullable
public java.lang.String getDiagnosticMessage()

Retrieves the diagnostic message for the operation.

Specified by:

getDiagnosticMessage in interface MinimalOperationResultAccessLogMessage

Returns:

The diagnostic message for the operation, or null if it is not included in the log message.

getAdditionalInformation

@Nullable
public java.lang.String getAdditionalInformation()

Retrieves a message with additional information about the result of the operation.

Specified by:

getAdditionalInformation in interface MinimalOperationResultAccessLogMessage

Returns:

A message with additional information about the result of the operation, or null if it is not included in the log message.

getMatchedDN

@Nullable
public java.lang.String getMatchedDN()

Retrieves the matched DN for the operation.

Specified by:

getMatchedDN in interface MinimalOperationResultAccessLogMessage

Returns:

The matched DN for the operation, or null if it is not included in the log message.

getReferralURLs

@NotNull
public java.util.List<java.lang.String> getReferralURLs()

Retrieves the list of referral URLs for the operation.

Specified by:

getReferralURLs in interface MinimalOperationResultAccessLogMessage

Returns:

The list of referral URLs for the operation, or an empty list if it is not included in the log message.

getIntermediateResponsesReturned

@Nullable
public java.lang.Long getIntermediateResponsesReturned()

Retrieves the number of intermediate response messages returned in the course of processing the operation.

Specified by:

getIntermediateResponsesReturned in interface OperationResultAccessLogMessage

Returns:

The number of intermediate response messages returned to the client in the course of processing the operation, or null if it is not included in the log message.

getProcessingTimeMillis

@Nullable
public java.lang.Double getProcessingTimeMillis()

Retrieves the length of time in milliseconds required to process the operation.

Specified by:

getProcessingTimeMillis in interface MinimalOperationResultAccessLogMessage

Returns:

The length of time in milliseconds required to process the operation, or null if it is not included in the log message.

getQueueTimeMillis

@Nullable
public java.lang.Double getQueueTimeMillis()

Retrieves the length of time in milliseconds the operation was required to wait on the work queue.

Specified by:

getQueueTimeMillis in interface MinimalOperationResultAccessLogMessage

Returns:

The length of time in milliseconds the operation was required to wait on the work queue, or null if it is not included in the log message.

getResponseControlOIDs

@NotNull
public java.util.List<java.lang.String> getResponseControlOIDs()

Retrieves the OIDs of any response controls contained in the log message.

Specified by:

getResponseControlOIDs in interface OperationResultAccessLogMessage

Returns:

The OIDs of any response controls contained in the log message, or an empty list if it is not included in the log message.

getServersAccessed

@NotNull
public java.util.List<java.lang.String> getServersAccessed()

Retrieves a list of the additional servers that were accessed in the course of processing the operation. For example, if the access log message is from a Directory Proxy Server instance, then this may contain a list of the backend servers used to process the operation.

Specified by:

getServersAccessed in interface OperationResultAccessLogMessage

Returns:

A list of the additional servers that were accessed in the course of processing the operation, or an empty list if it is not included in the log message.

getUncachedDataAccessed

@Nullable
public java.lang.Boolean getUncachedDataAccessed()

Indicates whether the server accessed any uncached data in the course of processing the operation.

Returns:

true if the server was known to access uncached data in the course of processing the operation, false if the server was known not to access uncached data, or null if it is not included in the log message (and the server likely did not access uncached data).

getIntermediateClientResult

@Nullable
public java.lang.String getIntermediateClientResult()

Retrieves the content of the intermediate client result for the operation.

Specified by:

getIntermediateClientResult in interface OperationResultAccessLogMessage

Returns:

The content of the intermediate client result for the operation, or null if it is not included in the log message.

getAuthenticationDN

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

getAuthenticationFailureReason

@Nullable
public java.lang.String getAuthenticationFailureReason()

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
public 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, or null if this was not included in the log message (and a retired password was likely not used in the course of processing the operation).

getTargetHost

@Nullable
public java.lang.String getTargetHost()

Retrieves the address of the backend server to which the request has been forwarded.

Returns:

The address of the backend server to which the request has been forwarded, or null if it is not included in the log message.

getTargetPort

@Nullable
public java.lang.Integer getTargetPort()

Retrieves the port of the backend server to which the request has been forwarded.

Returns:

The port of the backend server to which the request has been forwarded, or null if it is not included in the log message.

getTargetProtocol

@Nullable
public java.lang.String getTargetProtocol()

Retrieves the protocol used to forward the request to the backend server.

Returns:

The protocol used to forward the request to the backend server, or null if it is not included in the log message.

getClientConnectionPolicy

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

getUsedPrivileges

@NotNull
public java.util.List<java.lang.String> getUsedPrivileges()

Retrieves the names of any privileges used during the course of processing the operation.

Returns:

The names of any privileges used during the course of processing the operation, or an empty list if no privileges were used or this is not included in the log message.

getPreAuthorizationUsedPrivileges

@NotNull
public java.util.List<java.lang.String> getPreAuthorizationUsedPrivileges()

Retrieves the names of any privileges used during the course of processing the operation before an alternate authorization identity was assigned.

Returns:

The names of any privileges used during the course of processing the operation before an alternate authorization identity was assigned, or an empty list if no privileges were used or this is not included in the log message.

getMissingPrivileges

@NotNull
public java.util.List<java.lang.String> getMissingPrivileges()

Retrieves the names of any privileges that would have been required for processing the operation but that the requester did not have.

Returns:

The names of any privileges that would have been required for processing the operation but that the requester did not have, or an empty list if there were no missing privileges or this is not included in the log message.

getMessageType

@NotNull
public AccessLogMessageType getMessageType()

Retrieves the message type for this access log message.

Overrides:

getMessageType in class OperationRequestAccessLogMessage

Returns:

The message type for this access log message.