com.unboundid.ldap.sdk.unboundidds.logs
Class ErrorLogMessage

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.logs.LogMessage
      extended by com.unboundid.ldap.sdk.unboundidds.logs.ErrorLogMessage
All Implemented Interfaces:
java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class ErrorLogMessage
extends LogMessage

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This class provides a data structure that holds information about a log message that may appear in the Directory Server error log.

See Also:
Serialized Form

Constructor Summary
ErrorLogMessage(LogMessage m)
          Creates a new error log message from the provided message string.
ErrorLogMessage(java.lang.String s)
          Creates a new error log message from the provided message string.
 
Method Summary
 ErrorLogCategory getCategory()
          Retrieves the category for this error log message.
 java.lang.String getInstanceName()
          Retrieves the Directory Server instance name for this error log message.
 java.lang.String getMessage()
          Retrieves the message text for this error log message.
 java.lang.Long getMessageID()
          Retrieves the numeric identifier for this error log message.
 java.lang.String getProductName()
          Retrieves the server product name for this error log message.
 ErrorLogSeverity getSeverity()
          Retrieves the severity for this error log message.
 java.lang.String getStartupID()
          Retrieves the Directory Server startup ID for this error log message.
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.LogMessage
getNamedValue, getNamedValueAsBoolean, getNamedValueAsDouble, getNamedValueAsInteger, getNamedValueAsLong, getNamedValues, getTimestamp, getUnnamedValues, hasUnnamedValue, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ErrorLogMessage

public ErrorLogMessage(java.lang.String s)
                throws LogException
Creates a new error log message from the provided message string.

Parameters:
s - The string to be parsed as an error log message.
Throws:
LogException - If the provided string cannot be parsed as a valid log message.

ErrorLogMessage

public ErrorLogMessage(LogMessage m)
Creates a new error log message from the provided message string.

Parameters:
m - The log message to be parsed as an error log message.
Method Detail

getProductName

public java.lang.String getProductName()
Retrieves the server product name for this error log message.

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

getInstanceName

public java.lang.String getInstanceName()
Retrieves the Directory Server instance name for this error log message.

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

getStartupID

public java.lang.String getStartupID()
Retrieves the Directory Server startup ID for this error log message.

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

getCategory

public ErrorLogCategory getCategory()
Retrieves the category for this error log message.

Returns:
The category for this error log message, or null if it is not included in the log message.

getSeverity

public ErrorLogSeverity getSeverity()
Retrieves the severity for this error log message.

Returns:
The severity for this error log message, or null if it is not included in the log message.

getMessageID

public java.lang.Long getMessageID()
Retrieves the numeric identifier for this error log message.

Returns:
The numeric identifier for this error log message, or null if it is not included in the log message.

getMessage

public java.lang.String getMessage()
Retrieves the message text for this error log message.

Returns:
The message text for this error log message, or null if it is not included in the log message.