Class TextFormattedIntermediateResponseAccessLogMessage
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedLogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedAccessLogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedRequestAccessLogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedIntermediateResponseAccessLogMessage
-
- All Implemented Interfaces:
AccessLogMessage
,IntermediateResponseAccessLogMessage
,LogMessage
,OperationRequestAccessLogMessage
,java.io.Serializable
@NotMutable @ThreadSafety(level=INTERFACE_THREADSAFE) public final class TextFormattedIntermediateResponseAccessLogMessage extends TextFormattedRequestAccessLogMessage implements IntermediateResponseAccessLogMessage
This class provides a data structure that holds information about a text-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
-
-
Field Summary
-
Fields inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedLogMessage
NO_FIELD_NAME
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.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 class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedRequestAccessLogMessage
getAdministrativeOperationMessage, getIntermediateClientRequestControl, getMessageID, getOperationID, getOperationPurposeRequestControl, getOrigin, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, getTriggeredByConnectionID, getTriggeredByOperationID, getUsingAdminSessionWorkerThread
-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedAccessLogMessage
getConnectionID, getInstanceName, getProductName, getStartupID, getThreadID
-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedLogMessage
getBoolean, getDouble, getFields, getGeneralizedTime, getInteger, 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
-
-
-
-
Method Detail
-
getMessageType
@NotNull public AccessLogMessageType getMessageType()
Retrieves the message type for this access log message.- Specified by:
getMessageType
in interfaceAccessLogMessage
- Overrides:
getMessageType
in classTextFormattedRequestAccessLogMessage
- 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 interfaceOperationRequestAccessLogMessage
- Returns:
- The operation type for this access log message.
-
getOID
@Nullable public java.lang.String getOID()
Retrieves the OID of the intermediate response.- Specified by:
getOID
in interfaceIntermediateResponseAccessLogMessage
- Returns:
- The OID of the intermediate response, or
null
if it is not included in the log message.
-
getResponseName
@Nullable public java.lang.String getResponseName()
Retrieves a human-readable name for the intermediate response.- Specified by:
getResponseName
in interfaceIntermediateResponseAccessLogMessage
- 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.- Specified by:
getValueString
in interfaceIntermediateResponseAccessLogMessage
- 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.Set<java.lang.String> getResponseControlOIDs()
Retrieves the OIDs of any response controls contained in the log message.- Specified by:
getResponseControlOIDs
in interfaceIntermediateResponseAccessLogMessage
- 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.
-
-