Package com.unboundid.ldap.sdk.extensions

Class AbortedTransactionExtendedResult

java.lang.Object

com.unboundid.ldap.sdk.LDAPResult

com.unboundid.ldap.sdk.ExtendedResult

com.unboundid.ldap.sdk.extensions.AbortedTransactionExtendedResult

All Implemented Interfaces:

LDAPResponse, Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class AbortedTransactionExtendedResult
extends ExtendedResult

This class provides an implementation of the aborted transaction extended result as defined in RFC 5805, which is used as an unsolicited notification to indicate that the server has aborted an LDAP transaction without the client's explicit request.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ABORTED_TRANSACTION_RESULT_OID	The OID (1.3.6.1.1.21.4) for the aborted transaction extended result.

Fields inherited from interface com.unboundid.ldap.protocol.LDAPResponse

NO_CONTROLS

Constructor Summary

Constructors

Constructor	Description
AbortedTransactionExtendedResult(ASN1OctetString transactionID, ResultCode resultCode, String diagnosticMessage, String matchedDN, String[] referralURLs, Control[] controls)	Creates a new instance of this aborted transaction extended result with the provided information.
AbortedTransactionExtendedResult(ExtendedResult extendedResult)	Creates a new instance of this aborted transaction extended result from the provided generic extended result.

Method Summary

Modifier and Type	Method	Description
String	getExtendedResultName()	Retrieves the user-friendly name for the extended result, if available.
ASN1OctetString	getTransactionID()	Retrieves the transaction ID of the transaction that has been aborted.
void	toString(StringBuilder buffer)	Appends a string representation of this extended result to the provided buffer.

Methods inherited from class com.unboundid.ldap.sdk.ExtendedResult

getOID, getValue, hasValue, toString

Methods inherited from class com.unboundid.ldap.sdk.LDAPResult

getDiagnosticMessage, getMatchedDN, getMessageID, getOperationType, getReferralURLs, getResponseControl, getResponseControls, getResultCode, getResultString, hasResponseControl, hasResponseControl

Methods inherited from class java.lang.Object

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

Field Details

ABORTED_TRANSACTION_RESULT_OID

@NotNull
public static final String ABORTED_TRANSACTION_RESULT_OID

The OID (1.3.6.1.1.21.4) for the aborted transaction extended result.

See Also:

• Constant Field Values

Constructor Details

AbortedTransactionExtendedResult

public AbortedTransactionExtendedResult(@NotNull
 ASN1OctetString transactionID,
 @NotNull
 ResultCode resultCode,
 @Nullable
 String diagnosticMessage,
 @Nullable
 String matchedDN,
 @Nullable
 String[] referralURLs,
 @Nullable
 Control[] controls)

Creates a new instance of this aborted transaction extended result with the provided information.

Parameters:

transactionID - The transaction ID of the transaction that has been aborted. It must not be null.

resultCode - The result code for this aborted transaction result. It must not be null.

diagnosticMessage - The diagnostic message for this aborted transaction result. It may be null if there is no diagnostic message.

matchedDN - The matched DN for this aborted transaction result. It may be null if there is no matched DN.

referralURLs - The referral URLs for this aborted transaction result. It may be null or empty if there are no referral URLs.

controls - The controls for this aborted transaction result. It may be null or empty if there are no controls.

AbortedTransactionExtendedResult

public AbortedTransactionExtendedResult(@NotNull
 ExtendedResult extendedResult)
                                 throws LDAPException

Creates a new instance of this aborted transaction extended result from the provided generic extended result.

Parameters:

extendedResult - The extended result to use to create this aborted transaction extended result.

Throws:

LDAPException - If the provided extended result cannot be decoded as an aborted transaction extended result.

Method Details

getTransactionID

@NotNull
public ASN1OctetString getTransactionID()

Retrieves the transaction ID of the transaction that has been aborted.

Returns:

The transaction ID of the transaction that has been aborted.

getExtendedResultName

@NotNull
public String getExtendedResultName()

Retrieves the user-friendly name for the extended result, if available. If no user-friendly name has been defined, but a response OID is available, then that will be returned. If neither a user-friendly name nor a response OID are available, then null will be returned.

Overrides:

getExtendedResultName in class ExtendedResult

Returns:

The user-friendly name for this extended request, the response OID if a user-friendly name is not available but a response OID is, or null if neither a user-friendly name nor a response OID are available.

toString

public void toString(@NotNull
 StringBuilder buffer)

Appends a string representation of this extended result to the provided buffer.

Specified by:

toString in interface LDAPResponse

Overrides:

toString in class ExtendedResult

Parameters:

buffer - The buffer to which a string representation of this extended result will be appended.