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

Class JSONAbandonRequestAccessLogMessage

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

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

All Implemented Interfaces:

AbandonRequestAccessLogMessage, AccessLogMessage, LogMessage, OperationRequestAccessLogMessage, java.io.Serializable

Direct Known Subclasses:

JSONAbandonForwardAccessLogMessage, JSONAbandonResultAccessLogMessage

@NotExtensible
 @NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public class JSONAbandonRequestAccessLogMessage
extends JSONRequestAccessLogMessage
implements AbandonRequestAccessLogMessage

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

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

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getMessageIDToAbandon() Retrieves the message ID of the operation that should be abandoned.
AccessLogOperationType	getOperationType() Retrieves the operation type for the associated operation.

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

getAdministrativeOperationMessage, getIntermediateClientRequestControl, getMessageID, getMessageType, getOperationID, getOperationPurposeRequestControl, getOrigin, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, getTriggeredByConnectionID, getTriggeredByOperationID, getUsingAdminSessionWorkerThread

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

getAdministrativeOperationMessage, getMessageID, getOperationID, getOrigin, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, getTriggeredByConnectionID, getTriggeredByOperationID, getUsingAdminSessionWorkerThread

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

Constructor Detail

JSONAbandonRequestAccessLogMessage

public JSONAbandonRequestAccessLogMessage(@NotNull
                                          JSONObject jsonObject)
                                   throws LogException

Creates a new JSON abandon 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

getOperationType

@NotNull
public final AccessLogOperationType getOperationType()

Retrieves the operation type for the associated operation.

Specified by:

getOperationType in interface OperationRequestAccessLogMessage

Returns:

The operation type for this access log message.

getMessageIDToAbandon

@Nullable
public final java.lang.Integer getMessageIDToAbandon()

Retrieves the message ID of the operation that should be abandoned.

Specified by:

getMessageIDToAbandon in interface AbandonRequestAccessLogMessage

Returns:

The message ID of the operation that should be abandoned, or null if it is not included in the log message.