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

Interface OperationForwardFailedAccessLogMessage

All Superinterfaces:

AccessLogMessage, LogMessage, OperationForwardAccessLogMessage, OperationRequestAccessLogMessage, java.io.Serializable

All Known Subinterfaces:

AbandonForwardFailedAccessLogMessage, AddForwardFailedAccessLogMessage, BindForwardFailedAccessLogMessage, CompareForwardFailedAccessLogMessage, DeleteForwardFailedAccessLogMessage, ExtendedForwardFailedAccessLogMessage, ModifyDNForwardFailedAccessLogMessage, ModifyForwardFailedAccessLogMessage, SearchForwardFailedAccessLogMessage

All Known Implementing Classes:

JSONAbandonForwardFailedAccessLogMessage, JSONAddForwardFailedAccessLogMessage, JSONBindForwardFailedAccessLogMessage, JSONCompareForwardFailedAccessLogMessage, JSONDeleteForwardFailedAccessLogMessage, JSONExtendedForwardFailedAccessLogMessage, JSONModifyDNForwardFailedAccessLogMessage, JSONModifyForwardFailedAccessLogMessage, JSONSearchForwardFailedAccessLogMessage, TextFormattedAbandonForwardFailedAccessLogMessage, TextFormattedAddForwardFailedAccessLogMessage, TextFormattedBindForwardFailedAccessLogMessage, TextFormattedCompareForwardFailedAccessLogMessage, TextFormattedDeleteForwardFailedAccessLogMessage, TextFormattedExtendedForwardFailedAccessLogMessage, TextFormattedModifyDNForwardFailedAccessLogMessage, TextFormattedModifyForwardFailedAccessLogMessage, TextFormattedSearchForwardFailedAccessLogMessage

@NotExtensible
 @ThreadSafety(level=INTERFACE_THREADSAFE)
public interface OperationForwardFailedAccessLogMessage
extends OperationForwardAccessLogMessage

This class provides a data structure that holds information about a forward failed 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

Modifier and Type	Method and Description
java.lang.String	getDiagnosticMessage() Retrieves the diagnostic message received for the forwarded operation.
ResultCode	getResultCode() Retrieves the result code received for the forwarded operation.

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

getConnectionID, getInstanceName, getMessageType, getProductName, getStartupID, getThreadID

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

getBoolean, getDouble, getFields, getGeneralizedTime, getInteger, getLong, getRFC3339Timestamp, getString, getTimestamp, toString

Method Detail

getResultCode

@Nullable
ResultCode getResultCode()

Retrieves the result code received for the forwarded operation.

Returns:

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

getDiagnosticMessage

@Nullable
java.lang.String getDiagnosticMessage()

Retrieves the diagnostic message received for the forwarded operation.

Returns:

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