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

Interface OperationForwardAccessLogMessage

All Superinterfaces:

AccessLogMessage, LogMessage, OperationRequestAccessLogMessage, java.io.Serializable

All Known Subinterfaces:

AbandonForwardAccessLogMessage, AbandonForwardFailedAccessLogMessage, AbandonResultAccessLogMessage, AddAssuranceCompletedAccessLogMessage, AddForwardAccessLogMessage, AddForwardFailedAccessLogMessage, AddResultAccessLogMessage, AssuranceCompletedAccessLogMessage, BindForwardAccessLogMessage, BindForwardFailedAccessLogMessage, BindResultAccessLogMessage, CompareForwardAccessLogMessage, CompareForwardFailedAccessLogMessage, CompareResultAccessLogMessage, DeleteAssuranceCompletedAccessLogMessage, DeleteForwardAccessLogMessage, DeleteForwardFailedAccessLogMessage, DeleteResultAccessLogMessage, ExtendedForwardAccessLogMessage, ExtendedForwardFailedAccessLogMessage, ExtendedResultAccessLogMessage, ModifyAssuranceCompletedAccessLogMessage, ModifyDNAssuranceCompletedAccessLogMessage, ModifyDNForwardAccessLogMessage, ModifyDNForwardFailedAccessLogMessage, ModifyDNResultAccessLogMessage, ModifyForwardAccessLogMessage, ModifyForwardFailedAccessLogMessage, ModifyResultAccessLogMessage, OperationForwardFailedAccessLogMessage, OperationResultAccessLogMessage, SearchForwardAccessLogMessage, SearchForwardFailedAccessLogMessage, SearchResultAccessLogMessage

All Known Implementing Classes:

JSONAbandonForwardAccessLogMessage, JSONAbandonForwardFailedAccessLogMessage, JSONAbandonResultAccessLogMessage, JSONAddAssuranceCompletedAccessLogMessage, JSONAddForwardAccessLogMessage, JSONAddForwardFailedAccessLogMessage, JSONAddResultAccessLogMessage, JSONBindForwardAccessLogMessage, JSONBindForwardFailedAccessLogMessage, JSONBindResultAccessLogMessage, JSONCompareForwardAccessLogMessage, JSONCompareForwardFailedAccessLogMessage, JSONCompareResultAccessLogMessage, JSONDeleteAssuranceCompletedAccessLogMessage, JSONDeleteForwardAccessLogMessage, JSONDeleteForwardFailedAccessLogMessage, JSONDeleteResultAccessLogMessage, JSONExtendedForwardAccessLogMessage, JSONExtendedForwardFailedAccessLogMessage, JSONExtendedResultAccessLogMessage, JSONModifyAssuranceCompletedAccessLogMessage, JSONModifyDNAssuranceCompletedAccessLogMessage, JSONModifyDNForwardAccessLogMessage, JSONModifyDNForwardFailedAccessLogMessage, JSONModifyDNResultAccessLogMessage, JSONModifyForwardAccessLogMessage, JSONModifyForwardFailedAccessLogMessage, JSONModifyResultAccessLogMessage, JSONSearchForwardAccessLogMessage, JSONSearchForwardFailedAccessLogMessage, JSONSearchResultAccessLogMessage, TextFormattedAbandonForwardAccessLogMessage, TextFormattedAbandonForwardFailedAccessLogMessage, TextFormattedAbandonResultAccessLogMessage, TextFormattedAddAssuranceCompletedAccessLogMessage, TextFormattedAddForwardAccessLogMessage, TextFormattedAddForwardFailedAccessLogMessage, TextFormattedAddResultAccessLogMessage, TextFormattedBindForwardAccessLogMessage, TextFormattedBindForwardFailedAccessLogMessage, TextFormattedBindResultAccessLogMessage, TextFormattedCompareForwardAccessLogMessage, TextFormattedCompareForwardFailedAccessLogMessage, TextFormattedCompareResultAccessLogMessage, TextFormattedDeleteAssuranceCompletedAccessLogMessage, TextFormattedDeleteForwardAccessLogMessage, TextFormattedDeleteForwardFailedAccessLogMessage, TextFormattedDeleteResultAccessLogMessage, TextFormattedExtendedForwardAccessLogMessage, TextFormattedExtendedForwardFailedAccessLogMessage, TextFormattedExtendedResultAccessLogMessage, TextFormattedModifyAssuranceCompletedAccessLogMessage, TextFormattedModifyDNAssuranceCompletedAccessLogMessage, TextFormattedModifyDNForwardAccessLogMessage, TextFormattedModifyDNForwardFailedAccessLogMessage, TextFormattedModifyDNResultAccessLogMessage, TextFormattedModifyForwardAccessLogMessage, TextFormattedModifyForwardFailedAccessLogMessage, TextFormattedModifyResultAccessLogMessage, TextFormattedSearchForwardAccessLogMessage, TextFormattedSearchForwardFailedAccessLogMessage, TextFormattedSearchResultAccessLogMessage

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

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

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

getTargetHost

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