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

Interface LogMessage

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

AbandonForwardAccessLogMessage, AbandonForwardFailedAccessLogMessage, AbandonRequestAccessLogMessage, AbandonResultAccessLogMessage, AccessLogMessage, 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, JSONLogMessage, 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, TextFormattedLogMessage, 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 LogMessage
extends java.io.Serializable

This class provides a data structure that holds information about a 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.Boolean	getBoolean(LogField logField)	Retrieves the value of the specified field as a Boolean object.
java.lang.Double	getDouble(LogField logField)	Retrieves the value of the specified field as a Double value.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getFields()	Retrieves a map of the fields and their corresponding values in this log message.
java.util.Date	getGeneralizedTime(LogField logField)	Retrieves the value of the specified field as a Date object decoded from the generalized time format.
java.lang.Integer	getInteger(LogField logField)	Retrieves the value of the specified field as an Integer value.
java.lang.Long	getLong(LogField logField)	Retrieves the value of the specified field as a Long value.
java.util.Date	getRFC3339Timestamp(LogField logField)	Retrieves the value of the specified field as a Date object decoded from the ISO 8601 format described in RFC 3339.
java.lang.String	getString(LogField logField)	Retrieves the value of the specified field as a string.
java.util.Date	getTimestamp()	Retrieves the timestamp for this log message.
java.lang.String	toString()	Retrieves a string representation of this log message.

Method Detail

getTimestamp

@NotNull
java.util.Date getTimestamp()

Retrieves the timestamp for this log message.

Returns:

The timestamp for this log message.

getFields

@NotNull
java.util.Map<java.lang.String,java.util.List<java.lang.String>> getFields()

Retrieves a map of the fields and their corresponding values in this log message.

Returns:

A map of the fields and their corresponding values in this log message.

getBoolean

@Nullable
java.lang.Boolean getBoolean(@NotNull
                             LogField logField)
                      throws LogException

Retrieves the value of the specified field as a Boolean object. If the field has multiple values, the first will be returned.

Parameters:

logField - The field for which to retrieve the Boolean value.

Returns:

The value of the specified field as a Boolean object, or null if the log message does not have the specified field.

Throws:

LogException - If the value of the specified field cannot be parsed as a Boolean.

getGeneralizedTime

@Nullable
java.util.Date getGeneralizedTime(@NotNull
                                  LogField logField)
                           throws LogException

Retrieves the value of the specified field as a Date object decoded from the generalized time format. If the field has multiple values, the first will be returned.

Parameters:

logField - The field for which to retrieve the timestamp value.

Returns:

The value of the specified field as a Date object, or null if the log message does not have the specified field.

Throws:

LogException - If the value of the specified field cannot be parsed as a Date in the generalized time format.

getDouble

@Nullable
java.lang.Double getDouble(@NotNull
                           LogField logField)
                    throws LogException

Retrieves the value of the specified field as a Double value. If the field has multiple values, the first will be returned.

Parameters:

logField - The field for which to retrieve the Double value.

Returns:

The value of the specified field as a Double value, or null if the log message does not have the specified field.

Throws:

LogException - If the value of the specified field cannot be parsed as a Double.

getInteger

@Nullable
java.lang.Integer getInteger(@NotNull
                             LogField logField)
                      throws LogException

Retrieves the value of the specified field as an Integer value. If the field has multiple values, the first will be returned.

Parameters:

logField - The field for which to retrieve the Integer value.

Returns:

The Integer value of the specified field, or null if the log message does not have the specified field.

Throws:

LogException - If the value of the specified field cannot be parsed as an Integer.

getLong

@Nullable
java.lang.Long getLong(@NotNull
                       LogField logField)
                throws LogException

Retrieves the value of the specified field as a Long value. If the field has multiple values, the first will be returned.

Parameters:

logField - The field for which to retrieve the Long value.

Returns:

The Long value of the specified field, or null if the log message does not have the specified field.

Throws:

LogException - If the value of the specified field cannot be parsed as a Long.

getRFC3339Timestamp

@Nullable
java.util.Date getRFC3339Timestamp(@NotNull
                                   LogField logField)
                            throws LogException

Retrieves the value of the specified field as a Date object decoded from the ISO 8601 format described in RFC 3339. If the field has multiple values, the first will be returned.

Parameters:

logField - The field for which to retrieve the timestamp value.

Returns:

The value of the specified field as a Date object, or null if the log message does not have the specified field.

Throws:

LogException - If the value of the specified field cannot be parsed as a Date in the RFC 3339 format.

getString

@Nullable
java.lang.String getString(@NotNull
                           LogField logField)

Retrieves the value of the specified field as a string. If the field has multiple values, the first will be returned.

Parameters:

logField - The field for which to retrieve the string value.

Returns:

The value of the specified field as a string, or null if the log message does not have the specified field.

toString

@NotNull
java.lang.String toString()

Retrieves a string representation of this log message.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this log message.