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

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.logs.LogMessage
      extended by com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessage
          extended by 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

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 access log about an operation processed by the server.

See Also:
Serialized Form

Constructor Summary
protected OperationAccessLogMessage(LogMessage m)
          Creates a new operation access log message from the provided log message.
 
Method Summary
 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.
 
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(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

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.

getMessageID

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

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

public abstract AccessLogOperationType getOperationType()
Retrieves the operation type for the associated operation.

Returns:
The operation type for this access log message.