@NotExtensible @ThreadSafety(level=INTERFACE_THREADSAFE) public interface LogMessage extends java.io.Serializable
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.
Modifier and Type | Method and 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.
|
@NotNull java.util.Date getTimestamp()
@NotNull java.util.Map<java.lang.String,java.util.List<java.lang.String>> getFields()
@Nullable java.lang.Boolean getBoolean(@NotNull LogField logField) throws LogException
Boolean
object. If
the field has multiple values, the first will be returned.logField
- The field for which to retrieve the Boolean value.Boolean
object, or
null
if the log message does not have the specified field.LogException
- If the value of the specified field cannot be parsed
as a Boolean.@Nullable java.util.Date getGeneralizedTime(@NotNull LogField logField) throws LogException
Date
object decoded
from the generalized time format. If the field has multiple values, the
first will be returned.logField
- The field for which to retrieve the timestamp value.Date
object, or
null
if the log message does not have the specified field.LogException
- If the value of the specified field cannot be parsed
as a Date
in the generalized time format.@Nullable java.lang.Double getDouble(@NotNull LogField logField) throws LogException
Double
value. If
the field has multiple values, the first will be returned.logField
- The field for which to retrieve the Double
value.Double
value, or
null
if the log message does not have the specified field.LogException
- If the value of the specified field cannot be parsed
as a Double
.@Nullable java.lang.Integer getInteger(@NotNull LogField logField) throws LogException
Integer
value. If
the field has multiple values, the first will be returned.logField
- The field for which to retrieve the Integer
value.Integer
value of the specified field, or null
if the log message does not have the specified field.LogException
- If the value of the specified field cannot be parsed
as an Integer
.@Nullable java.lang.Long getLong(@NotNull LogField logField) throws LogException
Long
value. If the
field has multiple values, the first will be returned.logField
- The field for which to retrieve the Long
value.Long
value of the specified field, or null
if the log message does not have the specified field.LogException
- If the value of the specified field cannot be parsed
as a Long
.@Nullable java.util.Date getRFC3339Timestamp(@NotNull LogField logField) throws LogException
Date
object decoded
from the ISO 8601 format described in RFC 3339. If the field has multiple
values, the first will be returned.logField
- The field for which to retrieve the timestamp value.Date
object, or
null
if the log message does not have the specified field.LogException
- If the value of the specified field cannot be parsed
as a Date
in the RFC 3339 format.@Nullable java.lang.String getString(@NotNull LogField logField)
logField
- The field for which to retrieve the string value.null
if
the log message does not have the specified field.