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

Class JSONIntermediateResponseAccessLogMessage

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

All Implemented Interfaces:

AccessLogMessage, IntermediateResponseAccessLogMessage, LogMessage, OperationRequestAccessLogMessage, Serializable

@NotMutable
@ThreadSafety(level=INTERFACE_THREADSAFE)
public final class JSONIntermediateResponseAccessLogMessage
extends JSONRequestAccessLogMessage
implements IntermediateResponseAccessLogMessage

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

Constructor	Description
JSONIntermediateResponseAccessLogMessage(JSONObject jsonObject)	Creates a new JSON intermediate response access log message from the provided JSON object.

Method Summary

Modifier and Type	Method	Description
AccessLogMessageType	getMessageType()	Retrieves the message type for this access log message.
String	getOID()	Retrieves the OID of the intermediate response.
AccessLogOperationType	getOperationType()	Retrieves the operation type for the associated operation.
Set<String>	getResponseControlOIDs()	Retrieves the OIDs of any response controls contained in the log message.
String	getResponseName()	Retrieves a human-readable name for the intermediate response.
String	getValueString()	Retrieves a human-readable representation of the intermediate response value.

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

getAdministrativeOperationMessage, getIntermediateClientRequestControl, getMessageID, 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.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

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

Constructor Details

JSONIntermediateResponseAccessLogMessage

public JSONIntermediateResponseAccessLogMessage(@NotNull
 JSONObject jsonObject)
                                         throws LogException

Creates a new JSON intermediate response 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 Details

getMessageType

@NotNull
public AccessLogMessageType getMessageType()

Retrieves the message type for this access log message.

Specified by:

getMessageType in interface AccessLogMessage

Overrides:

getMessageType in class JSONRequestAccessLogMessage

Returns:

The message type for this access log message.

getOperationType

@NotNull
public 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.

getOID

@Nullable
public String getOID()

Retrieves the OID of the intermediate response.

Specified by:

getOID in interface IntermediateResponseAccessLogMessage

Returns:

The OID of the intermediate response, or null if it is not included in the log message.

getResponseName

@Nullable
public String getResponseName()

Retrieves a human-readable name for the intermediate response.

Specified by:

getResponseName in interface IntermediateResponseAccessLogMessage

Returns:

A human-readable name for the intermediate response, or null if it is not included in the log message.

getValueString

@Nullable
public String getValueString()

Retrieves a human-readable representation of the intermediate response value.

Specified by:

getValueString in interface IntermediateResponseAccessLogMessage

Returns:

A human-readable representation of the intermediate response value, or null if it is not included in the log message.

getResponseControlOIDs

@NotNull
public Set<String> getResponseControlOIDs()

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

Specified by:

getResponseControlOIDs in interface IntermediateResponseAccessLogMessage

Returns:

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