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

Interface AccessLogMessage

All Superinterfaces:

LogMessage, java.io.Serializable

All Known Subinterfaces:

AbandonForwardAccessLogMessage, AbandonForwardFailedAccessLogMessage, AbandonRequestAccessLogMessage, AbandonResultAccessLogMessage, AddAssuranceCompletedAccessLogMessage, AddForwardAccessLogMessage, AddForwardFailedAccessLogMessage, AddRequestAccessLogMessage, AddResultAccessLogMessage, AssuranceCompletedAccessLogMessage, BindForwardAccessLogMessage, BindForwardFailedAccessLogMessage, BindRequestAccessLogMessage, BindResultAccessLogMessage, ClientCertificateAccessLogMessage, CompareForwardAccessLogMessage, CompareForwardFailedAccessLogMessage, CompareRequestAccessLogMessage, CompareResultAccessLogMessage, ConnectAccessLogMessage, DeleteAssuranceCompletedAccessLogMessage, DeleteForwardAccessLogMessage, DeleteForwardFailedAccessLogMessage, DeleteRequestAccessLogMessage, DeleteResultAccessLogMessage, DisconnectAccessLogMessage, EntryRebalancingRequestAccessLogMessage, EntryRebalancingResultAccessLogMessage, ExtendedForwardAccessLogMessage, ExtendedForwardFailedAccessLogMessage, ExtendedRequestAccessLogMessage, ExtendedResultAccessLogMessage, IntermediateResponseAccessLogMessage, ModifyAssuranceCompletedAccessLogMessage, ModifyDNAssuranceCompletedAccessLogMessage, ModifyDNForwardAccessLogMessage, ModifyDNForwardFailedAccessLogMessage, ModifyDNRequestAccessLogMessage, ModifyDNResultAccessLogMessage, ModifyForwardAccessLogMessage, ModifyForwardFailedAccessLogMessage, ModifyRequestAccessLogMessage, ModifyResultAccessLogMessage, OperationForwardAccessLogMessage, OperationForwardFailedAccessLogMessage, OperationRequestAccessLogMessage, OperationResultAccessLogMessage, SearchEntryAccessLogMessage, SearchForwardAccessLogMessage, SearchForwardFailedAccessLogMessage, SearchReferenceAccessLogMessage, SearchRequestAccessLogMessage, SearchResultAccessLogMessage, SecurityNegotiationAccessLogMessage, UnbindRequestAccessLogMessage

All Known Implementing Classes:

JSONAbandonForwardAccessLogMessage, JSONAbandonForwardFailedAccessLogMessage, JSONAbandonRequestAccessLogMessage, JSONAbandonResultAccessLogMessage, JSONAccessLogMessage, JSONAddAssuranceCompletedAccessLogMessage, JSONAddForwardAccessLogMessage, JSONAddForwardFailedAccessLogMessage, JSONAddRequestAccessLogMessage, JSONAddResultAccessLogMessage, JSONBindForwardAccessLogMessage, JSONBindForwardFailedAccessLogMessage, JSONBindRequestAccessLogMessage, JSONBindResultAccessLogMessage, JSONClientCertificateAccessLogMessage, JSONCompareForwardAccessLogMessage, JSONCompareForwardFailedAccessLogMessage, JSONCompareRequestAccessLogMessage, JSONCompareResultAccessLogMessage, JSONConnectAccessLogMessage, JSONDeleteAssuranceCompletedAccessLogMessage, JSONDeleteForwardAccessLogMessage, JSONDeleteForwardFailedAccessLogMessage, JSONDeleteRequestAccessLogMessage, JSONDeleteResultAccessLogMessage, JSONDisconnectAccessLogMessage, JSONEntryRebalancingRequestAccessLogMessage, JSONEntryRebalancingResultAccessLogMessage, JSONExtendedForwardAccessLogMessage, JSONExtendedForwardFailedAccessLogMessage, JSONExtendedRequestAccessLogMessage, JSONExtendedResultAccessLogMessage, JSONIntermediateResponseAccessLogMessage, JSONModifyAssuranceCompletedAccessLogMessage, JSONModifyDNAssuranceCompletedAccessLogMessage, JSONModifyDNForwardAccessLogMessage, JSONModifyDNForwardFailedAccessLogMessage, JSONModifyDNRequestAccessLogMessage, JSONModifyDNResultAccessLogMessage, JSONModifyForwardAccessLogMessage, JSONModifyForwardFailedAccessLogMessage, JSONModifyRequestAccessLogMessage, JSONModifyResultAccessLogMessage, JSONRequestAccessLogMessage, JSONSearchEntryAccessLogMessage, JSONSearchForwardAccessLogMessage, JSONSearchForwardFailedAccessLogMessage, JSONSearchReferenceAccessLogMessage, JSONSearchRequestAccessLogMessage, JSONSearchResultAccessLogMessage, JSONSecurityNegotiationAccessLogMessage, JSONUnbindRequestAccessLogMessage, TextFormattedAbandonForwardAccessLogMessage, TextFormattedAbandonForwardFailedAccessLogMessage, TextFormattedAbandonRequestAccessLogMessage, TextFormattedAbandonResultAccessLogMessage, TextFormattedAccessLogMessage, TextFormattedAddAssuranceCompletedAccessLogMessage, TextFormattedAddForwardAccessLogMessage, TextFormattedAddForwardFailedAccessLogMessage, TextFormattedAddRequestAccessLogMessage, TextFormattedAddResultAccessLogMessage, TextFormattedBindForwardAccessLogMessage, TextFormattedBindForwardFailedAccessLogMessage, TextFormattedBindRequestAccessLogMessage, TextFormattedBindResultAccessLogMessage, TextFormattedClientCertificateAccessLogMessage, TextFormattedCompareForwardAccessLogMessage, TextFormattedCompareForwardFailedAccessLogMessage, TextFormattedCompareRequestAccessLogMessage, TextFormattedCompareResultAccessLogMessage, TextFormattedConnectAccessLogMessage, TextFormattedDeleteAssuranceCompletedAccessLogMessage, TextFormattedDeleteForwardAccessLogMessage, TextFormattedDeleteForwardFailedAccessLogMessage, TextFormattedDeleteRequestAccessLogMessage, TextFormattedDeleteResultAccessLogMessage, TextFormattedDisconnectAccessLogMessage, TextFormattedEntryRebalancingRequestAccessLogMessage, TextFormattedEntryRebalancingResultAccessLogMessage, TextFormattedExtendedForwardAccessLogMessage, TextFormattedExtendedForwardFailedAccessLogMessage, TextFormattedExtendedRequestAccessLogMessage, TextFormattedExtendedResultAccessLogMessage, TextFormattedIntermediateResponseAccessLogMessage, TextFormattedModifyAssuranceCompletedAccessLogMessage, TextFormattedModifyDNAssuranceCompletedAccessLogMessage, TextFormattedModifyDNForwardAccessLogMessage, TextFormattedModifyDNForwardFailedAccessLogMessage, TextFormattedModifyDNRequestAccessLogMessage, TextFormattedModifyDNResultAccessLogMessage, TextFormattedModifyForwardAccessLogMessage, TextFormattedModifyForwardFailedAccessLogMessage, TextFormattedModifyRequestAccessLogMessage, TextFormattedModifyResultAccessLogMessage, TextFormattedRequestAccessLogMessage, TextFormattedSearchEntryAccessLogMessage, TextFormattedSearchForwardAccessLogMessage, TextFormattedSearchForwardFailedAccessLogMessage, TextFormattedSearchReferenceAccessLogMessage, TextFormattedSearchRequestAccessLogMessage, TextFormattedSearchResultAccessLogMessage, TextFormattedSecurityNegotiationAccessLogMessage, TextFormattedUnbindRequestAccessLogMessage

@NotExtensible
@ThreadSafety(level=INTERFACE_THREADSAFE)
public interface AccessLogMessage
extends LogMessage

This class provides a data structure that holds information about an 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	Description
java.lang.Long	getConnectionID()	Retrieves the connection ID for the connection with which this access log message is associated.
java.lang.String	getInstanceName()	Retrieves the Directory Server instance name for this access log message.
AccessLogMessageType	getMessageType()	Retrieves the message type for this access log message.
java.lang.String	getProductName()	Retrieves the server product name for this access log message.
java.lang.String	getStartupID()	Retrieves the Directory Server startup ID for this access log message.
java.lang.Long	getThreadID()	Retrieves the thread ID for the server thread that generated this access log message.

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

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

Method Detail

getProductName

@Nullable
java.lang.String getProductName()

Retrieves the server product name for this access log message.

Returns:

The server product name for this access log message, or null if it is not included in the log message.

getInstanceName

@Nullable
java.lang.String getInstanceName()

Retrieves the Directory Server instance name for this access log message.

Returns:

The Directory Server instance name for this access log message, or null if it is not included in the log message.

getStartupID

@Nullable
java.lang.String getStartupID()

Retrieves the Directory Server startup ID for this access log message.

Returns:

The Directory Server startup ID for this access log message, or null if it is not included in the log message.

getThreadID

@Nullable
java.lang.Long getThreadID()

Retrieves the thread ID for the server thread that generated this access log message.

Returns:

The Directory Server thread ID for this access log message, or null if it is not included in the log message.

getConnectionID

@Nullable
java.lang.Long getConnectionID()

Retrieves the connection ID for the connection with which this access log message is associated.

Returns:

The connection ID for the connection with which this access log message is associated, or null if it is not included in the log message.

getMessageType

@NotNull
AccessLogMessageType getMessageType()

Retrieves the message type for this access log message.

Returns:

The message type for this access log message.