com.unboundid.ldap.sdk.unboundidds.logs

Class AbandonRequestAccessLogMessage

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.AbandonRequestAccessLogMessage

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AbandonForwardAccessLogMessage, AbandonResultAccessLogMessage

@NotExtensible
 @NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public class AbandonRequestAccessLogMessage
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 abandon request received from 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
AbandonRequestAccessLogMessage(LogMessage m) Creates a new abandon request access log message from the provided log message.
AbandonRequestAccessLogMessage(java.lang.String s) Creates a new abandon request access log message from the provided message string.

Method Summary

Modifier and Type	Method and 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.OperationRequestAccessLogMessage

getIntermediateClientRequest, getMessageType, 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

AbandonRequestAccessLogMessage

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

Creates a new abandon request access log message from the provided message string.

Parameters:

s - The string to be parsed as an abandon request access log message.

Throws:

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

AbandonRequestAccessLogMessage

public AbandonRequestAccessLogMessage(@NotNull
                                      LogMessage m)

Creates a new abandon request access log message from the provided log message.

Parameters:

m - The log message to be parsed as an abandon request access log message.

Method Detail

getMessageIDToAbandon

@Nullable
public final java.lang.Integer getMessageIDToAbandon()

Retrieves the message ID of the operation that should be abandoned.

Returns:

The message ID of the operation that should be abandoned, or null if it is not included in the log message.

getOperationType

@NotNull
public final 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.