com.unboundid.ldap.sdk.unboundidds.logs

Class IntermediateResponseAccessLogMessage

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.logs.LogMessage

com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessage

com.unboundid.ldap.sdk.unboundidds.logs.OperationAccessLogMessage

com.unboundid.ldap.sdk.unboundidds.logs.OperationRequestAccessLogMessage

com.unboundid.ldap.sdk.unboundidds.logs.IntermediateResponseAccessLogMessage

All Implemented Interfaces:

java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class IntermediateResponseAccessLogMessage
extends OperationRequestAccessLogMessage

This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about an intermediate response returned to a client.

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
IntermediateResponseAccessLogMessage(LogMessage m) Creates a new intermediate response access log message from the provided log message.
IntermediateResponseAccessLogMessage(java.lang.String s) Creates a new intermediate response access log message from the provided message string.

Method Summary

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

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.OperationRequestAccessLogMessage

getIntermediateClientRequest, getOperationPurpose, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, usingAdminSessionWorkerThread

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.OperationAccessLogMessage

getMessageID, getOperationID, getOrigin, getTriggeredByConnectionID, getTriggeredByOperationID

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessage

getConnectionID, getInstanceName, getProductName, getStartupID, parse

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.LogMessage

getNamedValue, getNamedValueAsBoolean, getNamedValueAsDouble, getNamedValueAsInteger, getNamedValueAsLong, getNamedValues, getTimestamp, getUnnamedValues, hasUnnamedValue, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IntermediateResponseAccessLogMessage

public IntermediateResponseAccessLogMessage(@NotNull
                                            java.lang.String s)
                                     throws LogException

Creates a new intermediate response access log message from the provided message string.

Parameters:

s - The string to be parsed as an intermediate response access log message.

Throws:

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

IntermediateResponseAccessLogMessage

public IntermediateResponseAccessLogMessage(@NotNull
                                            LogMessage m)

Creates a new intermediate response access log message from the provided log message.

Parameters:

m - The log message to be parsed as an intermediate response access log message.

Method Detail

getOID

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

getIntermediateResponseName

@Nullable
public java.lang.String getIntermediateResponseName()

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
public 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
public java.util.List<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.

getMessageType

@NotNull
public AccessLogMessageType getMessageType()

Retrieves the message type for this access log message.

Overrides:

getMessageType in class OperationRequestAccessLogMessage

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 class OperationAccessLogMessage

Returns:

The operation type for this access log message.