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
,java.io.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 java.lang.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, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.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(java.lang.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
-
-
-
-
Field Detail
-
ABORTED_TRANSACTION_RESULT_OID
public static final java.lang.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 Detail
-
AbortedTransactionExtendedResult
public AbortedTransactionExtendedResult(ASN1OctetString transactionID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, 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 benull
.resultCode
- The result code for this aborted transaction result. It must not benull
.diagnosticMessage
- The diagnostic message for this aborted transaction result. It may benull
if there is no diagnostic message.matchedDN
- The matched DN for this aborted transaction result. It may benull
if there is no matched DN.referralURLs
- The referral URLs for this aborted transaction result. It may benull
or empty if there are no referral URLs.controls
- The controls for this aborted transaction result. It may benull
or empty if there are no controls.
-
AbortedTransactionExtendedResult
public AbortedTransactionExtendedResult(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 Detail
-
getTransactionID
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
public java.lang.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, thennull
will be returned.- Overrides:
getExtendedResultName
in classExtendedResult
- 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(java.lang.StringBuilder buffer)
Appends a string representation of this extended result to the provided buffer.- Specified by:
toString
in interfaceLDAPResponse
- Overrides:
toString
in classExtendedResult
- Parameters:
buffer
- The buffer to which a string representation of this extended result will be appended.
-
-