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

Class TextFormattedRequestAccessLogMessage

java.lang.Object

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

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

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

All Implemented Interfaces:

AccessLogMessage, LogMessage, OperationRequestAccessLogMessage, Serializable

Direct Known Subclasses:

TextFormattedAbandonRequestAccessLogMessage, TextFormattedAddRequestAccessLogMessage, TextFormattedBindRequestAccessLogMessage, TextFormattedCompareRequestAccessLogMessage, TextFormattedDeleteRequestAccessLogMessage, TextFormattedExtendedRequestAccessLogMessage, TextFormattedIntermediateResponseAccessLogMessage, TextFormattedModifyDNRequestAccessLogMessage, TextFormattedModifyRequestAccessLogMessage, TextFormattedSearchRequestAccessLogMessage, TextFormattedUnbindRequestAccessLogMessage

@NotExtensible
@ThreadSafety(level=INTERFACE_THREADSAFE)
public abstract class TextFormattedRequestAccessLogMessage
extends TextFormattedAccessLogMessage
implements OperationRequestAccessLogMessage

This class provides a data structure that holds information about a text-formatted operation request 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	TextFormattedRequestAccessLogMessage(TextFormattedLogMessage logMessage)	Creates a new text-formatted request access log message from the provided message.

Method Summary

Modifier and Type	Method	Description
final String	getAdministrativeOperationMessage()	Retrieves a message from an associated administrative operation request control.
final String	getIntermediateClientRequestControl()	Retrieves a string representation of an intermediate client request control included in the log message.
final Integer	getMessageID()	Retrieves the message ID for the associated operation.
AccessLogMessageType	getMessageType()	Retrieves the message type for this access log message.
final Long	getOperationID()	Retrieves the operation ID for the associated operation.
final String	getOperationPurposeRequestControl()	Retrieves a string representation of an operation purpose request control included in the log message.
final String	getOrigin()	Retrieves the origin of the associated operation.
final Set<String>	getRequestControlOIDs()	Retrieves the OIDs of any request controls contained in the log message.
final String	getRequesterDN()	Retrieves the DN of the user that requested the operation.
final String	getRequesterIPAddress()	Retrieves the IP address of the client that requested the operation.
final Long	getTriggeredByConnectionID()	Retrieves the connection ID for the connection that triggered the associated operation.
final Long	getTriggeredByOperationID()	Retrieves the operation ID for the operation that triggered the associated operation.
final Boolean	getUsingAdminSessionWorkerThread()	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.v2.text.TextFormattedAccessLogMessage

getConnectionID, getInstanceName, getProductName, getStartupID, getThreadID

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

getConnectionID, getInstanceName, getProductName, getStartupID, getThreadID

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

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

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

getOperationType

Constructor Details

TextFormattedRequestAccessLogMessage

protected TextFormattedRequestAccessLogMessage(@NotNull
 TextFormattedLogMessage logMessage)

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

Parameters:

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

Method Details

getMessageType

@NotNull
public AccessLogMessageType getMessageType()

Retrieves the message type for this access log message.

Specified by:

getMessageType in interface AccessLogMessage

Returns:

The message type for this access log message.

getOperationID

@Nullable
public final Long getOperationID()

Retrieves the operation ID for the associated operation.

Specified by:

getOperationID in interface OperationRequestAccessLogMessage

Returns:

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

getMessageID

@Nullable
public final Integer getMessageID()

Retrieves the message ID for the associated operation.

Specified by:

getMessageID in interface OperationRequestAccessLogMessage

Returns:

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

getOrigin

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

Specified by:

getOrigin in interface OperationRequestAccessLogMessage

Returns:

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

getTriggeredByConnectionID

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

Specified by:

getTriggeredByConnectionID in interface OperationRequestAccessLogMessage

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

Specified by:

getTriggeredByOperationID in interface OperationRequestAccessLogMessage

Returns:

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

getRequesterDN

@Nullable
public final String getRequesterDN()

Retrieves the DN of the user that requested the operation.

Specified by:

getRequesterDN in interface OperationRequestAccessLogMessage

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 String getRequesterIPAddress()

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

Specified by:

getRequesterIPAddress in interface OperationRequestAccessLogMessage

Returns:

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

getRequestControlOIDs

@NotNull
public final Set<String> getRequestControlOIDs()

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

Specified by:

getRequestControlOIDs in interface OperationRequestAccessLogMessage

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.

getUsingAdminSessionWorkerThread

@Nullable
public final Boolean getUsingAdminSessionWorkerThread()

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

Specified by:

getUsingAdminSessionWorkerThread in interface OperationRequestAccessLogMessage

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.

getAdministrativeOperationMessage

@Nullable
public final String getAdministrativeOperationMessage()

Retrieves a message from an associated administrative operation request control.

Specified by:

getAdministrativeOperationMessage in interface OperationRequestAccessLogMessage

Returns:

A message from an associated administrative operation request control, or null if it is not included in teh log message.

getIntermediateClientRequestControl

@Nullable
public final String getIntermediateClientRequestControl()

Retrieves a string representation of an intermediate client request control included in the log message.

Returns:

A string representation of an intermediate client request control included in the log message, or null if there is none.

getOperationPurposeRequestControl

@Nullable
public final String getOperationPurposeRequestControl()

Retrieves a string representation of an operation purpose request control included in the log message.

Returns:

A string representation of an operation purpose request control included in the log message, or null if there is none.