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

Class JSONRequestAccessLogMessage

java.lang.Object

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

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

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

All Implemented Interfaces:

AccessLogMessage, LogMessage, OperationRequestAccessLogMessage, java.io.Serializable

Direct Known Subclasses:

JSONAbandonRequestAccessLogMessage, JSONAddRequestAccessLogMessage, JSONBindRequestAccessLogMessage, JSONCompareRequestAccessLogMessage, JSONDeleteRequestAccessLogMessage, JSONExtendedRequestAccessLogMessage, JSONIntermediateResponseAccessLogMessage, JSONModifyDNRequestAccessLogMessage, JSONModifyRequestAccessLogMessage, JSONSearchRequestAccessLogMessage, JSONUnbindRequestAccessLogMessage

@NotExtensible
 @ThreadSafety(level=INTERFACE_THREADSAFE)
public abstract class JSONRequestAccessLogMessage
extends JSONAccessLogMessage
implements OperationRequestAccessLogMessage

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JSONRequestAccessLogMessage(JSONObject jsonObject) Creates a new JSON request access log message from the provided JSON object.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAdministrativeOperationMessage() Retrieves a message from an associated administrative operation request control.
JSONIntermediateClientRequestControl	getIntermediateClientRequestControl() Retrieves information about an intermediate client request control included in the log message.
java.lang.Integer	getMessageID() Retrieves the message ID for the associated operation.
AccessLogMessageType	getMessageType() Retrieves the message type for this access log message.
java.lang.Long	getOperationID() Retrieves the operation ID for the associated operation.
JSONOperationPurposeRequestControl	getOperationPurposeRequestControl() Retrieves information about an operation purpose request control included in the log message.
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 class com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONAccessLogMessage

getConnectionID, getInstanceName, getProductName, getStartupID, getThreadID

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONLogMessage

getBoolean, getDouble, getFields, getGeneralizedTime, getInteger, getJSONObject, getLogType, 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.OperationRequestAccessLogMessage

getOperationType

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

Constructor Detail

JSONRequestAccessLogMessage

protected JSONRequestAccessLogMessage(@NotNull
                                      JSONObject jsonObject)
                               throws LogException

Creates a new JSON request access log message from the provided JSON object.

Parameters:

jsonObject - The JSON object that contains an encoded representation of this log message. It must not be null.

Throws:

LogException - If the provided JSON object cannot be parsed as a valid log message.

Method Detail

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

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

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

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 java.lang.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 java.lang.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 java.util.Set<java.lang.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 java.lang.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 java.lang.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 JSONIntermediateClientRequestControl getIntermediateClientRequestControl()

Retrieves information about an intermediate client request control included in the log message.

Returns:

An intermediate client request control included in the log message, or null if no intermediate client request control is available.

getOperationPurposeRequestControl

@Nullable
public final JSONOperationPurposeRequestControl getOperationPurposeRequestControl()

Retrieves information about an operation purpose request control included in the log message.

Returns:

An operation purpose request control included in the log message, or null if no operation purpose request control is available.