com.unboundid.ldap.sdk.unboundidds.logs

Class OperationAccessLogMessage

java.lang.Object

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

com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessage

com.unboundid.ldap.sdk.unboundidds.logs.OperationAccessLogMessage

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

OperationRequestAccessLogMessage

@NotExtensible
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public abstract class OperationAccessLogMessage
extends AccessLogMessage

This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about an operation processed by the server.

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

Modifier	Constructor and Description
protected	OperationAccessLogMessage(LogMessage m) Creates a new operation access log message from the provided log message.

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getMessageID() Retrieves the message ID for the associated operation.
java.lang.Long	getOperationID() Retrieves the operation ID for the associated operation.
abstract AccessLogOperationType	getOperationType() Retrieves the operation type for the associated operation.
java.lang.String	getOrigin() Retrieves the origin of the associated operation.
java.lang.Long	getTriggeredByConnectionID() Retrieves the connection ID for the connection that triggered the associated operation.
java.lang.Long	getTriggeredByOperationID() Retrieves the operation ID for the operation that triggered the associated operation.

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessage

getConnectionID, getInstanceName, getMessageType, getProductName, getStartupID, parse

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

OperationAccessLogMessage

protected OperationAccessLogMessage(@NotNull
                                    LogMessage m)

Creates a new operation access log message from the provided log message.

Parameters:

m - The log message to be parsed as an operation access log message.

Method Detail

getOperationID

@Nullable
public final java.lang.Long getOperationID()

Retrieves the operation ID for the associated operation.

Returns:

The operation ID for the associated operation, or null if it is not included in the log message.

getTriggeredByConnectionID

@Nullable
public final java.lang.Long getTriggeredByConnectionID()

Retrieves the connection ID for the connection that triggered the associated operation. This is generally used for internal operations that are processed as a direct result of an externally-requested operation.

Returns:

The connection ID for the connection that triggered the associated operation, or null if it is not included in the log message.

getTriggeredByOperationID

@Nullable
public final java.lang.Long getTriggeredByOperationID()

Retrieves the operation ID for the operation that triggered the associated operation. This is generally used for internal operations that are processed as a direct result of an externally-requested operation.

Returns:

The operation ID for the operation that triggered the associated operation, or null if it is not included in the log message.

getMessageID

@Nullable
public final java.lang.Integer getMessageID()

Retrieves the message ID for the associated operation.

Returns:

The message ID for the associated operation, or null if it is not included in the log message.

getOrigin

@Nullable
public final java.lang.String getOrigin()

Retrieves the origin of the associated operation. If present, it may be "synchronization" if the operation is replicated, or "internal" if it is an internal operation.

Returns:

The origin for the associated operation, or null if it is not included in the log message.

getOperationType

@NotNull
public abstract AccessLogOperationType getOperationType()

Retrieves the operation type for the associated operation.

Returns:

The operation type for this access log message.