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

Interface OperationRequestAccessLogMessage

All Superinterfaces:

AccessLogMessage, LogMessage, java.io.Serializable

All Known Subinterfaces:

AbandonForwardAccessLogMessage, AbandonForwardFailedAccessLogMessage, AbandonRequestAccessLogMessage, AbandonResultAccessLogMessage, AddAssuranceCompletedAccessLogMessage, AddForwardAccessLogMessage, AddForwardFailedAccessLogMessage, AddRequestAccessLogMessage, AddResultAccessLogMessage, AssuranceCompletedAccessLogMessage, BindForwardAccessLogMessage, BindForwardFailedAccessLogMessage, BindRequestAccessLogMessage, BindResultAccessLogMessage, CompareForwardAccessLogMessage, CompareForwardFailedAccessLogMessage, CompareRequestAccessLogMessage, CompareResultAccessLogMessage, DeleteAssuranceCompletedAccessLogMessage, DeleteForwardAccessLogMessage, DeleteForwardFailedAccessLogMessage, DeleteRequestAccessLogMessage, DeleteResultAccessLogMessage, ExtendedForwardAccessLogMessage, ExtendedForwardFailedAccessLogMessage, ExtendedRequestAccessLogMessage, ExtendedResultAccessLogMessage, IntermediateResponseAccessLogMessage, ModifyAssuranceCompletedAccessLogMessage, ModifyDNAssuranceCompletedAccessLogMessage, ModifyDNForwardAccessLogMessage, ModifyDNForwardFailedAccessLogMessage, ModifyDNRequestAccessLogMessage, ModifyDNResultAccessLogMessage, ModifyForwardAccessLogMessage, ModifyForwardFailedAccessLogMessage, ModifyRequestAccessLogMessage, ModifyResultAccessLogMessage, OperationForwardAccessLogMessage, OperationForwardFailedAccessLogMessage, OperationResultAccessLogMessage, SearchEntryAccessLogMessage, SearchForwardAccessLogMessage, SearchForwardFailedAccessLogMessage, SearchReferenceAccessLogMessage, SearchRequestAccessLogMessage, SearchResultAccessLogMessage, UnbindRequestAccessLogMessage

All Known Implementing Classes:

JSONAbandonForwardAccessLogMessage, JSONAbandonForwardFailedAccessLogMessage, JSONAbandonRequestAccessLogMessage, JSONAbandonResultAccessLogMessage, JSONAddAssuranceCompletedAccessLogMessage, JSONAddForwardAccessLogMessage, JSONAddForwardFailedAccessLogMessage, JSONAddRequestAccessLogMessage, JSONAddResultAccessLogMessage, JSONBindForwardAccessLogMessage, JSONBindForwardFailedAccessLogMessage, JSONBindRequestAccessLogMessage, JSONBindResultAccessLogMessage, JSONCompareForwardAccessLogMessage, JSONCompareForwardFailedAccessLogMessage, JSONCompareRequestAccessLogMessage, JSONCompareResultAccessLogMessage, JSONDeleteAssuranceCompletedAccessLogMessage, JSONDeleteForwardAccessLogMessage, JSONDeleteForwardFailedAccessLogMessage, JSONDeleteRequestAccessLogMessage, JSONDeleteResultAccessLogMessage, JSONExtendedForwardAccessLogMessage, JSONExtendedForwardFailedAccessLogMessage, JSONExtendedRequestAccessLogMessage, JSONExtendedResultAccessLogMessage, JSONIntermediateResponseAccessLogMessage, JSONModifyAssuranceCompletedAccessLogMessage, JSONModifyDNAssuranceCompletedAccessLogMessage, JSONModifyDNForwardAccessLogMessage, JSONModifyDNForwardFailedAccessLogMessage, JSONModifyDNRequestAccessLogMessage, JSONModifyDNResultAccessLogMessage, JSONModifyForwardAccessLogMessage, JSONModifyForwardFailedAccessLogMessage, JSONModifyRequestAccessLogMessage, JSONModifyResultAccessLogMessage, JSONRequestAccessLogMessage, JSONSearchEntryAccessLogMessage, JSONSearchForwardAccessLogMessage, JSONSearchForwardFailedAccessLogMessage, JSONSearchReferenceAccessLogMessage, JSONSearchRequestAccessLogMessage, JSONSearchResultAccessLogMessage, JSONUnbindRequestAccessLogMessage, TextFormattedAbandonForwardAccessLogMessage, TextFormattedAbandonForwardFailedAccessLogMessage, TextFormattedAbandonRequestAccessLogMessage, TextFormattedAbandonResultAccessLogMessage, TextFormattedAddAssuranceCompletedAccessLogMessage, TextFormattedAddForwardAccessLogMessage, TextFormattedAddForwardFailedAccessLogMessage, TextFormattedAddRequestAccessLogMessage, TextFormattedAddResultAccessLogMessage, TextFormattedBindForwardAccessLogMessage, TextFormattedBindForwardFailedAccessLogMessage, TextFormattedBindRequestAccessLogMessage, TextFormattedBindResultAccessLogMessage, TextFormattedCompareForwardAccessLogMessage, TextFormattedCompareForwardFailedAccessLogMessage, TextFormattedCompareRequestAccessLogMessage, TextFormattedCompareResultAccessLogMessage, TextFormattedDeleteAssuranceCompletedAccessLogMessage, TextFormattedDeleteForwardAccessLogMessage, TextFormattedDeleteForwardFailedAccessLogMessage, TextFormattedDeleteRequestAccessLogMessage, TextFormattedDeleteResultAccessLogMessage, TextFormattedExtendedForwardAccessLogMessage, TextFormattedExtendedForwardFailedAccessLogMessage, TextFormattedExtendedRequestAccessLogMessage, TextFormattedExtendedResultAccessLogMessage, TextFormattedIntermediateResponseAccessLogMessage, TextFormattedModifyAssuranceCompletedAccessLogMessage, TextFormattedModifyDNAssuranceCompletedAccessLogMessage, TextFormattedModifyDNForwardAccessLogMessage, TextFormattedModifyDNForwardFailedAccessLogMessage, TextFormattedModifyDNRequestAccessLogMessage, TextFormattedModifyDNResultAccessLogMessage, TextFormattedModifyForwardAccessLogMessage, TextFormattedModifyForwardFailedAccessLogMessage, TextFormattedModifyRequestAccessLogMessage, TextFormattedModifyResultAccessLogMessage, TextFormattedRequestAccessLogMessage, TextFormattedSearchEntryAccessLogMessage, TextFormattedSearchForwardAccessLogMessage, TextFormattedSearchForwardFailedAccessLogMessage, TextFormattedSearchReferenceAccessLogMessage, TextFormattedSearchRequestAccessLogMessage, TextFormattedSearchResultAccessLogMessage, TextFormattedUnbindRequestAccessLogMessage

@NotExtensible
 @ThreadSafety(level=INTERFACE_THREADSAFE)
public interface OperationRequestAccessLogMessage
extends AccessLogMessage

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAdministrativeOperationMessage() Retrieves a message from an associated administrative operation request control.
java.lang.Integer	getMessageID() Retrieves the message ID for the associated operation.
java.lang.Long	getOperationID() Retrieves the operation ID for the associated operation.
AccessLogOperationType	getOperationType() Retrieves the operation type for the associated operation.
java.lang.String	getOrigin() Retrieves the origin of the associated operation.
java.util.Set<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.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.
java.lang.Boolean	getUsingAdminSessionWorkerThread() Indicates whether the operation was processed using a worker thread from the dedicated administrative session thread pool.

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

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

Method Detail

getOperationType

@NotNull
AccessLogOperationType getOperationType()

Retrieves the operation type for the associated operation.

Returns:

The operation type for this access log message.

getOperationID

@Nullable
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

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

getTriggeredByConnectionID

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

getRequesterDN

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

getRequestControlOIDs

@NotNull
java.util.Set<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.

getUsingAdminSessionWorkerThread

@Nullable
java.lang.Boolean getUsingAdminSessionWorkerThread()

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.

getAdministrativeOperationMessage

@Nullable
java.lang.String getAdministrativeOperationMessage()

Retrieves a message from an associated administrative operation request control.

Returns:

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