Class TextFormattedAbandonRequestAccessLogMessage
- 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.TextFormattedAbandonRequestAccessLogMessage
-
- All Implemented Interfaces:
AbandonRequestAccessLogMessage
,AccessLogMessage
,LogMessage
,OperationRequestAccessLogMessage
,java.io.Serializable
- Direct Known Subclasses:
TextFormattedAbandonForwardAccessLogMessage
,TextFormattedAbandonResultAccessLogMessage
@NotExtensible @NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public class TextFormattedAbandonRequestAccessLogMessage extends TextFormattedRequestAccessLogMessage implements AbandonRequestAccessLogMessage
This class provides a data structure that holds information about a text-formatted abandon 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
-
-
Constructor Summary
Constructors Constructor Description TextFormattedAbandonRequestAccessLogMessage(java.lang.String logMessageString)
Creates a new text-formatted abandon request access log message from the provided message string.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Integer
getMessageIDToAbandon()
Retrieves the message ID of the operation that should be abandoned.AccessLogOperationType
getOperationType()
Retrieves the operation type for the associated operation.-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedRequestAccessLogMessage
getAdministrativeOperationMessage, getIntermediateClientRequestControl, getMessageID, getMessageType, 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, 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
-
Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.OperationRequestAccessLogMessage
getAdministrativeOperationMessage, getMessageID, getOperationID, getOrigin, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, getTriggeredByConnectionID, getTriggeredByOperationID, getUsingAdminSessionWorkerThread
-
-
-
-
Constructor Detail
-
TextFormattedAbandonRequestAccessLogMessage
public TextFormattedAbandonRequestAccessLogMessage(@NotNull java.lang.String logMessageString) throws LogException
Creates a new text-formatted abandon request access log message from the provided message string.- Parameters:
logMessageString
- The string representation of this log message. It must not benull
.- Throws:
LogException
- If the provided string cannot be parsed as a valid log message.
-
-
Method Detail
-
getOperationType
@NotNull public final AccessLogOperationType getOperationType()
Retrieves the operation type for the associated operation.- Specified by:
getOperationType
in interfaceOperationRequestAccessLogMessage
- Returns:
- The operation type for this access log message.
-
getMessageIDToAbandon
@Nullable public final java.lang.Integer getMessageIDToAbandon()
Retrieves the message ID of the operation that should be abandoned.- Specified by:
getMessageIDToAbandon
in interfaceAbandonRequestAccessLogMessage
- Returns:
- The message ID of the operation that should be abandoned, or
null
if it is not included in the log message.
-
-