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

Class LogMessage

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.logs.LogMessage
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
AccessLogMessage, ErrorLogMessage
@NotExtensible @NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public class LogMessage extends Object implements Serializable
This class provides a data structure that holds information about a log message contained in a Directory Server access or error log file.
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.
See Also:

  • Constructor Details

    • LogMessage

      protected LogMessage(@NotNull LogMessage m)
      Creates a log message from the provided log message.
      Parameters:
      m - The log message to use to create this log message.

    • LogMessage

      protected LogMessage(@NotNull String s) throws LogException
      Parses the provided string as a log message.
      Parameters:
      s - The string to be parsed as a log message.
      Throws:
      LogException - If the provided string cannot be parsed as a valid log message.

  • Method Details

    • getTimestamp

      @NotNull public final Date getTimestamp()
      Retrieves the timestamp for this log message.
      Returns:
      The timestamp for this log message.

    • getNamedValues

      @NotNull public final Map<String,String> getNamedValues()
      Retrieves the set of named tokens for this log message, mapped from the name to the corresponding value.
      Returns:
      The set of named tokens for this log message.

    • getNamedValue

      @Nullable public final String getNamedValue(@NotNull String name)
      Retrieves the value of the token with the specified name.
      Parameters:
      name - The name of the token to retrieve.
      Returns:
      The value of the token with the specified name, or null if there is no value with the specified name.

    • getNamedValueAsBoolean

      @Nullable public final Boolean getNamedValueAsBoolean(@NotNull String name)
      Retrieves the value of the token with the specified name as a Boolean.
      Parameters:
      name - The name of the token to retrieve.
      Returns:
      The value of the token with the specified name as a Boolean, or null if there is no value with the specified name or the value cannot be parsed as a Boolean.

    • getNamedValueAsDouble

      @Nullable public final Double getNamedValueAsDouble(@NotNull String name)
      Retrieves the value of the token with the specified name as a Double.
      Parameters:
      name - The name of the token to retrieve.
      Returns:
      The value of the token with the specified name as a Double, or null if there is no value with the specified name or the value cannot be parsed as a Double.

    • getNamedValueAsInteger

      @Nullable public final Integer getNamedValueAsInteger(@NotNull String name)
      Retrieves the value of the token with the specified name as an Integer.
      Parameters:
      name - The name of the token to retrieve.
      Returns:
      The value of the token with the specified name as an Integer, or null if there is no value with the specified name or the value cannot be parsed as an Integer.

    • getNamedValueAsLong

      @Nullable public final Long getNamedValueAsLong(@NotNull String name)
      Retrieves the value of the token with the specified name as a Long.
      Parameters:
      name - The name of the token to retrieve.
      Returns:
      The value of the token with the specified name as a Long, or null if there is no value with the specified name or the value cannot be parsed as a Long.

    • getUnnamedValues

      @NotNull public final Set<String> getUnnamedValues()
      Retrieves the set of unnamed tokens for this log message.
      Returns:
      The set of unnamed tokens for this log message.

    • hasUnnamedValue

      public final boolean hasUnnamedValue(@NotNull String value)
      Indicates whether this log message has the specified unnamed value.
      Parameters:
      value - The value for which to make the determination.
      Returns:
      true if this log message has the specified unnamed value, or false if not.

    • toString

      @NotNull public final String toString()
      Retrieves a string representation of this log message.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this log message.