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

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.logs.LogMessage
      extended by com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessage
          extended by com.unboundid.ldap.sdk.unboundidds.logs.OperationAccessLogMessage
              extended by com.unboundid.ldap.sdk.unboundidds.logs.OperationRequestAccessLogMessage
                  extended by com.unboundid.ldap.sdk.unboundidds.logs.IntermediateResponseAccessLogMessage
All Implemented Interfaces:
java.io.Serializable

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

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
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.

See Also:
Serialized Form

Constructor Summary
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
 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
 
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(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(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

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

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

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

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

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

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.