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

Interface IntermediateResponseAccessLogMessage

All Superinterfaces:

AccessLogMessage, LogMessage, OperationRequestAccessLogMessage, java.io.Serializable

All Known Implementing Classes:

JSONIntermediateResponseAccessLogMessage, TextFormattedIntermediateResponseAccessLogMessage

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

This class provides a data structure that holds information about an intermediate response 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	getOID() Retrieves the OID of the intermediate response.
java.util.Set<java.lang.String>	getResponseControlOIDs() Retrieves the OIDs of any response controls contained in the log message.
java.lang.String	getResponseName() Retrieves a human-readable name for the intermediate response.
java.lang.String	getValueString() Retrieves a human-readable representation of the intermediate response value.

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

getAdministrativeOperationMessage, getMessageID, getOperationID, getOperationType, 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

Method Detail

getOID

@Nullable
java.lang.String getOID()

Retrieves the OID of the intermediate response.

Returns:

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

getResponseName

@Nullable
java.lang.String getResponseName()

Retrieves a human-readable name for the intermediate response.

Returns:

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

getValueString

@Nullable
java.lang.String getValueString()

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

Returns:

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

getResponseControlOIDs

@NotNull
java.util.Set<java.lang.String> getResponseControlOIDs()

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

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.