com.unboundid.ldap.sdk.unboundidds.logs

Class ErrorLogMessage

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.logs.LogMessage

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

All Implemented Interfaces:

java.io.Serializable

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

This class provides a data structure that holds information about a log message that may appear in the Directory Server error log.

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:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
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

Modifier and Type	Method and Description
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.
java.lang.Long	getTriggeredByConnectionID() Retrieves the connection ID for the operation currently being processed by the thread that generated this error log message.
java.lang.Long	getTriggeredByOperationID() Retrieves the operation ID for the operation currently being processed by the thread that generated 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(@NotNull
                       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(@NotNull
                       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

@Nullable
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

@Nullable
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

@Nullable
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

@Nullable
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

@Nullable
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

@Nullable
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.

getTriggeredByConnectionID

@Nullable
public java.lang.Long getTriggeredByConnectionID()

Retrieves the connection ID for the operation currently being processed by the thread that generated this error log message.

Returns:

The connection ID for the operation currently being processed by the thread that generated this error log message, or null if it is not included in the log message.

getTriggeredByOperationID

@Nullable
public java.lang.Long getTriggeredByOperationID()

Retrieves the operation ID for the operation currently being processed by the thread that generated this error log message.

Returns:

The operation ID for the operation currently being processed by the thread that generated this error log message, or null if it is not included in the log message.

getMessage

@Nullable
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.