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

Class TextFormattedBindResultAccessLogMessage

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

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

All Implemented Interfaces:

AccessLogMessage, BindForwardAccessLogMessage, BindRequestAccessLogMessage, BindResultAccessLogMessage, LogMessage, OperationForwardAccessLogMessage, OperationRequestAccessLogMessage, OperationResultAccessLogMessage, java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class TextFormattedBindResultAccessLogMessage
extends TextFormattedBindRequestAccessLogMessage
implements BindResultAccessLogMessage

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

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	Description
TextFormattedBindResultAccessLogMessage(java.lang.String logMessageString)	Creates a new text-formatted bind result access log message from the provided message string.

Method Summary

Modifier and Type	Method	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	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.String	getDiagnosticMessage()	Retrieves the diagnostic message for the operation.
java.lang.String	getIntermediateClientResponseControl()	Retrieves a string representation of an intermediate client response control included in the log message.
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.Set<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.Set<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.util.List<java.lang.String>	getReferralURLs()	Retrieves the list of referral URLs for the operation.
java.util.Set<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.Set<java.lang.String>	getUsedPrivileges()	Retrieves the names of any privileges used during the course of processing the operation.
java.lang.Double	getWorkQueueWaitTimeMillis()	Retrieves the length of time in milliseconds the operation was required to wait on the work queue.

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

getAuthenticationType, getDN, getOperationType, getProtocolVersion, getSASLMechanismName

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

getAdministrativeOperationMessage, getIntermediateClientRequestControl, getMessageID, 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.AccessLogMessage

getConnectionID, getInstanceName, 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.OperationRequestAccessLogMessage

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

Constructor Detail

TextFormattedBindResultAccessLogMessage

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

Creates a new text-formatted bind result 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

getMessageType

@NotNull
public AccessLogMessageType getMessageType()

Retrieves the message type for this access log message.

Specified by:

getMessageType in interface AccessLogMessage

Overrides:

getMessageType in class TextFormattedRequestAccessLogMessage

Returns:

The message type for this access log message.

getResultCode

@Nullable
public ResultCode getResultCode()

Retrieves the result code for the operation.

Specified by:

getResultCode in interface OperationResultAccessLogMessage

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 OperationResultAccessLogMessage

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 OperationResultAccessLogMessage

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 OperationResultAccessLogMessage

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 OperationResultAccessLogMessage

Returns:

The list of referral URLs for the operation, or an empty list 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 OperationResultAccessLogMessage

Returns:

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

getWorkQueueWaitTimeMillis

@Nullable
public java.lang.Double getWorkQueueWaitTimeMillis()

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

Specified by:

getWorkQueueWaitTimeMillis in interface OperationResultAccessLogMessage

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.Set<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.

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.

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.

Specified by:

getUncachedDataAccessed in interface OperationResultAccessLogMessage

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).

getUsedPrivileges

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

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

Specified by:

getUsedPrivileges in interface OperationResultAccessLogMessage

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.Set<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.

Specified by:

getPreAuthorizationUsedPrivileges in interface OperationResultAccessLogMessage

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.Set<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.

Specified by:

getMissingPrivileges in interface OperationResultAccessLogMessage

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.

getIntermediateClientResponseControl

@Nullable
public java.lang.String getIntermediateClientResponseControl()

Retrieves a string representation of an intermediate client response control included in the log message.

Returns:

A string representation of an intermediate client response control included in the log message, or null if there is none.

getTargetHost

@Nullable
public java.lang.String getTargetHost()

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

Specified by:

getTargetHost in interface OperationForwardAccessLogMessage

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.

Specified by:

getTargetPort in interface OperationForwardAccessLogMessage

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.

Specified by:

getTargetProtocol in interface OperationForwardAccessLogMessage

Returns:

The protocol used to forward the request to the backend server, 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.

Specified by:

getAuthenticationDN in interface BindResultAccessLogMessage

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.

Specified by:

getAuthorizationDN in interface BindResultAccessLogMessage

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.

Specified by:

getAuthenticationFailureID in interface BindResultAccessLogMessage

Returns:

The numeric identifier for the authentication failure reason, or null if it is not included in the log message.

getAuthenticationFailureName

@Nullable
public java.lang.String getAuthenticationFailureName()

Retrieves the name for the authentication failure reason.

Specified by:

getAuthenticationFailureName in interface BindResultAccessLogMessage

Returns:

The name for the authentication failure reason, or null if it is not included in the log message.

getAuthenticationFailureMessage

@Nullable
public java.lang.String getAuthenticationFailureMessage()

Retrieves a message with information about the reason that the authentication attempt failed.

Specified by:

getAuthenticationFailureMessage in interface BindResultAccessLogMessage

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.

Specified by:

getRetiredPasswordUsed in interface BindResultAccessLogMessage

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).

getClientConnectionPolicy

@Nullable
public java.lang.String getClientConnectionPolicy()

Retrieves the name of the client connection policy that was selected for the client connection.

Specified by:

getClientConnectionPolicy in interface BindResultAccessLogMessage

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.