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

Class TextFormattedAddAssuranceCompletedAccessLogMessage

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

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

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

All Implemented Interfaces:

AccessLogMessage, AddAssuranceCompletedAccessLogMessage, AddForwardAccessLogMessage, AddRequestAccessLogMessage, AddResultAccessLogMessage, AssuranceCompletedAccessLogMessage, LogMessage, OperationForwardAccessLogMessage, OperationRequestAccessLogMessage, OperationResultAccessLogMessage, java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class TextFormattedAddAssuranceCompletedAccessLogMessage
extends TextFormattedAddResultAccessLogMessage
implements AddAssuranceCompletedAccessLogMessage

This class provides a data structure that holds information about a text-formatted add assurance completed 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
TextFormattedAddAssuranceCompletedAccessLogMessage(java.lang.String logMessageString) Creates a new text-formatted add assurance completed access log message from the provided message string.

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getLocalAssuranceSatisfied() Indicates whether the local assurance requirement was satisfied.
AccessLogMessageType	getMessageType() Retrieves the message type for this access log message.
java.lang.Boolean	getRemoteAssuranceSatisfied() Indicates whether the remote assurance requirement was satisfied.
java.util.List<java.lang.String>	getServerResults() Retrieves the list of server results.

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

getAdditionalInformation, getAlternateAuthorizationDN, getAssuredReplicationLocalLevel, getAssuredReplicationRemoteLevel, getAssuredReplicationTimeoutMillis, getDiagnosticMessage, getIndexesWithKeysAccessedExceedingEntryLimit, getIndexesWithKeysAccessedNearEntryLimit, getIntermediateClientResponseControl, getIntermediateResponsesReturned, getMatchedDN, getMissingPrivileges, getPreAuthorizationUsedPrivileges, getProcessingTimeMillis, getReferralURLs, getReplicationChangeID, getResponseControlOIDs, getResponseDelayedByAssurance, getResultCode, getServersAccessed, getTargetHost, getTargetPort, getTargetProtocol, getUncachedDataAccessed, getUndeleteFromDN, getUsedPrivileges, getWorkQueueWaitTimeMillis

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

getAttributeNames, getDN, getOperationType

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

getAlternateAuthorizationDN, getAssuredReplicationLocalLevel, getAssuredReplicationRemoteLevel, getAssuredReplicationTimeoutMillis, getIndexesWithKeysAccessedExceedingEntryLimit, getIndexesWithKeysAccessedNearEntryLimit, getReplicationChangeID, getResponseDelayedByAssurance, getUndeleteFromDN

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

getAttributeNames, getDN

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

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

getTargetHost, getTargetPort, getTargetProtocol

Constructor Detail

TextFormattedAddAssuranceCompletedAccessLogMessage

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

Creates a new text-formatted add assurance completed 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 TextFormattedAddResultAccessLogMessage

Returns:

The message type for this access log message.

getLocalAssuranceSatisfied

@Nullable
public java.lang.Boolean getLocalAssuranceSatisfied()

Indicates whether the local assurance requirement was satisfied.

Specified by:

getLocalAssuranceSatisfied in interface AssuranceCompletedAccessLogMessage

Returns:

true if the local assurance requirement was satisfied, false if the local assurance requirement was not satisfied, or null if it was not included in the log message.

getRemoteAssuranceSatisfied

@Nullable
public java.lang.Boolean getRemoteAssuranceSatisfied()

Indicates whether the remote assurance requirement was satisfied.

Specified by:

getRemoteAssuranceSatisfied in interface AssuranceCompletedAccessLogMessage

Returns:

true if the remote assurance requirement was satisfied, false if the remote assurance requirement was not satisfied, or null if it was not included in the log message.

getServerResults

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

Retrieves the list of server results.

Returns:

The list of server results, or an empty list if it was not included in the log message.