com.unboundid.ldap.sdk.unboundidds.logs

Class OperationRequestAccessLogMessage

java.lang.Object

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

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

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

com.unboundid.ldap.sdk.unboundidds.logs.OperationRequestAccessLogMessage

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AbandonRequestAccessLogMessage, AddRequestAccessLogMessage, BindRequestAccessLogMessage, CompareRequestAccessLogMessage, DeleteRequestAccessLogMessage, ExtendedRequestAccessLogMessage, IntermediateResponseAccessLogMessage, ModifyDNRequestAccessLogMessage, ModifyRequestAccessLogMessage, SearchRequestAccessLogMessage, UnbindRequestAccessLogMessage

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

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 request received from a client.

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	OperationRequestAccessLogMessage(LogMessage m) Creates a new operation request access log message from the provided log message.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getIntermediateClientRequest() Retrieves the content of any intermediate client request control contained in the request.
AccessLogMessageType	getMessageType() Retrieves the message type for this access log message.
java.lang.String	getOperationPurpose() Retrieves the content of any operation purpose request control contained in the request.
java.util.List<java.lang.String>	getRequestControlOIDs() Retrieves the OIDs of any request controls contained in the log message.
java.lang.String	getRequesterDN() Retrieves the DN of the user that requested the operation.
java.lang.String	getRequesterIPAddress() Retrieves the IP address of the client that requested the operation.
java.lang.Boolean	usingAdminSessionWorkerThread() Indicates whether the operation was processed using a worker thread from the dedicated administrative session thread pool.

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

getMessageID, getOperationID, getOperationType, getOrigin, getTriggeredByConnectionID, getTriggeredByOperationID

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

getConnectionID, getInstanceName, 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

OperationRequestAccessLogMessage

protected OperationRequestAccessLogMessage(@NotNull
                                           LogMessage m)

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

Parameters:

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

Method Detail

getRequesterDN

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

Retrieves the DN of the user that requested the operation.

Returns:

The DN of the user that requested the operation, or null if it is not included in the log message.

getRequesterIPAddress

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

Retrieves the IP address of the client that requested the operation.

Returns:

The IP address of the client that requested the operation, or null if it is not included in the log message.

getIntermediateClientRequest

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

Retrieves the content of any intermediate client request control contained in the request.

Returns:

The content of any intermediate client request control contained in the request, or null if it is not included in the log message.

getOperationPurpose

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

Retrieves the content of any operation purpose request control contained in the request.

Returns:

The content of any operation purpose request control included in the request, or null if it is not included in the log message.

getRequestControlOIDs

@NotNull
public final java.util.List<java.lang.String> getRequestControlOIDs()

Retrieves the OIDs of any request controls contained in the log message.

Returns:

The OIDs of any request controls contained in the log message, or an empty list if it is not included in the log message.

usingAdminSessionWorkerThread

@Nullable
public final java.lang.Boolean usingAdminSessionWorkerThread()

Indicates whether the operation was processed using a worker thread from the dedicated administrative session thread pool.

Returns:

true if the operation was processed using a worker thread from the dedicated administrative session thread pool, false if it was not, or null if that information was not included in the log message.

getMessageType

@NotNull
public AccessLogMessageType getMessageType()

Retrieves the message type for this access log message.

Specified by:

getMessageType in class AccessLogMessage

Returns:

The message type for this access log message.