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

Class TextFormattedAccessLogMessage

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedLogMessage

com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedAccessLogMessage

All Implemented Interfaces:

AccessLogMessage, LogMessage, Serializable

Direct Known Subclasses:

TextFormattedClientCertificateAccessLogMessage, TextFormattedConnectAccessLogMessage, TextFormattedDisconnectAccessLogMessage, TextFormattedEntryRebalancingRequestAccessLogMessage, TextFormattedRequestAccessLogMessage, TextFormattedSecurityNegotiationAccessLogMessage

@NotExtensible
@ThreadSafety(level=INTERFACE_THREADSAFE)
public abstract class TextFormattedAccessLogMessage
extends TextFormattedLogMessage
implements AccessLogMessage

This class provides a data structure that holds information about a text-formatted access 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.

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedLogMessage

NO_FIELD_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TextFormattedAccessLogMessage(TextFormattedLogMessage logMessage)	Creates a new text-formatted access log message from the provided message.

Method Summary

Modifier and Type	Method	Description
final Long	getConnectionID()	Retrieves the connection ID for the connection with which this access log message is associated.
final String	getInstanceName()	Retrieves the Directory Server instance name for this access log message.
final String	getProductName()	Retrieves the server product name for this access log message.
final String	getStartupID()	Retrieves the Directory Server startup ID for this access log message.
final Long	getThreadID()	Retrieves the thread ID for the server thread that generated this access log message.

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedLogMessage

getBoolean, getDouble, getFields, getGeneralizedTime, getInteger, getLong, getRFC3339Timestamp, getString, getTimestamp, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.AccessLogMessage

getMessageType

Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.LogMessage

getBoolean, getDouble, getFields, getGeneralizedTime, getInteger, getLong, getRFC3339Timestamp, getString, getTimestamp, toString

Constructor Details

TextFormattedAccessLogMessage

protected TextFormattedAccessLogMessage(@NotNull
 TextFormattedLogMessage logMessage)

Creates a new text-formatted access log message from the provided message.

Parameters:

logMessage - The log message to use to create this access log message. It must not be null.

Method Details

getProductName

@Nullable
public final String getProductName()

Retrieves the server product name for this access log message.

Specified by:

getProductName in interface AccessLogMessage

Returns:

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

getInstanceName

@Nullable
public final String getInstanceName()

Retrieves the Directory Server instance name for this access log message.

Specified by:

getInstanceName in interface AccessLogMessage

Returns:

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

getStartupID

@Nullable
public final String getStartupID()

Retrieves the Directory Server startup ID for this access log message.

Specified by:

getStartupID in interface AccessLogMessage

Returns:

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

getThreadID

@Nullable
public final Long getThreadID()

Retrieves the thread ID for the server thread that generated this access log message.

Specified by:

getThreadID in interface AccessLogMessage

Returns:

The Directory Server thread ID for this access log message, or null if it is not included in the log message.

getConnectionID

@Nullable
public final Long getConnectionID()

Retrieves the connection ID for the connection with which this access log message is associated.

Specified by:

getConnectionID in interface AccessLogMessage

Returns:

The connection ID for the connection with which this access log message is associated, or null if it is not included in the log message.